diff --git a/fern/openapi/openapi.json b/fern/openapi/openapi.json index 5b80291..15b35a9 100644 --- a/fern/openapi/openapi.json +++ b/fern/openapi/openapi.json @@ -4,7 +4,10 @@ "title": "Vocode Hosted API", "description": "\n Vocode's Hosted API helps you automate phone calls in minutes. 🚀\n\n ## Numbers\n\n You can buy phone lines and place agents on them.\n\n ## Calls\n\n You can start, end, and get information about calls.\n ", "termsOfService": "http://example.com/terms/", - "contact": { "name": "Support", "email": "support@vocode.dev" }, + "contact": { + "name": "Support", + "email": "support@vocode.dev" + }, "version": "1.0.0" }, "servers": [ @@ -17,19 +20,29 @@ "paths": { "/v1/numbers/list": { "get": { - "tags": ["numbers"], + "tags": [ + "numbers" + ], "summary": "List Numbers", "operationId": "list_numbers", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -39,7 +52,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PhoneNumberPage" } + "schema": { + "$ref": "#/components/schemas/PhoneNumberPage" + } } } }, @@ -47,23 +62,34 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/numbers": { "get": { - "tags": ["numbers"], + "tags": [ + "numbers" + ], "summary": "Get Number", "operationId": "get_number", "parameters": [ { "required": true, - "schema": { "type": "string", "title": "Phone Number" }, + "schema": { + "type": "string", + "title": "Phone Number" + }, "name": "phone_number", "in": "query" } @@ -73,7 +99,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PhoneNumber" } + "schema": { + "$ref": "#/components/schemas/PhoneNumber" + } } } }, @@ -81,17 +109,25 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/numbers/buy": { "post": { - "tags": ["numbers"], + "tags": [ + "numbers" + ], "summary": "Buy Number", "operationId": "buy_number", "requestBody": { @@ -99,10 +135,14 @@ "application/json": { "schema": { "allOf": [ - { "$ref": "#/components/schemas/BuyPhoneNumberRequest" } + { + "$ref": "#/components/schemas/BuyPhoneNumberRequest" + } ], "title": "Request", - "default": { "telephony_provider": "vonage" } + "default": { + "telephony_provider": "vonage" + } } } } @@ -112,7 +152,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PhoneNumber" } + "schema": { + "$ref": "#/components/schemas/PhoneNumber" + } } } }, @@ -120,23 +162,34 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/numbers/update": { "post": { - "tags": ["numbers"], + "tags": [ + "numbers" + ], "summary": "Update Number", "operationId": "update_number", "parameters": [ { "required": true, - "schema": { "type": "string", "title": "Phone Number" }, + "schema": { + "type": "string", + "title": "Phone Number" + }, "name": "phone_number", "in": "query" } @@ -144,7 +197,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/UpdateNumberRequest" } + "schema": { + "$ref": "#/components/schemas/UpdateNumberRequest" + } } }, "required": true @@ -154,7 +209,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PhoneNumber" } + "schema": { + "$ref": "#/components/schemas/PhoneNumber" + } } } }, @@ -162,23 +219,34 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/numbers/cancel": { "post": { - "tags": ["numbers"], + "tags": [ + "numbers" + ], "summary": "Cancel Number", "operationId": "cancel_number", "parameters": [ { "required": true, - "schema": { "type": "string", "title": "Phone Number" }, + "schema": { + "type": "string", + "title": "Phone Number" + }, "name": "phone_number", "in": "query" } @@ -188,7 +256,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PhoneNumber" } + "schema": { + "$ref": "#/components/schemas/PhoneNumber" + } } } }, @@ -196,17 +266,25 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/numbers/link": { "post": { - "tags": ["numbers"], + "tags": [ + "numbers" + ], "summary": "Link Number", "operationId": "link_number", "requestBody": { @@ -224,7 +302,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PhoneNumber" } + "schema": { + "$ref": "#/components/schemas/PhoneNumber" + } } } }, @@ -232,29 +312,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/calls/list": { "get": { - "tags": ["calls"], + "tags": [ + "calls" + ], "summary": "List Calls", "operationId": "list_calls", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -264,7 +360,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/CallPage" } + "schema": { + "$ref": "#/components/schemas/CallPage" + } } } }, @@ -272,23 +370,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/calls": { "get": { - "tags": ["calls"], + "tags": [ + "calls" + ], "summary": "Get Call", "operationId": "get_call", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -298,7 +408,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Call" } + "schema": { + "$ref": "#/components/schemas/Call" + } } } }, @@ -306,23 +418,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/calls/end": { "post": { - "tags": ["calls"], + "tags": [ + "calls" + ], "summary": "End Call", "operationId": "end_call", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -332,7 +456,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Call" } + "schema": { + "$ref": "#/components/schemas/Call" + } } } }, @@ -340,23 +466,33 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/calls/create": { "post": { - "tags": ["calls"], + "tags": [ + "calls" + ], "summary": "Create Call", "operationId": "create_call", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/CreateCallRequest" } + "schema": { + "$ref": "#/components/schemas/CreateCallRequest" + } } }, "required": true @@ -366,7 +502,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Call" } + "schema": { + "$ref": "#/components/schemas/Call" + } } } }, @@ -374,23 +512,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/calls/recording": { "get": { - "tags": ["calls"], + "tags": [ + "calls" + ], "summary": "Get Recording", "operationId": "get_recording", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -398,23 +548,33 @@ "responses": { "200": { "description": "Successful Response", - "content": { "audio/mpeg": {} } + "content": { + "audio/mpeg": {} + } }, "422": { "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/usage": { "get": { - "tags": ["usage"], + "tags": [ + "usage" + ], "summary": "Get Usage", "operationId": "get_usage", "responses": { @@ -422,23 +582,35 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Usage" } + "schema": { + "$ref": "#/components/schemas/Usage" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/actions": { "get": { - "tags": ["actions"], + "tags": [ + "actions" + ], "summary": "Get Action", "operationId": "get_action", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -448,7 +620,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ActionResponseModel" } + "schema": { + "$ref": "#/components/schemas/ActionResponseModel" + } } } }, @@ -456,29 +630,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/actions/list": { "get": { - "tags": ["actions"], + "tags": [ + "actions" + ], "summary": "List Actions", "operationId": "list_actions", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -488,7 +678,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ActionPage" } + "schema": { + "$ref": "#/components/schemas/ActionPage" + } } } }, @@ -496,23 +688,33 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/actions/create": { "post": { - "tags": ["actions"], + "tags": [ + "actions" + ], "summary": "Create Action", "operationId": "create_action", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ActionParamsRequest" } + "schema": { + "$ref": "#/components/schemas/ActionParamsRequest" + } } }, "required": true @@ -522,7 +724,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ActionResponseModel" } + "schema": { + "$ref": "#/components/schemas/ActionResponseModel" + } } } }, @@ -530,23 +734,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/actions/update": { "post": { - "tags": ["actions"], + "tags": [ + "actions" + ], "summary": "Update Action", "operationId": "update_action", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -566,7 +782,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ActionResponseModel" } + "schema": { + "$ref": "#/components/schemas/ActionResponseModel" + } } } }, @@ -574,23 +792,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/agents": { "get": { - "tags": ["agents"], + "tags": [ + "agents" + ], "summary": "Get Agent", "operationId": "get_agent", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -600,7 +830,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Agent" } + "schema": { + "$ref": "#/components/schemas/Agent" + } } } }, @@ -608,29 +840,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/agents/list": { "get": { - "tags": ["agents"], + "tags": [ + "agents" + ], "summary": "List Agents", "operationId": "list_agents", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -640,7 +888,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AgentPage" } + "schema": { + "$ref": "#/components/schemas/AgentPage" + } } } }, @@ -648,23 +898,33 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/agents/create": { "post": { - "tags": ["agents"], + "tags": [ + "agents" + ], "summary": "Create Agent", "operationId": "create_agent", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AgentParams" } + "schema": { + "$ref": "#/components/schemas/AgentParams" + } } }, "required": true @@ -674,7 +934,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Agent" } + "schema": { + "$ref": "#/components/schemas/Agent" + } } } }, @@ -682,23 +944,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/agents/update": { "post": { - "tags": ["agents"], + "tags": [ + "agents" + ], "summary": "Update Agent", "operationId": "update_agent", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -706,7 +980,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AgentUpdateParams" } + "schema": { + "$ref": "#/components/schemas/AgentUpdateParams" + } } }, "required": true @@ -716,7 +992,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Agent" } + "schema": { + "$ref": "#/components/schemas/Agent" + } } } }, @@ -724,23 +1002,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/voices": { "get": { - "tags": ["voices"], + "tags": [ + "voices" + ], "summary": "Get Voice", "operationId": "get_voice", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -750,7 +1040,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/VoiceResponseModel" } + "schema": { + "$ref": "#/components/schemas/VoiceResponseModel" + } } } }, @@ -758,29 +1050,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/voices/list": { "get": { - "tags": ["voices"], + "tags": [ + "voices" + ], "summary": "List Voices", "operationId": "list_voices", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -790,7 +1098,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/VoicePage" } + "schema": { + "$ref": "#/components/schemas/VoicePage" + } } } }, @@ -798,23 +1108,33 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/voices/create": { "post": { - "tags": ["voices"], + "tags": [ + "voices" + ], "summary": "Create Voice", "operationId": "create_voice", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/VoiceParamsRequest" } + "schema": { + "$ref": "#/components/schemas/VoiceParamsRequest" + } } }, "required": true @@ -824,7 +1144,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/VoiceResponseModel" } + "schema": { + "$ref": "#/components/schemas/VoiceResponseModel" + } } } }, @@ -832,23 +1154,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/voices/update": { "post": { - "tags": ["voices"], + "tags": [ + "voices" + ], "summary": "Update Voice", "operationId": "update_voice", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -868,7 +1202,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/VoiceResponseModel" } + "schema": { + "$ref": "#/components/schemas/VoiceResponseModel" + } } } }, @@ -876,23 +1212,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/webhooks": { "get": { - "tags": ["webhooks"], + "tags": [ + "webhooks" + ], "summary": "Get Webhook", "operationId": "get_webhook", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -902,7 +1250,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Webhook" } + "schema": { + "$ref": "#/components/schemas/Webhook" + } } } }, @@ -910,29 +1260,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/webhooks/list": { "get": { - "tags": ["webhooks"], + "tags": [ + "webhooks" + ], "summary": "List Webhooks", "operationId": "list_webhooks", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -942,7 +1308,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/WebhookPage" } + "schema": { + "$ref": "#/components/schemas/WebhookPage" + } } } }, @@ -950,23 +1318,33 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/webhooks/create": { "post": { - "tags": ["webhooks"], + "tags": [ + "webhooks" + ], "summary": "Create Webhook", "operationId": "create_webhook", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/WebhookParams" } + "schema": { + "$ref": "#/components/schemas/WebhookParams" + } } }, "required": true @@ -976,7 +1354,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Webhook" } + "schema": { + "$ref": "#/components/schemas/Webhook" + } } } }, @@ -984,23 +1364,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/webhooks/update": { "post": { - "tags": ["webhooks"], + "tags": [ + "webhooks" + ], "summary": "Update Webhook", "operationId": "update_webhook", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -1008,7 +1400,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/WebhookUpdateParams" } + "schema": { + "$ref": "#/components/schemas/WebhookUpdateParams" + } } }, "required": true @@ -1018,7 +1412,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Webhook" } + "schema": { + "$ref": "#/components/schemas/Webhook" + } } } }, @@ -1026,23 +1422,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/prompts": { "get": { - "tags": ["prompts"], + "tags": [ + "prompts" + ], "summary": "Get Prompt", "operationId": "get_prompt", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -1052,7 +1460,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Prompt" } + "schema": { + "$ref": "#/components/schemas/Prompt" + } } } }, @@ -1060,29 +1470,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/prompts/list": { "get": { - "tags": ["prompts"], + "tags": [ + "prompts" + ], "summary": "List Prompts", "operationId": "list_prompts", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -1092,7 +1518,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PromptPage" } + "schema": { + "$ref": "#/components/schemas/PromptPage" + } } } }, @@ -1100,23 +1528,33 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/prompts/create": { "post": { - "tags": ["prompts"], + "tags": [ + "prompts" + ], "summary": "Create Prompt", "operationId": "create_prompt", "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PromptParams" } + "schema": { + "$ref": "#/components/schemas/PromptParams" + } } }, "required": true @@ -1126,7 +1564,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Prompt" } + "schema": { + "$ref": "#/components/schemas/Prompt" + } } } }, @@ -1134,23 +1574,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/prompts/update": { "post": { - "tags": ["prompts"], + "tags": [ + "prompts" + ], "summary": "Update Prompt", "operationId": "update_prompt", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -1158,7 +1610,9 @@ "requestBody": { "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/PromptUpdateParams" } + "schema": { + "$ref": "#/components/schemas/PromptUpdateParams" + } } }, "required": true @@ -1168,7 +1622,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/Prompt" } + "schema": { + "$ref": "#/components/schemas/Prompt" + } } } }, @@ -1176,23 +1632,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/vector_databases": { "get": { - "tags": ["vector_databases"], + "tags": [ + "vector_databases" + ], "summary": "Get Vector Database", "operationId": "get_vector_database", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -1212,29 +1680,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/vector_databases/list": { "get": { - "tags": ["vector_databases"], + "tags": [ + "vector_databases" + ], "summary": "List Vector Databases", "operationId": "list_vector_databases", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -1244,7 +1728,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/VectorDatabasePage" } + "schema": { + "$ref": "#/components/schemas/VectorDatabasePage" + } } } }, @@ -1252,17 +1738,25 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/vector_databases/create": { "post": { - "tags": ["vector_databases"], + "tags": [ + "vector_databases" + ], "summary": "Create Vector Database", "operationId": "create_vector_database", "requestBody": { @@ -1290,23 +1784,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/vector_databases/update": { "post": { - "tags": ["vector_databases"], + "tags": [ + "vector_databases" + ], "summary": "Update Vector Database", "operationId": "update_vector_database", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -1336,23 +1842,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/account_connections": { "get": { - "tags": ["account_connections"], + "tags": [ + "account_connections" + ], "summary": "Get Account Connection", "operationId": "get_account_connection", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -1372,29 +1890,45 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/account_connections/list": { "get": { - "tags": ["account_connections"], + "tags": [ + "account_connections" + ], "summary": "List Account Connections", "operationId": "list_account_connections", "parameters": [ { "required": false, - "schema": { "type": "integer", "title": "Page", "default": 1 }, + "schema": { + "type": "integer", + "title": "Page", + "default": 1 + }, "name": "page", "in": "query" }, { "required": false, - "schema": { "type": "integer", "title": "Size", "default": 10 }, + "schema": { + "type": "integer", + "title": "Size", + "default": 10 + }, "name": "size", "in": "query" } @@ -1414,17 +1948,25 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/account_connections/create": { "post": { - "tags": ["account_connections"], + "tags": [ + "account_connections" + ], "summary": "Create Account Connection", "operationId": "create_account_connection", "requestBody": { @@ -1452,23 +1994,35 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } }, "/v1/account_connections/update": { "post": { - "tags": ["account_connections"], + "tags": [ + "account_connections" + ], "summary": "Update Account Connection", "operationId": "update_account_connection", "parameters": [ { "required": true, - "schema": { "type": "string", "format": "uuid", "title": "Id" }, + "schema": { + "type": "string", + "format": "uuid", + "title": "Id" + }, "name": "id", "in": "query" } @@ -1498,12 +2052,18 @@ "description": "Validation Error", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/HTTPValidationError" } + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } } } } }, - "security": [{ "HTTPBearer": [] }] + "security": [ + { + "HTTPBearer": [] + } + ] } } }, @@ -1514,8 +2074,12 @@ "items": { "items": { "oneOf": [ - { "$ref": "#/components/schemas/TwilioAccountConnection" }, - { "$ref": "#/components/schemas/OpenAIAccountConnection" } + { + "$ref": "#/components/schemas/TwilioAccountConnection" + }, + { + "$ref": "#/components/schemas/OpenAIAccountConnection" + } ], "discriminator": { "propertyName": "type", @@ -1528,18 +2092,36 @@ "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "AccountConnectionPage" }, "AccountConnectionParamsRequest": { "oneOf": [ - { "$ref": "#/components/schemas/TwilioAccountConnectionParams" }, - { "$ref": "#/components/schemas/OpenAIAccountConnectionParams" } + { + "$ref": "#/components/schemas/TwilioAccountConnectionParams" + }, + { + "$ref": "#/components/schemas/OpenAIAccountConnectionParams" + } ], "title": "AccountConnectionParamsRequest", "discriminator": { @@ -1552,8 +2134,12 @@ }, "AccountConnectionResponseModel": { "oneOf": [ - { "$ref": "#/components/schemas/TwilioAccountConnection" }, - { "$ref": "#/components/schemas/OpenAIAccountConnection" } + { + "$ref": "#/components/schemas/TwilioAccountConnection" + }, + { + "$ref": "#/components/schemas/OpenAIAccountConnection" + } ], "title": "AccountConnectionResponseModel", "discriminator": { @@ -1569,7 +2155,9 @@ { "$ref": "#/components/schemas/TwilioAccountConnectionUpdateParams" }, - { "$ref": "#/components/schemas/OpenAIAccountConnectionUpdateParams" } + { + "$ref": "#/components/schemas/OpenAIAccountConnectionUpdateParams" + } ], "title": "AccountConnectionUpdateParamsRequest", "discriminator": { @@ -1585,11 +2173,21 @@ "items": { "items": { "oneOf": [ - { "$ref": "#/components/schemas/TransferCallAction" }, - { "$ref": "#/components/schemas/EndConversationAction" }, - { "$ref": "#/components/schemas/DTMFAction" }, - { "$ref": "#/components/schemas/AddToConferenceAction" }, - { "$ref": "#/components/schemas/SetHoldAction" } + { + "$ref": "#/components/schemas/TransferCallAction" + }, + { + "$ref": "#/components/schemas/EndConversationAction" + }, + { + "$ref": "#/components/schemas/DTMFAction" + }, + { + "$ref": "#/components/schemas/AddToConferenceAction" + }, + { + "$ref": "#/components/schemas/SetHoldAction" + } ], "discriminator": { "propertyName": "type", @@ -1605,21 +2203,45 @@ "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "ActionPage" }, "ActionParamsRequest": { "oneOf": [ - { "$ref": "#/components/schemas/TransferCallActionParams" }, - { "$ref": "#/components/schemas/EndConversationActionParams" }, - { "$ref": "#/components/schemas/DTMFActionParams" }, - { "$ref": "#/components/schemas/AddToConferenceActionParams" }, - { "$ref": "#/components/schemas/SetHoldActionParams" } + { + "$ref": "#/components/schemas/TransferCallActionParams" + }, + { + "$ref": "#/components/schemas/EndConversationActionParams" + }, + { + "$ref": "#/components/schemas/DTMFActionParams" + }, + { + "$ref": "#/components/schemas/AddToConferenceActionParams" + }, + { + "$ref": "#/components/schemas/SetHoldActionParams" + } ], "title": "ActionParamsRequest", "discriminator": { @@ -1635,11 +2257,21 @@ }, "ActionResponseModel": { "oneOf": [ - { "$ref": "#/components/schemas/TransferCallAction" }, - { "$ref": "#/components/schemas/EndConversationAction" }, - { "$ref": "#/components/schemas/DTMFAction" }, - { "$ref": "#/components/schemas/AddToConferenceAction" }, - { "$ref": "#/components/schemas/SetHoldAction" } + { + "$ref": "#/components/schemas/TransferCallAction" + }, + { + "$ref": "#/components/schemas/EndConversationAction" + }, + { + "$ref": "#/components/schemas/DTMFAction" + }, + { + "$ref": "#/components/schemas/AddToConferenceAction" + }, + { + "$ref": "#/components/schemas/SetHoldAction" + } ], "title": "ActionResponseModel", "discriminator": { @@ -1655,11 +2287,21 @@ }, "ActionUpdateParamsRequest": { "oneOf": [ - { "$ref": "#/components/schemas/TransferCallActionUpdateParams" }, - { "$ref": "#/components/schemas/EndConversationActionUpdateParams" }, - { "$ref": "#/components/schemas/DTMFActionUpdateParams" }, - { "$ref": "#/components/schemas/AddToConferenceActionUpdateParams" }, - { "$ref": "#/components/schemas/SetHoldActionUpdateParams" } + { + "$ref": "#/components/schemas/TransferCallActionUpdateParams" + }, + { + "$ref": "#/components/schemas/EndConversationActionUpdateParams" + }, + { + "$ref": "#/components/schemas/DTMFActionUpdateParams" + }, + { + "$ref": "#/components/schemas/AddToConferenceActionUpdateParams" + }, + { + "$ref": "#/components/schemas/SetHoldActionUpdateParams" + } ], "title": "ActionUpdateParamsRequest", "discriminator": { @@ -1675,21 +2317,40 @@ }, "AddToConferenceAction": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["action_add_to_conference"], + "enum": [ + "action_add_to_conference" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/AddToConferenceConfig" }, + "config": { + "$ref": "#/components/schemas/AddToConferenceConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -1700,24 +2361,40 @@ } }, "type": "object", - "required": ["id", "user_id", "type", "config"], + "required": [ + "id", + "user_id", + "type", + "config" + ], "title": "AddToConferenceAction" }, "AddToConferenceActionParams": { "properties": { "type": { "type": "string", - "enum": ["action_add_to_conference"], + "enum": [ + "action_add_to_conference" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/AddToConferenceConfig" }, + "config": { + "$ref": "#/components/schemas/AddToConferenceConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -1728,20 +2405,29 @@ } }, "type": "object", - "required": ["type", "config"], + "required": [ + "type", + "config" + ], "title": "AddToConferenceActionParams" }, "AddToConferenceActionUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["action_add_to_conference"], + "enum": [ + "action_add_to_conference" + ], "title": "Type" }, "config": { "anyOf": [ - { "$ref": "#/components/schemas/AddToConferenceConfig" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/AddToConferenceConfig" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Config" }, @@ -1749,23 +2435,34 @@ "anyOf": [ { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ] }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Action Trigger", "default": {} } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "AddToConferenceActionUpdateParams" }, "AddToConferenceConfig": { "properties": { - "phone_number": { "type": "string", "title": "Phone Number" }, + "phone_number": { + "type": "string", + "title": "Phone Number" + }, "place_primary_on_hold": { "type": "boolean", "title": "Place Primary On Hold", @@ -1773,26 +2470,52 @@ } }, "type": "object", - "required": ["phone_number"], + "required": [ + "phone_number" + ], "title": "AddToConferenceConfig" }, "Agent": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "prompt": { "$ref": "#/components/schemas/Prompt" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "prompt": { + "$ref": "#/components/schemas/Prompt" + }, "language": { - "allOf": [{ "$ref": "#/components/schemas/Language" }], + "allOf": [ + { + "$ref": "#/components/schemas/Language" + } + ], "default": "en" }, "actions": { "items": { "oneOf": [ - { "$ref": "#/components/schemas/TransferCallAction" }, - { "$ref": "#/components/schemas/EndConversationAction" }, - { "$ref": "#/components/schemas/DTMFAction" }, - { "$ref": "#/components/schemas/AddToConferenceAction" }, - { "$ref": "#/components/schemas/SetHoldAction" } + { + "$ref": "#/components/schemas/TransferCallAction" + }, + { + "$ref": "#/components/schemas/EndConversationAction" + }, + { + "$ref": "#/components/schemas/DTMFAction" + }, + { + "$ref": "#/components/schemas/AddToConferenceAction" + }, + { + "$ref": "#/components/schemas/SetHoldAction" + } ], "discriminator": { "propertyName": "type", @@ -1810,10 +2533,18 @@ }, "voice": { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoice" }, - { "$ref": "#/components/schemas/RimeVoice" }, - { "$ref": "#/components/schemas/ElevenLabsVoice" }, - { "$ref": "#/components/schemas/PlayHtVoice" } + { + "$ref": "#/components/schemas/AzureVoice" + }, + { + "$ref": "#/components/schemas/RimeVoice" + }, + { + "$ref": "#/components/schemas/ElevenLabsVoice" + }, + { + "$ref": "#/components/schemas/PlayHtVoice" + } ], "title": "Voice", "discriminator": { @@ -1826,16 +2557,28 @@ } } }, - "initial_message": { "type": "string", "title": "Initial Message" }, - "webhook": { "$ref": "#/components/schemas/Webhook" }, + "initial_message": { + "type": "string", + "title": "Initial Message" + }, + "webhook": { + "$ref": "#/components/schemas/Webhook" + }, "vector_database": { "$ref": "#/components/schemas/PineconeVectorDatabase" }, "interrupt_sensitivity": { - "allOf": [{ "$ref": "#/components/schemas/InterruptSensitivity" }], + "allOf": [ + { + "$ref": "#/components/schemas/InterruptSensitivity" + } + ], "default": "low" }, - "context_endpoint": { "type": "string", "title": "Context Endpoint" }, + "context_endpoint": { + "type": "string", + "title": "Context Endpoint" + }, "noise_suppression": { "type": "boolean", "title": "Noise Suppression", @@ -1843,13 +2586,20 @@ }, "endpointing_sensitivity": { "type": "string", - "enum": ["auto", "relaxed", "sensitive"], + "enum": [ + "auto", + "relaxed", + "sensitive" + ], "title": "Endpointing Sensitivity", "default": "auto" }, "ivr_navigation_mode": { "type": "string", - "enum": ["default", "off"], + "enum": [ + "default", + "off" + ], "title": "Ivr Navigation Mode", "default": "off" }, @@ -1882,52 +2632,92 @@ } }, "type": "object", - "required": ["id", "user_id", "prompt", "actions", "voice"], + "required": [ + "id", + "user_id", + "prompt", + "actions", + "voice" + ], "title": "Agent" }, "AgentPage": { "properties": { "items": { - "items": { "$ref": "#/components/schemas/NormalizedAgent" }, + "items": { + "$ref": "#/components/schemas/NormalizedAgent" + }, "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "AgentPage" }, "AgentParams": { "properties": { "prompt": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PromptParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PromptParams" + } ], "title": "Prompt" }, "language": { - "allOf": [{ "$ref": "#/components/schemas/Language" }], + "allOf": [ + { + "$ref": "#/components/schemas/Language" + } + ], "default": "en" }, "actions": { "items": { "anyOf": [ - { "type": "string", "format": "uuid" }, + { + "type": "string", + "format": "uuid" + }, { "oneOf": [ - { "$ref": "#/components/schemas/TransferCallActionParams" }, + { + "$ref": "#/components/schemas/TransferCallActionParams" + }, { "$ref": "#/components/schemas/EndConversationActionParams" }, - { "$ref": "#/components/schemas/DTMFActionParams" }, + { + "$ref": "#/components/schemas/DTMFActionParams" + }, { "$ref": "#/components/schemas/AddToConferenceActionParams" }, - { "$ref": "#/components/schemas/SetHoldActionParams" } + { + "$ref": "#/components/schemas/SetHoldActionParams" + } ] } ] @@ -1938,38 +2728,69 @@ }, "voice": { "anyOf": [ - { "type": "string", "format": "uuid" }, + { + "type": "string", + "format": "uuid" + }, { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoiceParams" }, - { "$ref": "#/components/schemas/RimeVoiceParams" }, - { "$ref": "#/components/schemas/ElevenLabsVoiceParams" }, - { "$ref": "#/components/schemas/PlayHtVoiceParams" } + { + "$ref": "#/components/schemas/AzureVoiceParams" + }, + { + "$ref": "#/components/schemas/RimeVoiceParams" + }, + { + "$ref": "#/components/schemas/ElevenLabsVoiceParams" + }, + { + "$ref": "#/components/schemas/PlayHtVoiceParams" + } ] } ], "title": "Voice" }, - "initial_message": { "type": "string", "title": "Initial Message" }, + "initial_message": { + "type": "string", + "title": "Initial Message" + }, "webhook": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/WebhookParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/WebhookParams" + } ], "title": "Webhook" }, "vector_database": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PineconeVectorDatabaseParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PineconeVectorDatabaseParams" + } ], "title": "Vector Database" }, "interrupt_sensitivity": { - "allOf": [{ "$ref": "#/components/schemas/InterruptSensitivity" }], + "allOf": [ + { + "$ref": "#/components/schemas/InterruptSensitivity" + } + ], "default": "low" }, - "context_endpoint": { "type": "string", "title": "Context Endpoint" }, + "context_endpoint": { + "type": "string", + "title": "Context Endpoint" + }, "noise_suppression": { "type": "boolean", "title": "Noise Suppression", @@ -1977,13 +2798,20 @@ }, "endpointing_sensitivity": { "type": "string", - "enum": ["auto", "relaxed", "sensitive"], + "enum": [ + "auto", + "relaxed", + "sensitive" + ], "title": "Endpointing Sensitivity", "default": "auto" }, "ivr_navigation_mode": { "type": "string", - "enum": ["default", "off"], + "enum": [ + "default", + "off" + ], "title": "Ivr Navigation Mode", "default": "off" }, @@ -2008,8 +2836,13 @@ }, "openai_account_connection": { "anyOf": [ - { "$ref": "#/components/schemas/OpenAIAccountConnection" }, - { "type": "string", "format": "uuid" } + { + "$ref": "#/components/schemas/OpenAIAccountConnection" + }, + { + "type": "string", + "format": "uuid" + } ], "title": "Openai Account Connection" }, @@ -2020,23 +2853,37 @@ } }, "type": "object", - "required": ["prompt", "voice"], + "required": [ + "prompt", + "voice" + ], "title": "AgentParams" }, "AgentUpdateParams": { "properties": { "prompt": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PromptUpdateParams" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PromptUpdateParams" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Prompt" }, "language": { "anyOf": [ - { "$ref": "#/components/schemas/Language" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Language" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Language" }, @@ -2045,7 +2892,10 @@ { "items": { "anyOf": [ - { "type": "string", "format": "uuid" }, + { + "type": "string", + "format": "uuid" + }, { "oneOf": [ { @@ -2069,127 +2919,212 @@ }, "type": "array" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Actions" }, "voice": { "anyOf": [ - { "type": "string", "format": "uuid" }, + { + "type": "string", + "format": "uuid" + }, { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoiceUpdateParams" }, - { "$ref": "#/components/schemas/RimeVoiceUpdateParams" }, + { + "$ref": "#/components/schemas/AzureVoiceUpdateParams" + }, + { + "$ref": "#/components/schemas/RimeVoiceUpdateParams" + }, { "$ref": "#/components/schemas/ElevenLabsVoiceUpdateParams" }, - { "$ref": "#/components/schemas/PlayHtVoiceUpdateParams" } + { + "$ref": "#/components/schemas/PlayHtVoiceUpdateParams" + } ] }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Voice" }, "initial_message": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Initial Message" }, "webhook": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/WebhookUpdateParams" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/WebhookUpdateParams" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Webhook" }, "vector_database": { "anyOf": [ - { "type": "string", "format": "uuid" }, + { + "type": "string", + "format": "uuid" + }, { "$ref": "#/components/schemas/PineconeVectorDatabaseUpdateParams" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Vector Database" }, "interrupt_sensitivity": { "anyOf": [ - { "$ref": "#/components/schemas/InterruptSensitivity" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/InterruptSensitivity" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Interrupt Sensitivity" }, "context_endpoint": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Context Endpoint" }, "noise_suppression": { "anyOf": [ - { "type": "boolean" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Noise Suppression" }, "endpointing_sensitivity": { "anyOf": [ - { "type": "string", "enum": ["auto", "relaxed", "sensitive"] }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string", + "enum": [ + "auto", + "relaxed", + "sensitive" + ] + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Endpointing Sensitivity" }, "ivr_navigation_mode": { "anyOf": [ - { "type": "string", "enum": ["default", "off"] }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string", + "enum": [ + "default", + "off" + ] + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Ivr Navigation Mode" }, "conversation_speed": { "anyOf": [ - { "type": "number" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "number" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Conversation Speed" }, "initial_message_delay": { "anyOf": [ - { "type": "number" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "number" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Initial Message Delay" }, "openai_model_name_override": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Openai Model Name Override" }, "ask_if_human_present_on_idle": { "anyOf": [ - { "type": "boolean" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Ask If Human Present On Idle" }, "openai_account_connection": { "anyOf": [ - { "$ref": "#/components/schemas/OpenAIAccountConnection" }, - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/OpenAIAccountConnection" + }, + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Openai Account Connection" }, "run_do_not_call_detection": { "anyOf": [ - { "type": "boolean" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Run Do Not Call Detection" } @@ -2199,75 +3134,139 @@ }, "AzureVoice": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["voice_azure"], + "enum": [ + "voice_azure" + ], "title": "Type" }, - "voice_name": { "type": "string", "title": "Voice Name" }, - "pitch": { "type": "integer", "title": "Pitch", "default": 0 }, - "rate": { "type": "integer", "title": "Rate", "default": 15 } + "voice_name": { + "type": "string", + "title": "Voice Name" + }, + "pitch": { + "type": "integer", + "title": "Pitch", + "default": 0 + }, + "rate": { + "type": "integer", + "title": "Rate", + "default": 15 + } }, "type": "object", - "required": ["id", "user_id", "type", "voice_name"], + "required": [ + "id", + "user_id", + "type", + "voice_name" + ], "title": "AzureVoice" }, "AzureVoiceParams": { "properties": { "type": { "type": "string", - "enum": ["voice_azure"], + "enum": [ + "voice_azure" + ], "title": "Type" }, - "voice_name": { "type": "string", "title": "Voice Name" }, - "pitch": { "type": "integer", "title": "Pitch", "default": 0 }, - "rate": { "type": "integer", "title": "Rate", "default": 15 } + "voice_name": { + "type": "string", + "title": "Voice Name" + }, + "pitch": { + "type": "integer", + "title": "Pitch", + "default": 0 + }, + "rate": { + "type": "integer", + "title": "Rate", + "default": 15 + } }, "type": "object", - "required": ["type", "voice_name"], + "required": [ + "type", + "voice_name" + ], "title": "AzureVoiceParams" }, "AzureVoiceUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["voice_azure"], + "enum": [ + "voice_azure" + ], "title": "Type" }, "voice_name": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Voice Name" }, "pitch": { "anyOf": [ - { "type": "integer" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Pitch" }, "rate": { "anyOf": [ - { "type": "integer" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Rate" } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "AzureVoiceUpdateParams" }, "BuyPhoneNumberRequest": { "properties": { - "area_code": { "type": "string", "title": "Area Code" }, + "area_code": { + "type": "string", + "title": "Area Code" + }, "telephony_provider": { "type": "string", - "enum": ["vonage", "twilio"], + "enum": [ + "vonage", + "twilio" + ], "title": "Telephony Provider", "default": "vonage" }, @@ -2282,29 +3281,53 @@ }, "Call": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "status": { - "allOf": [{ "$ref": "#/components/schemas/CallStatus" }], + "allOf": [ + { + "$ref": "#/components/schemas/CallStatus" + } + ], "default": "not_started" }, - "error_message": { "type": "string", "title": "Error Message" }, + "error_message": { + "type": "string", + "title": "Error Message" + }, "recording_available": { "type": "boolean", "title": "Recording Available", "default": false }, - "transcript": { "type": "string", "title": "Transcript" }, + "transcript": { + "type": "string", + "title": "Transcript" + }, "human_detection_result": { "type": "string", - "enum": ["human", "no_human"], + "enum": [ + "human", + "no_human" + ], "title": "Human Detection Result" }, "do_not_call_result": { "type": "boolean", "title": "Do Not Call Result" }, - "telephony_id": { "type": "string", "title": "Telephony Id" }, + "telephony_id": { + "type": "string", + "title": "Telephony Id" + }, "stage": { "type": "string", "enum": [ @@ -2326,12 +3349,23 @@ ], "title": "Stage Outcome" }, - "to_number": { "type": "string", "title": "To Number" }, - "from_number": { "type": "string", "title": "From Number" }, - "agent": { "$ref": "#/components/schemas/Agent" }, + "to_number": { + "type": "string", + "title": "To Number" + }, + "from_number": { + "type": "string", + "title": "From Number" + }, + "agent": { + "$ref": "#/components/schemas/Agent" + }, "telephony_provider": { "type": "string", - "enum": ["vonage", "twilio"], + "enum": [ + "vonage", + "twilio" + ], "title": "Telephony Provider" }, "agent_phone_number": { @@ -2355,11 +3389,16 @@ }, "on_no_human_answer": { "type": "string", - "enum": ["continue", "hangup"], + "enum": [ + "continue", + "hangup" + ], "title": "On No Human Answer" }, "context": { - "additionalProperties": { "type": "string" }, + "additionalProperties": { + "type": "string" + }, "type": "object", "title": "Context" }, @@ -2386,21 +3425,42 @@ "CallPage": { "properties": { "items": { - "items": { "$ref": "#/components/schemas/NormalizedCall" }, + "items": { + "$ref": "#/components/schemas/NormalizedCall" + }, "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } - }, - "type": "object", - "required": ["items", "page", "size", "has_more"], - "title": "CallPage" + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } + }, + "type": "object", + "required": [ + "items", + "page", + "size", + "has_more" + ], + "title": "CallPage" }, "CallStatus": { "type": "string", - "enum": ["not_started", "in_progress", "error", "ended"], + "enum": [ + "not_started", + "in_progress", + "error", + "ended" + ], "title": "CallStatus", "description": "An enumeration." }, @@ -2408,45 +3468,78 @@ "properties": { "field_type": { "type": "string", - "enum": ["field_type_email"], + "enum": [ + "field_type_email" + ], "title": "Field Type" }, - "label": { "type": "string", "title": "Label" }, - "name": { "type": "string", "title": "Name" }, - "description": { "type": "string", "title": "Description" } + "label": { + "type": "string", + "title": "Label" + }, + "name": { + "type": "string", + "title": "Name" + }, + "description": { + "type": "string", + "title": "Description" + } }, "type": "object", - "required": ["field_type", "label", "name"], + "required": [ + "field_type", + "label", + "name" + ], "title": "CollectField" }, "CreateCallAgentParams": { "properties": { "prompt": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PromptParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PromptParams" + } ], "title": "Prompt" }, "language": { - "allOf": [{ "$ref": "#/components/schemas/Language" }], + "allOf": [ + { + "$ref": "#/components/schemas/Language" + } + ], "default": "en" }, "actions": { "items": { "anyOf": [ - { "type": "string", "format": "uuid" }, + { + "type": "string", + "format": "uuid" + }, { "oneOf": [ - { "$ref": "#/components/schemas/TransferCallActionParams" }, + { + "$ref": "#/components/schemas/TransferCallActionParams" + }, { "$ref": "#/components/schemas/EndConversationActionParams" }, - { "$ref": "#/components/schemas/DTMFActionParams" }, + { + "$ref": "#/components/schemas/DTMFActionParams" + }, { "$ref": "#/components/schemas/AddToConferenceActionParams" }, - { "$ref": "#/components/schemas/SetHoldActionParams" } + { + "$ref": "#/components/schemas/SetHoldActionParams" + } ] } ] @@ -2457,38 +3550,69 @@ }, "voice": { "anyOf": [ - { "type": "string", "format": "uuid" }, + { + "type": "string", + "format": "uuid" + }, { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoiceParams" }, - { "$ref": "#/components/schemas/RimeVoiceParams" }, - { "$ref": "#/components/schemas/ElevenLabsVoiceParams" }, - { "$ref": "#/components/schemas/PlayHtVoiceParams" } + { + "$ref": "#/components/schemas/AzureVoiceParams" + }, + { + "$ref": "#/components/schemas/RimeVoiceParams" + }, + { + "$ref": "#/components/schemas/ElevenLabsVoiceParams" + }, + { + "$ref": "#/components/schemas/PlayHtVoiceParams" + } ] } ], "title": "Voice" }, - "initial_message": { "type": "string", "title": "Initial Message" }, + "initial_message": { + "type": "string", + "title": "Initial Message" + }, "webhook": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/WebhookParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/WebhookParams" + } ], "title": "Webhook" }, "vector_database": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PineconeVectorDatabaseParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PineconeVectorDatabaseParams" + } ], "title": "Vector Database" }, "interrupt_sensitivity": { - "allOf": [{ "$ref": "#/components/schemas/InterruptSensitivity" }], + "allOf": [ + { + "$ref": "#/components/schemas/InterruptSensitivity" + } + ], "default": "low" }, - "context_endpoint": { "type": "string", "title": "Context Endpoint" }, + "context_endpoint": { + "type": "string", + "title": "Context Endpoint" + }, "noise_suppression": { "type": "boolean", "title": "Noise Suppression", @@ -2496,13 +3620,20 @@ }, "endpointing_sensitivity": { "type": "string", - "enum": ["auto", "relaxed", "sensitive"], + "enum": [ + "auto", + "relaxed", + "sensitive" + ], "title": "Endpointing Sensitivity", "default": "auto" }, "ivr_navigation_mode": { "type": "string", - "enum": ["default", "off"], + "enum": [ + "default", + "off" + ], "title": "Ivr Navigation Mode", "default": "off" }, @@ -2527,8 +3658,13 @@ }, "openai_account_connection": { "anyOf": [ - { "$ref": "#/components/schemas/OpenAIAccountConnection" }, - { "type": "string", "format": "uuid" } + { + "$ref": "#/components/schemas/OpenAIAccountConnection" + }, + { + "type": "string", + "format": "uuid" + } ], "title": "Openai Account Connection" }, @@ -2539,23 +3675,39 @@ } }, "type": "object", - "required": ["prompt"], + "required": [ + "prompt" + ], "title": "CreateCallAgentParams" }, "CreateCallRequest": { "properties": { - "from_number": { "type": "string", "title": "From Number" }, - "to_number": { "type": "string", "title": "To Number" }, + "from_number": { + "type": "string", + "title": "From Number" + }, + "to_number": { + "type": "string", + "title": "To Number" + }, "agent": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/CreateCallAgentParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/CreateCallAgentParams" + } ], "title": "Agent" }, "on_no_human_answer": { "type": "string", - "enum": ["continue", "hangup"], + "enum": [ + "continue", + "hangup" + ], "title": "On No Human Answer", "default": "continue" }, @@ -2569,32 +3721,57 @@ "default": false }, "context": { - "additionalProperties": { "type": "string" }, + "additionalProperties": { + "type": "string" + }, "type": "object", "title": "Context" } }, "type": "object", - "required": ["from_number", "to_number", "agent"], + "required": [ + "from_number", + "to_number", + "agent" + ], "title": "CreateCallRequest" }, "DTMFAction": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["action_dtmf"], + "enum": [ + "action_dtmf" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/EmptyActionConfig" }, + "config": { + "$ref": "#/components/schemas/EmptyActionConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -2605,24 +3782,39 @@ } }, "type": "object", - "required": ["id", "user_id", "type"], + "required": [ + "id", + "user_id", + "type" + ], "title": "DTMFAction" }, "DTMFActionParams": { "properties": { "type": { "type": "string", - "enum": ["action_dtmf"], + "enum": [ + "action_dtmf" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/EmptyActionConfig" }, + "config": { + "$ref": "#/components/schemas/EmptyActionConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -2633,20 +3825,28 @@ } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "DTMFActionParams" }, "DTMFActionUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["action_dtmf"], + "enum": [ + "action_dtmf" + ], "title": "Type" }, "config": { "anyOf": [ - { "$ref": "#/components/schemas/EmptyActionConfig" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/EmptyActionConfig" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Config" }, @@ -2654,116 +3854,202 @@ "anyOf": [ { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ] }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Action Trigger", "default": {} } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "DTMFActionUpdateParams" }, "ElevenLabsVoice": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["voice_eleven_labs"], + "enum": [ + "voice_eleven_labs" + ], "title": "Type" }, - "voice_id": { "type": "string", "title": "Voice Id" }, - "stability": { "type": "number", "title": "Stability" }, - "similarity_boost": { "type": "number", "title": "Similarity Boost" }, - "api_key": { "type": "string", "title": "Api Key" }, + "voice_id": { + "type": "string", + "title": "Voice Id" + }, + "stability": { + "type": "number", + "title": "Stability" + }, + "similarity_boost": { + "type": "number", + "title": "Similarity Boost" + }, + "api_key": { + "type": "string", + "title": "Api Key" + }, "optimize_streaming_latency": { "type": "integer", "title": "Optimize Streaming Latency" }, - "model_id": { "type": "string", "title": "Model Id" } + "model_id": { + "type": "string", + "title": "Model Id" + } }, "type": "object", - "required": ["id", "user_id", "type", "voice_id"], + "required": [ + "id", + "user_id", + "type", + "voice_id" + ], "title": "ElevenLabsVoice" }, "ElevenLabsVoiceParams": { "properties": { "type": { "type": "string", - "enum": ["voice_eleven_labs"], + "enum": [ + "voice_eleven_labs" + ], "title": "Type" }, - "voice_id": { "type": "string", "title": "Voice Id" }, - "stability": { "type": "number", "title": "Stability" }, - "similarity_boost": { "type": "number", "title": "Similarity Boost" }, - "api_key": { "type": "string", "title": "Api Key" }, + "voice_id": { + "type": "string", + "title": "Voice Id" + }, + "stability": { + "type": "number", + "title": "Stability" + }, + "similarity_boost": { + "type": "number", + "title": "Similarity Boost" + }, + "api_key": { + "type": "string", + "title": "Api Key" + }, "optimize_streaming_latency": { "type": "integer", "title": "Optimize Streaming Latency" }, - "model_id": { "type": "string", "title": "Model Id" } + "model_id": { + "type": "string", + "title": "Model Id" + } }, "type": "object", - "required": ["type", "voice_id"], + "required": [ + "type", + "voice_id" + ], "title": "ElevenLabsVoiceParams" }, "ElevenLabsVoiceUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["voice_eleven_labs"], + "enum": [ + "voice_eleven_labs" + ], "title": "Type" }, "voice_id": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Voice Id" }, "stability": { "anyOf": [ - { "type": "number" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "number" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Stability" }, "similarity_boost": { "anyOf": [ - { "type": "number" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "number" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Similarity Boost" }, "api_key": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Api Key" }, "optimize_streaming_latency": { "anyOf": [ - { "type": "integer" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Optimize Streaming Latency" }, "model_id": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Model Id" } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "ElevenLabsVoiceUpdateParams" }, "EmptyActionConfig": { @@ -2773,21 +4059,40 @@ }, "EndConversationAction": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["action_end_conversation"], + "enum": [ + "action_end_conversation" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/EmptyActionConfig" }, + "config": { + "$ref": "#/components/schemas/EmptyActionConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -2798,24 +4103,39 @@ } }, "type": "object", - "required": ["id", "user_id", "type"], + "required": [ + "id", + "user_id", + "type" + ], "title": "EndConversationAction" }, "EndConversationActionParams": { "properties": { "type": { "type": "string", - "enum": ["action_end_conversation"], + "enum": [ + "action_end_conversation" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/EmptyActionConfig" }, + "config": { + "$ref": "#/components/schemas/EmptyActionConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -2826,20 +4146,28 @@ } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "EndConversationActionParams" }, "EndConversationActionUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["action_end_conversation"], + "enum": [ + "action_end_conversation" + ], "title": "Type" }, "config": { "anyOf": [ - { "$ref": "#/components/schemas/EmptyActionConfig" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/EmptyActionConfig" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Config" }, @@ -2847,18 +4175,26 @@ "anyOf": [ { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ] }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Action Trigger", "default": {} } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "EndConversationActionUpdateParams" }, "EventType": { @@ -2879,7 +4215,9 @@ "properties": { "type": { "type": "string", - "enum": ["action_trigger_function_call"], + "enum": [ + "action_trigger_function_call" + ], "title": "Type" }, "config": { @@ -2887,7 +4225,9 @@ } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "FunctionCallActionTrigger" }, "FunctionCallActionTriggerConfig": { @@ -2897,14 +4237,19 @@ }, "HTTPMethod": { "type": "string", - "enum": ["GET", "POST"], + "enum": [ + "GET", + "POST" + ], "title": "HTTPMethod", "description": "An enumeration." }, "HTTPValidationError": { "properties": { "detail": { - "items": { "$ref": "#/components/schemas/ValidationError" }, + "items": { + "$ref": "#/components/schemas/ValidationError" + }, "type": "array", "title": "Detail" } @@ -2914,7 +4259,10 @@ }, "InterruptSensitivity": { "type": "string", - "enum": ["low", "high"], + "enum": [ + "low", + "high" + ], "title": "InterruptSensitivity", "description": "An enumeration." }, @@ -2938,7 +4286,10 @@ }, "LinkPhoneNumberRequest": { "properties": { - "phone_number": { "type": "string", "title": "Phone Number" }, + "phone_number": { + "type": "string", + "title": "Phone Number" + }, "telephony_account_connection": { "type": "string", "format": "uuid", @@ -2951,44 +4302,90 @@ } }, "type": "object", - "required": ["phone_number", "telephony_account_connection"], + "required": [ + "phone_number", + "telephony_account_connection" + ], "title": "LinkPhoneNumberRequest" }, "NormalizedAgent": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "prompt": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PromptParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PromptParams" + } ], "title": "Prompt" }, "language": { - "allOf": [{ "$ref": "#/components/schemas/Language" }], + "allOf": [ + { + "$ref": "#/components/schemas/Language" + } + ], "default": "en" }, "actions": { - "items": { "type": "string", "format": "uuid" }, + "items": { + "type": "string", + "format": "uuid" + }, "type": "array", "title": "Actions" }, - "voice": { "type": "string", "format": "uuid", "title": "Voice" }, - "initial_message": { "type": "string", "title": "Initial Message" }, - "webhook": { "type": "string", "format": "uuid", "title": "Webhook" }, + "voice": { + "type": "string", + "format": "uuid", + "title": "Voice" + }, + "initial_message": { + "type": "string", + "title": "Initial Message" + }, + "webhook": { + "type": "string", + "format": "uuid", + "title": "Webhook" + }, "vector_database": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PineconeVectorDatabaseParams" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PineconeVectorDatabaseParams" + } ], "title": "Vector Database" }, "interrupt_sensitivity": { - "allOf": [{ "$ref": "#/components/schemas/InterruptSensitivity" }], + "allOf": [ + { + "$ref": "#/components/schemas/InterruptSensitivity" + } + ], "default": "low" }, - "context_endpoint": { "type": "string", "title": "Context Endpoint" }, + "context_endpoint": { + "type": "string", + "title": "Context Endpoint" + }, "noise_suppression": { "type": "boolean", "title": "Noise Suppression", @@ -2996,13 +4393,20 @@ }, "endpointing_sensitivity": { "type": "string", - "enum": ["auto", "relaxed", "sensitive"], + "enum": [ + "auto", + "relaxed", + "sensitive" + ], "title": "Endpointing Sensitivity", "default": "auto" }, "ivr_navigation_mode": { "type": "string", - "enum": ["default", "off"], + "enum": [ + "default", + "off" + ], "title": "Ivr Navigation Mode", "default": "off" }, @@ -3027,8 +4431,13 @@ }, "openai_account_connection": { "anyOf": [ - { "$ref": "#/components/schemas/OpenAIAccountConnection" }, - { "type": "string", "format": "uuid" } + { + "$ref": "#/components/schemas/OpenAIAccountConnection" + }, + { + "type": "string", + "format": "uuid" + } ], "title": "Openai Account Connection" }, @@ -3039,34 +4448,64 @@ } }, "type": "object", - "required": ["id", "user_id", "prompt", "actions", "voice"], + "required": [ + "id", + "user_id", + "prompt", + "actions", + "voice" + ], "title": "NormalizedAgent" }, "NormalizedCall": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "status": { - "allOf": [{ "$ref": "#/components/schemas/CallStatus" }], + "allOf": [ + { + "$ref": "#/components/schemas/CallStatus" + } + ], "default": "not_started" }, - "error_message": { "type": "string", "title": "Error Message" }, + "error_message": { + "type": "string", + "title": "Error Message" + }, "recording_available": { "type": "boolean", "title": "Recording Available", "default": false }, - "transcript": { "type": "string", "title": "Transcript" }, + "transcript": { + "type": "string", + "title": "Transcript" + }, "human_detection_result": { "type": "string", - "enum": ["human", "no_human"], + "enum": [ + "human", + "no_human" + ], "title": "Human Detection Result" }, "do_not_call_result": { "type": "boolean", "title": "Do Not Call Result" }, - "telephony_id": { "type": "string", "title": "Telephony Id" }, + "telephony_id": { + "type": "string", + "title": "Telephony Id" + }, "stage": { "type": "string", "enum": [ @@ -3088,12 +4527,25 @@ ], "title": "Stage Outcome" }, - "to_number": { "type": "string", "title": "To Number" }, - "from_number": { "type": "string", "title": "From Number" }, - "agent": { "type": "string", "format": "uuid", "title": "Agent" }, + "to_number": { + "type": "string", + "title": "To Number" + }, + "from_number": { + "type": "string", + "title": "From Number" + }, + "agent": { + "type": "string", + "format": "uuid", + "title": "Agent" + }, "telephony_provider": { "type": "string", - "enum": ["vonage", "twilio"], + "enum": [ + "vonage", + "twilio" + ], "title": "Telephony Provider" }, "agent_phone_number": { @@ -3117,11 +4569,16 @@ }, "on_no_human_answer": { "type": "string", - "enum": ["continue", "hangup"], + "enum": [ + "continue", + "hangup" + ], "title": "On No Human Answer" }, "context": { - "additionalProperties": { "type": "string" }, + "additionalProperties": { + "type": "string" + }, "type": "object", "title": "Context" }, @@ -3131,8 +4588,13 @@ }, "telephony_account_connection": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/TwilioAccountConnection" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/TwilioAccountConnection" + } ], "title": "Telephony Account Connection" } @@ -3151,10 +4613,26 @@ }, "NormalizedPhoneNumber": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "active": { "type": "boolean", "title": "Active", "default": true }, - "label": { "type": "string", "title": "Label", "default": "" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "active": { + "type": "boolean", + "title": "Active", + "default": true + }, + "label": { + "type": "string", + "title": "Label", + "default": "" + }, "inbound_agent": { "type": "string", "format": "uuid", @@ -3166,40 +4644,75 @@ "default": false }, "example_context": { - "additionalProperties": { "type": "string" }, + "additionalProperties": { + "type": "string" + }, "type": "object", "title": "Example Context" }, - "number": { "type": "string", "title": "Number" }, + "number": { + "type": "string", + "title": "Number" + }, "telephony_provider": { "type": "string", - "enum": ["vonage", "twilio"], + "enum": [ + "vonage", + "twilio" + ], "title": "Telephony Provider", "default": "vonage" }, "telephony_account_connection": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/TwilioAccountConnection" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/TwilioAccountConnection" + } ], "title": "Telephony Account Connection" } }, "type": "object", - "required": ["id", "user_id", "inbound_agent", "number"], + "required": [ + "id", + "user_id", + "inbound_agent", + "number" + ], "title": "NormalizedPhoneNumber" }, "NormalizedPrompt": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "content": { "type": "string", "title": "Content", "default": "" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "content": { + "type": "string", + "title": "Content", + "default": "" + }, "collect_fields": { - "items": { "$ref": "#/components/schemas/CollectField" }, + "items": { + "$ref": "#/components/schemas/CollectField" + }, "type": "array", "title": "Collect Fields" }, - "context_endpoint": { "type": "string", "title": "Context Endpoint" }, + "context_endpoint": { + "type": "string", + "title": "Context Endpoint" + }, "prompt_template": { "type": "string", "format": "uuid", @@ -3207,85 +4720,151 @@ } }, "type": "object", - "required": ["id", "user_id"], + "required": [ + "id", + "user_id" + ], "title": "NormalizedPrompt" }, "OpenAIAccountConnection": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "credentials": { "$ref": "#/components/schemas/OpenAICredentials" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "credentials": { + "$ref": "#/components/schemas/OpenAICredentials" + }, "type": { "type": "string", - "enum": ["account_connection_openai"], + "enum": [ + "account_connection_openai" + ], "title": "Type" } }, "type": "object", - "required": ["id", "user_id", "credentials", "type"], + "required": [ + "id", + "user_id", + "credentials", + "type" + ], "title": "OpenAIAccountConnection" }, "OpenAIAccountConnectionParams": { "properties": { - "credentials": { "$ref": "#/components/schemas/OpenAICredentials" }, + "credentials": { + "$ref": "#/components/schemas/OpenAICredentials" + }, "type": { "type": "string", - "enum": ["account_connection_openai"], + "enum": [ + "account_connection_openai" + ], "title": "Type" } }, "type": "object", - "required": ["credentials", "type"], + "required": [ + "credentials", + "type" + ], "title": "OpenAIAccountConnectionParams" }, "OpenAIAccountConnectionUpdateParams": { "properties": { "credentials": { "anyOf": [ - { "$ref": "#/components/schemas/OpenAICredentials" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/OpenAICredentials" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Credentials" }, "type": { "type": "string", - "enum": ["account_connection_openai"], + "enum": [ + "account_connection_openai" + ], "title": "Type" } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "OpenAIAccountConnectionUpdateParams" }, "OpenAICredentials": { "properties": { - "openai_api_key": { "type": "string", "title": "Openai Api Key" } + "openai_api_key": { + "type": "string", + "title": "Openai Api Key" + } }, "type": "object", - "required": ["openai_api_key"], + "required": [ + "openai_api_key" + ], "title": "OpenAICredentials" }, "PhoneNumber": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "active": { "type": "boolean", "title": "Active", "default": true }, - "label": { "type": "string", "title": "Label", "default": "" }, - "inbound_agent": { "$ref": "#/components/schemas/Agent" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "active": { + "type": "boolean", + "title": "Active", + "default": true + }, + "label": { + "type": "string", + "title": "Label", + "default": "" + }, + "inbound_agent": { + "$ref": "#/components/schemas/Agent" + }, "outbound_only": { "type": "boolean", "title": "Outbound Only", "default": false }, "example_context": { - "additionalProperties": { "type": "string" }, + "additionalProperties": { + "type": "string" + }, "type": "object", "title": "Example Context" }, - "number": { "type": "string", "title": "Number" }, + "number": { + "type": "string", + "title": "Number" + }, "telephony_provider": { "type": "string", - "enum": ["vonage", "twilio"], + "enum": [ + "vonage", + "twilio" + ], "title": "Telephony Provider", "default": "vonage" }, @@ -3294,29 +4873,52 @@ } }, "type": "object", - "required": ["id", "user_id", "inbound_agent", "number"], + "required": [ + "id", + "user_id", + "inbound_agent", + "number" + ], "title": "PhoneNumber" }, "PhoneNumberPage": { "properties": { "items": { - "items": { "$ref": "#/components/schemas/NormalizedPhoneNumber" }, + "items": { + "$ref": "#/components/schemas/NormalizedPhoneNumber" + }, "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "PhoneNumberPage" }, "PhraseBasedActionTrigger": { "properties": { "type": { "type": "string", - "enum": ["action_trigger_phrase_based"], + "enum": [ + "action_trigger_phrase_based" + ], "title": "Type" }, "config": { @@ -3324,51 +4926,85 @@ } }, "type": "object", - "required": ["type", "config"], + "required": [ + "type", + "config" + ], "title": "PhraseBasedActionTrigger" }, "PhraseBasedActionTriggerConfig": { "properties": { "phrase_triggers": { - "items": { "$ref": "#/components/schemas/PhraseTrigger" }, + "items": { + "$ref": "#/components/schemas/PhraseTrigger" + }, "type": "array", "title": "Phrase Triggers" } }, "type": "object", - "required": ["phrase_triggers"], + "required": [ + "phrase_triggers" + ], "title": "PhraseBasedActionTriggerConfig" }, "PhraseTrigger": { "properties": { - "phrase": { "type": "string", "title": "Phrase" }, + "phrase": { + "type": "string", + "title": "Phrase" + }, "conditions": { "items": { "type": "string", - "enum": ["phrase_condition_type_contains"] + "enum": [ + "phrase_condition_type_contains" + ] }, "type": "array", "title": "Conditions" } }, "type": "object", - "required": ["phrase", "conditions"], + "required": [ + "phrase", + "conditions" + ], "title": "PhraseTrigger" }, "PineconeVectorDatabase": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["vector_database_pinecone"], + "enum": [ + "vector_database_pinecone" + ], "title": "Type" }, - "index": { "type": "string", "title": "Index" }, - "api_key": { "type": "string", "title": "Api Key" }, - "api_environment": { "type": "string", "title": "Api Environment" } - }, - "type": "object", + "index": { + "type": "string", + "title": "Index" + }, + "api_key": { + "type": "string", + "title": "Api Key" + }, + "api_environment": { + "type": "string", + "title": "Api Environment" + } + }, + "type": "object", "required": [ "id", "user_id", @@ -3383,48 +5019,80 @@ "properties": { "type": { "type": "string", - "enum": ["vector_database_pinecone"], + "enum": [ + "vector_database_pinecone" + ], "title": "Type" }, - "index": { "type": "string", "title": "Index" }, - "api_key": { "type": "string", "title": "Api Key" }, - "api_environment": { "type": "string", "title": "Api Environment" } + "index": { + "type": "string", + "title": "Index" + }, + "api_key": { + "type": "string", + "title": "Api Key" + }, + "api_environment": { + "type": "string", + "title": "Api Environment" + } }, "type": "object", - "required": ["type", "index", "api_key", "api_environment"], + "required": [ + "type", + "index", + "api_key", + "api_environment" + ], "title": "PineconeVectorDatabaseParams" }, "PineconeVectorDatabaseUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["vector_database_pinecone"], + "enum": [ + "vector_database_pinecone" + ], "title": "Type" }, "index": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Index" }, "api_key": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Api Key" }, "api_environment": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Api Environment" } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "PineconeVectorDatabaseUpdateParams" }, "PlanType": { @@ -3440,101 +5108,197 @@ }, "PlayHtVoice": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["voice_play_ht"], + "enum": [ + "voice_play_ht" + ], "title": "Type" }, - "voice_id": { "type": "string", "title": "Voice Id" }, - "api_user_id": { "type": "string", "title": "Api User Id" }, - "api_key": { "type": "string", "title": "Api Key" }, + "voice_id": { + "type": "string", + "title": "Voice Id" + }, + "api_user_id": { + "type": "string", + "title": "Api User Id" + }, + "api_key": { + "type": "string", + "title": "Api Key" + }, "version": { "type": "string", - "enum": ["1", "2"], + "enum": [ + "1", + "2" + ], "title": "Version", "default": "2" }, - "speed": { "type": "number", "title": "Speed" }, + "speed": { + "type": "number", + "title": "Speed" + }, "quality": { "type": "string", - "enum": ["faster", "draft", "low", "medium", "high", "premium"], + "enum": [ + "faster", + "draft", + "low", + "medium", + "high", + "premium" + ], "title": "Quality" }, - "temperature": { "type": "number", "title": "Temperature" } + "temperature": { + "type": "number", + "title": "Temperature" + } }, "type": "object", - "required": ["id", "user_id", "type", "voice_id"], + "required": [ + "id", + "user_id", + "type", + "voice_id" + ], "title": "PlayHtVoice" }, "PlayHtVoiceParams": { "properties": { "type": { "type": "string", - "enum": ["voice_play_ht"], + "enum": [ + "voice_play_ht" + ], "title": "Type" }, - "voice_id": { "type": "string", "title": "Voice Id" }, - "api_user_id": { "type": "string", "title": "Api User Id" }, - "api_key": { "type": "string", "title": "Api Key" }, + "voice_id": { + "type": "string", + "title": "Voice Id" + }, + "api_user_id": { + "type": "string", + "title": "Api User Id" + }, + "api_key": { + "type": "string", + "title": "Api Key" + }, "version": { "type": "string", - "enum": ["1", "2"], + "enum": [ + "1", + "2" + ], "title": "Version", "default": "2" }, - "speed": { "type": "number", "title": "Speed" }, + "speed": { + "type": "number", + "title": "Speed" + }, "quality": { "type": "string", - "enum": ["faster", "draft", "low", "medium", "high", "premium"], + "enum": [ + "faster", + "draft", + "low", + "medium", + "high", + "premium" + ], "title": "Quality" }, - "temperature": { "type": "number", "title": "Temperature" } + "temperature": { + "type": "number", + "title": "Temperature" + } }, "type": "object", - "required": ["type", "voice_id"], + "required": [ + "type", + "voice_id" + ], "title": "PlayHtVoiceParams" }, "PlayHtVoiceUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["voice_play_ht"], + "enum": [ + "voice_play_ht" + ], "title": "Type" }, "voice_id": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Voice Id" }, "api_user_id": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Api User Id" }, "api_key": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Api Key" }, "version": { "anyOf": [ - { "type": "string", "enum": ["1", "2"] }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string", + "enum": [ + "1", + "2" + ] + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Version" }, "speed": { "anyOf": [ - { "type": "number" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "number" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Speed" }, @@ -3542,69 +5306,136 @@ "anyOf": [ { "type": "string", - "enum": ["faster", "draft", "low", "medium", "high", "premium"] + "enum": [ + "faster", + "draft", + "low", + "medium", + "high", + "premium" + ] }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Quality" }, "temperature": { "anyOf": [ - { "type": "number" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "number" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Temperature" } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "PlayHtVoiceUpdateParams" }, "Prompt": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "content": { "type": "string", "title": "Content", "default": "" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "content": { + "type": "string", + "title": "Content", + "default": "" + }, "collect_fields": { - "items": { "$ref": "#/components/schemas/CollectField" }, + "items": { + "$ref": "#/components/schemas/CollectField" + }, "type": "array", "title": "Collect Fields" }, - "context_endpoint": { "type": "string", "title": "Context Endpoint" }, - "prompt_template": { "$ref": "#/components/schemas/PromptTemplate" } + "context_endpoint": { + "type": "string", + "title": "Context Endpoint" + }, + "prompt_template": { + "$ref": "#/components/schemas/PromptTemplate" + } }, "type": "object", - "required": ["id", "user_id"], + "required": [ + "id", + "user_id" + ], "title": "Prompt" }, "PromptPage": { "properties": { "items": { - "items": { "$ref": "#/components/schemas/NormalizedPrompt" }, + "items": { + "$ref": "#/components/schemas/NormalizedPrompt" + }, "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "PromptPage" }, "PromptParams": { "properties": { - "content": { "type": "string", "title": "Content", "default": "" }, + "content": { + "type": "string", + "title": "Content", + "default": "" + }, "collect_fields": { - "items": { "$ref": "#/components/schemas/CollectField" }, + "items": { + "$ref": "#/components/schemas/CollectField" + }, "type": "array", "title": "Collect Fields" }, - "context_endpoint": { "type": "string", "title": "Context Endpoint" }, + "context_endpoint": { + "type": "string", + "title": "Context Endpoint" + }, "prompt_template": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PromptTemplate" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PromptTemplate" + } ], "title": "Prompt Template" } @@ -3614,50 +5445,87 @@ }, "PromptTemplate": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "label": { "type": "string", "title": "Label", "default": "" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "label": { + "type": "string", + "title": "Label", + "default": "" + }, "required_context_keys": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Required Context Keys" } }, "type": "object", - "required": ["id", "user_id", "required_context_keys"], + "required": [ + "id", + "user_id", + "required_context_keys" + ], "title": "PromptTemplate" }, "PromptUpdateParams": { "properties": { "content": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Content" }, "collect_fields": { "anyOf": [ { - "items": { "$ref": "#/components/schemas/CollectField" }, + "items": { + "$ref": "#/components/schemas/CollectField" + }, "type": "array" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Collect Fields" }, "context_endpoint": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Context Endpoint" }, "prompt_template": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/PromptTemplate" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/PromptTemplate" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Prompt Template" } @@ -3667,65 +5535,140 @@ }, "RimeVoice": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "type": { "type": "string", "enum": ["voice_rime"], "title": "Type" }, - "speaker": { "type": "string", "title": "Speaker" }, - "speed_alpha": { "type": "number", "title": "Speed Alpha" } + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "type": { + "type": "string", + "enum": [ + "voice_rime" + ], + "title": "Type" + }, + "speaker": { + "type": "string", + "title": "Speaker" + }, + "speed_alpha": { + "type": "number", + "title": "Speed Alpha" + } }, "type": "object", - "required": ["id", "user_id", "type", "speaker"], + "required": [ + "id", + "user_id", + "type", + "speaker" + ], "title": "RimeVoice" }, "RimeVoiceParams": { "properties": { - "type": { "type": "string", "enum": ["voice_rime"], "title": "Type" }, - "speaker": { "type": "string", "title": "Speaker" }, - "speed_alpha": { "type": "number", "title": "Speed Alpha" } + "type": { + "type": "string", + "enum": [ + "voice_rime" + ], + "title": "Type" + }, + "speaker": { + "type": "string", + "title": "Speaker" + }, + "speed_alpha": { + "type": "number", + "title": "Speed Alpha" + } }, "type": "object", - "required": ["type", "speaker"], + "required": [ + "type", + "speaker" + ], "title": "RimeVoiceParams" }, "RimeVoiceUpdateParams": { "properties": { - "type": { "type": "string", "enum": ["voice_rime"], "title": "Type" }, + "type": { + "type": "string", + "enum": [ + "voice_rime" + ], + "title": "Type" + }, "speaker": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Speaker" }, "speed_alpha": { "anyOf": [ - { "type": "number" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "number" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Speed Alpha" } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "RimeVoiceUpdateParams" }, "SetHoldAction": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["action_set_hold"], + "enum": [ + "action_set_hold" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/EmptyActionConfig" }, + "config": { + "$ref": "#/components/schemas/EmptyActionConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -3736,24 +5679,39 @@ } }, "type": "object", - "required": ["id", "user_id", "type"], + "required": [ + "id", + "user_id", + "type" + ], "title": "SetHoldAction" }, "SetHoldActionParams": { "properties": { "type": { "type": "string", - "enum": ["action_set_hold"], + "enum": [ + "action_set_hold" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/EmptyActionConfig" }, + "config": { + "$ref": "#/components/schemas/EmptyActionConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -3764,20 +5722,28 @@ } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "SetHoldActionParams" }, "SetHoldActionUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["action_set_hold"], + "enum": [ + "action_set_hold" + ], "title": "Type" }, "config": { "anyOf": [ - { "$ref": "#/components/schemas/EmptyActionConfig" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/EmptyActionConfig" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Config" }, @@ -3785,37 +5751,64 @@ "anyOf": [ { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ] }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Action Trigger", "default": {} } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "SetHoldActionUpdateParams" }, "TransferCallAction": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "type": { "type": "string", - "enum": ["action_transfer_call"], + "enum": [ + "action_transfer_call" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/TransferCallConfig" }, + "config": { + "$ref": "#/components/schemas/TransferCallConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -3826,24 +5819,40 @@ } }, "type": "object", - "required": ["id", "user_id", "type", "config"], + "required": [ + "id", + "user_id", + "type", + "config" + ], "title": "TransferCallAction" }, "TransferCallActionParams": { "properties": { "type": { "type": "string", - "enum": ["action_transfer_call"], + "enum": [ + "action_transfer_call" + ], "title": "Type" }, - "config": { "$ref": "#/components/schemas/TransferCallConfig" }, + "config": { + "$ref": "#/components/schemas/TransferCallConfig" + }, "action_trigger": { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ], "title": "Action Trigger", - "default": { "type": "action_trigger_function_call", "config": {} }, + "default": { + "type": "action_trigger_function_call", + "config": {} + }, "discriminator": { "propertyName": "type", "mapping": { @@ -3854,20 +5863,29 @@ } }, "type": "object", - "required": ["type", "config"], + "required": [ + "type", + "config" + ], "title": "TransferCallActionParams" }, "TransferCallActionUpdateParams": { "properties": { "type": { "type": "string", - "enum": ["action_transfer_call"], + "enum": [ + "action_transfer_call" + ], "title": "Type" }, "config": { "anyOf": [ - { "$ref": "#/components/schemas/TransferCallConfig" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/TransferCallConfig" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Config" }, @@ -3875,73 +5893,118 @@ "anyOf": [ { "oneOf": [ - { "$ref": "#/components/schemas/FunctionCallActionTrigger" }, - { "$ref": "#/components/schemas/PhraseBasedActionTrigger" } + { + "$ref": "#/components/schemas/FunctionCallActionTrigger" + }, + { + "$ref": "#/components/schemas/PhraseBasedActionTrigger" + } ] }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Action Trigger", "default": {} } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "TransferCallActionUpdateParams" }, "TransferCallConfig": { "properties": { - "phone_number": { "type": "string", "title": "Phone Number" } + "phone_number": { + "type": "string", + "title": "Phone Number" + } }, "type": "object", - "required": ["phone_number"], + "required": [ + "phone_number" + ], "title": "TransferCallConfig" }, "TwilioAccountConnection": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, - "credentials": { "$ref": "#/components/schemas/TwilioCredentials" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, + "credentials": { + "$ref": "#/components/schemas/TwilioCredentials" + }, "type": { "type": "string", - "enum": ["account_connection_twilio"], + "enum": [ + "account_connection_twilio" + ], "title": "Type" } }, "type": "object", - "required": ["id", "user_id", "credentials", "type"], + "required": [ + "id", + "user_id", + "credentials", + "type" + ], "title": "TwilioAccountConnection" }, "TwilioAccountConnectionParams": { "properties": { - "credentials": { "$ref": "#/components/schemas/TwilioCredentials" }, + "credentials": { + "$ref": "#/components/schemas/TwilioCredentials" + }, "type": { "type": "string", - "enum": ["account_connection_twilio"], + "enum": [ + "account_connection_twilio" + ], "title": "Type" } }, "type": "object", - "required": ["credentials", "type"], + "required": [ + "credentials", + "type" + ], "title": "TwilioAccountConnectionParams" }, "TwilioAccountConnectionUpdateParams": { "properties": { "credentials": { "anyOf": [ - { "$ref": "#/components/schemas/TwilioCredentials" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/TwilioCredentials" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Credentials" }, "type": { "type": "string", - "enum": ["account_connection_twilio"], + "enum": [ + "account_connection_twilio" + ], "title": "Type" } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "TwilioAccountConnectionUpdateParams" }, "TwilioCredentials": { @@ -3956,7 +6019,10 @@ } }, "type": "object", - "required": ["twilio_account_sid", "twilio_auth_token"], + "required": [ + "twilio_account_sid", + "twilio_auth_token" + ], "title": "TwilioCredentials" }, "Undefined": { @@ -3969,23 +6035,52 @@ "properties": { "outbound_only": { "anyOf": [ - { "type": "boolean" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Outbound Only" }, + "example_context": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "$ref": "#/components/schemas/Undefined" + } + ], + "title": "Example Context" + }, "label": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Label" }, "inbound_agent": { "anyOf": [ - { "type": "string", "format": "uuid" }, - { "$ref": "#/components/schemas/AgentUpdateParams" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/components/schemas/AgentUpdateParams" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Inbound Agent" } @@ -3995,8 +6090,13 @@ }, "Usage": { "properties": { - "user_id": { "type": "string", "title": "User Id" }, - "plan_type": { "$ref": "#/components/schemas/PlanType" }, + "user_id": { + "type": "string", + "title": "User Id" + }, + "plan_type": { + "$ref": "#/components/schemas/PlanType" + }, "monthly_usage_minutes": { "type": "integer", "title": "Monthly Usage Minutes" @@ -4007,36 +6107,75 @@ } }, "type": "object", - "required": ["user_id", "plan_type", "monthly_usage_minutes"], + "required": [ + "user_id", + "plan_type", + "monthly_usage_minutes" + ], "title": "Usage" }, "ValidationError": { "properties": { "loc": { - "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] }, + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, "type": "array", "title": "Location" }, - "msg": { "type": "string", "title": "Message" }, - "type": { "type": "string", "title": "Error Type" } + "msg": { + "type": "string", + "title": "Message" + }, + "type": { + "type": "string", + "title": "Error Type" + } }, "type": "object", - "required": ["loc", "msg", "type"], + "required": [ + "loc", + "msg", + "type" + ], "title": "ValidationError" }, "VectorDatabasePage": { "properties": { "items": { - "items": { "$ref": "#/components/schemas/PineconeVectorDatabase" }, + "items": { + "$ref": "#/components/schemas/PineconeVectorDatabase" + }, "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "VectorDatabasePage" }, "VoicePage": { @@ -4044,10 +6183,18 @@ "items": { "items": { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoice" }, - { "$ref": "#/components/schemas/RimeVoice" }, - { "$ref": "#/components/schemas/ElevenLabsVoice" }, - { "$ref": "#/components/schemas/PlayHtVoice" } + { + "$ref": "#/components/schemas/AzureVoice" + }, + { + "$ref": "#/components/schemas/RimeVoice" + }, + { + "$ref": "#/components/schemas/ElevenLabsVoice" + }, + { + "$ref": "#/components/schemas/PlayHtVoice" + } ], "discriminator": { "propertyName": "type", @@ -4062,20 +6209,42 @@ "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "VoicePage" }, "VoiceParamsRequest": { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoiceParams" }, - { "$ref": "#/components/schemas/RimeVoiceParams" }, - { "$ref": "#/components/schemas/ElevenLabsVoiceParams" }, - { "$ref": "#/components/schemas/PlayHtVoiceParams" } + { + "$ref": "#/components/schemas/AzureVoiceParams" + }, + { + "$ref": "#/components/schemas/RimeVoiceParams" + }, + { + "$ref": "#/components/schemas/ElevenLabsVoiceParams" + }, + { + "$ref": "#/components/schemas/PlayHtVoiceParams" + } ], "title": "VoiceParamsRequest", "discriminator": { @@ -4090,10 +6259,18 @@ }, "VoiceResponseModel": { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoice" }, - { "$ref": "#/components/schemas/RimeVoice" }, - { "$ref": "#/components/schemas/ElevenLabsVoice" }, - { "$ref": "#/components/schemas/PlayHtVoice" } + { + "$ref": "#/components/schemas/AzureVoice" + }, + { + "$ref": "#/components/schemas/RimeVoice" + }, + { + "$ref": "#/components/schemas/ElevenLabsVoice" + }, + { + "$ref": "#/components/schemas/PlayHtVoice" + } ], "title": "VoiceResponseModel", "discriminator": { @@ -4108,10 +6285,18 @@ }, "VoiceUpdateParamsRequest": { "oneOf": [ - { "$ref": "#/components/schemas/AzureVoiceUpdateParams" }, - { "$ref": "#/components/schemas/RimeVoiceUpdateParams" }, - { "$ref": "#/components/schemas/ElevenLabsVoiceUpdateParams" }, - { "$ref": "#/components/schemas/PlayHtVoiceUpdateParams" } + { + "$ref": "#/components/schemas/AzureVoiceUpdateParams" + }, + { + "$ref": "#/components/schemas/RimeVoiceUpdateParams" + }, + { + "$ref": "#/components/schemas/ElevenLabsVoiceUpdateParams" + }, + { + "$ref": "#/components/schemas/PlayHtVoiceUpdateParams" + } ], "title": "VoiceUpdateParamsRequest", "discriminator": { @@ -4126,51 +6311,101 @@ }, "Webhook": { "properties": { - "id": { "type": "string", "format": "uuid", "title": "Id" }, - "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "user_id": { + "type": "string", + "format": "uuid", + "title": "User Id" + }, "subscriptions": { - "items": { "$ref": "#/components/schemas/EventType" }, + "items": { + "$ref": "#/components/schemas/EventType" + }, "type": "array" }, - "url": { "type": "string", "title": "Url" }, + "url": { + "type": "string", + "title": "Url" + }, "method": { - "allOf": [{ "$ref": "#/components/schemas/HTTPMethod" }], + "allOf": [ + { + "$ref": "#/components/schemas/HTTPMethod" + } + ], "default": "POST" } }, "type": "object", - "required": ["id", "user_id", "subscriptions", "url"], + "required": [ + "id", + "user_id", + "subscriptions", + "url" + ], "title": "Webhook" }, "WebhookPage": { "properties": { "items": { - "items": { "$ref": "#/components/schemas/Webhook" }, + "items": { + "$ref": "#/components/schemas/Webhook" + }, "type": "array", "title": "Items" }, - "page": { "type": "integer", "title": "Page" }, - "size": { "type": "integer", "title": "Size" }, - "has_more": { "type": "boolean", "title": "Has More" } + "page": { + "type": "integer", + "title": "Page" + }, + "size": { + "type": "integer", + "title": "Size" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + } }, "type": "object", - "required": ["items", "page", "size", "has_more"], + "required": [ + "items", + "page", + "size", + "has_more" + ], "title": "WebhookPage" }, "WebhookParams": { "properties": { "subscriptions": { - "items": { "$ref": "#/components/schemas/EventType" }, + "items": { + "$ref": "#/components/schemas/EventType" + }, "type": "array" }, - "url": { "type": "string", "title": "Url" }, + "url": { + "type": "string", + "title": "Url" + }, "method": { - "allOf": [{ "$ref": "#/components/schemas/HTTPMethod" }], + "allOf": [ + { + "$ref": "#/components/schemas/HTTPMethod" + } + ], "default": "POST" } }, "type": "object", - "required": ["subscriptions", "url"], + "required": [ + "subscriptions", + "url" + ], "title": "WebhookParams" }, "WebhookUpdateParams": { @@ -4178,24 +6413,36 @@ "subscriptions": { "anyOf": [ { - "items": { "$ref": "#/components/schemas/EventType" }, + "items": { + "$ref": "#/components/schemas/EventType" + }, "type": "array" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Subscriptions" }, "url": { "anyOf": [ - { "type": "string" }, - { "$ref": "#/components/schemas/Undefined" } + { + "type": "string" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Url" }, "method": { "anyOf": [ - { "$ref": "#/components/schemas/HTTPMethod" }, - { "$ref": "#/components/schemas/Undefined" } + { + "$ref": "#/components/schemas/HTTPMethod" + }, + { + "$ref": "#/components/schemas/Undefined" + } ], "title": "Method" } @@ -4204,10 +6451,21 @@ "title": "WebhookUpdateParams" } }, - "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } + "securitySchemes": { + "HTTPBearer": { + "type": "http", + "scheme": "bearer" + } + } }, "tags": [ - { "name": "numbers", "description": "Operations with phone numbers." }, - { "name": "calls", "description": "Manage calls." } + { + "name": "numbers", + "description": "Operations with phone numbers." + }, + { + "name": "calls", + "description": "Manage calls." + } ] -} +} \ No newline at end of file