diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json index ac5fa3627..d432d32d9 100644 --- a/fern/apis/api/openapi.json +++ b/fern/apis/api/openapi.json @@ -11304,6 +11304,11 @@ "exact" ] }, + "replaceAllEnabled": { + "type": "boolean", + "description": "This option let's you control whether to replace all instances of the key or only the first one. By default, it only replaces the first instance.\nExamples:\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: false }. Before: \"hello world, hello universe\" | After: \"hi world, hello universe\"\n- For { type: 'exact', key: 'hello', value: 'hi', replaceAllEnabled: true }. Before: \"hello world, hello universe\" | After: \"hi world, hi universe\"\n@default false", + "default": false + }, "key": { "type": "string", "description": "This is the key to replace." @@ -11839,31 +11844,79 @@ ] }, "voiceId": { + "type": "string", "description": "This is the provider-specific ID that will be used.", - "oneOf": [ - { - "type": "string", - "enum": [ - "asteria", - "luna", - "stella", - "athena", - "hera", - "orion", - "arcas", - "perseus", - "angus", - "orpheus", - "helios", - "zeus" - ], - "title": "Preset Voice Options" - }, - { - "type": "string", - "title": "Deepgram Voice ID" - } - ] + "enum": [ + "asteria", + "luna", + "stella", + "athena", + "hera", + "orion", + "arcas", + "perseus", + "angus", + "orpheus", + "helios", + "zeus", + "thalia", + "andromeda", + "helena", + "apollo", + "arcas", + "aries", + "amalthea", + "andromeda", + "apollo", + "arcas", + "aries", + "asteria", + "athena", + "atlas", + "aurora", + "callista", + "cora", + "cordelia", + "delia", + "draco", + "electra", + "harmonia", + "helena", + "hera", + "hermes", + "hyperion", + "iris", + "janus", + "juno", + "jupiter", + "luna", + "mars", + "minerva", + "neptune", + "odysseus", + "ophelia", + "orion", + "orpheus", + "pandora", + "phoebe", + "pluto", + "saturn", + "selene", + "thalia", + "theia", + "vesta", + "zeus" + ], + "title": "This is the Deepgram Voice ID" + }, + "model": { + "type": "string", + "description": "This is the model that will be used. Defaults to 'aura-2' when not specified.", + "enum": [ + "aura", + "aura-2" + ], + "example": "aura-2" }, "mipOptOut": { "type": "boolean", @@ -13070,31 +13123,79 @@ ] }, "voiceId": { + "type": "string", "description": "This is the provider-specific ID that will be used.", - "oneOf": [ - { - "type": "string", - "enum": [ - "asteria", - "luna", - "stella", - "athena", - "hera", - "orion", - "arcas", - "perseus", - "angus", - "orpheus", - "helios", - "zeus" - ], - "title": "Preset Voice Options" - }, - { - "type": "string", - "title": "Deepgram Voice ID" - } - ] + "enum": [ + "asteria", + "luna", + "stella", + "athena", + "hera", + "orion", + "arcas", + "perseus", + "angus", + "orpheus", + "helios", + "zeus", + "thalia", + "andromeda", + "helena", + "apollo", + "arcas", + "aries", + "amalthea", + "andromeda", + "apollo", + "arcas", + "aries", + "asteria", + "athena", + "atlas", + "aurora", + "callista", + "cora", + "cordelia", + "delia", + "draco", + "electra", + "harmonia", + "helena", + "hera", + "hermes", + "hyperion", + "iris", + "janus", + "juno", + "jupiter", + "luna", + "mars", + "minerva", + "neptune", + "odysseus", + "ophelia", + "orion", + "orpheus", + "pandora", + "phoebe", + "pluto", + "saturn", + "selene", + "thalia", + "theia", + "vesta", + "zeus" + ], + "title": "This is the Deepgram Voice ID" + }, + "model": { + "type": "string", + "description": "This is the model that will be used. Defaults to 'aura-2' when not specified.", + "enum": [ + "aura", + "aura-2" + ], + "example": "aura-2" }, "mipOptOut": { "type": "boolean", @@ -17946,6 +18047,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "twilioPhoneNumber": { "type": "string", "description": "These are the digits of the phone number you own on your Twilio.", @@ -18632,6 +18745,8 @@ "phone-call-provider-closed-websocket", "silence-timed-out", "call.in-progress.error-sip-telephony-provider-failed-to-connect-call", + "call.ringing.hook-executed-say", + "call.ringing.hook-executed-transfer", "twilio-failed-to-connect-call", "twilio-reported-customer-misdialed", "vonage-rejected", @@ -21090,6 +21205,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to bring your own phone numbers from your own SIP trunks or Carriers.", @@ -21186,6 +21313,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to use numbers bought on Twilio.", @@ -21281,6 +21420,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to use numbers bought on Vonage.", @@ -21396,6 +21547,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to create free SIP phone numbers on Vapi.", @@ -21498,6 +21661,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to use numbers bought on Telnyx.", @@ -21588,6 +21763,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to bring your own phone numbers from your own SIP trunks or Carriers.", @@ -21653,6 +21840,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to use numbers bought on Twilio.", @@ -21717,6 +21916,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to use numbers bought on Vonage.", @@ -21776,6 +21987,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to create free SIP phone numbers on Vapi.", @@ -21843,6 +22066,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "provider": { "type": "string", "description": "This is to use numbers bought on Telnyx.", @@ -21902,6 +22137,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "numberE164CheckEnabled": { "type": "boolean", "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)", @@ -21956,6 +22203,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "name": { "type": "string", "description": "This is the name of the phone number. This is just for your own reference.", @@ -22007,6 +22266,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "name": { "type": "string", "description": "This is the name of the phone number. This is just for your own reference.", @@ -22054,6 +22325,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "name": { "type": "string", "description": "This is the name of the phone number. This is just for your own reference.", @@ -22105,6 +22388,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "name": { "type": "string", "description": "This is the name of the phone number. This is just for your own reference.", @@ -22152,6 +22447,18 @@ } ] }, + "hooks": { + "type": "array", + "description": "This is the hooks that will be used for incoming calls to this phone number.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/PhoneNumberHookCallRinging", + "title": "PhoneNumberHookCallRinging" + } + ] + } + }, "vonagePhoneNumber": { "type": "string", "description": "These are the digits of the phone number you own on your Vonage.", @@ -25691,10 +25998,10 @@ "properties": { "phoneNumberId": { "type": "string", - "description": "This is the phoneNumberId that is being tested." + "description": "This is the phone number that is being tested.\nDuring the actual test, it'll be called and the assistant attached to it will pick up and be tested.\nTo test an assistant directly, send assistantId instead." }, "phoneNumber": { - "description": "This is the phone number that is being tested. Only use this if you have not imported the phone number to Vapi.", + "description": "This can be any phone number (even not on Vapi).\nDuring the actual test, it'll be called.\nTo test a Vapi number, send phoneNumberId. To test an assistant directly, send assistantId instead.", "allOf": [ { "$ref": "#/components/schemas/TestSuitePhoneNumber" @@ -25703,7 +26010,15 @@ }, "assistantId": { "type": "string", - "description": "This is the assistantId that is being tested." + "description": "This is the assistant being tested.\nDuring the actual test, it'll invoked directly.\nTo test the assistant over phone number, send phoneNumberId instead." + }, + "assistantOverrides": { + "description": "This is the assistant overrides applied to assistantId before it is tested.", + "allOf": [ + { + "$ref": "#/components/schemas/AssistantOverrides" + } + ] } } }, @@ -33336,6 +33651,8 @@ "phone-call-provider-closed-websocket", "silence-timed-out", "call.in-progress.error-sip-telephony-provider-failed-to-connect-call", + "call.ringing.hook-executed-say", + "call.ringing.hook-executed-transfer", "twilio-failed-to-connect-call", "twilio-reported-customer-misdialed", "vonage-rejected", @@ -34414,6 +34731,8 @@ "phone-call-provider-closed-websocket", "silence-timed-out", "call.in-progress.error-sip-telephony-provider-failed-to-connect-call", + "call.ringing.hook-executed-say", + "call.ringing.hook-executed-transfer", "twilio-failed-to-connect-call", "twilio-reported-customer-misdialed", "vonage-rejected",