diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json index 960745dce..68d8edd30 100644 --- a/fern/apis/api/openapi.json +++ b/fern/apis/api/openapi.json @@ -3075,50 +3075,6 @@ } ] } - }, - "/enterprise": { - "post": { - "operationId": "EnterpriseInfoController_createEnterprise", - "summary": "Create Enterprise", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateEnterpriseInfoDTO" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnterpriseInfo" - } - } - } - }, - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateEnterpriseInfoDTO" - } - } - } - } - }, - "security": [ - { - "bearer": [] - } - ] - } } }, "info": { @@ -3677,6 +3633,155 @@ "enum": [ "azure" ] + }, + "language": { + "type": "string", + "description": "This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt", + "enum": [ + "af-ZA", + "am-ET", + "ar-AE", + "ar-BH", + "ar-DZ", + "ar-EG", + "ar-IL", + "ar-IQ", + "ar-JO", + "ar-KW", + "ar-LB", + "ar-LY", + "ar-MA", + "ar-OM", + "ar-PS", + "ar-QA", + "ar-SA", + "ar-SY", + "ar-TN", + "ar-YE", + "az-AZ", + "bg-BG", + "bn-IN", + "bs-BA", + "ca-ES", + "cs-CZ", + "cy-GB", + "da-DK", + "de-AT", + "de-CH", + "de-DE", + "el-GR", + "en-AU", + "en-CA", + "en-GB", + "en-GH", + "en-HK", + "en-IE", + "en-IN", + "en-KE", + "en-NG", + "en-NZ", + "en-PH", + "en-SG", + "en-TZ", + "en-US", + "en-ZA", + "es-AR", + "es-BO", + "es-CL", + "es-CO", + "es-CR", + "es-CU", + "es-DO", + "es-EC", + "es-ES", + "es-GQ", + "es-GT", + "es-HN", + "es-MX", + "es-NI", + "es-PA", + "es-PE", + "es-PR", + "es-PY", + "es-SV", + "es-US", + "es-UY", + "es-VE", + "et-EE", + "eu-ES", + "fa-IR", + "fi-FI", + "fil-PH", + "fr-BE", + "fr-CA", + "fr-CH", + "fr-FR", + "ga-IE", + "gl-ES", + "gu-IN", + "he-IL", + "hi-IN", + "hr-HR", + "hu-HU", + "hy-AM", + "id-ID", + "is-IS", + "it-CH", + "it-IT", + "ja-JP", + "jv-ID", + "ka-GE", + "kk-KZ", + "km-KH", + "kn-IN", + "ko-KR", + "lo-LA", + "lt-LT", + "lv-LV", + "mk-MK", + "ml-IN", + "mn-MN", + "mr-IN", + "ms-MY", + "mt-MT", + "my-MM", + "nb-NO", + "ne-NP", + "nl-BE", + "nl-NL", + "pa-IN", + "pl-PL", + "ps-AF", + "pt-BR", + "pt-PT", + "ro-RO", + "ru-RU", + "si-LK", + "sk-SK", + "sl-SI", + "so-SO", + "sq-AL", + "sr-RS", + "sv-SE", + "sw-KE", + "sw-TZ", + "ta-IN", + "te-IN", + "th-TH", + "tr-TR", + "uk-UA", + "ur-IN", + "uz-UZ", + "vi-VN", + "wuu-CN", + "yue-CN", + "zh-CN", + "zh-CN-shandong", + "zh-CN-sichuan", + "zh-HK", + "zh-TW", + "zu-ZA" + ] } }, "required": [ @@ -4754,7 +4859,7 @@ ] }, "summaryPlan": { - "description": "This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`.", + "description": "This is the plan for generating a summary of the call to present to the destination party.\n\nUsage:\n- Used only when `mode` is `blind-transfer-add-summary-to-sip-header` or `warm-transfer-say-summary` or `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`.", "allOf": [ { "$ref": "#/components/schemas/SummaryPlan" @@ -5618,6 +5723,7 @@ "type": "string", "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b", "enum": [ + "llama-3.3-70b-versatile", "llama-3.1-405b-reasoning", "llama-3.1-70b-versatile", "llama-3.1-8b-instant", @@ -12508,415 +12614,17 @@ }, "squadId": { "type": "string", - "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected." - }, - "server": { - "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] - } - } - }, - "AutoReloadPlan": { - "type": "object", - "properties": { - "credits": { - "type": "number", - "description": "This the amount of credits to reload." - }, - "threshold": { - "type": "number", - "description": "This is the limit at which the reload is triggered." - } - }, - "required": [ - "credits", - "threshold" - ] - }, - "Subscription": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "This is the unique identifier for the subscription." - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "This is the timestamp when the subscription was created." - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "This is the timestamp when the subscription was last updated." - }, - "type": { - "type": "string", - "description": "This is the type / tier of the subscription.", - "enum": [ - "trial", - "pay-as-you-go", - "enterprise" - ] - }, - "status": { - "type": "string", - "description": "This is the status of the subscription. Past due subscriptions are subscriptions\nwith past due payments.", - "enum": [ - "active", - "frozen" - ] - }, - "credits": { - "type": "string", - "description": "This is the number of credits the subscription currently has.\n\nNote: This is a string to avoid floating point precision issues." - }, - "concurrencyLimit": { - "type": "number", - "description": "This is the total concurrency limit for the subscription.", - "minimum": 10 - }, - "concurrencyLimitIncluded": { - "type": "number", - "description": "This is the default concurrency limit for the subscription." - }, - "concurrencyLimitPurchased": { - "type": "number", - "description": "This is the purchased add-on concurrency limit for the subscription." - }, - "monthlyChargeScheduleId": { - "type": "number", - "description": "This is the ID of the monthly job that charges for subscription add ons and phone numbers." - }, - "monthlyCreditCheckScheduleId": { - "type": "number", - "description": "This is the ID of the monthly job that checks whether the credit balance of the subscription\nis sufficient for the monthly charge." - }, - "stripeCustomerId": { - "type": "string", - "description": "This is the Stripe customer ID." - }, - "stripePaymentMethodId": { - "type": "string", - "description": "This is the Stripe payment ID." - }, - "slackSupportEnabled": { - "type": "boolean", - "description": "If this flag is true, then the user has purchased slack support." - }, - "slackChannelId": { - "type": "string", - "description": "If this subscription has a slack support subscription, the slack channel's ID will be stored here." - }, - "hipaaEnabled": { - "type": "boolean", - "description": "This is the HIPAA enabled flag for the subscription. It determines whether orgs under this\nsubscription have the option to enable HIPAA compliance." - }, - "hipaaCommonPaperAgreementId": { - "type": "string", - "description": "This is the ID for the Common Paper agreement outlining the HIPAA contract." - }, - "stripePaymentMethodFingerprint": { - "type": "string", - "description": "This is the Stripe fingerprint of the payment method (card). It allows us\nto detect users who try to abuse our system through multiple sign-ups." - }, - "stripeCustomerEmail": { - "type": "string", - "description": "This is the customer's email on Stripe." - }, - "referredByEmail": { - "type": "string", - "description": "This is the email of the referrer for the subscription." - }, - "autoReloadPlan": { - "description": "This is the auto reload plan configured for the subscription.", - "allOf": [ - { - "$ref": "#/components/schemas/AutoReloadPlan" - } - ] - }, - "minutesIncluded": { - "type": "number", - "description": "The number of minutes included in the subscription. Enterprise only." - }, - "minutesUsed": { - "type": "number", - "description": "The number of minutes used in the subscription. Enterprise only." - }, - "minutesOverageCost": { - "type": "number", - "description": "The per minute charge on minutes that exceed the included minutes. Enterprise only." - }, - "providersIncluded": { - "description": "The list of providers included in the subscription. Enterprise only.", - "type": "array", - "items": { - "type": "string" - } - }, - "outboundCallsDailyLimit": { - "type": "number", - "description": "The maximum number of outbound calls this subscription may make in a day. Resets every night.", - "minimum": 10 - }, - "outboundCallsCounter": { - "type": "number", - "description": "The current number of outbound calls the subscription has made in the current day.", - "minimum": 0 - }, - "outboundCallsCounterNextResetAt": { - "format": "date-time", - "type": "string", - "description": "This is the timestamp at which the outbound calls counter is scheduled to reset at." - }, - "couponIds": { - "description": "This is the IDs of the coupons applicable to this subscription.", - "type": "array", - "items": { - "type": "string" - } - }, - "couponUsageLeft": { - "type": "string", - "description": "This is the number of credits left obtained from a coupon." - } - }, - "required": [ - "id", - "createdAt", - "updatedAt", - "type", - "status", - "credits", - "concurrencyLimit", - "concurrencyLimitIncluded", - "concurrencyLimitPurchased" - ] - }, - "UpdateSubscriptionDTO": { - "type": "object", - "properties": { - "stripeCustomerEmail": { - "type": "string", - "description": "This is the customer's email on Stripe." - } - } - }, - "Payment": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "This is the id of the payment" - }, - "orgId": { - "type": "string", - "description": "This is the id of the org" - }, - "cost": { - "type": "string", - "description": "This is the total cost of the payment, which is the sum of all the costs in the costs object.\n\nNote: this is a string to avoid floating point precision issues." - }, - "costs": { - "description": "This is the itemized breakdown of payment amounts", - "type": "array", - "items": { - "type": "object" - } - }, - "status": { - "type": "string", - "description": "This is the status of the payment", - "enum": [ - "past-due", - "pending", - "finalized", - "refunded" - ] - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "This is the timestamp when the payment was created" - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "This is the timestamp when the payment was last updated" - }, - "isAutoReload": { - "type": "boolean", - "description": "This indicates if this payment was automatically generated by the auto-reload feature" - }, - "subscriptionId": { - "type": "string", - "description": "This is the id of the subscription the payment belongs to" - }, - "callId": { - "type": "string", - "description": "This is the id of the call" - }, - "phoneNumberId": { - "type": "string", - "description": "This is the id of the purchased phone number" - }, - "stripePaymentIntentId": { - "type": "string", - "description": "This is the id of the associated stripe payment intent" - }, - "stripeInvoiceId": { - "type": "string", - "description": "This is the id of the associated stripe invoice" - } - }, - "required": [ - "id", - "cost", - "costs", - "status", - "createdAt", - "updatedAt", - "isAutoReload", - "subscriptionId" - ] - }, - "PaymentsPaginatedResponse": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Payment" - } - }, - "metadata": { - "$ref": "#/components/schemas/PaginationMeta" - } - }, - "required": [ - "results", - "metadata" - ] - }, - "SubscriptionMonthlyCharge": { - "type": "object", - "properties": { - "monthlyCharge": { - "type": "number", - "description": "This is the monthly charge for the subscription." - }, - "costs": { - "description": "These are the different costs that make up the monthly charge.", - "type": "array", - "items": { - "type": "object" - } - } - }, - "required": [ - "monthlyCharge", - "costs" - ] - }, - "CreditsBuyDTO": { - "type": "object", - "properties": { - "credits": { - "type": "number", - "description": "This is the number of credits to add to the subscription." - } - }, - "required": [ - "credits" - ] - }, - "AutoReloadPlanDTO": { - "type": "object", - "properties": { - "autoReloadPlan": { - "description": "This is the auto reload plan to be configured for the subscription.\nIt can be null if no auto reload plan is set.", - "allOf": [ - { - "$ref": "#/components/schemas/AutoReloadPlan" - } - ] - } - } - }, - "PaymentRetryDTO": { - "type": "object", - "properties": { - "paymentId": { - "type": "string", - "description": "This is the payment ID to retry." - } - }, - "required": [ - "paymentId" - ] - }, - "SubscriptionConcurrencyLineBuyDTO": { - "type": "object", - "properties": { - "quantity": { - "type": "number", - "description": "This is the number of concurrency lines to purchase." - } - }, - "required": [ - "quantity" - ] - }, - "SubscriptionConcurrencyLineRemoveDTO": { - "type": "object", - "properties": { - "quantity": { - "type": "number", - "description": "This is the number of concurrency lines to remove." - } - }, - "required": [ - "quantity" - ] - }, - "HipaaBuyDTO": { - "type": "object", - "properties": { - "recipientName": { - "type": "string", - "description": "This is the name of the recipient." - }, - "recipientOrganization": { - "type": "string", - "description": "This is the name of the recipient organization." - } - }, - "required": [ - "recipientName", - "recipientOrganization" - ] - }, - "SubscriptionCouponAddDTO": { - "type": "object", - "properties": { - "orgId": { - "type": "string", - "description": "This is the ID of the org within the subscription which the coupon will take effect on." + "description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected." }, - "couponCode": { - "type": "string", - "description": "This is the code of the coupon to apply to the subscription." + "server": { + "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server", + "allOf": [ + { + "$ref": "#/components/schemas/Server" + } + ] } - }, - "required": [ - "orgId", - "couponCode" - ] + } }, "Squad": { "type": "object", @@ -15790,6 +15498,10 @@ "messages" ] }, + "ChatServiceResponse": { + "type": "object", + "properties": {} + }, "AnthropicCredential": { "type": "object", "properties": { @@ -19903,6 +19615,184 @@ } } }, + "AutoReloadPlan": { + "type": "object", + "properties": { + "credits": { + "type": "number", + "description": "This the amount of credits to reload." + }, + "threshold": { + "type": "number", + "description": "This is the limit at which the reload is triggered." + } + }, + "required": [ + "credits", + "threshold" + ] + }, + "Subscription": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This is the unique identifier for the subscription." + }, + "createdAt": { + "format": "date-time", + "type": "string", + "description": "This is the timestamp when the subscription was created." + }, + "updatedAt": { + "format": "date-time", + "type": "string", + "description": "This is the timestamp when the subscription was last updated." + }, + "type": { + "type": "string", + "description": "This is the type / tier of the subscription.", + "enum": [ + "trial", + "pay-as-you-go", + "enterprise" + ] + }, + "status": { + "type": "string", + "description": "This is the status of the subscription. Past due subscriptions are subscriptions\nwith past due payments.", + "enum": [ + "active", + "frozen" + ] + }, + "credits": { + "type": "string", + "description": "This is the number of credits the subscription currently has.\n\nNote: This is a string to avoid floating point precision issues." + }, + "concurrencyLimit": { + "type": "number", + "description": "This is the total concurrency limit for the subscription.", + "minimum": 10 + }, + "concurrencyLimitIncluded": { + "type": "number", + "description": "This is the default concurrency limit for the subscription." + }, + "concurrencyLimitPurchased": { + "type": "number", + "description": "This is the purchased add-on concurrency limit for the subscription." + }, + "monthlyChargeScheduleId": { + "type": "number", + "description": "This is the ID of the monthly job that charges for subscription add ons and phone numbers." + }, + "monthlyCreditCheckScheduleId": { + "type": "number", + "description": "This is the ID of the monthly job that checks whether the credit balance of the subscription\nis sufficient for the monthly charge." + }, + "stripeCustomerId": { + "type": "string", + "description": "This is the Stripe customer ID." + }, + "stripePaymentMethodId": { + "type": "string", + "description": "This is the Stripe payment ID." + }, + "slackSupportEnabled": { + "type": "boolean", + "description": "If this flag is true, then the user has purchased slack support." + }, + "slackChannelId": { + "type": "string", + "description": "If this subscription has a slack support subscription, the slack channel's ID will be stored here." + }, + "hipaaEnabled": { + "type": "boolean", + "description": "This is the HIPAA enabled flag for the subscription. It determines whether orgs under this\nsubscription have the option to enable HIPAA compliance." + }, + "hipaaCommonPaperAgreementId": { + "type": "string", + "description": "This is the ID for the Common Paper agreement outlining the HIPAA contract." + }, + "stripePaymentMethodFingerprint": { + "type": "string", + "description": "This is the Stripe fingerprint of the payment method (card). It allows us\nto detect users who try to abuse our system through multiple sign-ups." + }, + "stripeCustomerEmail": { + "type": "string", + "description": "This is the customer's email on Stripe." + }, + "referredByEmail": { + "type": "string", + "description": "This is the email of the referrer for the subscription." + }, + "autoReloadPlan": { + "description": "This is the auto reload plan configured for the subscription.", + "allOf": [ + { + "$ref": "#/components/schemas/AutoReloadPlan" + } + ] + }, + "minutesIncluded": { + "type": "number", + "description": "The number of minutes included in the subscription. Enterprise only." + }, + "minutesUsed": { + "type": "number", + "description": "The number of minutes used in the subscription. Enterprise only." + }, + "minutesOverageCost": { + "type": "number", + "description": "The per minute charge on minutes that exceed the included minutes. Enterprise only." + }, + "providersIncluded": { + "description": "The list of providers included in the subscription. Enterprise only.", + "type": "array", + "items": { + "type": "string" + } + }, + "outboundCallsDailyLimit": { + "type": "number", + "description": "The maximum number of outbound calls this subscription may make in a day. Resets every night.", + "minimum": 10 + }, + "outboundCallsCounter": { + "type": "number", + "description": "The current number of outbound calls the subscription has made in the current day.", + "minimum": 0 + }, + "outboundCallsCounterNextResetAt": { + "format": "date-time", + "type": "string", + "description": "This is the timestamp at which the outbound calls counter is scheduled to reset at." + }, + "couponIds": { + "description": "This is the IDs of the coupons applicable to this subscription.", + "type": "array", + "items": { + "type": "string" + } + }, + "couponUsageLeft": { + "type": "string", + "description": "This is the number of credits left obtained from a coupon." + } + }, + "required": [ + "id", + "createdAt", + "updatedAt", + "type", + "status", + "credits", + "concurrencyLimit", + "concurrencyLimitIncluded", + "concurrencyLimitPurchased" + ] + }, "OrgPlan": { "type": "object", "properties": { @@ -21005,97 +20895,6 @@ } } }, - "CreateEnterpriseInfoDTO": { - "type": "object", - "properties": { - "companySize": { - "type": "string", - "description": "The size of the company." - }, - "source": { - "type": "string", - "description": "How the company heard about us." - }, - "companyType": { - "type": "string", - "description": "The type of the company." - }, - "callVolume": { - "type": "string", - "description": "The call volume of the company." - }, - "orgId": { - "type": "string", - "description": "The optional ID of the organization." - }, - "email": { - "type": "string", - "description": "The optional email of the company." - }, - "useCase": { - "type": "string", - "description": "The use case of the company." - } - }, - "required": [ - "companySize", - "source", - "companyType", - "callVolume" - ] - }, - "EnterpriseInfo": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The unique identifier for the enterprise info." - }, - "companySize": { - "type": "string", - "description": "The size of the company." - }, - "source": { - "type": "string", - "description": "How the company heard about us." - }, - "companyType": { - "type": "string", - "description": "The type of the company." - }, - "callVolume": { - "type": "string", - "description": "The call volume of the company." - }, - "orgId": { - "type": "string", - "description": "The optional ID of the organization." - }, - "email": { - "type": "string", - "description": "The optional email of the company." - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "The ISO 8601 date-time string of when the enterprise info was created." - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "The ISO 8601 date-time string of when the enterprise info was last updated." - } - }, - "required": [ - "id", - "companySize", - "source", - "companyType", - "callVolume", - "createdAt", - "updatedAt" - ] - }, "ClientMessageConversationUpdate": { "type": "object", "properties": { @@ -22852,6 +22651,10 @@ "type": "string", "description": "This is the transcript of the call. This is only sent if the status is \"forwarding\"." }, + "summary": { + "type": "string", + "description": "This is the summary of the call. This is only sent if the status is \"forwarding\"." + }, "inboundPhoneCallDebuggingArtifacts": { "type": "object", "description": "This is the inbound phone call debugging artifacts. This is only sent if the status is \"ended\" and there was an error accepting the inbound phone call.\n\nThis will include any errors related to the \"assistant-request\" if one was made."