diff --git a/.fern/metadata.json b/.fern/metadata.json index 0a17558..cd7956a 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -1,15 +1,15 @@ { - "cliVersion": "5.51.2", + "cliVersion": "5.75.6", "generatorName": "fernapi/fern-php-sdk", "generatorVersion": "2.4.0", "generatorConfig": { "namespace": "Vapi", "client-class-name": "VapiClient" }, - "originGitCommit": "5a015aa01196915bea6110904c69d5804f457ff5", + "originGitCommit": "5bfd858800a83849a00a0db760c7cce860f37da6", "originGitCommitIsDirty": true, "invokedBy": "ci", "requestedVersion": "AUTO", "ciProvider": "unknown", - "sdkVersion": "2.0.0" + "sdkVersion": "2.0.1" } \ No newline at end of file diff --git a/.fern/replay.lock b/.fern/replay.lock new file mode 100644 index 0000000..86a4dd9 --- /dev/null +++ b/.fern/replay.lock @@ -0,0 +1,16 @@ +# DO NOT EDIT MANUALLY - Managed by Fern Replay +version: "1.0" +generations: + - commit_sha: 13cd0c5de1ca81174c35f2ed009501bad4407ee6 + tree_hash: d10238b3698b8720795caaba3fff560bf0649009 + timestamp: 2026-07-21T02:24:12.644Z + cli_version: unknown + generator_versions: {} + - commit_sha: 1b1ff3d0a7c99e944180c77b52688c1bc29bf29c + tree_hash: ffcd1d5eecd88edd12cad3167ba85ee166686524 + timestamp: 2026-07-21T02:24:13.033Z + cli_version: unknown + generator_versions: + fernapi/fern-php-sdk: 2.4.0 +current_generation: 1b1ff3d0a7c99e944180c77b52688c1bc29bf29c +patches: [] diff --git a/.fernignore b/.fernignore index 978b3fa..0e6333f 100644 --- a/.fernignore +++ b/.fernignore @@ -1,3 +1,6 @@ # Specify files that shouldn't be modified by Fern .github/workflows/sdk-release-pr-notification.yml changelog.md +.fern/replay.lock +.fern/replay.yml +.gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..74928d6 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +.fern/replay.lock linguist-generated=true diff --git a/changelog.md b/changelog.md index 9e9180d..ae90a49 100644 --- a/changelog.md +++ b/changelog.md @@ -1,3 +1,5 @@ +## [2.0.1] - 2026-07-21 + ## 2.0.0 - 2026-06-24 ### Breaking Changes * **`CartesiaExperimentalControlsSpeedZero`** has been renamed to `CartesiaSpeedControlZero`. Update any references to this enum in your code to use the new name. diff --git a/composer.json b/composer.json index be52097..48297ac 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "vapi/vapi", - "version": "2.0.0", + "version": "2.0.1", "description": "Vapi PHP Library", "keywords": [ "vapi", diff --git a/reference.md b/reference.md index 676984d..6278378 100644 --- a/reference.md +++ b/reference.md @@ -4,6 +4,20 @@
+#### 📝 Description + +
+
+ +
+
+ +Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -110,6 +124,20 @@ $client->assistants->list(
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior. +
+
+
+
+ #### 🔌 Usage
@@ -152,6 +180,20 @@ $client->assistants->create(
+#### 📝 Description + +
+
+ +
+
+ +Returns the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -194,6 +236,20 @@ $client->assistants->get(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -236,6 +292,20 @@ $client->assistants->delete(
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the assistant identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -307,7 +377,7 @@ If unspecified, assistant will wait for user to speak and use the model to respo
-**$firstMessageInterruptionsEnabled:** `?bool` +**$firstMessageInterruptionsEnabled:** `?bool` — Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
@@ -474,7 +544,7 @@ If unspecified, it will hang up without saying anything.
-**$compliancePlan:** `?CompliancePlan` +**$compliancePlan:** `?CompliancePlan` — Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
@@ -597,7 +667,7 @@ The order of precedence is:
-**$keypadInputPlan:** `?KeypadInputPlan` +**$keypadInputPlan:** `?KeypadInputPlan` — Configuration for collecting and processing DTMF keypad input during calls.
@@ -614,6 +684,20 @@ The order of precedence is:
+#### 📝 Description + +
+
+ +
+
+ +Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -720,6 +804,20 @@ $client->squads->list(
+#### 📝 Description + +
+
+ +
+
+ +Creates a squad that coordinates multiple assistants and their handoffs during a conversation. +
+
+
+
+ #### 🔌 Usage
@@ -766,6 +864,20 @@ $client->squads->create(
+#### 📝 Description + +
+
+ +
+
+ +Returns the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -808,6 +920,20 @@ $client->squads->get(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -850,6 +976,20 @@ $client->squads->delete(
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the squad identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -930,6 +1070,20 @@ Both `membersOverrides` and `members[n].assistantOverrides` can be used together
+#### 📝 Description + +
+
+ +
+
+ +Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -1064,6 +1218,20 @@ Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+#### 📝 Description + +
+
+ +
+
+ +Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. +
+
+
+
+ #### 🔌 Usage
@@ -1299,6 +1467,20 @@ Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
+#### 📝 Description + +
+
+ +
+
+ +Returns the call identified by its ID, including its status, configuration, and available call data. +
+
+
+
+ #### 🔌 Usage
@@ -1341,6 +1523,20 @@ $client->calls->get(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the call identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -1397,6 +1593,20 @@ It may take up to a few hours to complete the bulk delete, and will be asynchron
+#### 📝 Description + +
+
+ +
+
+ +Updates the call identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2009,6 +2219,20 @@ Cannot specify both sessionId and transport fields (phoneNumberId/customer) toge
+#### 📝 Description + +
+
+ +
+
+ +Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -2147,6 +2371,20 @@ $client->campaigns->campaignControllerFindAll(
+#### 📝 Description + +
+
+ +
+
+ +Creates an outbound calling campaign that calls a set of customers. +
+
+
+
+ #### 🔌 Usage
@@ -2247,6 +2485,20 @@ $client->campaigns->campaignControllerCreate(
+#### 📝 Description + +
+
+ +
+
+ +Returns the outbound calling campaign identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2289,6 +2541,20 @@ $client->campaigns->campaignControllerFindOne(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the outbound calling campaign identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -2331,7 +2597,7 @@ $client->campaigns->campaignControllerRemove(
-#### 🔌 Usage +#### 📝 Description
@@ -2339,18 +2605,32 @@ $client->campaigns->campaignControllerRemove(
-```php -$client->campaigns->campaignControllerUpdate( - 'id', - new UpdateCampaignDto([]), -); -``` +Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`.
-#### ⚙️ Parameters +#### 🔌 Usage + +
+
+ +
+
+ +```php +$client->campaigns->campaignControllerUpdate( + 'id', + new UpdateCampaignDto([]), +); +``` +
+
+
+
+ +#### ⚙️ Parameters
@@ -3037,6 +3317,20 @@ $client->sessions->update(
+#### 📝 Description + +
+
+ +
+
+ +Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -3143,6 +3437,20 @@ $client->phoneNumbers->list(
+#### 📝 Description + +
+
+ +
+
+ +Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. +
+
+
+
+ #### 🔌 Usage
@@ -3187,6 +3495,20 @@ $client->phoneNumbers->create(
+#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -3317,6 +3639,20 @@ $client->phoneNumbers->phoneNumberControllerFindAllPaginated(
+#### 📝 Description + +
+
+ +
+
+ +Returns the phone number resource identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3359,6 +3695,20 @@ $client->phoneNumbers->get(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the phone number resource identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3401,6 +3751,20 @@ $client->phoneNumbers->delete(
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the phone number resource identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3455,6 +3819,20 @@ $client->phoneNumbers->update(
+#### 📝 Description + +
+
+ +
+
+ +Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. +
+
+
+
+ #### 🔌 Usage
@@ -3561,6 +3939,20 @@ $client->tools->list(
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable tool that assistants can invoke during conversations. +
+
+
+
+ #### 🔌 Usage
@@ -3606,6 +3998,20 @@ $client->tools->create(
+#### 📝 Description + +
+
+ +
+
+ +Returns the tool identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3648,6 +4054,20 @@ $client->tools->get(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the tool identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3690,6 +4110,20 @@ $client->tools->delete(
+#### 📝 Description + +
+
+ +
+
+ +Updates the specified fields of the tool identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3744,6 +4178,20 @@ $client->tools->update(
+#### 📝 Description + +
+
+ +
+
+ +Returns files uploaded to the authenticated organization. +
+
+
+
+ #### 🔌 Usage
@@ -3769,6 +4217,20 @@ $client->files->list();
+#### 📝 Description + +
+
+ +
+
+ +Uploads a file for use with a Vapi knowledge base. +
+
+
+
+ #### 🔌 Usage
@@ -3798,6 +4260,20 @@ $client->files->create(
+#### 📝 Description + +
+
+ +
+
+ +Returns the uploaded file identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3840,6 +4316,20 @@ $client->files->get(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the uploaded file identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3882,6 +4372,20 @@ $client->files->delete(
+#### 📝 Description + +
+
+ +
+
+ +Updates the name of the uploaded file identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -3934,6 +4438,20 @@ $client->files->update(
+#### 📝 Description + +
+
+ +
+
+ +Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -4072,6 +4590,20 @@ $client->structuredOutputs->structuredOutputControllerFindAll(
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. +
+
+
+
+ #### 🔌 Usage
@@ -4119,7 +4651,21 @@ $client->structuredOutputs->structuredOutputControllerCreate(
-#### 🔌 Usage +#### 📝 Description + +
+
+ +
+
+ +Returns the structured-output definition identified by its ID. +
+
+
+
+ +#### 🔌 Usage
@@ -4161,6 +4707,20 @@ $client->structuredOutputs->structuredOutputControllerFindOne(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the structured-output definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -4203,6 +4763,20 @@ $client->structuredOutputs->structuredOutputControllerRemove(
+#### 📝 Description + +
+
+ +
+
+ +Updates the structured-output definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -4380,6 +4954,20 @@ Defines the structure and validation rules for the data that will be extracted.
+#### 📝 Description + +
+
+ +
+
+ +Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. +
+
+
+
+ #### 🔌 Usage
@@ -4463,6 +5051,20 @@ If preview is false, up to 100 callIds may be provided.
+#### 📝 Description + +
+
+ +
+
+ +Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -4593,6 +5195,20 @@ $client->insight->insightControllerFindAll(
+#### 📝 Description + +
+
+ +
+
+ +Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. +
+
+
+
+ #### 🔌 Usage
@@ -4644,6 +5260,20 @@ $client->insight->insightControllerCreate(
+#### 📝 Description + +
+
+ +
+
+ +Returns the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -4686,6 +5316,20 @@ $client->insight->insightControllerFindOne(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -4728,6 +5372,20 @@ $client->insight->insightControllerRemove(
+#### 📝 Description + +
+
+ +
+
+ +Updates the reporting insight identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -4781,6 +5439,20 @@ $client->insight->insightControllerUpdate(
+#### 📝 Description + +
+
+ +
+
+ +Runs a saved reporting insight, optionally overriding its time range and response format. +
+
+
+
+ #### 🔌 Usage
@@ -4816,7 +5488,7 @@ $client->insight->insightControllerRun(
-**$formatPlan:** `?InsightRunFormatPlan` +**$formatPlan:** `?InsightRunFormatPlan` — Output-formatting instructions applied to the insight run.
@@ -4848,6 +5520,20 @@ For Pie and Text Insights, step will be ignored even if provided.
+#### 📝 Description + +
+
+ +
+
+ +Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. +
+
+
+
+ #### 🔌 Usage
@@ -4900,6 +5586,20 @@ $client->insight->insightControllerPreview(
+#### 📝 Description + +
+
+ +
+
+ +Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -5030,6 +5730,20 @@ $client->eval->evalControllerGetPaginated(
+#### 📝 Description + +
+
+ +
+
+ +Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. +
+
+
+
+ #### 🔌 Usage
@@ -5079,6 +5793,20 @@ $client->eval->evalControllerCreate(
+#### 📝 Description + +
+
+ +
+
+ +Returns the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5121,6 +5849,20 @@ $client->eval->evalControllerGet(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5163,6 +5905,20 @@ $client->eval->evalControllerRemove(
+#### 📝 Description + +
+
+ +
+
+ +Updates the eval definition identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5253,6 +6009,20 @@ Currently it is fixed to `chat.mockConversation`.
+#### 📝 Description + +
+
+ +
+
+ +Returns the eval run identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5295,6 +6065,20 @@ $client->eval->evalControllerGetRun(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the eval run identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5337,6 +6121,20 @@ $client->eval->evalControllerRemoveRun(
+#### 📝 Description + +
+
+ +
+
+ +Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -5467,6 +6265,20 @@ $client->eval->evalControllerGetRunsPaginated(
+#### 📝 Description + +
+
+ +
+
+ +Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. +
+
+
+
+ #### 🔌 Usage
@@ -5540,6 +6352,20 @@ Currently it is fixed to `eval`.
+#### 📝 Description + +
+
+ +
+
+ +Returns the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5582,6 +6408,20 @@ $client->observabilityScorecard->scorecardControllerGet(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5624,6 +6464,20 @@ $client->observabilityScorecard->scorecardControllerRemove(
+#### 📝 Description + +
+
+ +
+
+ +Updates the scorecard identified by its ID. +
+
+
+
+ #### 🔌 Usage
@@ -5705,6 +6559,20 @@ When linked to assistants, this scorecard will be available for evaluation durin
+#### 📝 Description + +
+
+ +
+
+ +Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -5835,6 +6703,20 @@ $client->observabilityScorecard->scorecardControllerGetPaginated(
+#### 📝 Description + +
+
+ +
+
+ +Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. +
+
+
+
+ #### 🔌 Usage
@@ -5889,6 +6771,20 @@ $client->observabilityScorecard->scorecardControllerCreate(
+#### 📝 Description + +
+
+ +
+
+ +Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. +
+
+
+
+ #### 🔌 Usage
@@ -6045,6 +6941,20 @@ $client->providerResources->providerResourceControllerGetProviderResourcesPagina
+#### 📝 Description + +
+
+ +
+
+ +Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. +
+
+
+
+ #### 🔌 Usage
@@ -6096,6 +7006,20 @@ $client->providerResources->providerResourceControllerCreateProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Returns the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -6156,6 +7080,20 @@ $client->providerResources->providerResourceControllerGetProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Deletes the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -6216,6 +7154,20 @@ $client->providerResources->providerResourceControllerDeleteProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Updates the provider resource identified by its Vapi resource ID. +
+
+
+
+ #### 🔌 Usage
@@ -6277,6 +7229,20 @@ $client->providerResources->providerResourceControllerUpdateProviderResource(
+#### 📝 Description + +
+
+ +
+
+ +Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations. +
+
+
+
+ #### 🔌 Usage
diff --git a/src/Analytics/AnalyticsClient.php b/src/Analytics/AnalyticsClient.php index 15fdf09..9000242 100644 --- a/src/Analytics/AnalyticsClient.php +++ b/src/Analytics/AnalyticsClient.php @@ -52,6 +52,8 @@ public function __construct( } /** + * Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations. + * * @param AnalyticsQueryDto $request * @param ?array{ * baseUrl?: string, diff --git a/src/Assistants/AssistantsClient.php b/src/Assistants/AssistantsClient.php index 023b75c..9888ad3 100644 --- a/src/Assistants/AssistantsClient.php +++ b/src/Assistants/AssistantsClient.php @@ -55,6 +55,8 @@ public function __construct( } /** + * Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param ListAssistantsRequest $request * @param ?array{ * baseUrl?: string, @@ -130,6 +132,8 @@ public function list(ListAssistantsRequest $request = new ListAssistantsRequest( } /** + * Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior. + * * @param CreateAssistantDto $request * @param ?array{ * baseUrl?: string, @@ -177,6 +181,8 @@ public function create(CreateAssistantDto $request, ?array $options = null): ?As } /** + * Returns the assistant identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -223,6 +229,8 @@ public function get(string $id, ?array $options = null): ?Assistant } /** + * Deletes the assistant identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -269,6 +277,8 @@ public function delete(string $id, ?array $options = null): ?Assistant } /** + * Updates the specified fields of the assistant identified by its ID. + * * @param string $id * @param UpdateAssistantDto $request * @param ?array{ diff --git a/src/Assistants/Requests/UpdateAssistantDto.php b/src/Assistants/Requests/UpdateAssistantDto.php index 2cc64ee..e0a47c0 100644 --- a/src/Assistants/Requests/UpdateAssistantDto.php +++ b/src/Assistants/Requests/UpdateAssistantDto.php @@ -67,7 +67,7 @@ class UpdateAssistantDto extends JsonSerializableType public ?string $firstMessage; /** - * @var ?bool $firstMessageInterruptionsEnabled + * @var ?bool $firstMessageInterruptionsEnabled Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ #[JsonProperty('firstMessageInterruptionsEnabled')] public ?bool $firstMessageInterruptionsEnabled; @@ -217,7 +217,7 @@ class UpdateAssistantDto extends JsonSerializableType public ?array $endCallPhrases; /** - * @var ?CompliancePlan $compliancePlan + * @var ?CompliancePlan $compliancePlan Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. */ #[JsonProperty('compliancePlan')] public ?CompliancePlan $compliancePlan; @@ -320,7 +320,7 @@ class UpdateAssistantDto extends JsonSerializableType public ?Server $server; /** - * @var ?KeypadInputPlan $keypadInputPlan + * @var ?KeypadInputPlan $keypadInputPlan Configuration for collecting and processing DTMF keypad input during calls. */ #[JsonProperty('keypadInputPlan')] public ?KeypadInputPlan $keypadInputPlan; diff --git a/src/Calls/CallsClient.php b/src/Calls/CallsClient.php index d255207..a9e9428 100644 --- a/src/Calls/CallsClient.php +++ b/src/Calls/CallsClient.php @@ -58,6 +58,8 @@ public function __construct( } /** + * Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps. + * * @param ListCallsRequest $request * @param ?array{ * baseUrl?: string, @@ -142,6 +144,8 @@ public function list(ListCallsRequest $request = new ListCallsRequest(), ?array } /** + * Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations. + * * @param CreateCallDto $request * @param ?array{ * baseUrl?: string, @@ -192,6 +196,8 @@ public function create(CreateCallDto $request = new CreateCallDto(), ?array $opt } /** + * Returns the call identified by its ID, including its status, configuration, and available call data. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -238,6 +244,8 @@ public function get(string $id, ?array $options = null): ?Call } /** + * Deletes the call identified by its ID. + * * @param string $id * @param DeleteCallDto $request * @param ?array{ @@ -286,6 +294,8 @@ public function delete(string $id, DeleteCallDto $request = new DeleteCallDto(), } /** + * Updates the call identified by its ID. + * * @param string $id * @param UpdateCallDto $request * @param ?array{ diff --git a/src/Campaigns/CampaignsClient.php b/src/Campaigns/CampaignsClient.php index c0230ab..9b5d88f 100644 --- a/src/Campaigns/CampaignsClient.php +++ b/src/Campaigns/CampaignsClient.php @@ -55,6 +55,8 @@ public function __construct( } /** + * Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps. + * * @param CampaignControllerFindAllRequest $request * @param ?array{ * baseUrl?: string, @@ -142,6 +144,8 @@ public function campaignControllerFindAll(CampaignControllerFindAllRequest $requ } /** + * Creates an outbound calling campaign that calls a set of customers. + * * @param CreateCampaignDto $request * @param ?array{ * baseUrl?: string, @@ -189,6 +193,8 @@ public function campaignControllerCreate(CreateCampaignDto $request, ?array $opt } /** + * Returns the outbound calling campaign identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -235,6 +241,8 @@ public function campaignControllerFindOne(string $id, ?array $options = null): ? } /** + * Deletes the outbound calling campaign identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -281,6 +289,8 @@ public function campaignControllerRemove(string $id, ?array $options = null): ?C } /** + * Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`. + * * @param string $id * @param UpdateCampaignDto $request * @param ?array{ diff --git a/src/Eval/EvalClient.php b/src/Eval/EvalClient.php index cb7e3a1..d2a1a1c 100644 --- a/src/Eval/EvalClient.php +++ b/src/Eval/EvalClient.php @@ -60,6 +60,8 @@ public function __construct( } /** + * Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param EvalControllerGetPaginatedRequest $request * @param ?array{ * baseUrl?: string, @@ -144,6 +146,8 @@ public function evalControllerGetPaginated(EvalControllerGetPaginatedRequest $re } /** + * Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls. + * * @param CreateEvalDto $request * @param ?array{ * baseUrl?: string, @@ -191,6 +195,8 @@ public function evalControllerCreate(CreateEvalDto $request, ?array $options = n } /** + * Returns the eval definition identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -237,6 +243,8 @@ public function evalControllerGet(string $id, ?array $options = null): ?Eval_ } /** + * Deletes the eval definition identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -283,6 +291,8 @@ public function evalControllerRemove(string $id, ?array $options = null): ?Eval_ } /** + * Updates the eval definition identified by its ID. + * * @param string $id * @param UpdateEvalDto $request * @param ?array{ @@ -331,6 +341,8 @@ public function evalControllerUpdate(string $id, UpdateEvalDto $request = new Up } /** + * Returns the eval run identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -377,6 +389,8 @@ public function evalControllerGetRun(string $id, ?array $options = null): ?EvalR } /** + * Deletes the eval run identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -423,6 +437,8 @@ public function evalControllerRemoveRun(string $id, ?array $options = null): ?Ev } /** + * Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param EvalControllerGetRunsPaginatedRequest $request * @param ?array{ * baseUrl?: string, @@ -507,6 +523,8 @@ public function evalControllerGetRunsPaginated(EvalControllerGetRunsPaginatedReq } /** + * Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results. + * * @param CreateEvalRunDto $request * @param ?array{ * baseUrl?: string, diff --git a/src/Files/FilesClient.php b/src/Files/FilesClient.php index 6302f0c..fd60acd 100644 --- a/src/Files/FilesClient.php +++ b/src/Files/FilesClient.php @@ -55,6 +55,8 @@ public function __construct( } /** + * Returns files uploaded to the authenticated organization. + * * @param ?array{ * baseUrl?: string, * maxRetries?: int, @@ -100,6 +102,8 @@ public function list(?array $options = null): ?array } /** + * Uploads a file for use with a Vapi knowledge base. + * * @param CreateFileDto $request * @param ?array{ * baseUrl?: string, @@ -148,6 +152,8 @@ public function create(CreateFileDto $request, ?array $options = null): ?File } /** + * Returns the uploaded file identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -194,6 +200,8 @@ public function get(string $id, ?array $options = null): ?File } /** + * Deletes the uploaded file identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -240,6 +248,8 @@ public function delete(string $id, ?array $options = null): ?File } /** + * Updates the name of the uploaded file identified by its ID. + * * @param string $id * @param UpdateFileDto $request * @param ?array{ diff --git a/src/Insight/InsightClient.php b/src/Insight/InsightClient.php index 317b79e..169d83d 100644 --- a/src/Insight/InsightClient.php +++ b/src/Insight/InsightClient.php @@ -61,6 +61,8 @@ public function __construct( } /** + * Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param InsightControllerFindAllRequest $request * @param ?array{ * baseUrl?: string, @@ -145,6 +147,8 @@ public function insightControllerFindAll(InsightControllerFindAllRequest $reques } /** + * Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value. + * * @param InsightControllerCreateRequest $request * @param ?array{ * baseUrl?: string, @@ -192,6 +196,8 @@ public function insightControllerCreate(InsightControllerCreateRequest $request, } /** + * Returns the reporting insight identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -238,6 +244,8 @@ public function insightControllerFindOne(string $id, ?array $options = null): ?I } /** + * Deletes the reporting insight identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -284,6 +292,8 @@ public function insightControllerRemove(string $id, ?array $options = null): ?In } /** + * Updates the reporting insight identified by its ID. + * * @param string $id * @param InsightControllerUpdateRequest $request * @param ?array{ @@ -332,6 +342,8 @@ public function insightControllerUpdate(string $id, InsightControllerUpdateReque } /** + * Runs a saved reporting insight, optionally overriding its time range and response format. + * * @param string $id * @param InsightRunDto $request * @param ?array{ @@ -380,6 +392,8 @@ public function insightControllerRun(string $id, InsightRunDto $request = new In } /** + * Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. + * * @param InsightControllerPreviewRequest $request * @param ?array{ * baseUrl?: string, diff --git a/src/Insight/Requests/InsightRunDto.php b/src/Insight/Requests/InsightRunDto.php index fa2cddc..a5d52ab 100644 --- a/src/Insight/Requests/InsightRunDto.php +++ b/src/Insight/Requests/InsightRunDto.php @@ -10,7 +10,7 @@ class InsightRunDto extends JsonSerializableType { /** - * @var ?InsightRunFormatPlan $formatPlan + * @var ?InsightRunFormatPlan $formatPlan Output-formatting instructions applied to the insight run. */ #[JsonProperty('formatPlan')] public ?InsightRunFormatPlan $formatPlan; diff --git a/src/ObservabilityScorecard/ObservabilityScorecardClient.php b/src/ObservabilityScorecard/ObservabilityScorecardClient.php index 46db0b3..75d293b 100644 --- a/src/ObservabilityScorecard/ObservabilityScorecardClient.php +++ b/src/ObservabilityScorecard/ObservabilityScorecardClient.php @@ -55,6 +55,8 @@ public function __construct( } /** + * Returns the scorecard identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -101,6 +103,8 @@ public function scorecardControllerGet(string $id, ?array $options = null): ?Sco } /** + * Deletes the scorecard identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -147,6 +151,8 @@ public function scorecardControllerRemove(string $id, ?array $options = null): ? } /** + * Updates the scorecard identified by its ID. + * * @param string $id * @param UpdateScorecardDto $request * @param ?array{ @@ -195,6 +201,8 @@ public function scorecardControllerUpdate(string $id, UpdateScorecardDto $reques } /** + * Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. + * * @param ScorecardControllerGetPaginatedRequest $request * @param ?array{ * baseUrl?: string, @@ -279,6 +287,8 @@ public function scorecardControllerGetPaginated(ScorecardControllerGetPaginatedR } /** + * Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated. + * * @param CreateScorecardDto $request * @param ?array{ * baseUrl?: string, diff --git a/src/PhoneNumbers/PhoneNumbersClient.php b/src/PhoneNumbers/PhoneNumbersClient.php index eee50e3..867c5f2 100644 --- a/src/PhoneNumbers/PhoneNumbersClient.php +++ b/src/PhoneNumbers/PhoneNumbersClient.php @@ -61,6 +61,8 @@ public function __construct( } /** + * Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param ListPhoneNumbersRequest $request * @param ?array{ * baseUrl?: string, @@ -136,6 +138,8 @@ public function list(ListPhoneNumbersRequest $request = new ListPhoneNumbersRequ } /** + * Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider. + * * @param CreatePhoneNumbersRequest $request * @param ?array{ * baseUrl?: string, @@ -183,6 +187,8 @@ public function create(CreatePhoneNumbersRequest $request, ?array $options = nul } /** + * Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps. + * * @param PhoneNumberControllerFindAllPaginatedRequest $request * @param ?array{ * baseUrl?: string, @@ -267,6 +273,8 @@ public function phoneNumberControllerFindAllPaginated(PhoneNumberControllerFindA } /** + * Returns the phone number resource identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -313,6 +321,8 @@ public function get(string $id, ?array $options = null): ?GetPhoneNumbersRespons } /** + * Deletes the phone number resource identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -359,6 +369,8 @@ public function delete(string $id, ?array $options = null): ?DeletePhoneNumbersR } /** + * Updates the specified fields of the phone number resource identified by its ID. + * * @param string $id * @param UpdatePhoneNumbersRequest $request * @param ?array{ diff --git a/src/ProviderResources/ProviderResourcesClient.php b/src/ProviderResources/ProviderResourcesClient.php index c5df272..0216f62 100644 --- a/src/ProviderResources/ProviderResourcesClient.php +++ b/src/ProviderResources/ProviderResourcesClient.php @@ -63,6 +63,8 @@ public function __construct( } /** + * Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps. + * * @param value-of $provider The provider (e.g., 11labs) * @param value-of $resourceName The resource name (e.g., pronunciation-dictionary) * @param ProviderResourceControllerGetProviderResourcesPaginatedRequest $request @@ -152,6 +154,8 @@ public function providerResourceControllerGetProviderResourcesPaginated(string $ } /** + * Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. + * * @param value-of $provider The provider (e.g., 11labs) * @param value-of $resourceName The resource name (e.g., pronunciation-dictionary) * @param ?array{ @@ -199,6 +203,8 @@ public function providerResourceControllerCreateProviderResource(string $provide } /** + * Returns the provider resource identified by its Vapi resource ID. + * * @param value-of $provider The provider (e.g., 11labs) * @param value-of $resourceName The resource name (e.g., pronunciation-dictionary) * @param string $id @@ -247,6 +253,8 @@ public function providerResourceControllerGetProviderResource(string $provider, } /** + * Deletes the provider resource identified by its Vapi resource ID. + * * @param value-of $provider The provider (e.g., 11labs) * @param value-of $resourceName The resource name (e.g., pronunciation-dictionary) * @param string $id @@ -295,6 +303,8 @@ public function providerResourceControllerDeleteProviderResource(string $provide } /** + * Updates the provider resource identified by its Vapi resource ID. + * * @param value-of $provider The provider (e.g., 11labs) * @param value-of $resourceName The resource name (e.g., pronunciation-dictionary) * @param string $id diff --git a/src/Squads/SquadsClient.php b/src/Squads/SquadsClient.php index b63d803..ba5acd8 100644 --- a/src/Squads/SquadsClient.php +++ b/src/Squads/SquadsClient.php @@ -55,6 +55,8 @@ public function __construct( } /** + * Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param ListSquadsRequest $request * @param ?array{ * baseUrl?: string, @@ -130,6 +132,8 @@ public function list(ListSquadsRequest $request = new ListSquadsRequest(), ?arra } /** + * Creates a squad that coordinates multiple assistants and their handoffs during a conversation. + * * @param CreateSquadDto $request * @param ?array{ * baseUrl?: string, @@ -177,6 +181,8 @@ public function create(CreateSquadDto $request, ?array $options = null): ?Squad } /** + * Returns the squad identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -223,6 +229,8 @@ public function get(string $id, ?array $options = null): ?Squad } /** + * Deletes the squad identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -269,6 +277,8 @@ public function delete(string $id, ?array $options = null): ?Squad } /** + * Updates the specified fields of the squad identified by its ID. + * * @param string $id * @param UpdateSquadDto $request * @param ?array{ diff --git a/src/StructuredOutputs/StructuredOutputsClient.php b/src/StructuredOutputs/StructuredOutputsClient.php index 4f7e607..d2b3d44 100644 --- a/src/StructuredOutputs/StructuredOutputsClient.php +++ b/src/StructuredOutputs/StructuredOutputsClient.php @@ -56,6 +56,8 @@ public function __construct( } /** + * Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps. + * * @param StructuredOutputControllerFindAllRequest $request * @param ?array{ * baseUrl?: string, @@ -143,6 +145,8 @@ public function structuredOutputControllerFindAll(StructuredOutputControllerFind } /** + * Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression. + * * @param CreateStructuredOutputDto $request * @param ?array{ * baseUrl?: string, @@ -190,6 +194,8 @@ public function structuredOutputControllerCreate(CreateStructuredOutputDto $requ } /** + * Returns the structured-output definition identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -236,6 +242,8 @@ public function structuredOutputControllerFindOne(string $id, ?array $options = } /** + * Deletes the structured-output definition identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -282,6 +290,8 @@ public function structuredOutputControllerRemove(string $id, ?array $options = n } /** + * Updates the structured-output definition identified by its ID. + * * @param string $id * @param UpdateStructuredOutputDto $request * @param ?array{ @@ -333,6 +343,8 @@ public function structuredOutputControllerUpdate(string $id, UpdateStructuredOut } /** + * Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts. + * * @param StructuredOutputRunDto $request * @param ?array{ * baseUrl?: string, diff --git a/src/Tools/ToolsClient.php b/src/Tools/ToolsClient.php index 9bee634..8232716 100644 --- a/src/Tools/ToolsClient.php +++ b/src/Tools/ToolsClient.php @@ -59,6 +59,8 @@ public function __construct( } /** + * Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned. + * * @param ListToolsRequest $request * @param ?array{ * baseUrl?: string, @@ -134,6 +136,8 @@ public function list(ListToolsRequest $request = new ListToolsRequest(), ?array } /** + * Creates a reusable tool that assistants can invoke during conversations. + * * @param CreateToolsRequest $request * @param ?array{ * baseUrl?: string, @@ -181,6 +185,8 @@ public function create(CreateToolsRequest $request, ?array $options = null): ?Cr } /** + * Returns the tool identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -227,6 +233,8 @@ public function get(string $id, ?array $options = null): ?GetToolsResponse } /** + * Deletes the tool identified by its ID. + * * @param string $id * @param ?array{ * baseUrl?: string, @@ -273,6 +281,8 @@ public function delete(string $id, ?array $options = null): ?DeleteToolsResponse } /** + * Updates the specified fields of the tool identified by its ID. + * * @param string $id * @param UpdateToolsRequest $request * @param ?array{ diff --git a/src/Types/AiEdgeCondition.php b/src/Types/AiEdgeCondition.php index 3b144e2..1d2a0a7 100644 --- a/src/Types/AiEdgeCondition.php +++ b/src/Types/AiEdgeCondition.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An AI-evaluated boolean condition that determines whether a workflow follows an edge. + */ class AiEdgeCondition extends JsonSerializableType { /** - * @var value-of $type + * @var value-of $type Selects an AI-evaluated workflow edge condition. */ #[JsonProperty('type')] public string $type; diff --git a/src/Types/Analysis.php b/src/Types/Analysis.php index fbe931e..5ee77fe 100644 --- a/src/Types/Analysis.php +++ b/src/Types/Analysis.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Post-call analysis results, including summary, structured data, and success evaluation outputs. + */ class Analysis extends JsonSerializableType { /** diff --git a/src/Types/AnalysisCost.php b/src/Types/AnalysisCost.php index bacedde..6fc5c43 100644 --- a/src/Types/AnalysisCost.php +++ b/src/Types/AnalysisCost.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Cost for an individual analysis request, including analysis type, model, token usage, and amount. + */ class AnalysisCost extends JsonSerializableType { /** diff --git a/src/Types/AnalysisCostBreakdown.php b/src/Types/AnalysisCostBreakdown.php index 82c07bc..373998c 100644 --- a/src/Types/AnalysisCostBreakdown.php +++ b/src/Types/AnalysisCostBreakdown.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Analysis costs and token usage grouped by summary, structured data, success evaluation, and structured-output generation. + */ class AnalysisCostBreakdown extends JsonSerializableType { /** diff --git a/src/Types/AnalysisPlan.php b/src/Types/AnalysisPlan.php index 823a901..1b47db1 100644 --- a/src/Types/AnalysisPlan.php +++ b/src/Types/AnalysisPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for post-call analysis of summaries, structured-data extraction, success evaluation, and outcomes. + */ class AnalysisPlan extends JsonSerializableType { /** diff --git a/src/Types/AnalyticsOperation.php b/src/Types/AnalyticsOperation.php index 5c27fa3..8193d37 100644 --- a/src/Types/AnalyticsOperation.php +++ b/src/Types/AnalyticsOperation.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An aggregation or history operation applied to an analytics column, with an optional response alias. + */ class AnalyticsOperation extends JsonSerializableType { /** diff --git a/src/Types/AnalyticsQuery.php b/src/Types/AnalyticsQuery.php index 73456f0..71c925e 100644 --- a/src/Types/AnalyticsQuery.php +++ b/src/Types/AnalyticsQuery.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A named analytics query against call or subscription data, including grouping, time range, and aggregation operations. + */ class AnalyticsQuery extends JsonSerializableType { /** diff --git a/src/Types/AnalyticsQueryResult.php b/src/Types/AnalyticsQueryResult.php index cfe40da..c1f1c00 100644 --- a/src/Types/AnalyticsQueryResult.php +++ b/src/Types/AnalyticsQueryResult.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * The result of a named analytics query, including the evaluated time range and returned metric data. + */ class AnalyticsQueryResult extends JsonSerializableType { /** diff --git a/src/Types/AnthropicBedrockModel.php b/src/Types/AnthropicBedrockModel.php index 67c26cd..f205dc8 100644 --- a/src/Types/AnthropicBedrockModel.php +++ b/src/Types/AnthropicBedrockModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Anthropic models through Amazon Bedrock, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. + */ class AnthropicBedrockModel extends JsonSerializableType { /** diff --git a/src/Types/AnthropicModel.php b/src/Types/AnthropicModel.php index 2b6a819..3b27cfc 100644 --- a/src/Types/AnthropicModel.php +++ b/src/Types/AnthropicModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Anthropic, including model, prompts, tools, knowledge-base access, reasoning, and generation settings. + */ class AnthropicModel extends JsonSerializableType { /** diff --git a/src/Types/AnthropicThinkingConfig.php b/src/Types/AnthropicThinkingConfig.php index d40c495..601456a 100644 --- a/src/Types/AnthropicThinkingConfig.php +++ b/src/Types/AnthropicThinkingConfig.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Enables Anthropic extended thinking with a maximum thinking-token budget. + */ class AnthropicThinkingConfig extends JsonSerializableType { /** - * @var value-of $type + * @var value-of $type Enables Anthropic extended thinking. */ #[JsonProperty('type')] public string $type; diff --git a/src/Types/AnyscaleModel.php b/src/Types/AnyscaleModel.php index 7695d6d..cb83631 100644 --- a/src/Types/AnyscaleModel.php +++ b/src/Types/AnyscaleModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Anyscale, including model, prompts, tools, knowledge-base access, and generation settings. + */ class AnyscaleModel extends JsonSerializableType { /** diff --git a/src/Types/ApiRequestTool.php b/src/Types/ApiRequestTool.php index c8b07cf..9fbde96 100644 --- a/src/Types/ApiRequestTool.php +++ b/src/Types/ApiRequestTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses. + */ class ApiRequestTool extends JsonSerializableType { /** @@ -21,7 +24,7 @@ class ApiRequestTool extends JsonSerializableType public ?array $messages; /** - * @var value-of $method + * @var value-of $method The HTTP method used for the API request. */ #[JsonProperty('method')] public string $method; diff --git a/src/Types/Artifact.php b/src/Types/Artifact.php index 8d69038..aae1567 100644 --- a/src/Types/Artifact.php +++ b/src/Types/Artifact.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * Artifacts generated during a call, including messages, recordings, transcript, logs, packet capture, workflow-node data, variables, performance metrics, structured outputs, scorecards, and transfers. + */ class Artifact extends JsonSerializableType { /** diff --git a/src/Types/ArtifactPlan.php b/src/Types/ArtifactPlan.php index 2d119e7..54f0a1f 100644 --- a/src/Types/ArtifactPlan.php +++ b/src/Types/ArtifactPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls artifacts generated and stored for calls, including recordings, packet captures, logs, transcripts, structured outputs, scorecards, and custom storage paths. + */ class ArtifactPlan extends JsonSerializableType { /** diff --git a/src/Types/AssemblyAiTranscriber.php b/src/Types/AssemblyAiTranscriber.php index e5d1722..fa9c05f 100644 --- a/src/Types/AssemblyAiTranscriber.php +++ b/src/Types/AssemblyAiTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for transcribing speech during assistant conversations with AssemblyAI, including language, streaming model, endpointing, vocabulary, and fallback settings. + */ class AssemblyAiTranscriber extends JsonSerializableType { /** diff --git a/src/Types/Assistant.php b/src/Types/Assistant.php index 950284a..f01cab7 100644 --- a/src/Types/Assistant.php +++ b/src/Types/Assistant.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved assistant configuration returned by the Vapi API. It defines how the assistant listens, reasons, speaks, handles conversations, sends events, and produces artifacts and analysis. + */ class Assistant extends JsonSerializableType { /** @@ -40,7 +43,7 @@ class Assistant extends JsonSerializableType public ?string $firstMessage; /** - * @var ?bool $firstMessageInterruptionsEnabled + * @var ?bool $firstMessageInterruptionsEnabled Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ #[JsonProperty('firstMessageInterruptionsEnabled')] public ?bool $firstMessageInterruptionsEnabled; @@ -190,7 +193,7 @@ class Assistant extends JsonSerializableType public ?array $endCallPhrases; /** - * @var ?CompliancePlan $compliancePlan + * @var ?CompliancePlan $compliancePlan Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. */ #[JsonProperty('compliancePlan')] public ?CompliancePlan $compliancePlan; @@ -293,7 +296,7 @@ class Assistant extends JsonSerializableType public ?Server $server; /** - * @var ?KeypadInputPlan $keypadInputPlan + * @var ?KeypadInputPlan $keypadInputPlan Configuration for collecting and processing DTMF keypad input during calls. */ #[JsonProperty('keypadInputPlan')] public ?KeypadInputPlan $keypadInputPlan; diff --git a/src/Types/AssistantActivation.php b/src/Types/AssistantActivation.php index fbab03f..54a39b2 100644 --- a/src/Types/AssistantActivation.php +++ b/src/Types/AssistantActivation.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Identifies an assistant that became active during a call. + */ class AssistantActivation extends JsonSerializableType { /** diff --git a/src/Types/AssistantCustomEndpointingRule.php b/src/Types/AssistantCustomEndpointingRule.php index 0ad8eaa..5e4cd03 100644 --- a/src/Types/AssistantCustomEndpointingRule.php +++ b/src/Types/AssistantCustomEndpointingRule.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A custom endpointing rule that matches the assistant's last message and applies a configured timeout. + */ class AssistantCustomEndpointingRule extends JsonSerializableType { /** diff --git a/src/Types/AssistantMessage.php b/src/Types/AssistantMessage.php index 51fc110..6b8e80a 100644 --- a/src/Types/AssistantMessage.php +++ b/src/Types/AssistantMessage.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * An assistant-authored message, including content, refusal text, tool calls, participant name, and metadata. + */ class AssistantMessage extends JsonSerializableType { /** diff --git a/src/Types/AssistantMessageEvaluationContinuePlan.php b/src/Types/AssistantMessageEvaluationContinuePlan.php index 81873ce..665fc7c 100644 --- a/src/Types/AssistantMessageEvaluationContinuePlan.php +++ b/src/Types/AssistantMessageEvaluationContinuePlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls how an evaluation proceeds after judging an assistant message, including failure handling and optional message overrides. + */ class AssistantMessageEvaluationContinuePlan extends JsonSerializableType { /** diff --git a/src/Types/AssistantMessageJudgePlanAi.php b/src/Types/AssistantMessageJudgePlanAi.php index b78f6b8..3532178 100644 --- a/src/Types/AssistantMessageJudgePlanAi.php +++ b/src/Types/AssistantMessageJudgePlanAi.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Evaluates an assistant message with an LLM judge and a configured evaluation model. + */ class AssistantMessageJudgePlanAi extends JsonSerializableType { /** diff --git a/src/Types/AssistantMessageJudgePlanExact.php b/src/Types/AssistantMessageJudgePlanExact.php index a707794..9e7180c 100644 --- a/src/Types/AssistantMessageJudgePlanExact.php +++ b/src/Types/AssistantMessageJudgePlanExact.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Evaluates an assistant message using case-insensitive exact content matching and expected tool calls. + */ class AssistantMessageJudgePlanExact extends JsonSerializableType { /** diff --git a/src/Types/AssistantMessageJudgePlanRegex.php b/src/Types/AssistantMessageJudgePlanRegex.php index f487271..b5c7775 100644 --- a/src/Types/AssistantMessageJudgePlanRegex.php +++ b/src/Types/AssistantMessageJudgePlanRegex.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Evaluates assistant-message content and tool-call arguments using regular-expression patterns. + */ class AssistantMessageJudgePlanRegex extends JsonSerializableType { /** diff --git a/src/Types/AssistantOverrides.php b/src/Types/AssistantOverrides.php index f7b3505..2fd827b 100644 --- a/src/Types/AssistantOverrides.php +++ b/src/Types/AssistantOverrides.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\Union; use Vapi\Core\Types\ArrayType; +/** + * Per-call or handoff overrides for an assistant's providers, messages, tools, credentials, call behavior, and server configuration. + */ class AssistantOverrides extends JsonSerializableType { /** @@ -38,7 +41,7 @@ class AssistantOverrides extends JsonSerializableType public ?string $firstMessage; /** - * @var ?bool $firstMessageInterruptionsEnabled + * @var ?bool $firstMessageInterruptionsEnabled Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ #[JsonProperty('firstMessageInterruptionsEnabled')] public ?bool $firstMessageInterruptionsEnabled; @@ -152,7 +155,7 @@ class AssistantOverrides extends JsonSerializableType public ?array $hooks; /** - * @var ?array $toolsAppend + * @var ?array $toolsAppend Tools to append to the assistant's existing tool configuration. */ #[JsonProperty('tools:append'), ArrayType([AssistantOverridesToolsAppendItem::class])] public ?array $toolsAppend; @@ -208,7 +211,7 @@ class AssistantOverrides extends JsonSerializableType public ?array $endCallPhrases; /** - * @var ?CompliancePlan $compliancePlan + * @var ?CompliancePlan $compliancePlan Compliance settings to apply, including HIPAA and PCI behavior, security filtering, and recording consent. */ #[JsonProperty('compliancePlan')] public ?CompliancePlan $compliancePlan; @@ -311,7 +314,7 @@ class AssistantOverrides extends JsonSerializableType public ?Server $server; /** - * @var ?KeypadInputPlan $keypadInputPlan + * @var ?KeypadInputPlan $keypadInputPlan Configuration for collecting and processing DTMF keypad input. */ #[JsonProperty('keypadInputPlan')] public ?KeypadInputPlan $keypadInputPlan; diff --git a/src/Types/AwsStsAuthenticationPlan.php b/src/Types/AwsStsAuthenticationPlan.php index 067ae6c..0a7bb95 100644 --- a/src/Types/AwsStsAuthenticationPlan.php +++ b/src/Types/AwsStsAuthenticationPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * AWS Security Token Service role-assumption configuration used to authenticate requests. + */ class AwsStsAuthenticationPlan extends JsonSerializableType { /** diff --git a/src/Types/AwsiamCredentialsAuthenticationPlan.php b/src/Types/AwsiamCredentialsAuthenticationPlan.php index 8414b00..65eb7b5 100644 --- a/src/Types/AwsiamCredentialsAuthenticationPlan.php +++ b/src/Types/AwsiamCredentialsAuthenticationPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Direct AWS IAM credentials used to authenticate requests. + */ class AwsiamCredentialsAuthenticationPlan extends JsonSerializableType { /** diff --git a/src/Types/AzureBlobStorageBucketPlan.php b/src/Types/AzureBlobStorageBucketPlan.php index 820b397..7280c8c 100644 --- a/src/Types/AzureBlobStorageBucketPlan.php +++ b/src/Types/AzureBlobStorageBucketPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Azure Blob Storage container configuration for call artifacts, including its connection string, container name, and storage path. + */ class AzureBlobStorageBucketPlan extends JsonSerializableType { /** diff --git a/src/Types/AzureSpeechTranscriber.php b/src/Types/AzureSpeechTranscriber.php index d5b1acf..afc669b 100644 --- a/src/Types/AzureSpeechTranscriber.php +++ b/src/Types/AzureSpeechTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for transcribing speech during assistant conversations with Azure Speech, including language, segmentation, and fallback settings. + */ class AzureSpeechTranscriber extends JsonSerializableType { /** diff --git a/src/Types/AzureVoice.php b/src/Types/AzureVoice.php index 25755db..23c7765 100644 --- a/src/Types/AzureVoice.php +++ b/src/Types/AzureVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, caching, and fallback settings. + */ class AzureVoice extends JsonSerializableType { /** diff --git a/src/Types/BackgroundSpeechDenoisingPlan.php b/src/Types/BackgroundSpeechDenoisingPlan.php index 11a1396..2aba1ea 100644 --- a/src/Types/BackgroundSpeechDenoisingPlan.php +++ b/src/Types/BackgroundSpeechDenoisingPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls smart and Fourier denoising applied to customer audio before transcription. + */ class BackgroundSpeechDenoisingPlan extends JsonSerializableType { /** diff --git a/src/Types/BackoffPlan.php b/src/Types/BackoffPlan.php index 4ad6825..fd99abf 100644 --- a/src/Types/BackoffPlan.php +++ b/src/Types/BackoffPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls retry behavior for failed server requests, including strategy, maximum retries, base delay, and status codes excluded from retries. + */ class BackoffPlan extends JsonSerializableType { /** @@ -29,16 +32,13 @@ class BackoffPlan extends JsonSerializableType public float $maxRetries; /** - * @var float $baseDelaySeconds This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay. + * @var float $baseDelaySeconds Base delay in seconds. For fixed backoff, this is the delay between retries. For exponential backoff, this is the initial delay. */ #[JsonProperty('baseDelaySeconds')] public float $baseDelaySeconds; /** - * This is the excluded status codes. If the response status code is in this list, the request will not be retried. - * By default, the request will be retried for any non-2xx status code. - * - * @var ?array> $excludedStatusCodes + * @var ?array> $excludedStatusCodes HTTP status codes that should not trigger a retry. By default, any non-2xx status code not listed here can be retried. */ #[JsonProperty('excludedStatusCodes'), ArrayType([['string' => 'mixed']])] public ?array $excludedStatusCodes; diff --git a/src/Types/BarInsight.php b/src/Types/BarInsight.php index 464e9a2..1c46631 100644 --- a/src/Types/BarInsight.php +++ b/src/Types/BarInsight.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved bar-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. + */ class BarInsight extends JsonSerializableType { /** @@ -46,7 +49,7 @@ class BarInsight extends JsonSerializableType public ?BarInsightMetadata $metadata; /** - * @var ?InsightTimeRangeWithStep $timeRange + * @var ?InsightTimeRangeWithStep $timeRange The time range and interval used to aggregate the bar-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRangeWithStep $timeRange; diff --git a/src/Types/BarInsightMetadata.php b/src/Types/BarInsightMetadata.php index 8ff14ff..be74732 100644 --- a/src/Types/BarInsightMetadata.php +++ b/src/Types/BarInsightMetadata.php @@ -5,34 +5,37 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Display settings for a bar insight, including chart name, axis labels, and optional y-axis bounds. + */ class BarInsightMetadata extends JsonSerializableType { /** - * @var ?string $xAxisLabel + * @var ?string $xAxisLabel Label displayed on the chart's x-axis. */ #[JsonProperty('xAxisLabel')] public ?string $xAxisLabel; /** - * @var ?string $yAxisLabel + * @var ?string $yAxisLabel Label displayed on the chart's y-axis. */ #[JsonProperty('yAxisLabel')] public ?string $yAxisLabel; /** - * @var ?float $yAxisMin + * @var ?float $yAxisMin Minimum value displayed on the chart's y-axis. */ #[JsonProperty('yAxisMin')] public ?float $yAxisMin; /** - * @var ?float $yAxisMax + * @var ?float $yAxisMax Maximum value displayed on the chart's y-axis. */ #[JsonProperty('yAxisMax')] public ?float $yAxisMax; /** - * @var ?string $name + * @var ?string $name Display name for the insight chart. */ #[JsonProperty('name')] public ?string $name; diff --git a/src/Types/BashTool.php b/src/Types/BashTool.php index 9d54215..2909e49 100644 --- a/src/Types/BashTool.php +++ b/src/Types/BashTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that executes shell commands in a configured environment. + */ class BashTool extends JsonSerializableType { /** diff --git a/src/Types/BearerAuthenticationPlan.php b/src/Types/BearerAuthenticationPlan.php index 4bb58c5..643be87 100644 --- a/src/Types/BearerAuthenticationPlan.php +++ b/src/Types/BearerAuthenticationPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for authenticating outbound requests with a bearer token, including header name and optional `Bearer` prefix. + */ class BearerAuthenticationPlan extends JsonSerializableType { /** diff --git a/src/Types/BotMessage.php b/src/Types/BotMessage.php index 333149d..3caef4b 100644 --- a/src/Types/BotMessage.php +++ b/src/Types/BotMessage.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An assistant-authored entry in the call message history, including content, timing, source, and duration. + */ class BotMessage extends JsonSerializableType { /** diff --git a/src/Types/BothCustomEndpointingRule.php b/src/Types/BothCustomEndpointingRule.php index 8732ff0..e2d60fe 100644 --- a/src/Types/BothCustomEndpointingRule.php +++ b/src/Types/BothCustomEndpointingRule.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A custom endpointing rule that matches both the assistant's last message and the customer's current speech before applying a configured timeout. + */ class BothCustomEndpointingRule extends JsonSerializableType { /** @@ -34,7 +37,7 @@ class BothCustomEndpointingRule extends JsonSerializableType public ?array $assistantRegexOptions; /** - * @var string $customerRegex + * @var string $customerRegex The regular expression pattern matched against the customer's speech. */ #[JsonProperty('customerRegex')] public string $customerRegex; diff --git a/src/Types/BucketPlan.php b/src/Types/BucketPlan.php index cc353dc..43a36f8 100644 --- a/src/Types/BucketPlan.php +++ b/src/Types/BucketPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Google Cloud Storage bucket configuration for call artifacts, including bucket name, region, path, and optional HMAC credentials. + */ class BucketPlan extends JsonSerializableType { /** diff --git a/src/Types/ByoPhoneNumber.php b/src/Types/ByoPhoneNumber.php index f35fc44..16bc6f4 100644 --- a/src/Types/ByoPhoneNumber.php +++ b/src/Types/ByoPhoneNumber.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A phone number connected to Vapi through a bring-your-own telephony provider, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ class ByoPhoneNumber extends JsonSerializableType { /** diff --git a/src/Types/Call.php b/src/Types/Call.php index 3600c3c..7a38453 100644 --- a/src/Types/Call.php +++ b/src/Types/Call.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A call record returned by Vapi. It contains the configuration and resources used for the call, its lifecycle status and timestamps, conversation messages, artifacts, analysis, and costs. + */ class Call extends JsonSerializableType { /** @@ -30,7 +33,7 @@ class Call extends JsonSerializableType * |BotMessage * |ToolCallMessage * |ToolCallResultMessage - * )> $messages + * )> $messages Messages exchanged during the call, including user, assistant, system, tool-call, and tool-result messages. */ #[JsonProperty('messages'), ArrayType([new Union(UserMessage::class, SystemMessage::class, BotMessage::class, ToolCallMessage::class, ToolCallResultMessage::class)])] public ?array $messages; diff --git a/src/Types/CallBatchError.php b/src/Types/CallBatchError.php index 92dd730..a273b4e 100644 --- a/src/Types/CallBatchError.php +++ b/src/Types/CallBatchError.php @@ -5,16 +5,19 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Error returned for one customer entry in a batch call request. + */ class CallBatchError extends JsonSerializableType { /** - * @var CreateCustomerDto $customer + * @var CreateCustomerDto $customer Customer configuration associated with the failed call. */ #[JsonProperty('customer')] public CreateCustomerDto $customer; /** - * @var string $error + * @var string $error Error message explaining why the call could not be created. */ #[JsonProperty('error')] public string $error; diff --git a/src/Types/CallBatchResponse.php b/src/Types/CallBatchResponse.php index b279927..dd5b672 100644 --- a/src/Types/CallBatchResponse.php +++ b/src/Types/CallBatchResponse.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * The result of a batch call creation request, containing successfully created calls, per-call failures, and subscription limits recorded at the end of the batch. + */ class CallBatchResponse extends JsonSerializableType { /** diff --git a/src/Types/CallHookAssistantSpeechInterrupted.php b/src/Types/CallHookAssistantSpeechInterrupted.php index ef6345e..41eefb5 100644 --- a/src/Types/CallHookAssistantSpeechInterrupted.php +++ b/src/Types/CallHookAssistantSpeechInterrupted.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Runs configured actions when the customer's speech interrupts the assistant. + */ class CallHookAssistantSpeechInterrupted extends JsonSerializableType { /** diff --git a/src/Types/CallHookCallEnding.php b/src/Types/CallHookCallEnding.php index 3139361..0d1d222 100644 --- a/src/Types/CallHookCallEnding.php +++ b/src/Types/CallHookCallEnding.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Runs configured actions when a call is ending, optionally only when its filters match. + */ class CallHookCallEnding extends JsonSerializableType { /** diff --git a/src/Types/CallHookCustomerSpeechInterrupted.php b/src/Types/CallHookCustomerSpeechInterrupted.php index 661b3f7..6337f33 100644 --- a/src/Types/CallHookCustomerSpeechInterrupted.php +++ b/src/Types/CallHookCustomerSpeechInterrupted.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Runs configured actions when the assistant interrupts the customer's speech. + */ class CallHookCustomerSpeechInterrupted extends JsonSerializableType { /** diff --git a/src/Types/CallHookCustomerSpeechTimeout.php b/src/Types/CallHookCustomerSpeechTimeout.php index 4356f49..6f0568d 100644 --- a/src/Types/CallHookCustomerSpeechTimeout.php +++ b/src/Types/CallHookCustomerSpeechTimeout.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Runs configured actions when the customer does not speak before the configured timeout, with support for trigger limits and named instances. + */ class CallHookCustomerSpeechTimeout extends JsonSerializableType { /** @@ -21,7 +24,7 @@ class CallHookCustomerSpeechTimeout extends JsonSerializableType public array $do; /** - * @var ?CustomerSpeechTimeoutOptions $options This is the set of filters that must match for the hook to trigger + * @var ?CustomerSpeechTimeoutOptions $options Controls the speech timeout, maximum trigger count, and counter reset behavior for this hook. */ #[JsonProperty('options')] public ?CustomerSpeechTimeoutOptions $options; diff --git a/src/Types/CallHookFilter.php b/src/Types/CallHookFilter.php index a8ffb9f..5edb912 100644 --- a/src/Types/CallHookFilter.php +++ b/src/Types/CallHookFilter.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Matches a call field against one or more allowed values to determine whether a hook runs. + */ class CallHookFilter extends JsonSerializableType { /** diff --git a/src/Types/CallHookModelResponseTimeout.php b/src/Types/CallHookModelResponseTimeout.php index 22981c1..cf98f33 100644 --- a/src/Types/CallHookModelResponseTimeout.php +++ b/src/Types/CallHookModelResponseTimeout.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Runs configured actions when the language model does not respond before its timeout. + */ class CallHookModelResponseTimeout extends JsonSerializableType { /** diff --git a/src/Types/Campaign.php b/src/Types/Campaign.php index 0c3eb60..66c5f1b 100644 --- a/src/Types/Campaign.php +++ b/src/Types/Campaign.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved outbound calling campaign, including its calling configuration, schedule, status, customers, calls, and call-progress counters. + */ class Campaign extends JsonSerializableType { /** diff --git a/src/Types/CampaignPaginatedResponse.php b/src/Types/CampaignPaginatedResponse.php index 4a74d8c..f6d3919 100644 --- a/src/Types/CampaignPaginatedResponse.php +++ b/src/Types/CampaignPaginatedResponse.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of outbound calling campaigns and metadata describing the result set. + */ class CampaignPaginatedResponse extends JsonSerializableType { /** - * @var array $results + * @var array $results The campaigns returned for the current page. */ #[JsonProperty('results'), ArrayType([Campaign::class])] public array $results; /** - * @var PaginationMeta $metadata + * @var PaginationMeta $metadata Pagination metadata for the campaign result set. */ #[JsonProperty('metadata')] public PaginationMeta $metadata; diff --git a/src/Types/CartesiaExperimentalControls.php b/src/Types/CartesiaExperimentalControls.php index ea34767..0104697 100644 --- a/src/Types/CartesiaExperimentalControls.php +++ b/src/Types/CartesiaExperimentalControls.php @@ -6,19 +6,22 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\Union; +/** + * Cartesia voice controls for speed and emotion. + */ class CartesiaExperimentalControls extends JsonSerializableType { /** * @var ( * value-of * |float - * )|null $speed + * )|null $speed Speaking-speed control expressed as a preset or a value from -1 to 1. */ #[JsonProperty('speed'), Union('string', 'float', 'null')] public string|float|null $speed; /** - * @var ?value-of $emotion + * @var ?value-of $emotion Emotion and intensity applied to the Cartesia voice. */ #[JsonProperty('emotion')] public ?string $emotion; diff --git a/src/Types/CartesiaGenerationConfig.php b/src/Types/CartesiaGenerationConfig.php index 81809f5..22f42bc 100644 --- a/src/Types/CartesiaGenerationConfig.php +++ b/src/Types/CartesiaGenerationConfig.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Generation controls for Cartesia Sonic 3 voices, including speed, volume, and accent localization. + */ class CartesiaGenerationConfig extends JsonSerializableType { /** diff --git a/src/Types/CartesiaGenerationConfigExperimental.php b/src/Types/CartesiaGenerationConfigExperimental.php index 17d697d..f7c88cf 100644 --- a/src/Types/CartesiaGenerationConfigExperimental.php +++ b/src/Types/CartesiaGenerationConfigExperimental.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Cartesia Sonic 3 generation controls, including accent localization. + */ class CartesiaGenerationConfigExperimental extends JsonSerializableType { /** diff --git a/src/Types/CartesiaTranscriber.php b/src/Types/CartesiaTranscriber.php index 1bf5519..588bee2 100644 --- a/src/Types/CartesiaTranscriber.php +++ b/src/Types/CartesiaTranscriber.php @@ -5,16 +5,19 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for transcribing speech during assistant conversations with Cartesia, including model, language, and fallback settings. + */ class CartesiaTranscriber extends JsonSerializableType { /** - * @var ?value-of $model + * @var ?value-of $model The Cartesia speech-to-text model used for transcription. */ #[JsonProperty('model')] public ?string $model; /** - * @var ?value-of $language + * @var ?value-of $language The language code used for transcription. */ #[JsonProperty('language')] public ?string $language; diff --git a/src/Types/CartesiaVoice.php b/src/Types/CartesiaVoice.php index c5ccecb..5a3f8ff 100644 --- a/src/Types/CartesiaVoice.php +++ b/src/Types/CartesiaVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, caching, and fallback settings. + */ class CartesiaVoice extends JsonSerializableType { /** diff --git a/src/Types/CerebrasModel.php b/src/Types/CerebrasModel.php index 6ade83d..a037a43 100644 --- a/src/Types/CerebrasModel.php +++ b/src/Types/CerebrasModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Cerebras, including model, prompts, tools, knowledge-base access, and generation settings. + */ class CerebrasModel extends JsonSerializableType { /** diff --git a/src/Types/ChatEvalAssistantMessageEvaluation.php b/src/Types/ChatEvalAssistantMessageEvaluation.php index 504abe3..dd3a796 100644 --- a/src/Types/ChatEvalAssistantMessageEvaluation.php +++ b/src/Types/ChatEvalAssistantMessageEvaluation.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An expected assistant turn in an evaluation, including the judge plan and how the evaluation should continue afterward. + */ class ChatEvalAssistantMessageEvaluation extends JsonSerializableType { /** diff --git a/src/Types/ChatEvalAssistantMessageMock.php b/src/Types/ChatEvalAssistantMessageMock.php index 57bb7a8..cdcbe38 100644 --- a/src/Types/ChatEvalAssistantMessageMock.php +++ b/src/Types/ChatEvalAssistantMessageMock.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A simulated assistant turn in an evaluation conversation, with optional message content and tool calls. + */ class ChatEvalAssistantMessageMock extends JsonSerializableType { /** diff --git a/src/Types/ChatEvalAssistantMessageMockToolCall.php b/src/Types/ChatEvalAssistantMessageMockToolCall.php index c9445e8..d9c1a0e 100644 --- a/src/Types/ChatEvalAssistantMessageMockToolCall.php +++ b/src/Types/ChatEvalAssistantMessageMockToolCall.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A simulated assistant tool call with the tool name and optional arguments. + */ class ChatEvalAssistantMessageMockToolCall extends JsonSerializableType { /** diff --git a/src/Types/ChatEvalSystemMessageMock.php b/src/Types/ChatEvalSystemMessageMock.php index 52face9..182f033 100644 --- a/src/Types/ChatEvalSystemMessageMock.php +++ b/src/Types/ChatEvalSystemMessageMock.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A simulated system message in an evaluation conversation. + */ class ChatEvalSystemMessageMock extends JsonSerializableType { /** diff --git a/src/Types/ChatEvalToolResponseMessageEvaluation.php b/src/Types/ChatEvalToolResponseMessageEvaluation.php index 9ae1df2..4221297 100644 --- a/src/Types/ChatEvalToolResponseMessageEvaluation.php +++ b/src/Types/ChatEvalToolResponseMessageEvaluation.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An expected tool-response turn evaluated by a configured LLM judge. + */ class ChatEvalToolResponseMessageEvaluation extends JsonSerializableType { /** diff --git a/src/Types/ChatEvalToolResponseMessageMock.php b/src/Types/ChatEvalToolResponseMessageMock.php index 35867a7..95d10b8 100644 --- a/src/Types/ChatEvalToolResponseMessageMock.php +++ b/src/Types/ChatEvalToolResponseMessageMock.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A simulated tool response in an evaluation conversation. + */ class ChatEvalToolResponseMessageMock extends JsonSerializableType { /** diff --git a/src/Types/ChatEvalUserMessageMock.php b/src/Types/ChatEvalUserMessageMock.php index d9a4a83..c009b26 100644 --- a/src/Types/ChatEvalUserMessageMock.php +++ b/src/Types/ChatEvalUserMessageMock.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A simulated user message in an evaluation conversation. + */ class ChatEvalUserMessageMock extends JsonSerializableType { /** diff --git a/src/Types/ChunkPlan.php b/src/Types/ChunkPlan.php index afb53b9..cef87ee 100644 --- a/src/Types/ChunkPlan.php +++ b/src/Types/ChunkPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls how model output is split into chunks before voice synthesis, including minimum length, punctuation boundaries, and formatting. + */ class ChunkPlan extends JsonSerializableType { /** diff --git a/src/Types/CloudflareR2BucketPlan.php b/src/Types/CloudflareR2BucketPlan.php index 1133eda..d2881ff 100644 --- a/src/Types/CloudflareR2BucketPlan.php +++ b/src/Types/CloudflareR2BucketPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Cloudflare R2 bucket configuration for call-artifact storage, including access keys, base URL, bucket name, and path. + */ class CloudflareR2BucketPlan extends JsonSerializableType { /** diff --git a/src/Types/CodeTool.php b/src/Types/CodeTool.php index 0b78fb5..ba57dd6 100644 --- a/src/Types/CodeTool.php +++ b/src/Types/CodeTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. + */ class CodeTool extends JsonSerializableType { /** diff --git a/src/Types/CodeToolEnvironmentVariable.php b/src/Types/CodeToolEnvironmentVariable.php index d815f6f..b2af55a 100644 --- a/src/Types/CodeToolEnvironmentVariable.php +++ b/src/Types/CodeToolEnvironmentVariable.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An environment variable supplied to code-tool execution, with support for Liquid templates in its value. + */ class CodeToolEnvironmentVariable extends JsonSerializableType { /** diff --git a/src/Types/Compliance.php b/src/Types/Compliance.php index a137992..b2a5858 100644 --- a/src/Types/Compliance.php +++ b/src/Types/Compliance.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Compliance information captured for a call, including recording consent. + */ class Compliance extends JsonSerializableType { /** diff --git a/src/Types/ComplianceOverride.php b/src/Types/ComplianceOverride.php index 57ea71e..ce78eca 100644 --- a/src/Types/ComplianceOverride.php +++ b/src/Types/ComplianceOverride.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Overrides storage behavior for an output when HIPAA compliance is enabled. + */ class ComplianceOverride extends JsonSerializableType { /** diff --git a/src/Types/CompliancePlan.php b/src/Types/CompliancePlan.php index 86131b0..dc7eb1c 100644 --- a/src/Types/CompliancePlan.php +++ b/src/Types/CompliancePlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls HIPAA and PCI requirements, transcript security filtering, and recording-consent handling for assistant calls. + */ class CompliancePlan extends JsonSerializableType { /** @@ -29,7 +32,7 @@ class CompliancePlan extends JsonSerializableType public ?SecurityFilterPlan $securityFilterPlan; /** - * @var ?CompliancePlanRecordingConsentPlan $recordingConsentPlan + * @var ?CompliancePlanRecordingConsentPlan $recordingConsentPlan Controls how recording consent is requested before the assistant joins the call. */ #[JsonProperty('recordingConsentPlan')] public ?CompliancePlanRecordingConsentPlan $recordingConsentPlan; diff --git a/src/Types/CompliancePlanRecordingConsentPlan.php b/src/Types/CompliancePlanRecordingConsentPlan.php index f741483..a5a092b 100644 --- a/src/Types/CompliancePlanRecordingConsentPlan.php +++ b/src/Types/CompliancePlanRecordingConsentPlan.php @@ -6,6 +6,9 @@ use Exception; use Vapi\Core\Json\JsonDecoder; +/** + * Controls how recording consent is requested before the assistant joins the call. + */ class CompliancePlanRecordingConsentPlan extends JsonSerializableType { /** diff --git a/src/Types/ComputerTool.php b/src/Types/ComputerTool.php index 1c80136..2e640cf 100644 --- a/src/Types/ComputerTool.php +++ b/src/Types/ComputerTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. + */ class ComputerTool extends JsonSerializableType { /** diff --git a/src/Types/Condition.php b/src/Types/Condition.php index 3bcde95..0cdd1ad 100644 --- a/src/Types/Condition.php +++ b/src/Types/Condition.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Compares a named parameter with a value using the selected comparison operator. + */ class Condition extends JsonSerializableType { /** diff --git a/src/Types/ContextEngineeringPlanAll.php b/src/Types/ContextEngineeringPlanAll.php index 8e733be..2ad42c4 100644 --- a/src/Types/ContextEngineeringPlanAll.php +++ b/src/Types/ContextEngineeringPlanAll.php @@ -4,6 +4,9 @@ use Vapi\Core\Json\JsonSerializableType; +/** + * Includes all available messages when constructing context for a handoff. + */ class ContextEngineeringPlanAll extends JsonSerializableType { /** diff --git a/src/Types/ContextEngineeringPlanLastNMessages.php b/src/Types/ContextEngineeringPlanLastNMessages.php index b87b309..6918ef2 100644 --- a/src/Types/ContextEngineeringPlanLastNMessages.php +++ b/src/Types/ContextEngineeringPlanLastNMessages.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Includes a configured number of the most recent messages when constructing context for a handoff. + */ class ContextEngineeringPlanLastNMessages extends JsonSerializableType { /** diff --git a/src/Types/ContextEngineeringPlanNone.php b/src/Types/ContextEngineeringPlanNone.php index 015d8e1..b69b124 100644 --- a/src/Types/ContextEngineeringPlanNone.php +++ b/src/Types/ContextEngineeringPlanNone.php @@ -4,6 +4,9 @@ use Vapi\Core\Json\JsonSerializableType; +/** + * Excludes prior conversation messages when constructing context for a handoff. + */ class ContextEngineeringPlanNone extends JsonSerializableType { /** diff --git a/src/Types/ContextEngineeringPlanUserAndAssistantMessages.php b/src/Types/ContextEngineeringPlanUserAndAssistantMessages.php index 133d36a..b0c13d5 100644 --- a/src/Types/ContextEngineeringPlanUserAndAssistantMessages.php +++ b/src/Types/ContextEngineeringPlanUserAndAssistantMessages.php @@ -4,6 +4,9 @@ use Vapi\Core\Json\JsonSerializableType; +/** + * Includes only user and assistant messages when constructing context for a handoff. + */ class ContextEngineeringPlanUserAndAssistantMessages extends JsonSerializableType { /** diff --git a/src/Types/ConversationNode.php b/src/Types/ConversationNode.php index 256da69..62fe2b9 100644 --- a/src/Types/ConversationNode.php +++ b/src/Types/ConversationNode.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A workflow node where the assistant conducts a conversation using optional node-specific providers, tools, prompt, and variable extraction. + */ class ConversationNode extends JsonSerializableType { /** @@ -59,7 +62,7 @@ class ConversationNode extends JsonSerializableType public ?array $toolIds; /** - * @var ?string $prompt + * @var ?string $prompt Prompt that guides the assistant while this node is active. */ #[JsonProperty('prompt')] public ?string $prompt; @@ -125,7 +128,7 @@ class ConversationNode extends JsonSerializableType public ?VariableExtractionPlan $variableExtractionPlan; /** - * @var string $name + * @var string $name Unique name used to identify this workflow node. */ #[JsonProperty('name')] public string $name; diff --git a/src/Types/CostBreakdown.php b/src/Types/CostBreakdown.php index 8c0108b..575e21a 100644 --- a/src/Types/CostBreakdown.php +++ b/src/Types/CostBreakdown.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Aggregated call costs and usage, including transport, transcription, model, voice, Vapi, analysis, token, and character totals. + */ class CostBreakdown extends JsonSerializableType { /** diff --git a/src/Types/CreateAnthropicBedrockCredentialDto.php b/src/Types/CreateAnthropicBedrockCredentialDto.php index 0001065..9c144f2 100644 --- a/src/Types/CreateAnthropicBedrockCredentialDto.php +++ b/src/Types/CreateAnthropicBedrockCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating Anthropic model requests through Amazon Bedrock, including AWS region and authentication method. + */ class CreateAnthropicBedrockCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateAnthropicCredentialDto.php b/src/Types/CreateAnthropicCredentialDto.php index 42a243b..b0c66f8 100644 --- a/src/Types/CreateAnthropicCredentialDto.php +++ b/src/Types/CreateAnthropicCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Anthropic. + */ class CreateAnthropicCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateAnyscaleCredentialDto.php b/src/Types/CreateAnyscaleCredentialDto.php index 12e880f..c27ec39 100644 --- a/src/Types/CreateAnyscaleCredentialDto.php +++ b/src/Types/CreateAnyscaleCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Anyscale. + */ class CreateAnyscaleCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateApiRequestToolDto.php b/src/Types/CreateApiRequestToolDto.php index 1d55733..6b50717 100644 --- a/src/Types/CreateApiRequestToolDto.php +++ b/src/Types/CreateApiRequestToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses. + */ class CreateApiRequestToolDto extends JsonSerializableType { /** @@ -19,7 +22,7 @@ class CreateApiRequestToolDto extends JsonSerializableType public ?array $messages; /** - * @var value-of $method + * @var value-of $method The HTTP method used for the API request. */ #[JsonProperty('method')] public string $method; diff --git a/src/Types/CreateAssemblyAiCredentialDto.php b/src/Types/CreateAssemblyAiCredentialDto.php index 9d1d1fa..5f0ac5d 100644 --- a/src/Types/CreateAssemblyAiCredentialDto.php +++ b/src/Types/CreateAssemblyAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating transcription requests with AssemblyAI. + */ class CreateAssemblyAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateAssistantDto.php b/src/Types/CreateAssistantDto.php index ca213ce..cbef952 100644 --- a/src/Types/CreateAssistantDto.php +++ b/src/Types/CreateAssistantDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\Union; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create an assistant, including its model, voice, transcriber, prompts, tools, messaging, and conversation behavior. + */ class CreateAssistantDto extends JsonSerializableType { /** @@ -38,7 +41,7 @@ class CreateAssistantDto extends JsonSerializableType public ?string $firstMessage; /** - * @var ?bool $firstMessageInterruptionsEnabled + * @var ?bool $firstMessageInterruptionsEnabled Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`. */ #[JsonProperty('firstMessageInterruptionsEnabled')] public ?bool $firstMessageInterruptionsEnabled; @@ -188,7 +191,7 @@ class CreateAssistantDto extends JsonSerializableType public ?array $endCallPhrases; /** - * @var ?CompliancePlan $compliancePlan + * @var ?CompliancePlan $compliancePlan Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent. */ #[JsonProperty('compliancePlan')] public ?CompliancePlan $compliancePlan; @@ -291,7 +294,7 @@ class CreateAssistantDto extends JsonSerializableType public ?Server $server; /** - * @var ?KeypadInputPlan $keypadInputPlan + * @var ?KeypadInputPlan $keypadInputPlan Configuration for collecting and processing DTMF keypad input during calls. */ #[JsonProperty('keypadInputPlan')] public ?KeypadInputPlan $keypadInputPlan; diff --git a/src/Types/CreateAzureCredentialDto.php b/src/Types/CreateAzureCredentialDto.php index c7fe77d..a3eaa37 100644 --- a/src/Types/CreateAzureCredentialDto.php +++ b/src/Types/CreateAzureCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for Azure Speech or Blob Storage, including service, region, and optional storage bucket settings. + */ class CreateAzureCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateAzureOpenAiCredentialDto.php b/src/Types/CreateAzureOpenAiCredentialDto.php index ad98512..5a4a47d 100644 --- a/src/Types/CreateAzureOpenAiCredentialDto.php +++ b/src/Types/CreateAzureOpenAiCredentialDto.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Credentials for authenticating assistant model requests with Azure OpenAI, including region, endpoint, and available models. + */ class CreateAzureOpenAiCredentialDto extends JsonSerializableType { /** - * @var value-of $region + * @var value-of $region Azure region that hosts the OpenAI resource. */ #[JsonProperty('region')] public string $region; /** - * @var array> $models + * @var array> $models Azure OpenAI models available through this credential. */ #[JsonProperty('models'), ArrayType(['string'])] public array $models; @@ -33,7 +36,7 @@ class CreateAzureOpenAiCredentialDto extends JsonSerializableType public ?string $ocpApimSubscriptionKey; /** - * @var string $openAiEndpoint + * @var string $openAiEndpoint Endpoint URL for the Azure OpenAI resource. */ #[JsonProperty('openAIEndpoint')] public string $openAiEndpoint; diff --git a/src/Types/CreateBarInsightFromCallTableDto.php b/src/Types/CreateBarInsightFromCallTableDto.php index 9c48214..17f452b 100644 --- a/src/Types/CreateBarInsightFromCallTableDto.php +++ b/src/Types/CreateBarInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Configuration used to create a bar-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. + */ class CreateBarInsightFromCallTableDto extends JsonSerializableType { /** @@ -44,7 +47,7 @@ class CreateBarInsightFromCallTableDto extends JsonSerializableType public ?BarInsightMetadata $metadata; /** - * @var ?InsightTimeRangeWithStep $timeRange + * @var ?InsightTimeRangeWithStep $timeRange The time range and interval used to aggregate the bar-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRangeWithStep $timeRange; diff --git a/src/Types/CreateBashToolDto.php b/src/Types/CreateBashToolDto.php index 7771e74..e5a68ce 100644 --- a/src/Types/CreateBashToolDto.php +++ b/src/Types/CreateBashToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that executes shell commands in a configured environment. + */ class CreateBashToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateByoPhoneNumberDto.php b/src/Types/CreateByoPhoneNumberDto.php index 7fbd96e..dbb30be 100644 --- a/src/Types/CreateByoPhoneNumberDto.php +++ b/src/Types/CreateByoPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to connect a bring-your-own phone number to Vapi with a stored telephony credential and routing settings. + */ class CreateByoPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/CreateByoSipTrunkCredentialDto.php b/src/Types/CreateByoSipTrunkCredentialDto.php index 5390190..32cbcc4 100644 --- a/src/Types/CreateByoSipTrunkCredentialDto.php +++ b/src/Types/CreateByoSipTrunkCredentialDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for connecting Vapi to a bring-your-own SIP trunk or carrier, including gateways, outbound authentication, number handling, and optional session border controller routing. + */ class CreateByoSipTrunkCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCartesiaCredentialDto.php b/src/Types/CreateCartesiaCredentialDto.php index da2e570..07d36d9 100644 --- a/src/Types/CreateCartesiaCredentialDto.php +++ b/src/Types/CreateCartesiaCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating speech recognition and voice synthesis requests with Cartesia. + */ class CreateCartesiaCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCerebrasCredentialDto.php b/src/Types/CreateCerebrasCredentialDto.php index 716194a..e5bb903 100644 --- a/src/Types/CreateCerebrasCredentialDto.php +++ b/src/Types/CreateCerebrasCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Cerebras. + */ class CreateCerebrasCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCloudflareCredentialDto.php b/src/Types/CreateCloudflareCredentialDto.php index cf34e6d..ed33ec9 100644 --- a/src/Types/CreateCloudflareCredentialDto.php +++ b/src/Types/CreateCloudflareCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for storing call artifacts in Cloudflare R2, including account details, bucket configuration, and upload fallback order. + */ class CreateCloudflareCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCodeToolDto.php b/src/Types/CreateCodeToolDto.php index 40b3f68..ecadc9b 100644 --- a/src/Types/CreateCodeToolDto.php +++ b/src/Types/CreateCodeToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. + */ class CreateCodeToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateComputerToolDto.php b/src/Types/CreateComputerToolDto.php index 9697d50..bc2647a 100644 --- a/src/Types/CreateComputerToolDto.php +++ b/src/Types/CreateComputerToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that lets the model interact with a computer display through screen, pointer, and keyboard actions. + */ class CreateComputerToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCustomCredentialDto.php b/src/Types/CreateCustomCredentialDto.php index 579df1f..102b310 100644 --- a/src/Types/CreateCustomCredentialDto.php +++ b/src/Types/CreateCustomCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Reusable custom credentials for authenticating outbound requests, with optional public-key encryption for sensitive request data. + */ class CreateCustomCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCustomKnowledgeBaseDto.php b/src/Types/CreateCustomKnowledgeBaseDto.php index efa4bcd..c96d085 100644 --- a/src/Types/CreateCustomKnowledgeBaseDto.php +++ b/src/Types/CreateCustomKnowledgeBaseDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for connecting a custom knowledge-base implementation through a customer-hosted server. + */ class CreateCustomKnowledgeBaseDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCustomLlmCredentialDto.php b/src/Types/CreateCustomLlmCredentialDto.php index a41c3db..7485cac 100644 --- a/src/Types/CreateCustomLlmCredentialDto.php +++ b/src/Types/CreateCustomLlmCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating requests to a custom language model with an API key or OAuth 2.0 authentication plan. + */ class CreateCustomLlmCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateCustomerDto.php b/src/Types/CreateCustomerDto.php index cbdd702..d380c06 100644 --- a/src/Types/CreateCustomerDto.php +++ b/src/Types/CreateCustomerDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Customer details used for call delivery and assistant personalization, including phone or SIP destination, contact identifiers, extension, and assistant overrides. + */ class CreateCustomerDto extends JsonSerializableType { /** diff --git a/src/Types/CreateDeepInfraCredentialDto.php b/src/Types/CreateDeepInfraCredentialDto.php index 9b25d01..6cb17d9 100644 --- a/src/Types/CreateDeepInfraCredentialDto.php +++ b/src/Types/CreateDeepInfraCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with DeepInfra. + */ class CreateDeepInfraCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateDeepSeekCredentialDto.php b/src/Types/CreateDeepSeekCredentialDto.php index 9f4cd26..273e095 100644 --- a/src/Types/CreateDeepSeekCredentialDto.php +++ b/src/Types/CreateDeepSeekCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with DeepSeek. + */ class CreateDeepSeekCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateDeepgramCredentialDto.php b/src/Types/CreateDeepgramCredentialDto.php index c0b3e54..d44c843 100644 --- a/src/Types/CreateDeepgramCredentialDto.php +++ b/src/Types/CreateDeepgramCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating speech recognition and voice synthesis requests with Deepgram, with an optional API URL for an on-premises instance. + */ class CreateDeepgramCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateDtmfToolDto.php b/src/Types/CreateDtmfToolDto.php index 67e11a5..cd71dc4 100644 --- a/src/Types/CreateDtmfToolDto.php +++ b/src/Types/CreateDtmfToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that lets an assistant send DTMF keypad tones during a call. + */ class CreateDtmfToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateElevenLabsCredentialDto.php b/src/Types/CreateElevenLabsCredentialDto.php index 754a5bb..764ea3b 100644 --- a/src/Types/CreateElevenLabsCredentialDto.php +++ b/src/Types/CreateElevenLabsCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating speech recognition and voice synthesis requests with ElevenLabs. + */ class CreateElevenLabsCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateEmailCredentialDto.php b/src/Types/CreateEmailCredentialDto.php index 7b22666..566805d 100644 --- a/src/Types/CreateEmailCredentialDto.php +++ b/src/Types/CreateEmailCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Destination configuration for sending Vapi alerts to an email address. + */ class CreateEmailCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateEndCallToolDto.php b/src/Types/CreateEndCallToolDto.php index c869a16..131b987 100644 --- a/src/Types/CreateEndCallToolDto.php +++ b/src/Types/CreateEndCallToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that lets an assistant end the active call. + */ class CreateEndCallToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateEvalDto.php b/src/Types/CreateEvalDto.php index b61ebcc..3d47bc9 100644 --- a/src/Types/CreateEvalDto.php +++ b/src/Types/CreateEvalDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Configuration used to create a reusable eval containing a mock conversation and checkpoints for assessing assistant responses and tool calls. + */ class CreateEvalDto extends JsonSerializableType { /** diff --git a/src/Types/CreateFunctionToolDto.php b/src/Types/CreateFunctionToolDto.php index 103a6c4..fb4b560 100644 --- a/src/Types/CreateFunctionToolDto.php +++ b/src/Types/CreateFunctionToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a custom function tool that sends model-generated arguments to a server and returns the result to the assistant. + */ class CreateFunctionToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGcpCredentialDto.php b/src/Types/CreateGcpCredentialDto.php index add18ce..5bfe018 100644 --- a/src/Types/CreateGcpCredentialDto.php +++ b/src/Types/CreateGcpCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Service-account credentials for Google Cloud resources and optional call-artifact storage, including region, bucket configuration, and upload fallback order. + */ class CreateGcpCredentialDto extends JsonSerializableType { /** @@ -30,7 +33,7 @@ class CreateGcpCredentialDto extends JsonSerializableType public ?string $region; /** - * @var ?BucketPlan $bucketPlan + * @var ?BucketPlan $bucketPlan Bucket configuration used to store call artifacts in Google Cloud Storage. */ #[JsonProperty('bucketPlan')] public ?BucketPlan $bucketPlan; diff --git a/src/Types/CreateGladiaCredentialDto.php b/src/Types/CreateGladiaCredentialDto.php index 0ac748a..db46248 100644 --- a/src/Types/CreateGladiaCredentialDto.php +++ b/src/Types/CreateGladiaCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating transcription requests with Gladia. + */ class CreateGladiaCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoHighLevelCalendarAvailabilityToolDto.php b/src/Types/CreateGoHighLevelCalendarAvailabilityToolDto.php index 964d1a0..90c04b5 100644 --- a/src/Types/CreateGoHighLevelCalendarAvailabilityToolDto.php +++ b/src/Types/CreateGoHighLevelCalendarAvailabilityToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that checks calendar availability in a connected GoHighLevel account. + */ class CreateGoHighLevelCalendarAvailabilityToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoHighLevelCalendarEventCreateToolDto.php b/src/Types/CreateGoHighLevelCalendarEventCreateToolDto.php index 548f8ef..106a570 100644 --- a/src/Types/CreateGoHighLevelCalendarEventCreateToolDto.php +++ b/src/Types/CreateGoHighLevelCalendarEventCreateToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that adds calendar events to a connected GoHighLevel account. + */ class CreateGoHighLevelCalendarEventCreateToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoHighLevelContactCreateToolDto.php b/src/Types/CreateGoHighLevelContactCreateToolDto.php index d030285..59c4b1d 100644 --- a/src/Types/CreateGoHighLevelContactCreateToolDto.php +++ b/src/Types/CreateGoHighLevelContactCreateToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that adds contacts to a connected GoHighLevel account. + */ class CreateGoHighLevelContactCreateToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoHighLevelContactGetToolDto.php b/src/Types/CreateGoHighLevelContactGetToolDto.php index 0578752..f8075f1 100644 --- a/src/Types/CreateGoHighLevelContactGetToolDto.php +++ b/src/Types/CreateGoHighLevelContactGetToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that retrieves contacts from a connected GoHighLevel account. + */ class CreateGoHighLevelContactGetToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoHighLevelCredentialDto.php b/src/Types/CreateGoHighLevelCredentialDto.php index 8d72662..3043afe 100644 --- a/src/Types/CreateGoHighLevelCredentialDto.php +++ b/src/Types/CreateGoHighLevelCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating Vapi integrations with GoHighLevel. + */ class CreateGoHighLevelCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoHighLevelMcpCredentialDto.php b/src/Types/CreateGoHighLevelMcpCredentialDto.php index 6263a8e..39ce4ec 100644 --- a/src/Types/CreateGoHighLevelMcpCredentialDto.php +++ b/src/Types/CreateGoHighLevelMcpCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * OAuth 2.0 session credentials for authenticating GoHighLevel MCP requests. + */ class CreateGoHighLevelMcpCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoogleCalendarCheckAvailabilityToolDto.php b/src/Types/CreateGoogleCalendarCheckAvailabilityToolDto.php index 811c03c..77797ef 100644 --- a/src/Types/CreateGoogleCalendarCheckAvailabilityToolDto.php +++ b/src/Types/CreateGoogleCalendarCheckAvailabilityToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that checks availability in a connected Google Calendar. + */ class CreateGoogleCalendarCheckAvailabilityToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoogleCalendarCreateEventToolDto.php b/src/Types/CreateGoogleCalendarCreateEventToolDto.php index 9fe14c3..965a02d 100644 --- a/src/Types/CreateGoogleCalendarCreateEventToolDto.php +++ b/src/Types/CreateGoogleCalendarCreateEventToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that adds events to a connected Google Calendar. + */ class CreateGoogleCalendarCreateEventToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.php b/src/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.php index 67c7d45..86a8cc7 100644 --- a/src/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.php +++ b/src/Types/CreateGoogleCalendarOAuth2AuthorizationCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Stored OAuth 2.0 authorization for Google Calendar operations. + */ class CreateGoogleCalendarOAuth2AuthorizationCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.php b/src/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.php index b1e929e..53d2de3 100644 --- a/src/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.php +++ b/src/Types/CreateGoogleCalendarOAuth2ClientCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * OAuth 2.0 client credential for Google Calendar integrations. + */ class CreateGoogleCalendarOAuth2ClientCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoogleCredentialDto.php b/src/Types/CreateGoogleCredentialDto.php index a2f01f5..114cf57 100644 --- a/src/Types/CreateGoogleCredentialDto.php +++ b/src/Types/CreateGoogleCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Google AI. + */ class CreateGoogleCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.php b/src/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.php index 11eb9de..66999c6 100644 --- a/src/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.php +++ b/src/Types/CreateGoogleSheetsOAuth2AuthorizationCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Stored OAuth 2.0 authorization for Google Sheets operations. + */ class CreateGoogleSheetsOAuth2AuthorizationCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGoogleSheetsRowAppendToolDto.php b/src/Types/CreateGoogleSheetsRowAppendToolDto.php index def255c..a25bc0a 100644 --- a/src/Types/CreateGoogleSheetsRowAppendToolDto.php +++ b/src/Types/CreateGoogleSheetsRowAppendToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that appends rows to a connected Google Sheet. + */ class CreateGoogleSheetsRowAppendToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateGroqCredentialDto.php b/src/Types/CreateGroqCredentialDto.php index 0bb167e..f4f7180 100644 --- a/src/Types/CreateGroqCredentialDto.php +++ b/src/Types/CreateGroqCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Groq. + */ class CreateGroqCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateHandoffToolDto.php b/src/Types/CreateHandoffToolDto.php index fd067c3..fea9596 100644 --- a/src/Types/CreateHandoffToolDto.php +++ b/src/Types/CreateHandoffToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that hands a conversation to another assistant, squad, or dynamically selected destination. + */ class CreateHandoffToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateHumeCredentialDto.php b/src/Types/CreateHumeCredentialDto.php index c0d984c..5c1c17e 100644 --- a/src/Types/CreateHumeCredentialDto.php +++ b/src/Types/CreateHumeCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with Hume. + */ class CreateHumeCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateInflectionAiCredentialDto.php b/src/Types/CreateInflectionAiCredentialDto.php index 87a6083..dafebf7 100644 --- a/src/Types/CreateInflectionAiCredentialDto.php +++ b/src/Types/CreateInflectionAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Inflection AI. + */ class CreateInflectionAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateInworldCredentialDto.php b/src/Types/CreateInworldCredentialDto.php index dc263a1..caebbb9 100644 --- a/src/Types/CreateInworldCredentialDto.php +++ b/src/Types/CreateInworldCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with Inworld. + */ class CreateInworldCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateLangfuseCredentialDto.php b/src/Types/CreateLangfuseCredentialDto.php index 9865c9b..65226fb 100644 --- a/src/Types/CreateLangfuseCredentialDto.php +++ b/src/Types/CreateLangfuseCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for sending assistant call traces to a Langfuse project, including its public key, secret key, and host URL. + */ class CreateLangfuseCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateLineInsightFromCallTableDto.php b/src/Types/CreateLineInsightFromCallTableDto.php index af44a0b..c1c5ac9 100644 --- a/src/Types/CreateLineInsightFromCallTableDto.php +++ b/src/Types/CreateLineInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Configuration used to create a line-chart insight from call data using metric queries, formulas, grouping, and a stepped time range. + */ class CreateLineInsightFromCallTableDto extends JsonSerializableType { /** @@ -44,7 +47,7 @@ class CreateLineInsightFromCallTableDto extends JsonSerializableType public ?LineInsightMetadata $metadata; /** - * @var ?InsightTimeRangeWithStep $timeRange + * @var ?InsightTimeRangeWithStep $timeRange The time range and interval used to aggregate the line-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRangeWithStep $timeRange; diff --git a/src/Types/CreateLmntCredentialDto.php b/src/Types/CreateLmntCredentialDto.php index 09613ba..382be16 100644 --- a/src/Types/CreateLmntCredentialDto.php +++ b/src/Types/CreateLmntCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with LMNT. + */ class CreateLmntCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateMakeCredentialDto.php b/src/Types/CreateMakeCredentialDto.php index ebf2692..d490713 100644 --- a/src/Types/CreateMakeCredentialDto.php +++ b/src/Types/CreateMakeCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating Vapi integrations with Make, including team, region, and API key. + */ class CreateMakeCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateMcpToolDto.php b/src/Types/CreateMcpToolDto.php index a3146f8..c81768f 100644 --- a/src/Types/CreateMcpToolDto.php +++ b/src/Types/CreateMcpToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that connects an assistant to a Model Context Protocol server and exposes its available tools. + */ class CreateMcpToolDto extends JsonSerializableType { /** @@ -41,7 +44,7 @@ class CreateMcpToolDto extends JsonSerializableType public ?array $toolMessages; /** - * @var ?McpToolMetadata $metadata + * @var ?McpToolMetadata $metadata Connection metadata for the MCP server, including its communication protocol. */ #[JsonProperty('metadata')] public ?McpToolMetadata $metadata; diff --git a/src/Types/CreateMinimaxCredentialDto.php b/src/Types/CreateMinimaxCredentialDto.php index 8d688e6..4b6123e 100644 --- a/src/Types/CreateMinimaxCredentialDto.php +++ b/src/Types/CreateMinimaxCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model and voice synthesis requests with MiniMax, including the MiniMax group identifier. + */ class CreateMinimaxCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateMistralCredentialDto.php b/src/Types/CreateMistralCredentialDto.php index a3b2053..38921d0 100644 --- a/src/Types/CreateMistralCredentialDto.php +++ b/src/Types/CreateMistralCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Mistral. + */ class CreateMistralCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateNeuphonicCredentialDto.php b/src/Types/CreateNeuphonicCredentialDto.php index fd6fa89..422f2e5 100644 --- a/src/Types/CreateNeuphonicCredentialDto.php +++ b/src/Types/CreateNeuphonicCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with Neuphonic. + */ class CreateNeuphonicCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateOpenAiCredentialDto.php b/src/Types/CreateOpenAiCredentialDto.php index f4f1225..0424ccc 100644 --- a/src/Types/CreateOpenAiCredentialDto.php +++ b/src/Types/CreateOpenAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model, transcription, and voice synthesis requests with OpenAI. + */ class CreateOpenAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateOpenRouterCredentialDto.php b/src/Types/CreateOpenRouterCredentialDto.php index ad88d54..9e90623 100644 --- a/src/Types/CreateOpenRouterCredentialDto.php +++ b/src/Types/CreateOpenRouterCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with OpenRouter. + */ class CreateOpenRouterCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreatePerplexityAiCredentialDto.php b/src/Types/CreatePerplexityAiCredentialDto.php index e289031..c5cff60 100644 --- a/src/Types/CreatePerplexityAiCredentialDto.php +++ b/src/Types/CreatePerplexityAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Perplexity AI. + */ class CreatePerplexityAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreatePieInsightFromCallTableDto.php b/src/Types/CreatePieInsightFromCallTableDto.php index 0fd2bc0..4b4176b 100644 --- a/src/Types/CreatePieInsightFromCallTableDto.php +++ b/src/Types/CreatePieInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Configuration used to create a pie-chart insight from call data using metric queries, formulas, grouping, and a time range. + */ class CreatePieInsightFromCallTableDto extends JsonSerializableType { /** @@ -38,7 +41,7 @@ class CreatePieInsightFromCallTableDto extends JsonSerializableType public ?array $formulas; /** - * @var ?InsightTimeRange $timeRange + * @var ?InsightTimeRange $timeRange The time range used to query the pie-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRange $timeRange; diff --git a/src/Types/CreatePlayHtCredentialDto.php b/src/Types/CreatePlayHtCredentialDto.php index 5e82354..3f11aec 100644 --- a/src/Types/CreatePlayHtCredentialDto.php +++ b/src/Types/CreatePlayHtCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with PlayHT, including the PlayHT user identifier. + */ class CreatePlayHtCredentialDto extends JsonSerializableType { /** @@ -14,7 +17,7 @@ class CreatePlayHtCredentialDto extends JsonSerializableType public string $apiKey; /** - * @var string $userId + * @var string $userId PlayHT user identifier associated with the API key. */ #[JsonProperty('userId')] public string $userId; diff --git a/src/Types/CreateQueryToolDto.php b/src/Types/CreateQueryToolDto.php index e9aa8bb..ef9c96e 100644 --- a/src/Types/CreateQueryToolDto.php +++ b/src/Types/CreateQueryToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that searches configured knowledge bases and returns relevant content to the assistant. + */ class CreateQueryToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateRimeAiCredentialDto.php b/src/Types/CreateRimeAiCredentialDto.php index 8fa41ac..623ea90 100644 --- a/src/Types/CreateRimeAiCredentialDto.php +++ b/src/Types/CreateRimeAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with Rime AI. + */ class CreateRimeAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateRunpodCredentialDto.php b/src/Types/CreateRunpodCredentialDto.php index 18260ad..cbcacba 100644 --- a/src/Types/CreateRunpodCredentialDto.php +++ b/src/Types/CreateRunpodCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests through Runpod. + */ class CreateRunpodCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateS3CredentialDto.php b/src/Types/CreateS3CredentialDto.php index 5fec721..528aa1f 100644 --- a/src/Types/CreateS3CredentialDto.php +++ b/src/Types/CreateS3CredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for storing call artifacts in Amazon S3, including access keys, region, bucket, path prefix, and upload fallback order. + */ class CreateS3CredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateScorecardDto.php b/src/Types/CreateScorecardDto.php index 3b457b0..2825c8c 100644 --- a/src/Types/CreateScorecardDto.php +++ b/src/Types/CreateScorecardDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a scorecard containing evaluation metrics, scoring conditions, and optional assistant associations. + */ class CreateScorecardDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSipRequestToolDto.php b/src/Types/CreateSipRequestToolDto.php index 647758c..7f6bcfa 100644 --- a/src/Types/CreateSipRequestToolDto.php +++ b/src/Types/CreateSipRequestToolDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Configuration used to create a tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. + */ class CreateSipRequestToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSlackOAuth2AuthorizationCredentialDto.php b/src/Types/CreateSlackOAuth2AuthorizationCredentialDto.php index 7953cc6..aced386 100644 --- a/src/Types/CreateSlackOAuth2AuthorizationCredentialDto.php +++ b/src/Types/CreateSlackOAuth2AuthorizationCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Stored OAuth 2.0 authorization for Slack operations. + */ class CreateSlackOAuth2AuthorizationCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSlackSendMessageToolDto.php b/src/Types/CreateSlackSendMessageToolDto.php index 8804de6..7996e10 100644 --- a/src/Types/CreateSlackSendMessageToolDto.php +++ b/src/Types/CreateSlackSendMessageToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that lets an assistant send a message to Slack. + */ class CreateSlackSendMessageToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSlackWebhookCredentialDto.php b/src/Types/CreateSlackWebhookCredentialDto.php index c1a9473..8755136 100644 --- a/src/Types/CreateSlackWebhookCredentialDto.php +++ b/src/Types/CreateSlackWebhookCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for sending Vapi alerts through a Slack incoming webhook. + */ class CreateSlackWebhookCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSmallestAiCredentialDto.php b/src/Types/CreateSmallestAiCredentialDto.php index f9ac5c1..1d872a0 100644 --- a/src/Types/CreateSmallestAiCredentialDto.php +++ b/src/Types/CreateSmallestAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with Smallest AI. + */ class CreateSmallestAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSmsToolDto.php b/src/Types/CreateSmsToolDto.php index a871140..4dbca07 100644 --- a/src/Types/CreateSmsToolDto.php +++ b/src/Types/CreateSmsToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that lets an assistant send an SMS message during a call. + */ class CreateSmsToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSonioxCredentialDto.php b/src/Types/CreateSonioxCredentialDto.php index 056aa62..a2f2a6f 100644 --- a/src/Types/CreateSonioxCredentialDto.php +++ b/src/Types/CreateSonioxCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating transcription requests with Soniox. + */ class CreateSonioxCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSpeechmaticsCredentialDto.php b/src/Types/CreateSpeechmaticsCredentialDto.php index 5a61e5f..aaa3ac4 100644 --- a/src/Types/CreateSpeechmaticsCredentialDto.php +++ b/src/Types/CreateSpeechmaticsCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating transcription requests with Speechmatics. + */ class CreateSpeechmaticsCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSquadDto.php b/src/Types/CreateSquadDto.php index ce93781..5c7448d 100644 --- a/src/Types/CreateSquadDto.php +++ b/src/Types/CreateSquadDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a squad. Provide an ordered list of assistant members and optional overrides that control how the squad handles a conversation and transfers between assistants. + */ class CreateSquadDto extends JsonSerializableType { /** diff --git a/src/Types/CreateStructuredOutputDto.php b/src/Types/CreateStructuredOutputDto.php index 12aa961..75ecb38 100644 --- a/src/Types/CreateStructuredOutputDto.php +++ b/src/Types/CreateStructuredOutputDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a structured-output definition that extracts validated data from calls using an AI model or regular expression. + */ class CreateStructuredOutputDto extends JsonSerializableType { /** diff --git a/src/Types/CreateSupabaseCredentialDto.php b/src/Types/CreateSupabaseCredentialDto.php index 3b8c544..6ac7ad5 100644 --- a/src/Types/CreateSupabaseCredentialDto.php +++ b/src/Types/CreateSupabaseCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for storing call artifacts in Supabase's S3-compatible storage, including bucket configuration and upload fallback order. + */ class CreateSupabaseCredentialDto extends JsonSerializableType { /** @@ -14,7 +17,7 @@ class CreateSupabaseCredentialDto extends JsonSerializableType public ?float $fallbackIndex; /** - * @var ?SupabaseBucketPlan $bucketPlan + * @var ?SupabaseBucketPlan $bucketPlan Supabase S3-compatible bucket configuration used to store call artifacts. */ #[JsonProperty('bucketPlan')] public ?SupabaseBucketPlan $bucketPlan; diff --git a/src/Types/CreateTavusCredentialDto.php b/src/Types/CreateTavusCredentialDto.php index d5f442f..8146d18 100644 --- a/src/Types/CreateTavusCredentialDto.php +++ b/src/Types/CreateTavusCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with Tavus. + */ class CreateTavusCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateTelnyxPhoneNumberDto.php b/src/Types/CreateTelnyxPhoneNumberDto.php index 20c4625..e886aff 100644 --- a/src/Types/CreateTelnyxPhoneNumberDto.php +++ b/src/Types/CreateTelnyxPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to import a Telnyx phone number into Vapi with a stored credential and routing settings. + */ class CreateTelnyxPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/CreateTextEditorToolDto.php b/src/Types/CreateTextEditorToolDto.php index abe8e73..e3ab71d 100644 --- a/src/Types/CreateTextEditorToolDto.php +++ b/src/Types/CreateTextEditorToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that reads and edits text files in a configured environment. + */ class CreateTextEditorToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateTextInsightFromCallTableDto.php b/src/Types/CreateTextInsightFromCallTableDto.php index b557500..7fea118 100644 --- a/src/Types/CreateTextInsightFromCallTableDto.php +++ b/src/Types/CreateTextInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Configuration used to create a text-value insight from call data using metric queries, a formula, and a time range. + */ class CreateTextInsightFromCallTableDto extends JsonSerializableType { /** @@ -38,7 +41,7 @@ class CreateTextInsightFromCallTableDto extends JsonSerializableType public ?array $formula; /** - * @var ?InsightTimeRange $timeRange + * @var ?InsightTimeRange $timeRange The time range used to query the text-value data. */ #[JsonProperty('timeRange')] public ?InsightTimeRange $timeRange; diff --git a/src/Types/CreateTogetherAiCredentialDto.php b/src/Types/CreateTogetherAiCredentialDto.php index f9ca5b6..c5c0172 100644 --- a/src/Types/CreateTogetherAiCredentialDto.php +++ b/src/Types/CreateTogetherAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with Together AI. + */ class CreateTogetherAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateTransferCallToolDto.php b/src/Types/CreateTransferCallToolDto.php index e57b33c..336fc39 100644 --- a/src/Types/CreateTransferCallToolDto.php +++ b/src/Types/CreateTransferCallToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a tool that transfers the active call to one of its configured destinations. + */ class CreateTransferCallToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateTrieveCredentialDto.php b/src/Types/CreateTrieveCredentialDto.php index 25b769b..8e6a750 100644 --- a/src/Types/CreateTrieveCredentialDto.php +++ b/src/Types/CreateTrieveCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating knowledge-base requests with Trieve. + */ class CreateTrieveCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateTwilioCredentialDto.php b/src/Types/CreateTwilioCredentialDto.php index 16b336b..6ad395b 100644 --- a/src/Types/CreateTwilioCredentialDto.php +++ b/src/Types/CreateTwilioCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating telephony requests with Twilio using an account SID and either an auth token or API key credentials. + */ class CreateTwilioCredentialDto extends JsonSerializableType { /** @@ -26,7 +29,7 @@ class CreateTwilioCredentialDto extends JsonSerializableType public ?string $apiSecret; /** - * @var string $accountSid + * @var string $accountSid Twilio Account SID associated with the credential. */ #[JsonProperty('accountSid')] public string $accountSid; diff --git a/src/Types/CreateTwilioPhoneNumberDto.php b/src/Types/CreateTwilioPhoneNumberDto.php index 13aa1c5..8f765e0 100644 --- a/src/Types/CreateTwilioPhoneNumberDto.php +++ b/src/Types/CreateTwilioPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to import a Twilio phone number into Vapi with its account credentials and routing settings. + */ class CreateTwilioPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/CreateVapiPhoneNumberDto.php b/src/Types/CreateVapiPhoneNumberDto.php index e60c595..1983f8d 100644 --- a/src/Types/CreateVapiPhoneNumberDto.php +++ b/src/Types/CreateVapiPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to provision a Vapi-managed phone number or connect a SIP URI, with optional routing and authentication settings. + */ class CreateVapiPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/CreateVoicemailToolDto.php b/src/Types/CreateVoicemailToolDto.php index 341184e..374f1ab 100644 --- a/src/Types/CreateVoicemailToolDto.php +++ b/src/Types/CreateVoicemailToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to create a voicemail-detection tool with optional beep detection for supported calls. + */ class CreateVoicemailToolDto extends JsonSerializableType { /** diff --git a/src/Types/CreateVonageCredentialDto.php b/src/Types/CreateVonageCredentialDto.php index 0bbb341..ff3da88 100644 --- a/src/Types/CreateVonageCredentialDto.php +++ b/src/Types/CreateVonageCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating telephony requests with Vonage. + */ class CreateVonageCredentialDto extends JsonSerializableType { /** @@ -14,7 +17,7 @@ class CreateVonageCredentialDto extends JsonSerializableType public string $apiSecret; /** - * @var string $apiKey + * @var string $apiKey Vonage API key associated with the credential. */ #[JsonProperty('apiKey')] public string $apiKey; diff --git a/src/Types/CreateVonagePhoneNumberDto.php b/src/Types/CreateVonagePhoneNumberDto.php index 444db91..bf63b68 100644 --- a/src/Types/CreateVonagePhoneNumberDto.php +++ b/src/Types/CreateVonagePhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration used to import a Vonage phone number into Vapi with a stored credential and routing settings. + */ class CreateVonagePhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/CreateWellSaidCredentialDto.php b/src/Types/CreateWellSaidCredentialDto.php index 504444d..f11a192 100644 --- a/src/Types/CreateWellSaidCredentialDto.php +++ b/src/Types/CreateWellSaidCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating voice synthesis requests with WellSaid. + */ class CreateWellSaidCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CreateWorkflowDto.php b/src/Types/CreateWorkflowDto.php index f690c47..288404c 100644 --- a/src/Types/CreateWorkflowDto.php +++ b/src/Types/CreateWorkflowDto.php @@ -7,10 +7,13 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Configuration for creating a graph-based workflow, including conversation and tool nodes, directed edges, global prompts, shared providers, hooks, credentials, and call behavior. + */ class CreateWorkflowDto extends JsonSerializableType { /** - * @var array $nodes + * @var array $nodes Nodes that make up the workflow graph. Conversation nodes interact with the customer, while tool nodes invoke configured tools. */ #[JsonProperty('nodes'), ArrayType([CreateWorkflowDtoNodesItem::class])] public array $nodes; @@ -110,19 +113,19 @@ class CreateWorkflowDto extends JsonSerializableType public ?float $maxDurationSeconds; /** - * @var string $name + * @var string $name Name used to identify the workflow. */ #[JsonProperty('name')] public string $name; /** - * @var array $edges + * @var array $edges Directed connections that determine transitions between nodes. */ #[JsonProperty('edges'), ArrayType([Edge::class])] public array $edges; /** - * @var ?string $globalPrompt + * @var ?string $globalPrompt Prompt applied across the workflow's conversation nodes. */ #[JsonProperty('globalPrompt')] public ?string $globalPrompt; diff --git a/src/Types/CreateXAiCredentialDto.php b/src/Types/CreateXAiCredentialDto.php index e9378c0..8aaf754 100644 --- a/src/Types/CreateXAiCredentialDto.php +++ b/src/Types/CreateXAiCredentialDto.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials for authenticating assistant model requests with xAI. + */ class CreateXAiCredentialDto extends JsonSerializableType { /** diff --git a/src/Types/CustomEndpointingModelSmartEndpointingPlan.php b/src/Types/CustomEndpointingModelSmartEndpointingPlan.php index bde7483..943c393 100644 --- a/src/Types/CustomEndpointingModelSmartEndpointingPlan.php +++ b/src/Types/CustomEndpointingModelSmartEndpointingPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for using a custom endpointing model, including its provider identifier and server connection. + */ class CustomEndpointingModelSmartEndpointingPlan extends JsonSerializableType { /** diff --git a/src/Types/CustomLlmModel.php b/src/Types/CustomLlmModel.php index 5c3f183..201aeb0 100644 --- a/src/Types/CustomLlmModel.php +++ b/src/Types/CustomLlmModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses through a custom language model endpoint, including server URL, headers, metadata, prompts, tools, and generation settings. + */ class CustomLlmModel extends JsonSerializableType { /** diff --git a/src/Types/CustomMessage.php b/src/Types/CustomMessage.php index 22c3750..1c3d0ec 100644 --- a/src/Types/CustomMessage.php +++ b/src/Types/CustomMessage.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A message spoken by the assistant with optional language-specific content variants. + */ class CustomMessage extends JsonSerializableType { /** diff --git a/src/Types/CustomTranscriber.php b/src/Types/CustomTranscriber.php index d60e551..196b3b2 100644 --- a/src/Types/CustomTranscriber.php +++ b/src/Types/CustomTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for sending conversation audio to a custom WebSocket transcription server. + */ class CustomTranscriber extends JsonSerializableType { /** diff --git a/src/Types/CustomVoice.php b/src/Types/CustomVoice.php index 61fb7ee..2f2738e 100644 --- a/src/Types/CustomVoice.php +++ b/src/Types/CustomVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, caching, and fallback settings. + */ class CustomVoice extends JsonSerializableType { /** diff --git a/src/Types/CustomerCustomEndpointingRule.php b/src/Types/CustomerCustomEndpointingRule.php index fdda79d..e6564a8 100644 --- a/src/Types/CustomerCustomEndpointingRule.php +++ b/src/Types/CustomerCustomEndpointingRule.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A custom endpointing rule that matches the customer's current speech and applies a configured timeout. + */ class CustomerCustomEndpointingRule extends JsonSerializableType { /** diff --git a/src/Types/CustomerSpeechTimeoutOptions.php b/src/Types/CustomerSpeechTimeoutOptions.php index d6973d4..e850963 100644 --- a/src/Types/CustomerSpeechTimeoutOptions.php +++ b/src/Types/CustomerSpeechTimeoutOptions.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls how long a hook waits for customer speech, how often it can trigger, and when its trigger counter resets. + */ class CustomerSpeechTimeoutOptions extends JsonSerializableType { /** @@ -30,11 +33,7 @@ class CustomerSpeechTimeoutOptions extends JsonSerializableType public ?float $triggerMaxCount; /** - * This is whether the counter for hook trigger resets the user speaks. - * - * @default never - * - * @var ?array $triggerResetMode + * @var ?array $triggerResetMode Controls whether the hook's trigger counter resets after the customer speaks. Defaults to `never`. */ #[JsonProperty('triggerResetMode'), ArrayType(['string' => 'mixed'])] public ?array $triggerResetMode; diff --git a/src/Types/DeepInfraModel.php b/src/Types/DeepInfraModel.php index 66fb539..37c17bb 100644 --- a/src/Types/DeepInfraModel.php +++ b/src/Types/DeepInfraModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with DeepInfra, including model, prompts, tools, knowledge-base access, and generation settings. + */ class DeepInfraModel extends JsonSerializableType { /** diff --git a/src/Types/DeepSeekModel.php b/src/Types/DeepSeekModel.php index 6310458..998ad93 100644 --- a/src/Types/DeepSeekModel.php +++ b/src/Types/DeepSeekModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with DeepSeek, including model, prompts, tools, knowledge-base access, and generation settings. + */ class DeepSeekModel extends JsonSerializableType { /** diff --git a/src/Types/DeepgramTranscriber.php b/src/Types/DeepgramTranscriber.php index c9e3f43..eaffec1 100644 --- a/src/Types/DeepgramTranscriber.php +++ b/src/Types/DeepgramTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for transcribing speech during assistant conversations with Deepgram, including model, language, formatting, endpointing, vocabulary, and fallback settings. + */ class DeepgramTranscriber extends JsonSerializableType { /** diff --git a/src/Types/DeepgramVoice.php b/src/Types/DeepgramVoice.php index ad15a8d..363295a 100644 --- a/src/Types/DeepgramVoice.php +++ b/src/Types/DeepgramVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, caching, and fallback settings. + */ class DeepgramVoice extends JsonSerializableType { /** diff --git a/src/Types/DeveloperMessage.php b/src/Types/DeveloperMessage.php index 47f2fab..cb75f3e 100644 --- a/src/Types/DeveloperMessage.php +++ b/src/Types/DeveloperMessage.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A developer-authored instruction message supplied to the language model. + */ class DeveloperMessage extends JsonSerializableType { /** diff --git a/src/Types/DialPlanEntry.php b/src/Types/DialPlanEntry.php index bf8eb61..390b5eb 100644 --- a/src/Types/DialPlanEntry.php +++ b/src/Types/DialPlanEntry.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Associates a phone number with the customers to dial through that number in a batch call plan. + */ class DialPlanEntry extends JsonSerializableType { /** diff --git a/src/Types/DtmfTool.php b/src/Types/DtmfTool.php index 3cfab92..c89d81b 100644 --- a/src/Types/DtmfTool.php +++ b/src/Types/DtmfTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that lets an assistant send DTMF keypad tones during a call. + */ class DtmfTool extends JsonSerializableType { /** diff --git a/src/Types/Edge.php b/src/Types/Edge.php index 3e39595..8964bbf 100644 --- a/src/Types/Edge.php +++ b/src/Types/Edge.php @@ -6,22 +6,25 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A directed connection between two workflow nodes, with an optional AI-evaluated transition condition. + */ class Edge extends JsonSerializableType { /** - * @var ?AiEdgeCondition $condition + * @var ?AiEdgeCondition $condition Condition that must evaluate to true to follow this edge. */ #[JsonProperty('condition')] public ?AiEdgeCondition $condition; /** - * @var string $from + * @var string $from Name of the source workflow node. */ #[JsonProperty('from')] public string $from; /** - * @var string $to + * @var string $to Name of the destination workflow node. */ #[JsonProperty('to')] public string $to; diff --git a/src/Types/ElevenLabsPronunciationDictionaryLocator.php b/src/Types/ElevenLabsPronunciationDictionaryLocator.php index 581f1ae..4ef66d3 100644 --- a/src/Types/ElevenLabsPronunciationDictionaryLocator.php +++ b/src/Types/ElevenLabsPronunciationDictionaryLocator.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Identifies a specific version of an ElevenLabs pronunciation dictionary. + */ class ElevenLabsPronunciationDictionaryLocator extends JsonSerializableType { /** diff --git a/src/Types/ElevenLabsTranscriber.php b/src/Types/ElevenLabsTranscriber.php index fa15e50..14f0d94 100644 --- a/src/Types/ElevenLabsTranscriber.php +++ b/src/Types/ElevenLabsTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for transcribing speech during assistant conversations with ElevenLabs, including model, language, speech thresholds, and fallback settings. + */ class ElevenLabsTranscriber extends JsonSerializableType { /** diff --git a/src/Types/ElevenLabsVoice.php b/src/Types/ElevenLabsVoice.php index 7c76683..47220a2 100644 --- a/src/Types/ElevenLabsVoice.php +++ b/src/Types/ElevenLabsVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, caching, and fallback settings. + */ class ElevenLabsVoice extends JsonSerializableType { /** diff --git a/src/Types/EndCallTool.php b/src/Types/EndCallTool.php index 011a990..3feb6dd 100644 --- a/src/Types/EndCallTool.php +++ b/src/Types/EndCallTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that lets an assistant end the active call. + */ class EndCallTool extends JsonSerializableType { /** diff --git a/src/Types/EvalAnthropicModel.php b/src/Types/EvalAnthropicModel.php index bcd5463..c02f287 100644 --- a/src/Types/EvalAnthropicModel.php +++ b/src/Types/EvalAnthropicModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Anthropic model configuration for an LLM judge, including its messages, generation settings, and optional extended thinking. + */ class EvalAnthropicModel extends JsonSerializableType { /** diff --git a/src/Types/EvalCustomModel.php b/src/Types/EvalCustomModel.php index 4eff4e6..9b9c705 100644 --- a/src/Types/EvalCustomModel.php +++ b/src/Types/EvalCustomModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * OpenAI-compatible custom model configuration for an LLM judge, including its endpoint, headers, messages, and generation settings. + */ class EvalCustomModel extends JsonSerializableType { /** diff --git a/src/Types/EvalGoogleModel.php b/src/Types/EvalGoogleModel.php index 66f473d..d1b4ef1 100644 --- a/src/Types/EvalGoogleModel.php +++ b/src/Types/EvalGoogleModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Google model configuration for an LLM judge, including its messages and generation settings. + */ class EvalGoogleModel extends JsonSerializableType { /** diff --git a/src/Types/EvalOpenAiModel.php b/src/Types/EvalOpenAiModel.php index 49dc673..4eb7008 100644 --- a/src/Types/EvalOpenAiModel.php +++ b/src/Types/EvalOpenAiModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * OpenAI model configuration for an LLM judge, including its messages and generation settings. + */ class EvalOpenAiModel extends JsonSerializableType { /** diff --git a/src/Types/EvalPaginatedResponse.php b/src/Types/EvalPaginatedResponse.php index 368c9a0..8d9c879 100644 --- a/src/Types/EvalPaginatedResponse.php +++ b/src/Types/EvalPaginatedResponse.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of saved eval definitions and metadata describing the result set. + */ class EvalPaginatedResponse extends JsonSerializableType { /** - * @var array $results + * @var array $results The eval definitions returned for the current page. */ #[JsonProperty('results'), ArrayType([Eval_::class])] public array $results; /** - * @var PaginationMeta $metadata + * @var PaginationMeta $metadata Pagination metadata for the eval result set. */ #[JsonProperty('metadata')] public PaginationMeta $metadata; diff --git a/src/Types/EvalRun.php b/src/Types/EvalRun.php index 5268c1a..3937f48 100644 --- a/src/Types/EvalRun.php +++ b/src/Types/EvalRun.php @@ -8,6 +8,9 @@ use Vapi\Core\Types\Date; use Vapi\Core\Types\ArrayType; +/** + * A record of an eval execution, including its target, status, results, costs, completion details, and lifecycle timestamps. + */ class EvalRun extends JsonSerializableType { /** @@ -45,31 +48,31 @@ class EvalRun extends JsonSerializableType public EvalRunTarget $target; /** - * @var string $id + * @var string $id The unique identifier for the eval run. */ #[JsonProperty('id')] public string $id; /** - * @var string $orgId + * @var string $orgId The unique identifier for the organization that owns the run. */ #[JsonProperty('orgId')] public string $orgId; /** - * @var DateTime $createdAt + * @var DateTime $createdAt The ISO 8601 timestamp when the eval run was created. */ #[JsonProperty('createdAt'), Date(Date::TYPE_DATETIME)] public DateTime $createdAt; /** - * @var DateTime $startedAt + * @var DateTime $startedAt The ISO 8601 timestamp when the eval run started. */ #[JsonProperty('startedAt'), Date(Date::TYPE_DATETIME)] public DateTime $startedAt; /** - * @var DateTime $endedAt + * @var DateTime $endedAt The ISO 8601 timestamp when the eval run ended. */ #[JsonProperty('endedAt'), Date(Date::TYPE_DATETIME)] public DateTime $endedAt; diff --git a/src/Types/EvalRunPaginatedResponse.php b/src/Types/EvalRunPaginatedResponse.php index 63b2217..74b83e6 100644 --- a/src/Types/EvalRunPaginatedResponse.php +++ b/src/Types/EvalRunPaginatedResponse.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of eval runs and metadata describing the result set. + */ class EvalRunPaginatedResponse extends JsonSerializableType { /** - * @var array $results + * @var array $results The eval runs returned for the current page. */ #[JsonProperty('results'), ArrayType([EvalRun::class])] public array $results; /** - * @var PaginationMeta $metadata + * @var PaginationMeta $metadata Pagination metadata for the eval-run result set. */ #[JsonProperty('metadata')] public PaginationMeta $metadata; diff --git a/src/Types/EvalRunResult.php b/src/Types/EvalRunResult.php index f6cded4..95ba5d2 100644 --- a/src/Types/EvalRunResult.php +++ b/src/Types/EvalRunResult.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * The pass or fail result of an evaluation run, including its conversation messages and timing. + */ class EvalRunResult extends JsonSerializableType { /** diff --git a/src/Types/EvalRunTargetAssistant.php b/src/Types/EvalRunTargetAssistant.php index 1e43b60..5a64713 100644 --- a/src/Types/EvalRunTargetAssistant.php +++ b/src/Types/EvalRunTargetAssistant.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An assistant evaluation target provided as a saved assistant ID or a transient assistant, with optional assistant overrides. + */ class EvalRunTargetAssistant extends JsonSerializableType { /** diff --git a/src/Types/EvalRunTargetSquad.php b/src/Types/EvalRunTargetSquad.php index ed6ed8d..f435709 100644 --- a/src/Types/EvalRunTargetSquad.php +++ b/src/Types/EvalRunTargetSquad.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A squad evaluation target provided as a saved squad ID or a transient squad, with optional assistant overrides. + */ class EvalRunTargetSquad extends JsonSerializableType { /** diff --git a/src/Types/Eval_.php b/src/Types/Eval_.php index 91e47ad..c634370 100644 --- a/src/Types/Eval_.php +++ b/src/Types/Eval_.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved eval definition containing its mock conversation, checkpoints, descriptive metadata, type, and lifecycle information. + */ class Eval_ extends JsonSerializableType { /** @@ -31,25 +34,25 @@ class Eval_ extends JsonSerializableType public array $messages; /** - * @var string $id + * @var string $id The unique identifier for the eval. */ #[JsonProperty('id')] public string $id; /** - * @var string $orgId + * @var string $orgId The unique identifier for the organization that owns the eval. */ #[JsonProperty('orgId')] public string $orgId; /** - * @var DateTime $createdAt + * @var DateTime $createdAt The ISO 8601 timestamp when the eval was created. */ #[JsonProperty('createdAt'), Date(Date::TYPE_DATETIME)] public DateTime $createdAt; /** - * @var DateTime $updatedAt + * @var DateTime $updatedAt The ISO 8601 timestamp when the eval was last updated. */ #[JsonProperty('updatedAt'), Date(Date::TYPE_DATETIME)] public DateTime $updatedAt; diff --git a/src/Types/EventsTableBooleanCondition.php b/src/Types/EventsTableBooleanCondition.php index d6339dc..f2f560f 100644 --- a/src/Types/EventsTableBooleanCondition.php +++ b/src/Types/EventsTableBooleanCondition.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters event data by comparing a boolean field with an expected value. + */ class EventsTableBooleanCondition extends JsonSerializableType { /** diff --git a/src/Types/EventsTableNumberCondition.php b/src/Types/EventsTableNumberCondition.php index 1d7bdd3..a6a8221 100644 --- a/src/Types/EventsTableNumberCondition.php +++ b/src/Types/EventsTableNumberCondition.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters event data by comparing a numeric field with a value. + */ class EventsTableNumberCondition extends JsonSerializableType { /** diff --git a/src/Types/EventsTableStringCondition.php b/src/Types/EventsTableStringCondition.php index 37aa13c..f68120f 100644 --- a/src/Types/EventsTableStringCondition.php +++ b/src/Types/EventsTableStringCondition.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters event data by comparing or searching a string field. + */ class EventsTableStringCondition extends JsonSerializableType { /** diff --git a/src/Types/ExactReplacement.php b/src/Types/ExactReplacement.php index 894d5e4..8bfac65 100644 --- a/src/Types/ExactReplacement.php +++ b/src/Types/ExactReplacement.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Replaces an exact word or phrase before text is sent to a voice provider. + */ class ExactReplacement extends JsonSerializableType { /** diff --git a/src/Types/FallbackAssemblyAiTranscriber.php b/src/Types/FallbackAssemblyAiTranscriber.php index fd25810..311c5f3 100644 --- a/src/Types/FallbackAssemblyAiTranscriber.php +++ b/src/Types/FallbackAssemblyAiTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for transcribing speech with AssemblyAI, including language, streaming model, endpointing, and vocabulary. + */ class FallbackAssemblyAiTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackAzureSpeechTranscriber.php b/src/Types/FallbackAzureSpeechTranscriber.php index dd59da4..6c460dd 100644 --- a/src/Types/FallbackAzureSpeechTranscriber.php +++ b/src/Types/FallbackAzureSpeechTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for transcribing speech with Azure Speech, including language and segmentation. + */ class FallbackAzureSpeechTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackAzureVoice.php b/src/Types/FallbackAzureVoice.php index cd9f901..37eb3ed 100644 --- a/src/Types/FallbackAzureVoice.php +++ b/src/Types/FallbackAzureVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, and caching. + */ class FallbackAzureVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackCartesiaTranscriber.php b/src/Types/FallbackCartesiaTranscriber.php index 6df7d14..eb4b05d 100644 --- a/src/Types/FallbackCartesiaTranscriber.php +++ b/src/Types/FallbackCartesiaTranscriber.php @@ -5,16 +5,19 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for transcribing speech with Cartesia, including model and language. + */ class FallbackCartesiaTranscriber extends JsonSerializableType { /** - * @var ?value-of $model + * @var ?value-of $model The Cartesia speech-to-text model used for transcription. */ #[JsonProperty('model')] public ?string $model; /** - * @var ?value-of $language + * @var ?value-of $language The language code used for transcription. */ #[JsonProperty('language')] public ?string $language; diff --git a/src/Types/FallbackCartesiaVoice.php b/src/Types/FallbackCartesiaVoice.php index 738ffd0..e7d53eb 100644 --- a/src/Types/FallbackCartesiaVoice.php +++ b/src/Types/FallbackCartesiaVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, and caching. + */ class FallbackCartesiaVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackCustomTranscriber.php b/src/Types/FallbackCustomTranscriber.php index 239ecaa..ccbf3af 100644 --- a/src/Types/FallbackCustomTranscriber.php +++ b/src/Types/FallbackCustomTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for sending conversation audio to a custom WebSocket transcription server. + */ class FallbackCustomTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackCustomVoice.php b/src/Types/FallbackCustomVoice.php index 157b4bf..e6209d8 100644 --- a/src/Types/FallbackCustomVoice.php +++ b/src/Types/FallbackCustomVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, and caching. + */ class FallbackCustomVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackDeepgramTranscriber.php b/src/Types/FallbackDeepgramTranscriber.php index 232b80c..0ff2467 100644 --- a/src/Types/FallbackDeepgramTranscriber.php +++ b/src/Types/FallbackDeepgramTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for transcribing speech with Deepgram, including model, language, formatting, endpointing, and vocabulary. + */ class FallbackDeepgramTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackDeepgramVoice.php b/src/Types/FallbackDeepgramVoice.php index f451468..04e4ea0 100644 --- a/src/Types/FallbackDeepgramVoice.php +++ b/src/Types/FallbackDeepgramVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, and caching. + */ class FallbackDeepgramVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackElevenLabsTranscriber.php b/src/Types/FallbackElevenLabsTranscriber.php index e5fef51..7dd62d8 100644 --- a/src/Types/FallbackElevenLabsTranscriber.php +++ b/src/Types/FallbackElevenLabsTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for transcribing speech with ElevenLabs, including model, language, and speech thresholds. + */ class FallbackElevenLabsTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackElevenLabsVoice.php b/src/Types/FallbackElevenLabsVoice.php index 699de13..ac67a64 100644 --- a/src/Types/FallbackElevenLabsVoice.php +++ b/src/Types/FallbackElevenLabsVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, and caching. + */ class FallbackElevenLabsVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackGladiaTranscriber.php b/src/Types/FallbackGladiaTranscriber.php index 284e613..5319db1 100644 --- a/src/Types/FallbackGladiaTranscriber.php +++ b/src/Types/FallbackGladiaTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for transcribing speech with Gladia, including language behavior, audio processing, endpointing, vocabulary, and region. + */ class FallbackGladiaTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackGoogleTranscriber.php b/src/Types/FallbackGoogleTranscriber.php index 9c0b68f..4733723 100644 --- a/src/Types/FallbackGoogleTranscriber.php +++ b/src/Types/FallbackGoogleTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for transcribing speech with Google, including model and language. + */ class FallbackGoogleTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackHumeVoice.php b/src/Types/FallbackHumeVoice.php index 37d667c..a588e1b 100644 --- a/src/Types/FallbackHumeVoice.php +++ b/src/Types/FallbackHumeVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, and caching. + */ class FallbackHumeVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackInworldVoice.php b/src/Types/FallbackInworldVoice.php index 9e878fe..d7bc50e 100644 --- a/src/Types/FallbackInworldVoice.php +++ b/src/Types/FallbackInworldVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, and caching. + */ class FallbackInworldVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackLmntVoice.php b/src/Types/FallbackLmntVoice.php index 0894669..5494b67 100644 --- a/src/Types/FallbackLmntVoice.php +++ b/src/Types/FallbackLmntVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, and caching. + */ class FallbackLmntVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackNeuphonicVoice.php b/src/Types/FallbackNeuphonicVoice.php index b435e81..a92b666 100644 --- a/src/Types/FallbackNeuphonicVoice.php +++ b/src/Types/FallbackNeuphonicVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, and caching. + */ class FallbackNeuphonicVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackOpenAiTranscriber.php b/src/Types/FallbackOpenAiTranscriber.php index b0fab4a..bf3c6ed 100644 --- a/src/Types/FallbackOpenAiTranscriber.php +++ b/src/Types/FallbackOpenAiTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for transcribing speech with OpenAI, including model and language. + */ class FallbackOpenAiTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackOpenAiVoice.php b/src/Types/FallbackOpenAiVoice.php index b2aeddb..5a61879 100644 --- a/src/Types/FallbackOpenAiVoice.php +++ b/src/Types/FallbackOpenAiVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, and caching. + */ class FallbackOpenAiVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackPlan.php b/src/Types/FallbackPlan.php index 4bbc349..a573982 100644 --- a/src/Types/FallbackPlan.php +++ b/src/Types/FallbackPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Lists backup voice configurations that can be used if the primary voice provider fails. + */ class FallbackPlan extends JsonSerializableType { /** diff --git a/src/Types/FallbackPlayHtVoice.php b/src/Types/FallbackPlayHtVoice.php index 60f1d28..c439848 100644 --- a/src/Types/FallbackPlayHtVoice.php +++ b/src/Types/FallbackPlayHtVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, and caching. + */ class FallbackPlayHtVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackRimeAiVoice.php b/src/Types/FallbackRimeAiVoice.php index 882a1f4..aa8abb6 100644 --- a/src/Types/FallbackRimeAiVoice.php +++ b/src/Types/FallbackRimeAiVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, and caching. + */ class FallbackRimeAiVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackSesameVoice.php b/src/Types/FallbackSesameVoice.php index 01c31bb..e906aa4 100644 --- a/src/Types/FallbackSesameVoice.php +++ b/src/Types/FallbackSesameVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, and caching. + */ class FallbackSesameVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackSmallestAiVoice.php b/src/Types/FallbackSmallestAiVoice.php index ebf5d8c..bf47137 100644 --- a/src/Types/FallbackSmallestAiVoice.php +++ b/src/Types/FallbackSmallestAiVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, and caching. + */ class FallbackSmallestAiVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackSonioxTranscriber.php b/src/Types/FallbackSonioxTranscriber.php index 1c6eee1..7aef7a2 100644 --- a/src/Types/FallbackSonioxTranscriber.php +++ b/src/Types/FallbackSonioxTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for transcribing speech with Soniox, including model, language detection, endpointing, and vocabulary. + */ class FallbackSonioxTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackSpeechmaticsTranscriber.php b/src/Types/FallbackSpeechmaticsTranscriber.php index 4476465..37d3230 100644 --- a/src/Types/FallbackSpeechmaticsTranscriber.php +++ b/src/Types/FallbackSpeechmaticsTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for transcribing speech with Speechmatics, including language, region, diarization, vocabulary, endpointing, and formatting. + */ class FallbackSpeechmaticsTranscriber extends JsonSerializableType { /** @@ -15,7 +18,7 @@ class FallbackSpeechmaticsTranscriber extends JsonSerializableType public ?string $model; /** - * @var ?value-of $language + * @var ?value-of $language Language used for transcription. Set to `auto` to detect the language automatically. */ #[JsonProperty('language')] public ?string $language; @@ -61,7 +64,7 @@ class FallbackSpeechmaticsTranscriber extends JsonSerializableType public ?float $maxDelay; /** - * @var array $customVocabulary + * @var array $customVocabulary Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. */ #[JsonProperty('customVocabulary'), ArrayType([SpeechmaticsCustomVocabularyItem::class])] public array $customVocabulary; diff --git a/src/Types/FallbackTalkscriberTranscriber.php b/src/Types/FallbackTalkscriberTranscriber.php index 01b5eda..b4f969e 100644 --- a/src/Types/FallbackTalkscriberTranscriber.php +++ b/src/Types/FallbackTalkscriberTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for transcribing speech with Talkscriber, including model and language. + */ class FallbackTalkscriberTranscriber extends JsonSerializableType { /** diff --git a/src/Types/FallbackTavusVoice.php b/src/Types/FallbackTavusVoice.php index 5c0401c..043bfd7 100644 --- a/src/Types/FallbackTavusVoice.php +++ b/src/Types/FallbackTavusVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Fallback configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, and caching. + */ class FallbackTavusVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackTranscriberPlan.php b/src/Types/FallbackTranscriberPlan.php index 3514712..6c0f7b6 100644 --- a/src/Types/FallbackTranscriberPlan.php +++ b/src/Types/FallbackTranscriberPlan.php @@ -6,10 +6,13 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Lists backup transcriber configurations that can be used if the primary transcriber fails. + */ class FallbackTranscriberPlan extends JsonSerializableType { /** - * @var array $transcribers + * @var array $transcribers Transcriber configurations available when the primary transcriber fails. */ #[JsonProperty('transcribers'), ArrayType([FallbackTranscriberPlanTranscribersItem::class])] public array $transcribers; diff --git a/src/Types/FallbackVapiVoice.php b/src/Types/FallbackVapiVoice.php index d2edc44..ec7b68b 100644 --- a/src/Types/FallbackVapiVoice.php +++ b/src/Types/FallbackVapiVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, and caching. + */ class FallbackVapiVoice extends JsonSerializableType { /** diff --git a/src/Types/FallbackWellSaidVoice.php b/src/Types/FallbackWellSaidVoice.php index 9b34e0c..d9cb742 100644 --- a/src/Types/FallbackWellSaidVoice.php +++ b/src/Types/FallbackWellSaidVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fallback configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, and caching. + */ class FallbackWellSaidVoice extends JsonSerializableType { /** diff --git a/src/Types/File.php b/src/Types/File.php index 4b9c183..9e3f6a0 100644 --- a/src/Types/File.php +++ b/src/Types/File.php @@ -8,16 +8,19 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * An uploaded file record, including its processing status, storage details, extracted-text location, metadata, and lifecycle timestamps. + */ class File extends JsonSerializableType { /** - * @var ?value-of $object + * @var ?value-of $object The object type. This is always `file`. */ #[JsonProperty('object')] public ?string $object; /** - * @var ?value-of $status + * @var ?value-of $status The current processing status of the uploaded file. */ #[JsonProperty('status')] public ?string $status; @@ -29,67 +32,67 @@ class File extends JsonSerializableType public ?string $name; /** - * @var ?string $originalName + * @var ?string $originalName The original name of the uploaded file. */ #[JsonProperty('originalName')] public ?string $originalName; /** - * @var ?float $bytes + * @var ?float $bytes The size of the uploaded file in bytes. */ #[JsonProperty('bytes')] public ?float $bytes; /** - * @var ?string $purpose + * @var ?string $purpose The intended use assigned to the uploaded file. */ #[JsonProperty('purpose')] public ?string $purpose; /** - * @var ?string $mimetype + * @var ?string $mimetype The MIME type of the uploaded file. */ #[JsonProperty('mimetype')] public ?string $mimetype; /** - * @var ?string $key + * @var ?string $key The object-storage key for the uploaded file. */ #[JsonProperty('key')] public ?string $key; /** - * @var ?string $path + * @var ?string $path The object-storage path for the uploaded file. */ #[JsonProperty('path')] public ?string $path; /** - * @var ?string $bucket + * @var ?string $bucket The object-storage bucket containing the uploaded file. */ #[JsonProperty('bucket')] public ?string $bucket; /** - * @var ?string $url + * @var ?string $url The URL used to access the uploaded file. */ #[JsonProperty('url')] public ?string $url; /** - * @var ?string $parsedTextUrl + * @var ?string $parsedTextUrl The URL used to access text extracted from the file. */ #[JsonProperty('parsedTextUrl')] public ?string $parsedTextUrl; /** - * @var ?float $parsedTextBytes + * @var ?float $parsedTextBytes The size of the extracted text in bytes. */ #[JsonProperty('parsedTextBytes')] public ?float $parsedTextBytes; /** - * @var ?array $metadata + * @var ?array $metadata Additional metadata associated with the uploaded file. */ #[JsonProperty('metadata'), ArrayType(['string' => 'mixed'])] public ?array $metadata; diff --git a/src/Types/FilterDateTypeColumnOnCallTable.php b/src/Types/FilterDateTypeColumnOnCallTable.php index d2b7757..c36df38 100644 --- a/src/Types/FilterDateTypeColumnOnCallTable.php +++ b/src/Types/FilterDateTypeColumnOnCallTable.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters call records by comparing a start or end timestamp with a date. + */ class FilterDateTypeColumnOnCallTable extends JsonSerializableType { /** diff --git a/src/Types/FilterNumberArrayTypeColumnOnCallTable.php b/src/Types/FilterNumberArrayTypeColumnOnCallTable.php index 810860c..131ba2d 100644 --- a/src/Types/FilterNumberArrayTypeColumnOnCallTable.php +++ b/src/Types/FilterNumberArrayTypeColumnOnCallTable.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Filters numeric call fields using a list of values or an emptiness test. + */ class FilterNumberArrayTypeColumnOnCallTable extends JsonSerializableType { /** diff --git a/src/Types/FilterNumberTypeColumnOnCallTable.php b/src/Types/FilterNumberTypeColumnOnCallTable.php index f46e93f..9db6e57 100644 --- a/src/Types/FilterNumberTypeColumnOnCallTable.php +++ b/src/Types/FilterNumberTypeColumnOnCallTable.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters call records by comparing a numeric field with a value. + */ class FilterNumberTypeColumnOnCallTable extends JsonSerializableType { /** diff --git a/src/Types/FilterStringArrayTypeColumnOnCallTable.php b/src/Types/FilterStringArrayTypeColumnOnCallTable.php index ae40e3f..ebf5d42 100644 --- a/src/Types/FilterStringArrayTypeColumnOnCallTable.php +++ b/src/Types/FilterStringArrayTypeColumnOnCallTable.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Filters string-valued call fields using a list of values or an emptiness test. + */ class FilterStringArrayTypeColumnOnCallTable extends JsonSerializableType { /** diff --git a/src/Types/FilterStringTypeColumnOnCallTable.php b/src/Types/FilterStringTypeColumnOnCallTable.php index a4a8a17..0504cc8 100644 --- a/src/Types/FilterStringTypeColumnOnCallTable.php +++ b/src/Types/FilterStringTypeColumnOnCallTable.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters call records by comparing or searching a string-valued field. + */ class FilterStringTypeColumnOnCallTable extends JsonSerializableType { /** diff --git a/src/Types/FilterStructuredOutputColumnOnCallTable.php b/src/Types/FilterStructuredOutputColumnOnCallTable.php index 557c1af..65b17b6 100644 --- a/src/Types/FilterStructuredOutputColumnOnCallTable.php +++ b/src/Types/FilterStructuredOutputColumnOnCallTable.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Filters a structured-output value stored on a call using comparison, membership, containment, or emptiness operators. + */ class FilterStructuredOutputColumnOnCallTable extends JsonSerializableType { /** diff --git a/src/Types/FormatPlan.php b/src/Types/FormatPlan.php index 88e73e9..1231c94 100644 --- a/src/Types/FormatPlan.php +++ b/src/Types/FormatPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls text normalization before voice synthesis, including built-in formatters, number handling, and custom replacements. + */ class FormatPlan extends JsonSerializableType { /** diff --git a/src/Types/FourierDenoisingPlan.php b/src/Types/FourierDenoisingPlan.php index 7ccf098..632c07e 100644 --- a/src/Types/FourierDenoisingPlan.php +++ b/src/Types/FourierDenoisingPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for Fourier denoising, including media detection, thresholds, baseline calculation, and analysis window. + */ class FourierDenoisingPlan extends JsonSerializableType { /** diff --git a/src/Types/FunctionTool.php b/src/Types/FunctionTool.php index 0be7762..88e75e1 100644 --- a/src/Types/FunctionTool.php +++ b/src/Types/FunctionTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable custom function tool that sends model-generated arguments to a configured server and returns the result to the assistant. + */ class FunctionTool extends JsonSerializableType { /** diff --git a/src/Types/GcpKey.php b/src/Types/GcpKey.php index 5e2eb9d..6030a86 100644 --- a/src/Types/GcpKey.php +++ b/src/Types/GcpKey.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Google Cloud service-account key used to authenticate access to Google Cloud resources. + */ class GcpKey extends JsonSerializableType { /** diff --git a/src/Types/GeminiMultimodalLivePrebuiltVoiceConfig.php b/src/Types/GeminiMultimodalLivePrebuiltVoiceConfig.php index 7d6214a..5a693a0 100644 --- a/src/Types/GeminiMultimodalLivePrebuiltVoiceConfig.php +++ b/src/Types/GeminiMultimodalLivePrebuiltVoiceConfig.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Selects a prebuilt voice for Gemini Multimodal Live audio output. + */ class GeminiMultimodalLivePrebuiltVoiceConfig extends JsonSerializableType { /** - * @var value-of $voiceName + * @var value-of $voiceName Prebuilt Gemini voice used for audio output. */ #[JsonProperty('voiceName')] public string $voiceName; diff --git a/src/Types/GeminiMultimodalLiveSpeechConfig.php b/src/Types/GeminiMultimodalLiveSpeechConfig.php index e7ea312..ca97620 100644 --- a/src/Types/GeminiMultimodalLiveSpeechConfig.php +++ b/src/Types/GeminiMultimodalLiveSpeechConfig.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Speech-output configuration for Gemini Multimodal Live. + */ class GeminiMultimodalLiveSpeechConfig extends JsonSerializableType { /** - * @var GeminiMultimodalLiveVoiceConfig $voiceConfig + * @var GeminiMultimodalLiveVoiceConfig $voiceConfig Voice configuration used for Gemini Multimodal Live speech output. */ #[JsonProperty('voiceConfig')] public GeminiMultimodalLiveVoiceConfig $voiceConfig; diff --git a/src/Types/GeminiMultimodalLiveVoiceConfig.php b/src/Types/GeminiMultimodalLiveVoiceConfig.php index ace1287..f95dd42 100644 --- a/src/Types/GeminiMultimodalLiveVoiceConfig.php +++ b/src/Types/GeminiMultimodalLiveVoiceConfig.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Voice selection configuration for Gemini Multimodal Live. + */ class GeminiMultimodalLiveVoiceConfig extends JsonSerializableType { /** - * @var GeminiMultimodalLivePrebuiltVoiceConfig $prebuiltVoiceConfig + * @var GeminiMultimodalLivePrebuiltVoiceConfig $prebuiltVoiceConfig Prebuilt voice used for Gemini Multimodal Live speech output. */ #[JsonProperty('prebuiltVoiceConfig')] public GeminiMultimodalLivePrebuiltVoiceConfig $prebuiltVoiceConfig; diff --git a/src/Types/GhlToolMetadata.php b/src/Types/GhlToolMetadata.php index 46e0c04..c35822b 100644 --- a/src/Types/GhlToolMetadata.php +++ b/src/Types/GhlToolMetadata.php @@ -5,16 +5,19 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * GHL workflow and location identifiers attached to a tool. + */ class GhlToolMetadata extends JsonSerializableType { /** - * @var ?string $workflowId + * @var ?string $workflowId GHL workflow identifier associated with the tool. */ #[JsonProperty('workflowId')] public ?string $workflowId; /** - * @var ?string $locationId + * @var ?string $locationId GHL location identifier associated with the tool. */ #[JsonProperty('locationId')] public ?string $locationId; diff --git a/src/Types/GladiaCustomVocabularyConfigDto.php b/src/Types/GladiaCustomVocabularyConfigDto.php index e0876c8..48f4eaf 100644 --- a/src/Types/GladiaCustomVocabularyConfigDto.php +++ b/src/Types/GladiaCustomVocabularyConfigDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Custom vocabulary configuration for Gladia transcription, including vocabulary items and default recognition intensity. + */ class GladiaCustomVocabularyConfigDto extends JsonSerializableType { /** diff --git a/src/Types/GladiaTranscriber.php b/src/Types/GladiaTranscriber.php index 3dc3c06..22db1b6 100644 --- a/src/Types/GladiaTranscriber.php +++ b/src/Types/GladiaTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for transcribing speech during assistant conversations with Gladia, including language behavior, audio processing, endpointing, vocabulary, region, and fallback settings. + */ class GladiaTranscriber extends JsonSerializableType { /** diff --git a/src/Types/GladiaVocabularyItemDto.php b/src/Types/GladiaVocabularyItemDto.php index 04df1d0..2a8feb3 100644 --- a/src/Types/GladiaVocabularyItemDto.php +++ b/src/Types/GladiaVocabularyItemDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A Gladia custom vocabulary word or phrase with optional pronunciations, intensity, and language. + */ class GladiaVocabularyItemDto extends JsonSerializableType { /** diff --git a/src/Types/GlobalNodePlan.php b/src/Types/GlobalNodePlan.php index c613f02..869db06 100644 --- a/src/Types/GlobalNodePlan.php +++ b/src/Types/GlobalNodePlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls whether a conversation node can be entered globally and the condition evaluated before that node runs. + */ class GlobalNodePlan extends JsonSerializableType { /** diff --git a/src/Types/GoHighLevelCalendarAvailabilityTool.php b/src/Types/GoHighLevelCalendarAvailabilityTool.php index 9b79153..132f6ff 100644 --- a/src/Types/GoHighLevelCalendarAvailabilityTool.php +++ b/src/Types/GoHighLevelCalendarAvailabilityTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that checks calendar availability in a connected GoHighLevel account. + */ class GoHighLevelCalendarAvailabilityTool extends JsonSerializableType { /** diff --git a/src/Types/GoHighLevelCalendarEventCreateTool.php b/src/Types/GoHighLevelCalendarEventCreateTool.php index 1acc404..f346dec 100644 --- a/src/Types/GoHighLevelCalendarEventCreateTool.php +++ b/src/Types/GoHighLevelCalendarEventCreateTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that adds calendar events to a connected GoHighLevel account. + */ class GoHighLevelCalendarEventCreateTool extends JsonSerializableType { /** diff --git a/src/Types/GoHighLevelContactCreateTool.php b/src/Types/GoHighLevelContactCreateTool.php index 5d72657..10ab84c 100644 --- a/src/Types/GoHighLevelContactCreateTool.php +++ b/src/Types/GoHighLevelContactCreateTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that adds contacts to a connected GoHighLevel account. + */ class GoHighLevelContactCreateTool extends JsonSerializableType { /** diff --git a/src/Types/GoHighLevelContactGetTool.php b/src/Types/GoHighLevelContactGetTool.php index 9835805..ce8a782 100644 --- a/src/Types/GoHighLevelContactGetTool.php +++ b/src/Types/GoHighLevelContactGetTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that retrieves contacts from a connected GoHighLevel account. + */ class GoHighLevelContactGetTool extends JsonSerializableType { /** diff --git a/src/Types/GoogleCalendarCheckAvailabilityTool.php b/src/Types/GoogleCalendarCheckAvailabilityTool.php index 2413702..5d86167 100644 --- a/src/Types/GoogleCalendarCheckAvailabilityTool.php +++ b/src/Types/GoogleCalendarCheckAvailabilityTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that checks availability in a connected Google Calendar. + */ class GoogleCalendarCheckAvailabilityTool extends JsonSerializableType { /** diff --git a/src/Types/GoogleCalendarCreateEventTool.php b/src/Types/GoogleCalendarCreateEventTool.php index 369b545..9385698 100644 --- a/src/Types/GoogleCalendarCreateEventTool.php +++ b/src/Types/GoogleCalendarCreateEventTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that adds events to a connected Google Calendar. + */ class GoogleCalendarCreateEventTool extends JsonSerializableType { /** diff --git a/src/Types/GoogleModel.php b/src/Types/GoogleModel.php index d45a63a..933673b 100644 --- a/src/Types/GoogleModel.php +++ b/src/Types/GoogleModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Google, including model, prompts, tools, knowledge-base access, realtime settings, and generation settings. + */ class GoogleModel extends JsonSerializableType { /** diff --git a/src/Types/GoogleRealtimeConfig.php b/src/Types/GoogleRealtimeConfig.php index 0d83dca..015b139 100644 --- a/src/Types/GoogleRealtimeConfig.php +++ b/src/Types/GoogleRealtimeConfig.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Realtime Gemini generation and speech-output settings, including sampling, repetition penalties, and voice configuration. + */ class GoogleRealtimeConfig extends JsonSerializableType { /** diff --git a/src/Types/GoogleSheetsRowAppendTool.php b/src/Types/GoogleSheetsRowAppendTool.php index aa65dc1..b12f087 100644 --- a/src/Types/GoogleSheetsRowAppendTool.php +++ b/src/Types/GoogleSheetsRowAppendTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that appends rows to a connected Google Sheet. + */ class GoogleSheetsRowAppendTool extends JsonSerializableType { /** diff --git a/src/Types/GoogleTranscriber.php b/src/Types/GoogleTranscriber.php index 30acabb..b30a05c 100644 --- a/src/Types/GoogleTranscriber.php +++ b/src/Types/GoogleTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for transcribing speech during assistant conversations with Google, including model, language, and fallback settings. + */ class GoogleTranscriber extends JsonSerializableType { /** diff --git a/src/Types/GoogleVoicemailDetectionPlan.php b/src/Types/GoogleVoicemailDetectionPlan.php index bd720bc..dafb72a 100644 --- a/src/Types/GoogleVoicemailDetectionPlan.php +++ b/src/Types/GoogleVoicemailDetectionPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for detecting voicemail with Google, including detection type, maximum beep wait, and retry backoff. + */ class GoogleVoicemailDetectionPlan extends JsonSerializableType { /** diff --git a/src/Types/GroqModel.php b/src/Types/GroqModel.php index 3896910..9e071b6 100644 --- a/src/Types/GroqModel.php +++ b/src/Types/GroqModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Groq, including model, prompts, tools, knowledge-base access, and generation settings. + */ class GroqModel extends JsonSerializableType { /** diff --git a/src/Types/GroupCondition.php b/src/Types/GroupCondition.php index 2bab21e..c8d13f2 100644 --- a/src/Types/GroupCondition.php +++ b/src/Types/GroupCondition.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Combines nested regular-expression, Liquid, or grouped conditions with an `AND` or `OR` operator. + */ class GroupCondition extends JsonSerializableType { /** diff --git a/src/Types/HandoffDestinationAssistant.php b/src/Types/HandoffDestinationAssistant.php index 1124fa2..042f0c5 100644 --- a/src/Types/HandoffDestinationAssistant.php +++ b/src/Types/HandoffDestinationAssistant.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Routes a handoff to a saved or transient assistant, with optional context engineering, variable extraction, and assistant overrides. + */ class HandoffDestinationAssistant extends JsonSerializableType { /** - * @var value-of $type + * @var value-of $type Selects an assistant as the handoff destination. */ #[JsonProperty('type')] public string $type; diff --git a/src/Types/HandoffDestinationDynamic.php b/src/Types/HandoffDestinationDynamic.php index d049488..59f9d5f 100644 --- a/src/Types/HandoffDestinationDynamic.php +++ b/src/Types/HandoffDestinationDynamic.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Uses a webhook response to select the handoff destination at runtime. + */ class HandoffDestinationDynamic extends JsonSerializableType { /** diff --git a/src/Types/HandoffDestinationSquad.php b/src/Types/HandoffDestinationSquad.php index aec085c..01637f2 100644 --- a/src/Types/HandoffDestinationSquad.php +++ b/src/Types/HandoffDestinationSquad.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Routes a handoff to a saved or transient squad, with optional entry assistant, context engineering, variable extraction, and overrides. + */ class HandoffDestinationSquad extends JsonSerializableType { /** diff --git a/src/Types/HandoffTool.php b/src/Types/HandoffTool.php index 92e8f16..9f11bd0 100644 --- a/src/Types/HandoffTool.php +++ b/src/Types/HandoffTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that hands a conversation to another assistant, squad, or dynamically selected destination. + */ class HandoffTool extends JsonSerializableType { /** diff --git a/src/Types/HmacAuthenticationPlan.php b/src/Types/HmacAuthenticationPlan.php index 176e7ef..5ec11a5 100644 --- a/src/Types/HmacAuthenticationPlan.php +++ b/src/Types/HmacAuthenticationPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for signing outbound requests with an HMAC secret, including algorithm, headers, payload format, and signature encoding. + */ class HmacAuthenticationPlan extends JsonSerializableType { /** diff --git a/src/Types/HumeVoice.php b/src/Types/HumeVoice.php index be732bb..ebacbdc 100644 --- a/src/Types/HumeVoice.php +++ b/src/Types/HumeVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, caching, and fallback settings. + */ class HumeVoice extends JsonSerializableType { /** diff --git a/src/Types/ImportTwilioPhoneNumberDto.php b/src/Types/ImportTwilioPhoneNumberDto.php index fc86fd0..8011883 100644 --- a/src/Types/ImportTwilioPhoneNumberDto.php +++ b/src/Types/ImportTwilioPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for importing a Twilio phone number into Vapi, including Twilio credentials, routing target, fallback destination, hooks, SMS, and server settings. + */ class ImportTwilioPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/InflectionAiModel.php b/src/Types/InflectionAiModel.php index cb34714..0e687ef 100644 --- a/src/Types/InflectionAiModel.php +++ b/src/Types/InflectionAiModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Inflection AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ class InflectionAiModel extends JsonSerializableType { /** diff --git a/src/Types/Insight.php b/src/Types/Insight.php index 5189335..58417eb 100644 --- a/src/Types/Insight.php +++ b/src/Types/Insight.php @@ -7,6 +7,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved insight returned by the API, including its visualization type, identity, organization, and lifecycle timestamps. + */ class Insight extends JsonSerializableType { /** diff --git a/src/Types/InsightFormula.php b/src/Types/InsightFormula.php index 841c05b..a4a5e09 100644 --- a/src/Types/InsightFormula.php +++ b/src/Types/InsightFormula.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A formula used to calculate an insight from its query results, with an optional display name. + */ class InsightFormula extends JsonSerializableType { /** diff --git a/src/Types/InsightPaginatedResponse.php b/src/Types/InsightPaginatedResponse.php index afa4903..c20ac5c 100644 --- a/src/Types/InsightPaginatedResponse.php +++ b/src/Types/InsightPaginatedResponse.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of saved reporting insights and metadata describing the result set. + */ class InsightPaginatedResponse extends JsonSerializableType { /** - * @var array $results + * @var array $results The reporting insights returned for the current page. */ #[JsonProperty('results'), ArrayType([Insight::class])] public array $results; /** - * @var PaginationMeta $metadata + * @var PaginationMeta $metadata Pagination metadata for the insight result set. */ #[JsonProperty('metadata')] public PaginationMeta $metadata; diff --git a/src/Types/InsightRunFormatPlan.php b/src/Types/InsightRunFormatPlan.php index f69acca..488ef39 100644 --- a/src/Types/InsightRunFormatPlan.php +++ b/src/Types/InsightRunFormatPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Selects whether an insight run returns raw data or Recharts-formatted data. + */ class InsightRunFormatPlan extends JsonSerializableType { /** diff --git a/src/Types/InsightRunResponse.php b/src/Types/InsightRunResponse.php index 8c8909a..f22ee64 100644 --- a/src/Types/InsightRunResponse.php +++ b/src/Types/InsightRunResponse.php @@ -7,34 +7,37 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * Metadata identifying a saved insight run and its lifecycle timestamps. + */ class InsightRunResponse extends JsonSerializableType { /** - * @var string $id + * @var string $id The unique identifier for the insight run. */ #[JsonProperty('id')] public string $id; /** - * @var string $insightId + * @var string $insightId The unique identifier for the insight that was run. */ #[JsonProperty('insightId')] public string $insightId; /** - * @var string $orgId + * @var string $orgId The unique identifier for the organization that owns the run. */ #[JsonProperty('orgId')] public string $orgId; /** - * @var DateTime $createdAt + * @var DateTime $createdAt The ISO 8601 timestamp when the insight run was created. */ #[JsonProperty('createdAt'), Date(Date::TYPE_DATETIME)] public DateTime $createdAt; /** - * @var DateTime $updatedAt + * @var DateTime $updatedAt The ISO 8601 timestamp when the insight run was last updated. */ #[JsonProperty('updatedAt'), Date(Date::TYPE_DATETIME)] public DateTime $updatedAt; diff --git a/src/Types/InsightTimeRange.php b/src/Types/InsightTimeRange.php index 09d7637..4e6d6f6 100644 --- a/src/Types/InsightTimeRange.php +++ b/src/Types/InsightTimeRange.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Start, end, and timezone used to limit an insight query by time. + */ class InsightTimeRange extends JsonSerializableType { /** diff --git a/src/Types/InsightTimeRangeWithStep.php b/src/Types/InsightTimeRangeWithStep.php index ba3a3a5..3c202eb 100644 --- a/src/Types/InsightTimeRangeWithStep.php +++ b/src/Types/InsightTimeRangeWithStep.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Start, end, timezone, and aggregation step used for a time-series insight query. + */ class InsightTimeRangeWithStep extends JsonSerializableType { /** diff --git a/src/Types/InworldVoice.php b/src/Types/InworldVoice.php index 40a23bb..dcf68c6 100644 --- a/src/Types/InworldVoice.php +++ b/src/Types/InworldVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, caching, and fallback settings. + */ class InworldVoice extends JsonSerializableType { /** diff --git a/src/Types/JsonQueryOnCallTableWithNumberTypeColumn.php b/src/Types/JsonQueryOnCallTableWithNumberTypeColumn.php index 3b0bd9a..7e9ce8f 100644 --- a/src/Types/JsonQueryOnCallTableWithNumberTypeColumn.php +++ b/src/Types/JsonQueryOnCallTableWithNumberTypeColumn.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * VapiQL JSON query that aggregates a numeric call-table column with optional call filters. + */ class JsonQueryOnCallTableWithNumberTypeColumn extends JsonSerializableType { /** diff --git a/src/Types/JsonQueryOnCallTableWithStringTypeColumn.php b/src/Types/JsonQueryOnCallTableWithStringTypeColumn.php index eebe1ba..1fde5a4 100644 --- a/src/Types/JsonQueryOnCallTableWithStringTypeColumn.php +++ b/src/Types/JsonQueryOnCallTableWithStringTypeColumn.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * VapiQL JSON query that counts values from a string-valued call-table column with optional call filters. + */ class JsonQueryOnCallTableWithStringTypeColumn extends JsonSerializableType { /** diff --git a/src/Types/JsonQueryOnCallTableWithStructuredOutputColumn.php b/src/Types/JsonQueryOnCallTableWithStructuredOutputColumn.php index 338528b..2b29699 100644 --- a/src/Types/JsonQueryOnCallTableWithStructuredOutputColumn.php +++ b/src/Types/JsonQueryOnCallTableWithStructuredOutputColumn.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * VapiQL JSON query that aggregates or counts a structured-output value stored on call records. + */ class JsonQueryOnCallTableWithStructuredOutputColumn extends JsonSerializableType { /** diff --git a/src/Types/JsonQueryOnEventsTable.php b/src/Types/JsonQueryOnEventsTable.php index 01b666e..5eb2d5a 100644 --- a/src/Types/JsonQueryOnEventsTable.php +++ b/src/Types/JsonQueryOnEventsTable.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * VapiQL JSON query that counts or calculates the percentage of matching events using optional typed event-data filters. + */ class JsonQueryOnEventsTable extends JsonSerializableType { /** diff --git a/src/Types/JsonSchema.php b/src/Types/JsonSchema.php index bdd9b06..127e021 100644 --- a/src/Types/JsonSchema.php +++ b/src/Types/JsonSchema.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * JSON Schema definition used to describe structured data for extraction, validation, or model output. + */ class JsonSchema extends JsonSerializableType { /** diff --git a/src/Types/KeypadInputPlan.php b/src/Types/KeypadInputPlan.php index 14b0c57..87188d9 100644 --- a/src/Types/KeypadInputPlan.php +++ b/src/Types/KeypadInputPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls collection of dual-tone multi-frequency (DTMF) keypad input, including enablement, processing timeout, and delimiters. + */ class KeypadInputPlan extends JsonSerializableType { /** diff --git a/src/Types/KnowledgeBase.php b/src/Types/KnowledgeBase.php index bf56472..8508857 100644 --- a/src/Types/KnowledgeBase.php +++ b/src/Types/KnowledgeBase.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A knowledge-base configuration, including its provider, model, description, and associated files. + */ class KnowledgeBase extends JsonSerializableType { /** diff --git a/src/Types/KnowledgeBaseCost.php b/src/Types/KnowledgeBaseCost.php index c1916d7..0c98a5b 100644 --- a/src/Types/KnowledgeBaseCost.php +++ b/src/Types/KnowledgeBaseCost.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Knowledge-base model cost, including model, token usage, and amount. + */ class KnowledgeBaseCost extends JsonSerializableType { /** diff --git a/src/Types/LangfuseObservabilityPlan.php b/src/Types/LangfuseObservabilityPlan.php index 80eb525..6aa37f3 100644 --- a/src/Types/LangfuseObservabilityPlan.php +++ b/src/Types/LangfuseObservabilityPlan.php @@ -6,10 +6,13 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for sending assistant call traces to Langfuse, including prompt version linkage, trace naming, tags, and metadata. + */ class LangfuseObservabilityPlan extends JsonSerializableType { /** - * @var value-of $provider + * @var value-of $provider Routes assistant call observability data to Langfuse. */ #[JsonProperty('provider')] public string $provider; diff --git a/src/Types/LineInsight.php b/src/Types/LineInsight.php index 4ab43f3..f99be36 100644 --- a/src/Types/LineInsight.php +++ b/src/Types/LineInsight.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved line-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information. + */ class LineInsight extends JsonSerializableType { /** @@ -46,7 +49,7 @@ class LineInsight extends JsonSerializableType public ?LineInsightMetadata $metadata; /** - * @var ?InsightTimeRangeWithStep $timeRange + * @var ?InsightTimeRangeWithStep $timeRange The time range and interval used to aggregate the line-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRangeWithStep $timeRange; diff --git a/src/Types/LineInsightMetadata.php b/src/Types/LineInsightMetadata.php index bb80d0f..16705f7 100644 --- a/src/Types/LineInsightMetadata.php +++ b/src/Types/LineInsightMetadata.php @@ -5,34 +5,37 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Display settings for a line insight, including chart name, axis labels, and optional y-axis bounds. + */ class LineInsightMetadata extends JsonSerializableType { /** - * @var ?string $xAxisLabel + * @var ?string $xAxisLabel Label displayed on the chart's x-axis. */ #[JsonProperty('xAxisLabel')] public ?string $xAxisLabel; /** - * @var ?string $yAxisLabel + * @var ?string $yAxisLabel Label displayed on the chart's y-axis. */ #[JsonProperty('yAxisLabel')] public ?string $yAxisLabel; /** - * @var ?float $yAxisMin + * @var ?float $yAxisMin Minimum value displayed on the chart's y-axis. */ #[JsonProperty('yAxisMin')] public ?float $yAxisMin; /** - * @var ?float $yAxisMax + * @var ?float $yAxisMax Maximum value displayed on the chart's y-axis. */ #[JsonProperty('yAxisMax')] public ?float $yAxisMax; /** - * @var ?string $name + * @var ?string $name Display name for the insight chart. */ #[JsonProperty('name')] public ?string $name; diff --git a/src/Types/LiquidCondition.php b/src/Types/LiquidCondition.php index f1cc312..68b5836 100644 --- a/src/Types/LiquidCondition.php +++ b/src/Types/LiquidCondition.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Evaluates a Liquid template that must return `true` or `false`. + */ class LiquidCondition extends JsonSerializableType { /** diff --git a/src/Types/LivekitSmartEndpointingPlan.php b/src/Types/LivekitSmartEndpointingPlan.php index b5d1543..c55e023 100644 --- a/src/Types/LivekitSmartEndpointingPlan.php +++ b/src/Types/LivekitSmartEndpointingPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for using LiveKit smart endpointing, including provider selection and wait-function behavior. + */ class LivekitSmartEndpointingPlan extends JsonSerializableType { /** diff --git a/src/Types/LmntVoice.php b/src/Types/LmntVoice.php index df65c45..20a98ae 100644 --- a/src/Types/LmntVoice.php +++ b/src/Types/LmntVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, caching, and fallback settings. + */ class LmntVoice extends JsonSerializableType { /** diff --git a/src/Types/McpTool.php b/src/Types/McpTool.php index d1376c7..bee08e6 100644 --- a/src/Types/McpTool.php +++ b/src/Types/McpTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that connects an assistant to a Model Context Protocol server and exposes its available tools. + */ class McpTool extends JsonSerializableType { /** @@ -152,7 +155,7 @@ class McpTool extends JsonSerializableType public ?ToolRejectionPlan $rejectionPlan; /** - * @var ?McpToolMetadata $metadata + * @var ?McpToolMetadata $metadata Connection metadata for the MCP server, including its communication protocol. */ #[JsonProperty('metadata')] public ?McpToolMetadata $metadata; diff --git a/src/Types/McpToolMessages.php b/src/Types/McpToolMessages.php index 86351fe..12aeba6 100644 --- a/src/Types/McpToolMessages.php +++ b/src/Types/McpToolMessages.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Per-tool message overrides for a tool discovered through an MCP server. + */ class McpToolMessages extends JsonSerializableType { /** diff --git a/src/Types/McpToolMetadata.php b/src/Types/McpToolMetadata.php index d64842a..cc01b47 100644 --- a/src/Types/McpToolMetadata.php +++ b/src/Types/McpToolMetadata.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Protocol metadata used to communicate with an MCP server. + */ class McpToolMetadata extends JsonSerializableType { /** diff --git a/src/Types/MessageAddHookAction.php b/src/Types/MessageAddHookAction.php index fdbe10f..71edd1f 100644 --- a/src/Types/MessageAddHookAction.php +++ b/src/Types/MessageAddHookAction.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A hook action that adds an OpenAI-format message to the conversation and can trigger an assistant response. + */ class MessageAddHookAction extends JsonSerializableType { /** diff --git a/src/Types/MessageTarget.php b/src/Types/MessageTarget.php index 85c4a68..e2a32ef 100644 --- a/src/Types/MessageTarget.php +++ b/src/Types/MessageTarget.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Selects a conversation message by participant role and position for condition evaluation. + */ class MessageTarget extends JsonSerializableType { /** diff --git a/src/Types/MinimaxLlmModel.php b/src/Types/MinimaxLlmModel.php index 118aa65..889dd10 100644 --- a/src/Types/MinimaxLlmModel.php +++ b/src/Types/MinimaxLlmModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with MiniMax, including model, prompts, tools, knowledge-base access, and generation settings. + */ class MinimaxLlmModel extends JsonSerializableType { /** diff --git a/src/Types/MinimaxVoice.php b/src/Types/MinimaxVoice.php index c39c7fe..e6fd309 100644 --- a/src/Types/MinimaxVoice.php +++ b/src/Types/MinimaxVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with MiniMax, including voice and model selection, emotion, pitch, speed, volume, region, language, text normalization, chunking, caching, and fallback settings. + */ class MinimaxVoice extends JsonSerializableType { /** diff --git a/src/Types/ModelCost.php b/src/Types/ModelCost.php index 27930ba..5b3d225 100644 --- a/src/Types/ModelCost.php +++ b/src/Types/ModelCost.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Language-model cost for a call, including model, token usage, and amount. + */ class ModelCost extends JsonSerializableType { /** diff --git a/src/Types/Monitor.php b/src/Types/Monitor.php index dbe5c2e..4ab4587 100644 --- a/src/Types/Monitor.php +++ b/src/Types/Monitor.php @@ -6,10 +6,13 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Live monitoring data for a call, including attached monitor results and listening and control URLs. + */ class Monitor extends JsonSerializableType { /** - * @var ?array $monitors + * @var ?array $monitors Results produced by monitors attached to the call. */ #[JsonProperty('monitors'), ArrayType([MonitorResult::class])] public ?array $monitors; diff --git a/src/Types/MonitorPlan.php b/src/Types/MonitorPlan.php index e0e540a..3efb9f6 100644 --- a/src/Types/MonitorPlan.php +++ b/src/Types/MonitorPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls real-time listening and control for assistant calls, authentication requirements for monitor URLs, and attached monitors. + */ class MonitorPlan extends JsonSerializableType { /** @@ -59,13 +62,7 @@ class MonitorPlan extends JsonSerializableType public ?bool $controlAuthenticationEnabled; /** - * This the set of monitor ids that are attached to the assistant. - * The source of truth for the monitor ids is the assistant_monitor join table. - * This field can be used for transient assistants and to update assistants with new monitor ids. - * - * @default [] - * - * @var ?array $monitorIds + * @var ?array $monitorIds IDs of the monitors attached to the assistant. Use this field for transient assistants or to update the monitors attached to an existing assistant. Defaults to an empty array. */ #[JsonProperty('monitorIds'), ArrayType(['string'])] public ?array $monitorIds; diff --git a/src/Types/MonitorResult.php b/src/Types/MonitorResult.php index ecd7b01..55a845d 100644 --- a/src/Types/MonitorResult.php +++ b/src/Types/MonitorResult.php @@ -5,16 +5,19 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Result of evaluating an attached monitor's filter for a call. + */ class MonitorResult extends JsonSerializableType { /** - * @var string $monitorId + * @var string $monitorId Unique identifier of the monitor that produced this result. */ #[JsonProperty('monitorId')] public string $monitorId; /** - * @var bool $filterPassed + * @var bool $filterPassed Whether the monitor's filter matched the call. */ #[JsonProperty('filterPassed')] public bool $filterPassed; diff --git a/src/Types/Mono.php b/src/Types/Mono.php index b252ea9..38ffaea 100644 --- a/src/Types/Mono.php +++ b/src/Types/Mono.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Mono recording URLs for the combined call and isolated assistant and customer audio. + */ class Mono extends JsonSerializableType { /** diff --git a/src/Types/NeuphonicVoice.php b/src/Types/NeuphonicVoice.php index 44ee6c9..8683c55 100644 --- a/src/Types/NeuphonicVoice.php +++ b/src/Types/NeuphonicVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, caching, and fallback settings. + */ class NeuphonicVoice extends JsonSerializableType { /** diff --git a/src/Types/NodeArtifact.php b/src/Types/NodeArtifact.php index c26e717..5c73a84 100644 --- a/src/Types/NodeArtifact.php +++ b/src/Types/NodeArtifact.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Messages and variable values captured while a workflow node was active. + */ class NodeArtifact extends JsonSerializableType { /** diff --git a/src/Types/OAuth2AuthenticationPlan.php b/src/Types/OAuth2AuthenticationPlan.php index cc302fd..97e1fc3 100644 --- a/src/Types/OAuth2AuthenticationPlan.php +++ b/src/Types/OAuth2AuthenticationPlan.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Client-credentials configuration for obtaining an OAuth 2.0 access token used to authenticate outbound requests. + */ class OAuth2AuthenticationPlan extends JsonSerializableType { /** - * @var value-of $type + * @var value-of $type Selects OAuth 2.0 authentication. */ #[JsonProperty('type')] public string $type; diff --git a/src/Types/Oauth2AuthenticationSession.php b/src/Types/Oauth2AuthenticationSession.php index 5b24fe5..3e83a1b 100644 --- a/src/Types/Oauth2AuthenticationSession.php +++ b/src/Types/Oauth2AuthenticationSession.php @@ -7,6 +7,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * OAuth 2.0 session tokens and expiration used to authenticate integration requests. + */ class Oauth2AuthenticationSession extends JsonSerializableType { /** diff --git a/src/Types/OpenAiFunction.php b/src/Types/OpenAiFunction.php index bc37c5a..c3f7f55 100644 --- a/src/Types/OpenAiFunction.php +++ b/src/Types/OpenAiFunction.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Function definition exposed to a language model, including its name, purpose, parameter schema, and strict-schema behavior. + */ class OpenAiFunction extends JsonSerializableType { /** diff --git a/src/Types/OpenAiFunctionParameters.php b/src/Types/OpenAiFunctionParameters.php index 0d261aa..02dff29 100644 --- a/src/Types/OpenAiFunctionParameters.php +++ b/src/Types/OpenAiFunctionParameters.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * JSON object schema defining the properties accepted by a function and which properties are required. + */ class OpenAiFunctionParameters extends JsonSerializableType { /** diff --git a/src/Types/OpenAiMessage.php b/src/Types/OpenAiMessage.php index 29e851d..5e10e58 100644 --- a/src/Types/OpenAiMessage.php +++ b/src/Types/OpenAiMessage.php @@ -5,16 +5,19 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A conversation message represented in OpenAI chat format. + */ class OpenAiMessage extends JsonSerializableType { /** - * @var ?string $content + * @var ?string $content Content of the conversation message. */ #[JsonProperty('content')] public ?string $content; /** - * @var value-of $role + * @var value-of $role Role associated with the conversation message. */ #[JsonProperty('role')] public string $role; diff --git a/src/Types/OpenAiModel.php b/src/Types/OpenAiModel.php index 8668029..c64e50c 100644 --- a/src/Types/OpenAiModel.php +++ b/src/Types/OpenAiModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with OpenAI, including model selection, fallback models, prompts, tools, prompt caching, and generation settings. + */ class OpenAiModel extends JsonSerializableType { /** diff --git a/src/Types/OpenAiTranscriber.php b/src/Types/OpenAiTranscriber.php index 1a5faa2..04d2117 100644 --- a/src/Types/OpenAiTranscriber.php +++ b/src/Types/OpenAiTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for transcribing speech during assistant conversations with OpenAI, including model, language, and fallback settings. + */ class OpenAiTranscriber extends JsonSerializableType { /** diff --git a/src/Types/OpenAiVoice.php b/src/Types/OpenAiVoice.php index fc2a215..35872b1 100644 --- a/src/Types/OpenAiVoice.php +++ b/src/Types/OpenAiVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, caching, and fallback settings. + */ class OpenAiVoice extends JsonSerializableType { /** diff --git a/src/Types/OpenAiVoicemailDetectionPlan.php b/src/Types/OpenAiVoicemailDetectionPlan.php index cb83626..9d98bcb 100644 --- a/src/Types/OpenAiVoicemailDetectionPlan.php +++ b/src/Types/OpenAiVoicemailDetectionPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for detecting voicemail with OpenAI, including detection type, maximum beep wait, and retry backoff. + */ class OpenAiVoicemailDetectionPlan extends JsonSerializableType { /** diff --git a/src/Types/OpenRouterModel.php b/src/Types/OpenRouterModel.php index 373cf6f..1c552fb 100644 --- a/src/Types/OpenRouterModel.php +++ b/src/Types/OpenRouterModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses through OpenRouter, including routed model selection, prompts, tools, knowledge-base access, and generation settings. + */ class OpenRouterModel extends JsonSerializableType { /** diff --git a/src/Types/PaginationMeta.php b/src/Types/PaginationMeta.php index 114b351..d48f266 100644 --- a/src/Types/PaginationMeta.php +++ b/src/Types/PaginationMeta.php @@ -7,40 +7,43 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * Pagination and retention metadata returned with a paginated list of phone numbers. + */ class PaginationMeta extends JsonSerializableType { /** - * @var float $itemsPerPage + * @var float $itemsPerPage The number of phone numbers returned per page. */ #[JsonProperty('itemsPerPage')] public float $itemsPerPage; /** - * @var float $totalItems + * @var float $totalItems The total number of phone numbers matching the request. */ #[JsonProperty('totalItems')] public float $totalItems; /** - * @var float $currentPage + * @var float $currentPage The current page number. */ #[JsonProperty('currentPage')] public float $currentPage; /** - * @var ?bool $itemsBeyondRetention + * @var ?bool $itemsBeyondRetention Whether additional matching phone numbers exist beyond the organization's data-retention window. */ #[JsonProperty('itemsBeyondRetention')] public ?bool $itemsBeyondRetention; /** - * @var ?DateTime $createdAtLe + * @var ?DateTime $createdAtLe The inclusive upper creation-time boundary applied to the result set. */ #[JsonProperty('createdAtLe'), Date(Date::TYPE_DATETIME)] public ?DateTime $createdAtLe; /** - * @var ?DateTime $createdAtGe + * @var ?DateTime $createdAtGe The inclusive lower creation-time boundary applied to the result set. */ #[JsonProperty('createdAtGe'), Date(Date::TYPE_DATETIME)] public ?DateTime $createdAtGe; diff --git a/src/Types/PerformanceMetrics.php b/src/Types/PerformanceMetrics.php index f452f18..d884eee 100644 --- a/src/Types/PerformanceMetrics.php +++ b/src/Types/PerformanceMetrics.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Call performance measurements, including per-turn and average provider, endpointing, transport, and interruption metrics. + */ class PerformanceMetrics extends JsonSerializableType { /** diff --git a/src/Types/PerplexityAiModel.php b/src/Types/PerplexityAiModel.php index ee5e1bd..54c48d5 100644 --- a/src/Types/PerplexityAiModel.php +++ b/src/Types/PerplexityAiModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Perplexity AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ class PerplexityAiModel extends JsonSerializableType { /** diff --git a/src/Types/PhoneNumberCallEndingHookFilter.php b/src/Types/PhoneNumberCallEndingHookFilter.php index 46c068d..21a9c32 100644 --- a/src/Types/PhoneNumberCallEndingHookFilter.php +++ b/src/Types/PhoneNumberCallEndingHookFilter.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Matches the call's ended reason against configured assistant-request failure reasons before an ending hook runs. + */ class PhoneNumberCallEndingHookFilter extends JsonSerializableType { /** diff --git a/src/Types/PhoneNumberCallRingingHookFilter.php b/src/Types/PhoneNumberCallRingingHookFilter.php index e0d15e4..e0ea5f8 100644 --- a/src/Types/PhoneNumberCallRingingHookFilter.php +++ b/src/Types/PhoneNumberCallRingingHookFilter.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Matches an incoming caller's phone number against one or more prefixes before a ringing hook runs. + */ class PhoneNumberCallRingingHookFilter extends JsonSerializableType { /** diff --git a/src/Types/PhoneNumberHookCallEnding.php b/src/Types/PhoneNumberHookCallEnding.php index 54de57d..8c28d5e 100644 --- a/src/Types/PhoneNumberHookCallEnding.php +++ b/src/Types/PhoneNumberHookCallEnding.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Runs configured transfer or message actions when a call ends with a matching assistant-request failure reason. + */ class PhoneNumberHookCallEnding extends JsonSerializableType { /** diff --git a/src/Types/PhoneNumberHookCallRinging.php b/src/Types/PhoneNumberHookCallRinging.php index c8acd2b..8ca9bdb 100644 --- a/src/Types/PhoneNumberHookCallRinging.php +++ b/src/Types/PhoneNumberHookCallRinging.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Runs configured transfer or message actions when an incoming call rings and its caller-number prefix filters match. + */ class PhoneNumberHookCallRinging extends JsonSerializableType { /** diff --git a/src/Types/PhoneNumberPaginatedResponse.php b/src/Types/PhoneNumberPaginatedResponse.php index b314412..3417cf0 100644 --- a/src/Types/PhoneNumberPaginatedResponse.php +++ b/src/Types/PhoneNumberPaginatedResponse.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of phone numbers and metadata describing the result set. + */ class PhoneNumberPaginatedResponse extends JsonSerializableType { /** diff --git a/src/Types/PieInsight.php b/src/Types/PieInsight.php index 9e140d8..fbfa77b 100644 --- a/src/Types/PieInsight.php +++ b/src/Types/PieInsight.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved pie-chart insight containing its call-data queries, formulas, grouping, time range, and lifecycle information. + */ class PieInsight extends JsonSerializableType { /** @@ -40,7 +43,7 @@ class PieInsight extends JsonSerializableType public ?array $formulas; /** - * @var ?InsightTimeRange $timeRange + * @var ?InsightTimeRange $timeRange The time range used to query the pie-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRange $timeRange; diff --git a/src/Types/PlayHtVoice.php b/src/Types/PlayHtVoice.php index 5c9d454..b17e9c7 100644 --- a/src/Types/PlayHtVoice.php +++ b/src/Types/PlayHtVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, caching, and fallback settings. + */ class PlayHtVoice extends JsonSerializableType { /** diff --git a/src/Types/PromptInjectionSecurityFilter.php b/src/Types/PromptInjectionSecurityFilter.php index 57e0621..e70beaf 100644 --- a/src/Types/PromptInjectionSecurityFilter.php +++ b/src/Types/PromptInjectionSecurityFilter.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters potential prompt-injection patterns from transcripts. + */ class PromptInjectionSecurityFilter extends JsonSerializableType { /** diff --git a/src/Types/ProviderResource.php b/src/Types/ProviderResource.php index 2dd24e8..b2f52c9 100644 --- a/src/Types/ProviderResource.php +++ b/src/Types/ProviderResource.php @@ -8,6 +8,9 @@ use Vapi\Core\Types\Date; use Vapi\Core\Types\ArrayType; +/** + * A provider-managed pronunciation-dictionary resource mirrored in Vapi, including its provider identifiers, resource data, and lifecycle information. + */ class ProviderResource extends JsonSerializableType { /** diff --git a/src/Types/ProviderResourcePaginatedResponse.php b/src/Types/ProviderResourcePaginatedResponse.php index 5534856..534b093 100644 --- a/src/Types/ProviderResourcePaginatedResponse.php +++ b/src/Types/ProviderResourcePaginatedResponse.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of provider resources and metadata describing the result set. + */ class ProviderResourcePaginatedResponse extends JsonSerializableType { /** - * @var array $results + * @var array $results The provider resources returned for the current page. */ #[JsonProperty('results'), ArrayType([ProviderResource::class])] public array $results; /** - * @var PaginationMeta $metadata + * @var PaginationMeta $metadata Pagination metadata for the provider-resource result set. */ #[JsonProperty('metadata')] public PaginationMeta $metadata; diff --git a/src/Types/PublicKeyEncryptionPlan.php b/src/Types/PublicKeyEncryptionPlan.php index 79bac3a..8cb708f 100644 --- a/src/Types/PublicKeyEncryptionPlan.php +++ b/src/Types/PublicKeyEncryptionPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for encrypting sensitive outbound request data with a public key. + */ class PublicKeyEncryptionPlan extends JsonSerializableType { /** diff --git a/src/Types/QueryTool.php b/src/Types/QueryTool.php index 1c74328..482a4c8 100644 --- a/src/Types/QueryTool.php +++ b/src/Types/QueryTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that searches configured knowledge bases and returns relevant content to the assistant. + */ class QueryTool extends JsonSerializableType { /** diff --git a/src/Types/RceSecurityFilter.php b/src/Types/RceSecurityFilter.php index acb7758..f3dba37 100644 --- a/src/Types/RceSecurityFilter.php +++ b/src/Types/RceSecurityFilter.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters potential remote code execution (RCE) patterns from transcripts. + */ class RceSecurityFilter extends JsonSerializableType { /** diff --git a/src/Types/Recording.php b/src/Types/Recording.php index 90eb84d..426588c 100644 --- a/src/Types/Recording.php +++ b/src/Types/Recording.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Call recording locations, including stereo, video, and separated mono recording URLs. + */ class Recording extends JsonSerializableType { /** diff --git a/src/Types/RecordingConsent.php b/src/Types/RecordingConsent.php index a940073..54a61b9 100644 --- a/src/Types/RecordingConsent.php +++ b/src/Types/RecordingConsent.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * Result of the recording-consent flow, including consent type and the time consent was granted. + */ class RecordingConsent extends JsonSerializableType { /** diff --git a/src/Types/RecordingConsentPlanStayOnLine.php b/src/Types/RecordingConsentPlanStayOnLine.php index 2614254..3f1c1a8 100644 --- a/src/Types/RecordingConsentPlanStayOnLine.php +++ b/src/Types/RecordingConsentPlanStayOnLine.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for requesting recording consent by treating continued presence on the call as consent, including the announcement voice and wait time. + */ class RecordingConsentPlanStayOnLine extends JsonSerializableType { /** diff --git a/src/Types/RecordingConsentPlanVerbal.php b/src/Types/RecordingConsentPlanVerbal.php index 3ef1093..71bf098 100644 --- a/src/Types/RecordingConsentPlanVerbal.php +++ b/src/Types/RecordingConsentPlanVerbal.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for requesting explicit verbal recording consent, including the announcement voice and action to take when the customer declines. + */ class RecordingConsentPlanVerbal extends JsonSerializableType { /** diff --git a/src/Types/RegexCondition.php b/src/Types/RegexCondition.php index 7b15004..90f40d2 100644 --- a/src/Types/RegexCondition.php +++ b/src/Types/RegexCondition.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Evaluates whether targeted conversation-message content matches a regular expression. + */ class RegexCondition extends JsonSerializableType { /** diff --git a/src/Types/RegexOption.php b/src/Types/RegexOption.php index db80642..68559ef 100644 --- a/src/Types/RegexOption.php +++ b/src/Types/RegexOption.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Enables or disables one regular-expression matching option for a text replacement. + */ class RegexOption extends JsonSerializableType { /** diff --git a/src/Types/RegexReplacement.php b/src/Types/RegexReplacement.php index 4bb87cd..1a44f85 100644 --- a/src/Types/RegexReplacement.php +++ b/src/Types/RegexReplacement.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Replaces text matching a regular expression before it is sent to a voice provider. + */ class RegexReplacement extends JsonSerializableType { /** diff --git a/src/Types/RegexSecurityFilter.php b/src/Types/RegexSecurityFilter.php index b14cb45..5d1ded3 100644 --- a/src/Types/RegexSecurityFilter.php +++ b/src/Types/RegexSecurityFilter.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters transcript content that matches a custom regular expression. + */ class RegexSecurityFilter extends JsonSerializableType { /** diff --git a/src/Types/RimeAiVoice.php b/src/Types/RimeAiVoice.php index c0f40a8..8cd9ddb 100644 --- a/src/Types/RimeAiVoice.php +++ b/src/Types/RimeAiVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, caching, and fallback settings. + */ class RimeAiVoice extends JsonSerializableType { /** diff --git a/src/Types/SayHookAction.php b/src/Types/SayHookAction.php index 217bfec..e3ba221 100644 --- a/src/Types/SayHookAction.php +++ b/src/Types/SayHookAction.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\Union; use Vapi\Core\Types\ArrayType; +/** + * A hook action that makes the assistant speak exact text or generate a response from a prompt. + */ class SayHookAction extends JsonSerializableType { /** diff --git a/src/Types/SayPhoneNumberHookAction.php b/src/Types/SayPhoneNumberHookAction.php index 8c68d5c..4141d81 100644 --- a/src/Types/SayPhoneNumberHookAction.php +++ b/src/Types/SayPhoneNumberHookAction.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A phone-number hook action that speaks an exact message to the caller. + */ class SayPhoneNumberHookAction extends JsonSerializableType { /** diff --git a/src/Types/SbcConfiguration.php b/src/Types/SbcConfiguration.php index 41a1fd4..2d81cf0 100644 --- a/src/Types/SbcConfiguration.php +++ b/src/Types/SbcConfiguration.php @@ -4,6 +4,9 @@ use Vapi\Core\Json\JsonSerializableType; +/** + * Routes bring-your-own SIP traffic through an on-premises session border controller instead of Vapi's managed controller. + */ class SbcConfiguration extends JsonSerializableType { /** diff --git a/src/Types/SchedulePlan.php b/src/Types/SchedulePlan.php index 3ff8a25..2288b50 100644 --- a/src/Types/SchedulePlan.php +++ b/src/Types/SchedulePlan.php @@ -7,6 +7,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\Date; +/** + * Time window that controls the earliest and latest time a call may begin. + */ class SchedulePlan extends JsonSerializableType { /** diff --git a/src/Types/Scorecard.php b/src/Types/Scorecard.php index f5ad9c6..2ffe687 100644 --- a/src/Types/Scorecard.php +++ b/src/Types/Scorecard.php @@ -8,6 +8,9 @@ use Vapi\Core\Types\Date; use Vapi\Core\Types\ArrayType; +/** + * A saved scorecard containing its evaluation metrics, scoring conditions, assistant associations, descriptive metadata, and lifecycle information. + */ class Scorecard extends JsonSerializableType { /** diff --git a/src/Types/ScorecardMetric.php b/src/Types/ScorecardMetric.php index 6d7c497..bc065ca 100644 --- a/src/Types/ScorecardMetric.php +++ b/src/Types/ScorecardMetric.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A scorecard metric that awards points when a structured output meets its configured conditions. + */ class ScorecardMetric extends JsonSerializableType { /** diff --git a/src/Types/ScorecardPaginatedResponse.php b/src/Types/ScorecardPaginatedResponse.php index 12e9098..c75a9fe 100644 --- a/src/Types/ScorecardPaginatedResponse.php +++ b/src/Types/ScorecardPaginatedResponse.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of scorecards and metadata describing the result set. + */ class ScorecardPaginatedResponse extends JsonSerializableType { /** - * @var array $results + * @var array $results The scorecards returned for the current page. */ #[JsonProperty('results'), ArrayType([Scorecard::class])] public array $results; /** - * @var PaginationMeta $metadata + * @var PaginationMeta $metadata Pagination metadata for the scorecard result set. */ #[JsonProperty('metadata')] public PaginationMeta $metadata; diff --git a/src/Types/SecurityFilterBase.php b/src/Types/SecurityFilterBase.php index 0e5efcf..12adfcf 100644 --- a/src/Types/SecurityFilterBase.php +++ b/src/Types/SecurityFilterBase.php @@ -4,6 +4,9 @@ use Vapi\Core\Json\JsonSerializableType; +/** + * Base configuration for a security filter applied to transcripts before model processing. + */ class SecurityFilterBase extends JsonSerializableType { /** diff --git a/src/Types/SecurityFilterPlan.php b/src/Types/SecurityFilterPlan.php index d5c3c55..87b4ad0 100644 --- a/src/Types/SecurityFilterPlan.php +++ b/src/Types/SecurityFilterPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls filtering of transcripts for security threats before content is sent to the assistant's language model, including filter selection, handling mode, and replacement text. + */ class SecurityFilterPlan extends JsonSerializableType { /** diff --git a/src/Types/Server.php b/src/Types/Server.php index 40a3784..9ea7317 100644 --- a/src/Types/Server.php +++ b/src/Types/Server.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for requests Vapi sends to a customer server, including URL, authentication, headers, timeout, encryption, static IP addresses, and retry behavior. + */ class Server extends JsonSerializableType { /** diff --git a/src/Types/SesameVoice.php b/src/Types/SesameVoice.php index 7e85508..a6d6e5f 100644 --- a/src/Types/SesameVoice.php +++ b/src/Types/SesameVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, caching, and fallback settings. + */ class SesameVoice extends JsonSerializableType { /** diff --git a/src/Types/SipAuthentication.php b/src/Types/SipAuthentication.php index 5927121..7db7f99 100644 --- a/src/Types/SipAuthentication.php +++ b/src/Types/SipAuthentication.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Realm, username, and password used to authenticate SIP requests. + */ class SipAuthentication extends JsonSerializableType { /** diff --git a/src/Types/SipRequestTool.php b/src/Types/SipRequestTool.php index b0ddee3..a927a4c 100644 --- a/src/Types/SipRequestTool.php +++ b/src/Types/SipRequestTool.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. + */ class SipRequestTool extends JsonSerializableType { /** diff --git a/src/Types/SipTrunkGateway.php b/src/Types/SipTrunkGateway.php index c22bfe4..390ad2e 100644 --- a/src/Types/SipTrunkGateway.php +++ b/src/Types/SipTrunkGateway.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Network and routing settings for a SIP trunk gateway, including address, port, netmask, inbound and outbound use, signaling protocol, and OPTIONS health checks. + */ class SipTrunkGateway extends JsonSerializableType { /** diff --git a/src/Types/SipTrunkOutboundAuthenticationPlan.php b/src/Types/SipTrunkOutboundAuthenticationPlan.php index a3ed0f2..d8c7c56 100644 --- a/src/Types/SipTrunkOutboundAuthenticationPlan.php +++ b/src/Types/SipTrunkOutboundAuthenticationPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Credentials and optional SIP REGISTER settings used to authenticate outbound calls with a SIP trunk. + */ class SipTrunkOutboundAuthenticationPlan extends JsonSerializableType { /** @@ -14,7 +17,7 @@ class SipTrunkOutboundAuthenticationPlan extends JsonSerializableType public ?string $authPassword; /** - * @var ?string $authUsername + * @var ?string $authUsername Username used to authenticate outbound SIP requests. */ #[JsonProperty('authUsername')] public ?string $authUsername; diff --git a/src/Types/SipTrunkOutboundSipRegisterPlan.php b/src/Types/SipTrunkOutboundSipRegisterPlan.php index 87d88c9..39c93e0 100644 --- a/src/Types/SipTrunkOutboundSipRegisterPlan.php +++ b/src/Types/SipTrunkOutboundSipRegisterPlan.php @@ -5,22 +5,25 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Registration settings used when the SIP trunk requires SIP REGISTER. + */ class SipTrunkOutboundSipRegisterPlan extends JsonSerializableType { /** - * @var ?string $domain + * @var ?string $domain SIP registrar domain used for registration. */ #[JsonProperty('domain')] public ?string $domain; /** - * @var ?string $username + * @var ?string $username Username sent with the SIP REGISTER request. */ #[JsonProperty('username')] public ?string $username; /** - * @var ?string $realm + * @var ?string $realm Authentication realm used for SIP registration. */ #[JsonProperty('realm')] public ?string $realm; diff --git a/src/Types/SlackSendMessageTool.php b/src/Types/SlackSendMessageTool.php index 73d38fc..7657d9e 100644 --- a/src/Types/SlackSendMessageTool.php +++ b/src/Types/SlackSendMessageTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that lets an assistant send a message to Slack. + */ class SlackSendMessageTool extends JsonSerializableType { /** diff --git a/src/Types/SmallestAiVoice.php b/src/Types/SmallestAiVoice.php index 173baa7..c64af92 100644 --- a/src/Types/SmallestAiVoice.php +++ b/src/Types/SmallestAiVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, caching, and fallback settings. + */ class SmallestAiVoice extends JsonSerializableType { /** diff --git a/src/Types/SmartDenoisingPlan.php b/src/Types/SmartDenoisingPlan.php index 6522d27..e67eb38 100644 --- a/src/Types/SmartDenoisingPlan.php +++ b/src/Types/SmartDenoisingPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls whether Krisp smart denoising filters background speech and noise. + */ class SmartDenoisingPlan extends JsonSerializableType { /** diff --git a/src/Types/SmsTool.php b/src/Types/SmsTool.php index 2ca433b..f9aa841 100644 --- a/src/Types/SmsTool.php +++ b/src/Types/SmsTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that lets an assistant send an SMS message during a call. + */ class SmsTool extends JsonSerializableType { /** diff --git a/src/Types/SonioxTranscriber.php b/src/Types/SonioxTranscriber.php index 24a8896..e0d9969 100644 --- a/src/Types/SonioxTranscriber.php +++ b/src/Types/SonioxTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for transcribing speech during assistant conversations with Soniox, including model, language detection, endpointing, vocabulary, and fallback settings. + */ class SonioxTranscriber extends JsonSerializableType { /** diff --git a/src/Types/SpeechmaticsCustomVocabularyItem.php b/src/Types/SpeechmaticsCustomVocabularyItem.php index 3228aac..b447329 100644 --- a/src/Types/SpeechmaticsCustomVocabularyItem.php +++ b/src/Types/SpeechmaticsCustomVocabularyItem.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A word or phrase to prioritize during Speechmatics transcription, with optional phonetic alternatives. + */ class SpeechmaticsCustomVocabularyItem extends JsonSerializableType { /** diff --git a/src/Types/SpeechmaticsTranscriber.php b/src/Types/SpeechmaticsTranscriber.php index 0095b02..5daa5bf 100644 --- a/src/Types/SpeechmaticsTranscriber.php +++ b/src/Types/SpeechmaticsTranscriber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for transcribing speech during assistant conversations with Speechmatics, including language, region, diarization, vocabulary, endpointing, formatting, and fallback settings. + */ class SpeechmaticsTranscriber extends JsonSerializableType { /** @@ -15,7 +18,7 @@ class SpeechmaticsTranscriber extends JsonSerializableType public ?string $model; /** - * @var ?value-of $language + * @var ?value-of $language Language used for transcription. Set to `auto` to detect the language automatically. */ #[JsonProperty('language')] public ?string $language; @@ -61,7 +64,7 @@ class SpeechmaticsTranscriber extends JsonSerializableType public ?float $maxDelay; /** - * @var array $customVocabulary + * @var array $customVocabulary Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives. */ #[JsonProperty('customVocabulary'), ArrayType([SpeechmaticsCustomVocabularyItem::class])] public array $customVocabulary; diff --git a/src/Types/SpkiPemPublicKeyConfig.php b/src/Types/SpkiPemPublicKeyConfig.php index fefbcba..ab4eab4 100644 --- a/src/Types/SpkiPemPublicKeyConfig.php +++ b/src/Types/SpkiPemPublicKeyConfig.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * An SPKI public key in PEM format used to encrypt sensitive request data. + */ class SpkiPemPublicKeyConfig extends JsonSerializableType { /** diff --git a/src/Types/SqlInjectionSecurityFilter.php b/src/Types/SqlInjectionSecurityFilter.php index 8062695..041c3cb 100644 --- a/src/Types/SqlInjectionSecurityFilter.php +++ b/src/Types/SqlInjectionSecurityFilter.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters potential SQL injection patterns from transcripts. + */ class SqlInjectionSecurityFilter extends JsonSerializableType { /** diff --git a/src/Types/Squad.php b/src/Types/Squad.php index 63f5f29..baa415d 100644 --- a/src/Types/Squad.php +++ b/src/Types/Squad.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved squad configuration that coordinates a group of assistants during a conversation. The first member starts the call, and member destinations control transfers between assistants. + */ class Squad extends JsonSerializableType { /** diff --git a/src/Types/SquadMemberDto.php b/src/Types/SquadMemberDto.php index c0ee777..7b5a36e 100644 --- a/src/Types/SquadMemberDto.php +++ b/src/Types/SquadMemberDto.php @@ -7,13 +7,16 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * An assistant member of a squad. Reference a saved assistant or provide a transient assistant, then configure member-specific overrides and destinations for transfers. + */ class SquadMemberDto extends JsonSerializableType { /** * @var ?array<( * TransferDestinationAssistant * |HandoffDestinationAssistant - * )> $assistantDestinations + * )> $assistantDestinations Assistants this squad member can route the conversation to through a transfer or handoff. */ #[JsonProperty('assistantDestinations'), ArrayType([new Union(TransferDestinationAssistant::class, HandoffDestinationAssistant::class)])] public ?array $assistantDestinations; diff --git a/src/Types/SsrfSecurityFilter.php b/src/Types/SsrfSecurityFilter.php index 014536a..1cf4395 100644 --- a/src/Types/SsrfSecurityFilter.php +++ b/src/Types/SsrfSecurityFilter.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters potential server-side request forgery (SSRF) patterns from transcripts. + */ class SsrfSecurityFilter extends JsonSerializableType { /** diff --git a/src/Types/StartSpeakingPlan.php b/src/Types/StartSpeakingPlan.php index 2b2e454..1d4b1ba 100644 --- a/src/Types/StartSpeakingPlan.php +++ b/src/Types/StartSpeakingPlan.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\Union; use Vapi\Core\Types\ArrayType; +/** + * Controls when the assistant begins speaking after customer speech, including the minimum wait, endpointing strategy, and custom endpointing rules. + */ class StartSpeakingPlan extends JsonSerializableType { /** diff --git a/src/Types/StopSpeakingPlan.php b/src/Types/StopSpeakingPlan.php index 3ad5770..94a072e 100644 --- a/src/Types/StopSpeakingPlan.php +++ b/src/Types/StopSpeakingPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls when the assistant stops speaking after a customer interruption, including word and voice thresholds, restart delay, and phrase exceptions. + */ class StopSpeakingPlan extends JsonSerializableType { /** diff --git a/src/Types/StructuredDataMultiPlan.php b/src/Types/StructuredDataMultiPlan.php index 2133199..390c33f 100644 --- a/src/Types/StructuredDataMultiPlan.php +++ b/src/Types/StructuredDataMultiPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Associates a catalog key with a structured data extraction plan. + */ class StructuredDataMultiPlan extends JsonSerializableType { /** diff --git a/src/Types/StructuredDataPlan.php b/src/Types/StructuredDataPlan.php index 6281d07..5355a25 100644 --- a/src/Types/StructuredDataPlan.php +++ b/src/Types/StructuredDataPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls extraction of post-call structured data, including prompt messages, JSON schema, enablement, and request timeout. + */ class StructuredDataPlan extends JsonSerializableType { /** diff --git a/src/Types/StructuredOutput.php b/src/Types/StructuredOutput.php index 4487b19..99b76cc 100644 --- a/src/Types/StructuredOutput.php +++ b/src/Types/StructuredOutput.php @@ -8,6 +8,9 @@ use Vapi\Core\Types\Date; use Vapi\Core\Types\ArrayType; +/** + * A saved structured-output definition containing its extraction schema, execution method, model or regular expression, linked resources, and lifecycle metadata. + */ class StructuredOutput extends JsonSerializableType { /** diff --git a/src/Types/StructuredOutputPaginatedResponse.php b/src/Types/StructuredOutputPaginatedResponse.php index 5378c1a..0e52d5d 100644 --- a/src/Types/StructuredOutputPaginatedResponse.php +++ b/src/Types/StructuredOutputPaginatedResponse.php @@ -6,16 +6,19 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A paginated collection of structured-output definitions and metadata describing the result set. + */ class StructuredOutputPaginatedResponse extends JsonSerializableType { /** - * @var array $results + * @var array $results The structured-output definitions returned for the current page. */ #[JsonProperty('results'), ArrayType([StructuredOutput::class])] public array $results; /** - * @var PaginationMeta $metadata + * @var PaginationMeta $metadata Pagination metadata for the structured-output result set. */ #[JsonProperty('metadata')] public PaginationMeta $metadata; diff --git a/src/Types/SubscriptionLimits.php b/src/Types/SubscriptionLimits.php index 07a8509..e0fbe9d 100644 --- a/src/Types/SubscriptionLimits.php +++ b/src/Types/SubscriptionLimits.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Organization concurrency limits and remaining concurrent call capacity. + */ class SubscriptionLimits extends JsonSerializableType { /** diff --git a/src/Types/SuccessEvaluationPlan.php b/src/Types/SuccessEvaluationPlan.php index 8c700cb..f54d42f 100644 --- a/src/Types/SuccessEvaluationPlan.php +++ b/src/Types/SuccessEvaluationPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls post-call success evaluation, including the rubric, prompt messages, enablement, and request timeout. + */ class SuccessEvaluationPlan extends JsonSerializableType { /** diff --git a/src/Types/SummaryPlan.php b/src/Types/SummaryPlan.php index d7f5f8c..5b054b5 100644 --- a/src/Types/SummaryPlan.php +++ b/src/Types/SummaryPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Controls generation of a post-call summary, including prompt messages, enablement, and request timeout. + */ class SummaryPlan extends JsonSerializableType { /** diff --git a/src/Types/SupabaseBucketPlan.php b/src/Types/SupabaseBucketPlan.php index f9e4dc3..f008d85 100644 --- a/src/Types/SupabaseBucketPlan.php +++ b/src/Types/SupabaseBucketPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Supabase S3-compatible bucket configuration for call artifacts, including region, endpoint, access keys, bucket name, and path. + */ class SupabaseBucketPlan extends JsonSerializableType { /** diff --git a/src/Types/SystemMessage.php b/src/Types/SystemMessage.php index 1d975b5..2b4e597 100644 --- a/src/Types/SystemMessage.php +++ b/src/Types/SystemMessage.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A system-authored entry in the call message history, including its content and timing. + */ class SystemMessage extends JsonSerializableType { /** diff --git a/src/Types/TalkscriberTranscriber.php b/src/Types/TalkscriberTranscriber.php index 5eb191f..0ac794d 100644 --- a/src/Types/TalkscriberTranscriber.php +++ b/src/Types/TalkscriberTranscriber.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for transcribing speech during assistant conversations with Talkscriber, including model, language, and fallback settings. + */ class TalkscriberTranscriber extends JsonSerializableType { /** diff --git a/src/Types/TavusConversationProperties.php b/src/Types/TavusConversationProperties.php index 16ebb85..4561d11 100644 --- a/src/Types/TavusConversationProperties.php +++ b/src/Types/TavusConversationProperties.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Tavus conversation behavior and media settings, including duration, participant timeouts, recording, transcription, background, language, and recording storage. + */ class TavusConversationProperties extends JsonSerializableType { /** diff --git a/src/Types/TavusVoice.php b/src/Types/TavusVoice.php index 6a755c4..1f50308 100644 --- a/src/Types/TavusVoice.php +++ b/src/Types/TavusVoice.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, caching, and fallback settings. + */ class TavusVoice extends JsonSerializableType { /** diff --git a/src/Types/TelnyxPhoneNumber.php b/src/Types/TelnyxPhoneNumber.php index a5d4da6..fd2807c 100644 --- a/src/Types/TelnyxPhoneNumber.php +++ b/src/Types/TelnyxPhoneNumber.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A Telnyx phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ class TelnyxPhoneNumber extends JsonSerializableType { /** diff --git a/src/Types/TextContent.php b/src/Types/TextContent.php index 719e9b1..46d455c 100644 --- a/src/Types/TextContent.php +++ b/src/Types/TextContent.php @@ -5,22 +5,25 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Localized text content used as a language-specific message variant. + */ class TextContent extends JsonSerializableType { /** - * @var value-of $type + * @var value-of $type Selects text as the content type. */ #[JsonProperty('type')] public string $type; /** - * @var string $text + * @var string $text Text spoken or displayed for this content variant. */ #[JsonProperty('text')] public string $text; /** - * @var value-of $language + * @var value-of $language Language code associated with this text variant. */ #[JsonProperty('language')] public string $language; diff --git a/src/Types/TextEditorTool.php b/src/Types/TextEditorTool.php index 3682338..70b089d 100644 --- a/src/Types/TextEditorTool.php +++ b/src/Types/TextEditorTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that reads and edits text files in a configured environment. + */ class TextEditorTool extends JsonSerializableType { /** diff --git a/src/Types/TextInsight.php b/src/Types/TextInsight.php index 13d0659..febcc84 100644 --- a/src/Types/TextInsight.php +++ b/src/Types/TextInsight.php @@ -9,6 +9,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A saved text-value insight containing its call-data queries, formula, time range, and lifecycle information. + */ class TextInsight extends JsonSerializableType { /** @@ -40,7 +43,7 @@ class TextInsight extends JsonSerializableType public ?array $formula; /** - * @var ?InsightTimeRange $timeRange + * @var ?InsightTimeRange $timeRange The time range used to query the text-value data. */ #[JsonProperty('timeRange')] public ?InsightTimeRange $timeRange; diff --git a/src/Types/TimeRange.php b/src/Types/TimeRange.php index 81a411d..2f4981c 100644 --- a/src/Types/TimeRange.php +++ b/src/Types/TimeRange.php @@ -7,6 +7,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * Start, end, timezone, and time step used for analytics aggregation. + */ class TimeRange extends JsonSerializableType { /** diff --git a/src/Types/TogetherAiModel.php b/src/Types/TogetherAiModel.php index 9943272..d88f4c2 100644 --- a/src/Types/TogetherAiModel.php +++ b/src/Types/TogetherAiModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with Together AI, including model, prompts, tools, knowledge-base access, and generation settings. + */ class TogetherAiModel extends JsonSerializableType { /** diff --git a/src/Types/ToolCall.php b/src/Types/ToolCall.php index d7e595c..61f085e 100644 --- a/src/Types/ToolCall.php +++ b/src/Types/ToolCall.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A tool invocation requested by the assistant, including its identifier, type, and function details. + */ class ToolCall extends JsonSerializableType { /** diff --git a/src/Types/ToolCallFunction.php b/src/Types/ToolCallFunction.php index 80bdd37..4a17720 100644 --- a/src/Types/ToolCallFunction.php +++ b/src/Types/ToolCallFunction.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * The function name and serialized arguments associated with a tool call. + */ class ToolCallFunction extends JsonSerializableType { /** diff --git a/src/Types/ToolCallHookAction.php b/src/Types/ToolCallHookAction.php index a3bc5a6..b6408a0 100644 --- a/src/Types/ToolCallHookAction.php +++ b/src/Types/ToolCallHookAction.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A hook action that invokes an inline tool or an existing tool when the hook triggers. + */ class ToolCallHookAction extends JsonSerializableType { /** diff --git a/src/Types/ToolCallMessage.php b/src/Types/ToolCallMessage.php index 6a604b2..dc4ce4d 100644 --- a/src/Types/ToolCallMessage.php +++ b/src/Types/ToolCallMessage.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * An entry in the call message history that records one or more tool calls requested during the conversation. + */ class ToolCallMessage extends JsonSerializableType { /** diff --git a/src/Types/ToolCallResultMessage.php b/src/Types/ToolCallResultMessage.php index db9569f..d9fa724 100644 --- a/src/Types/ToolCallResultMessage.php +++ b/src/Types/ToolCallResultMessage.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * An entry in the call message history that records the result and metadata for a completed tool call. + */ class ToolCallResultMessage extends JsonSerializableType { /** diff --git a/src/Types/ToolMessage.php b/src/Types/ToolMessage.php index f11a08e..3880c38 100644 --- a/src/Types/ToolMessage.php +++ b/src/Types/ToolMessage.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A tool-result message associated with a specific tool call. + */ class ToolMessage extends JsonSerializableType { /** diff --git a/src/Types/ToolMessageComplete.php b/src/Types/ToolMessageComplete.php index 4bdcc68..0e63921 100644 --- a/src/Types/ToolMessageComplete.php +++ b/src/Types/ToolMessageComplete.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Message spoken when a tool call completes, with optional language variants, argument conditions, role, and end-call behavior. + */ class ToolMessageComplete extends JsonSerializableType { /** diff --git a/src/Types/ToolMessageDelayed.php b/src/Types/ToolMessageDelayed.php index 99de8fb..49dfe18 100644 --- a/src/Types/ToolMessageDelayed.php +++ b/src/Types/ToolMessageDelayed.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Message spoken when a tool call exceeds a configured response delay, with optional language variants and argument conditions. + */ class ToolMessageDelayed extends JsonSerializableType { /** diff --git a/src/Types/ToolMessageFailed.php b/src/Types/ToolMessageFailed.php index d5774e3..ce6e733 100644 --- a/src/Types/ToolMessageFailed.php +++ b/src/Types/ToolMessageFailed.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Message spoken when a tool call fails, with optional language variants, argument conditions, and end-call behavior. + */ class ToolMessageFailed extends JsonSerializableType { /** diff --git a/src/Types/ToolMessageStart.php b/src/Types/ToolMessageStart.php index 6a3385c..9633b15 100644 --- a/src/Types/ToolMessageStart.php +++ b/src/Types/ToolMessageStart.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Message spoken when a tool call starts, with optional language variants, argument conditions, and blocking behavior. + */ class ToolMessageStart extends JsonSerializableType { /** diff --git a/src/Types/ToolNode.php b/src/Types/ToolNode.php index f6fe720..0b25835 100644 --- a/src/Types/ToolNode.php +++ b/src/Types/ToolNode.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A workflow node that invokes an inline tool or an existing saved tool. + */ class ToolNode extends JsonSerializableType { /** @@ -21,7 +24,7 @@ class ToolNode extends JsonSerializableType public ?string $toolId; /** - * @var string $name + * @var string $name Unique name used to identify this workflow node. */ #[JsonProperty('name')] public string $name; diff --git a/src/Types/ToolParameter.php b/src/Types/ToolParameter.php index 88ea828..9ed977a 100644 --- a/src/Types/ToolParameter.php +++ b/src/Types/ToolParameter.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\Union; +/** + * Static key-value parameter added to a tool request, with Liquid template support for string values. + */ class ToolParameter extends JsonSerializableType { /** diff --git a/src/Types/ToolRejectionPlan.php b/src/Types/ToolRejectionPlan.php index 613fc25..b285bf7 100644 --- a/src/Types/ToolRejectionPlan.php +++ b/src/Types/ToolRejectionPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Conditions evaluated to determine whether a requested tool call should be rejected. + */ class ToolRejectionPlan extends JsonSerializableType { /** diff --git a/src/Types/TranscriberCost.php b/src/Types/TranscriberCost.php index 8e6ad1e..d57f195 100644 --- a/src/Types/TranscriberCost.php +++ b/src/Types/TranscriberCost.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Speech-to-text cost for a call, including transcriber, billable minutes, and amount. + */ class TranscriberCost extends JsonSerializableType { /** diff --git a/src/Types/TranscriptPlan.php b/src/Types/TranscriptPlan.php index 0b3f3bb..4099c0b 100644 --- a/src/Types/TranscriptPlan.php +++ b/src/Types/TranscriptPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls whether the call transcript is stored and the speaker names used in the transcript. + */ class TranscriptPlan extends JsonSerializableType { /** diff --git a/src/Types/TranscriptionEndpointingPlan.php b/src/Types/TranscriptionEndpointingPlan.php index df2debf..1350770 100644 --- a/src/Types/TranscriptionEndpointingPlan.php +++ b/src/Types/TranscriptionEndpointingPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls endpointing delays based on whether customer speech ends with punctuation, without punctuation, or with a number. + */ class TranscriptionEndpointingPlan extends JsonSerializableType { /** diff --git a/src/Types/TransferCallTool.php b/src/Types/TransferCallTool.php index be6fca2..ad6daee 100644 --- a/src/Types/TransferCallTool.php +++ b/src/Types/TransferCallTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable tool that transfers the active call to one of its configured destinations. + */ class TransferCallTool extends JsonSerializableType { /** diff --git a/src/Types/TransferDestinationAssistant.php b/src/Types/TransferDestinationAssistant.php index 74309f9..394f26f 100644 --- a/src/Types/TransferDestinationAssistant.php +++ b/src/Types/TransferDestinationAssistant.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\Union; +/** + * Transfers a call to another assistant by name, with an optional message and assistant-transfer mode. + */ class TransferDestinationAssistant extends JsonSerializableType { /** @@ -26,7 +29,7 @@ class TransferDestinationAssistant extends JsonSerializableType public string|CustomMessage|null $message; /** - * @var value-of $type + * @var value-of $type Selects another assistant as the transfer destination. */ #[JsonProperty('type')] public string $type; diff --git a/src/Types/TransferDestinationNumber.php b/src/Types/TransferDestinationNumber.php index 45cdd02..078aa69 100644 --- a/src/Types/TransferDestinationNumber.php +++ b/src/Types/TransferDestinationNumber.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\Union; +/** + * Transfers a call to a phone number, with optional extension, caller ID, message, transfer plan, and number validation. + */ class TransferDestinationNumber extends JsonSerializableType { /** diff --git a/src/Types/TransferDestinationSip.php b/src/Types/TransferDestinationSip.php index 9598930..f79e6c2 100644 --- a/src/Types/TransferDestinationSip.php +++ b/src/Types/TransferDestinationSip.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\Union; use Vapi\Core\Types\ArrayType; +/** + * Transfers a call to a SIP URI, with optional caller ID, headers, message, and transfer plan. + */ class TransferDestinationSip extends JsonSerializableType { /** diff --git a/src/Types/TransferFallbackPlan.php b/src/Types/TransferFallbackPlan.php index c7bd9c9..7bb4a92 100644 --- a/src/Types/TransferFallbackPlan.php +++ b/src/Types/TransferFallbackPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\Union; +/** + * Controls the message and end-call behavior used when a call transfer fails. + */ class TransferFallbackPlan extends JsonSerializableType { /** diff --git a/src/Types/TransferPhoneNumberHookAction.php b/src/Types/TransferPhoneNumberHookAction.php index 94320a9..5f664a9 100644 --- a/src/Types/TransferPhoneNumberHookAction.php +++ b/src/Types/TransferPhoneNumberHookAction.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * A phone-number hook action that transfers the call to a phone number or SIP destination. + */ class TransferPhoneNumberHookAction extends JsonSerializableType { /** diff --git a/src/Types/TransferPlan.php b/src/Types/TransferPlan.php index dd5665e..7896d19 100644 --- a/src/Types/TransferPlan.php +++ b/src/Types/TransferPlan.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\Union; use Vapi\Core\Types\ArrayType; +/** + * Controls how a call transfer is executed, including blind and warm transfer modes, dialing and SIP behavior, hold audio, context, summary, and failure handling. + */ class TransferPlan extends JsonSerializableType { /** diff --git a/src/Types/TransportConfigurationTwilio.php b/src/Types/TransportConfigurationTwilio.php index d47d780..288bdaa 100644 --- a/src/Types/TransportConfigurationTwilio.php +++ b/src/Types/TransportConfigurationTwilio.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration passed to Twilio for assistant calls, including ring timeout and Twilio recording behavior. + */ class TransportConfigurationTwilio extends JsonSerializableType { /** - * @var value-of $provider + * @var value-of $provider Selects Twilio as the call transport provider. */ #[JsonProperty('provider')] public string $provider; diff --git a/src/Types/TransportCost.php b/src/Types/TransportCost.php index 5276ae0..068688a 100644 --- a/src/Types/TransportCost.php +++ b/src/Types/TransportCost.php @@ -5,10 +5,13 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Telephony transport cost for a call, including provider, billable minutes, and amount. + */ class TransportCost extends JsonSerializableType { /** - * @var ?value-of $provider + * @var ?value-of $provider Telephony or transport provider that generated the cost. */ #[JsonProperty('provider')] public ?string $provider; diff --git a/src/Types/TurnLatency.php b/src/Types/TurnLatency.php index a2c9374..0c97381 100644 --- a/src/Types/TurnLatency.php +++ b/src/Types/TurnLatency.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Model, voice, transcription, endpointing, and total latency measurements for a conversation turn. + */ class TurnLatency extends JsonSerializableType { /** diff --git a/src/Types/TwilioPhoneNumber.php b/src/Types/TwilioPhoneNumber.php index bf5f3a9..c0c9141 100644 --- a/src/Types/TwilioPhoneNumber.php +++ b/src/Types/TwilioPhoneNumber.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, server settings, and lifecycle metadata. + */ class TwilioPhoneNumber extends JsonSerializableType { /** diff --git a/src/Types/TwilioVoicemailDetectionPlan.php b/src/Types/TwilioVoicemailDetectionPlan.php index 88872dc..54cd707 100644 --- a/src/Types/TwilioVoicemailDetectionPlan.php +++ b/src/Types/TwilioVoicemailDetectionPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for Twilio answering-machine detection, including recognized outcomes, enablement, timeout, speech thresholds, and silence timeout. + */ class TwilioVoicemailDetectionPlan extends JsonSerializableType { /** diff --git a/src/Types/UpdateApiRequestToolDto.php b/src/Types/UpdateApiRequestToolDto.php index 34ecee3..f67cc9a 100644 --- a/src/Types/UpdateApiRequestToolDto.php +++ b/src/Types/UpdateApiRequestToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update an API-request tool, including its URL, HTTP method, authentication, request data, retries, and response handling. + */ class UpdateApiRequestToolDto extends JsonSerializableType { /** @@ -19,7 +22,7 @@ class UpdateApiRequestToolDto extends JsonSerializableType public ?array $messages; /** - * @var ?value-of $method + * @var ?value-of $method The HTTP method used for the API request. */ #[JsonProperty('method')] public ?string $method; diff --git a/src/Types/UpdateBarInsightFromCallTableDto.php b/src/Types/UpdateBarInsightFromCallTableDto.php index 1e3a03d..584384c 100644 --- a/src/Types/UpdateBarInsightFromCallTableDto.php +++ b/src/Types/UpdateBarInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Fields used to update a bar-chart insight, including its queries, formulas, grouping, time range, metadata, and name. + */ class UpdateBarInsightFromCallTableDto extends JsonSerializableType { /** @@ -44,7 +47,7 @@ class UpdateBarInsightFromCallTableDto extends JsonSerializableType public ?BarInsightMetadata $metadata; /** - * @var ?InsightTimeRangeWithStep $timeRange + * @var ?InsightTimeRangeWithStep $timeRange The time range and interval used to aggregate the bar-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRangeWithStep $timeRange; diff --git a/src/Types/UpdateBashToolDto.php b/src/Types/UpdateBashToolDto.php index 624e0b4..4dfc10e 100644 --- a/src/Types/UpdateBashToolDto.php +++ b/src/Types/UpdateBashToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Bash tool, including its name, environment subtype, server, messages, and rejection plan. + */ class UpdateBashToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateByoPhoneNumberDto.php b/src/Types/UpdateByoPhoneNumberDto.php index ad8b040..4f5df1a 100644 --- a/src/Types/UpdateByoPhoneNumberDto.php +++ b/src/Types/UpdateByoPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a bring-your-own phone number, including its credential, number, routing, hooks, and server settings. + */ class UpdateByoPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateComputerToolDto.php b/src/Types/UpdateComputerToolDto.php index 75471cf..582c478 100644 --- a/src/Types/UpdateComputerToolDto.php +++ b/src/Types/UpdateComputerToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a computer tool, including its display settings, environment subtype, server, messages, and rejection plan. + */ class UpdateComputerToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateDtmfToolDto.php b/src/Types/UpdateDtmfToolDto.php index aa3f61e..530eeac 100644 --- a/src/Types/UpdateDtmfToolDto.php +++ b/src/Types/UpdateDtmfToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a DTMF tool, including its spoken messages, rejection plan, and SIP INFO behavior. + */ class UpdateDtmfToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateEndCallToolDto.php b/src/Types/UpdateEndCallToolDto.php index 5cc449e..9623902 100644 --- a/src/Types/UpdateEndCallToolDto.php +++ b/src/Types/UpdateEndCallToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update an end-call tool, including its spoken messages and rejection plan. + */ class UpdateEndCallToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateFunctionToolDto.php b/src/Types/UpdateFunctionToolDto.php index 8038f10..12f8af4 100644 --- a/src/Types/UpdateFunctionToolDto.php +++ b/src/Types/UpdateFunctionToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a custom function tool, including its function definition, server, parameters, messages, and execution behavior. + */ class UpdateFunctionToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.php b/src/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.php index 8432800..637d122 100644 --- a/src/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.php +++ b/src/Types/UpdateGoHighLevelCalendarAvailabilityToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a GoHighLevel calendar-availability tool, including its spoken messages and rejection plan. + */ class UpdateGoHighLevelCalendarAvailabilityToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateGoHighLevelCalendarEventCreateToolDto.php b/src/Types/UpdateGoHighLevelCalendarEventCreateToolDto.php index 3dbf96a..9282443 100644 --- a/src/Types/UpdateGoHighLevelCalendarEventCreateToolDto.php +++ b/src/Types/UpdateGoHighLevelCalendarEventCreateToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a GoHighLevel calendar-event tool, including its spoken messages and rejection plan. + */ class UpdateGoHighLevelCalendarEventCreateToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateGoHighLevelContactCreateToolDto.php b/src/Types/UpdateGoHighLevelContactCreateToolDto.php index cfcea2d..098c83a 100644 --- a/src/Types/UpdateGoHighLevelContactCreateToolDto.php +++ b/src/Types/UpdateGoHighLevelContactCreateToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a GoHighLevel contact-creation tool, including its spoken messages and rejection plan. + */ class UpdateGoHighLevelContactCreateToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateGoHighLevelContactGetToolDto.php b/src/Types/UpdateGoHighLevelContactGetToolDto.php index 49d9066..8f66b9d 100644 --- a/src/Types/UpdateGoHighLevelContactGetToolDto.php +++ b/src/Types/UpdateGoHighLevelContactGetToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a GoHighLevel contact-retrieval tool, including its spoken messages and rejection plan. + */ class UpdateGoHighLevelContactGetToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.php b/src/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.php index 9b54244..f70188d 100644 --- a/src/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.php +++ b/src/Types/UpdateGoogleCalendarCheckAvailabilityToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Google Calendar availability tool, including its spoken messages and rejection plan. + */ class UpdateGoogleCalendarCheckAvailabilityToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateGoogleCalendarCreateEventToolDto.php b/src/Types/UpdateGoogleCalendarCreateEventToolDto.php index 149523f..e685f8d 100644 --- a/src/Types/UpdateGoogleCalendarCreateEventToolDto.php +++ b/src/Types/UpdateGoogleCalendarCreateEventToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Google Calendar event-creation tool, including its spoken messages and rejection plan. + */ class UpdateGoogleCalendarCreateEventToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateGoogleSheetsRowAppendToolDto.php b/src/Types/UpdateGoogleSheetsRowAppendToolDto.php index fff8879..823e054 100644 --- a/src/Types/UpdateGoogleSheetsRowAppendToolDto.php +++ b/src/Types/UpdateGoogleSheetsRowAppendToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Google Sheets row-append tool, including its spoken messages and rejection plan. + */ class UpdateGoogleSheetsRowAppendToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateHandoffToolDto.php b/src/Types/UpdateHandoffToolDto.php index 354add8..8e7c8ce 100644 --- a/src/Types/UpdateHandoffToolDto.php +++ b/src/Types/UpdateHandoffToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a handoff tool, including its destinations, function definition, default result, messages, and rejection plan. + */ class UpdateHandoffToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateLineInsightFromCallTableDto.php b/src/Types/UpdateLineInsightFromCallTableDto.php index c995ff6..f83c13d 100644 --- a/src/Types/UpdateLineInsightFromCallTableDto.php +++ b/src/Types/UpdateLineInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Fields used to update a line-chart insight, including its queries, formulas, grouping, time range, metadata, and name. + */ class UpdateLineInsightFromCallTableDto extends JsonSerializableType { /** @@ -44,7 +47,7 @@ class UpdateLineInsightFromCallTableDto extends JsonSerializableType public ?LineInsightMetadata $metadata; /** - * @var ?InsightTimeRangeWithStep $timeRange + * @var ?InsightTimeRangeWithStep $timeRange The time range and interval used to aggregate the line-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRangeWithStep $timeRange; diff --git a/src/Types/UpdateMcpToolDto.php b/src/Types/UpdateMcpToolDto.php index c836084..83ba5a0 100644 --- a/src/Types/UpdateMcpToolDto.php +++ b/src/Types/UpdateMcpToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update an MCP tool, including its server, connection metadata, exposed tool messages, and rejection plan. + */ class UpdateMcpToolDto extends JsonSerializableType { /** @@ -126,7 +129,7 @@ class UpdateMcpToolDto extends JsonSerializableType public ?ToolRejectionPlan $rejectionPlan; /** - * @var ?McpToolMetadata $metadata + * @var ?McpToolMetadata $metadata Connection metadata for the MCP server, including its communication protocol. */ #[JsonProperty('metadata')] public ?McpToolMetadata $metadata; diff --git a/src/Types/UpdatePieInsightFromCallTableDto.php b/src/Types/UpdatePieInsightFromCallTableDto.php index 7ff20be..faecfa3 100644 --- a/src/Types/UpdatePieInsightFromCallTableDto.php +++ b/src/Types/UpdatePieInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Fields used to update a pie-chart insight, including its queries, formulas, grouping, time range, and name. + */ class UpdatePieInsightFromCallTableDto extends JsonSerializableType { /** @@ -38,7 +41,7 @@ class UpdatePieInsightFromCallTableDto extends JsonSerializableType public ?array $formulas; /** - * @var ?InsightTimeRange $timeRange + * @var ?InsightTimeRange $timeRange The time range used to query the pie-chart data. */ #[JsonProperty('timeRange')] public ?InsightTimeRange $timeRange; diff --git a/src/Types/UpdateQueryToolDto.php b/src/Types/UpdateQueryToolDto.php index 21cf3a5..832f2e0 100644 --- a/src/Types/UpdateQueryToolDto.php +++ b/src/Types/UpdateQueryToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a query tool, including its knowledge bases, spoken messages, and rejection plan. + */ class UpdateQueryToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateSipRequestToolDto.php b/src/Types/UpdateSipRequestToolDto.php index 6ee80ed..e23006a 100644 --- a/src/Types/UpdateSipRequestToolDto.php +++ b/src/Types/UpdateSipRequestToolDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Fields used to update a SIP-request tool, including its method, headers, body, spoken messages, and rejection plan. + */ class UpdateSipRequestToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateSlackSendMessageToolDto.php b/src/Types/UpdateSlackSendMessageToolDto.php index dacf865..42eda73 100644 --- a/src/Types/UpdateSlackSendMessageToolDto.php +++ b/src/Types/UpdateSlackSendMessageToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Slack message tool, including its spoken messages and rejection plan. + */ class UpdateSlackSendMessageToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateSmsToolDto.php b/src/Types/UpdateSmsToolDto.php index e104087..5b4b068 100644 --- a/src/Types/UpdateSmsToolDto.php +++ b/src/Types/UpdateSmsToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update an SMS tool, including its spoken messages and rejection plan. + */ class UpdateSmsToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateTelnyxPhoneNumberDto.php b/src/Types/UpdateTelnyxPhoneNumberDto.php index 5d71906..6ba9044 100644 --- a/src/Types/UpdateTelnyxPhoneNumberDto.php +++ b/src/Types/UpdateTelnyxPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Telnyx phone number, including its credential, number, routing, hooks, and server settings. + */ class UpdateTelnyxPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateTextEditorToolDto.php b/src/Types/UpdateTextEditorToolDto.php index fa8ae2e..1c29746 100644 --- a/src/Types/UpdateTextEditorToolDto.php +++ b/src/Types/UpdateTextEditorToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a text-editor tool, including its name, environment subtype, server, messages, and rejection plan. + */ class UpdateTextEditorToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateTextInsightFromCallTableDto.php b/src/Types/UpdateTextInsightFromCallTableDto.php index 98b79b4..e34b178 100644 --- a/src/Types/UpdateTextInsightFromCallTableDto.php +++ b/src/Types/UpdateTextInsightFromCallTableDto.php @@ -7,6 +7,9 @@ use Vapi\Core\Types\ArrayType; use Vapi\Core\Types\Union; +/** + * Fields used to update a text-value insight, including its queries, formula, time range, and name. + */ class UpdateTextInsightFromCallTableDto extends JsonSerializableType { /** @@ -38,7 +41,7 @@ class UpdateTextInsightFromCallTableDto extends JsonSerializableType public ?array $formula; /** - * @var ?InsightTimeRange $timeRange + * @var ?InsightTimeRange $timeRange The time range used to query the text-value data. */ #[JsonProperty('timeRange')] public ?InsightTimeRange $timeRange; diff --git a/src/Types/UpdateTransferCallToolDto.php b/src/Types/UpdateTransferCallToolDto.php index cffa0d3..ac388c2 100644 --- a/src/Types/UpdateTransferCallToolDto.php +++ b/src/Types/UpdateTransferCallToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a call-transfer tool, including its destinations, spoken messages, and rejection plan. + */ class UpdateTransferCallToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateTwilioPhoneNumberDto.php b/src/Types/UpdateTwilioPhoneNumberDto.php index 569bc63..39eb26c 100644 --- a/src/Types/UpdateTwilioPhoneNumberDto.php +++ b/src/Types/UpdateTwilioPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, and server settings. + */ class UpdateTwilioPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateVapiPhoneNumberDto.php b/src/Types/UpdateVapiPhoneNumberDto.php index 12862d8..99c40ae 100644 --- a/src/Types/UpdateVapiPhoneNumberDto.php +++ b/src/Types/UpdateVapiPhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, and server settings. + */ class UpdateVapiPhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateVoicemailToolDto.php b/src/Types/UpdateVoicemailToolDto.php index 4c730d0..75702d0 100644 --- a/src/Types/UpdateVoicemailToolDto.php +++ b/src/Types/UpdateVoicemailToolDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a voicemail-detection tool, including beep detection, spoken messages, and rejection plan. + */ class UpdateVoicemailToolDto extends JsonSerializableType { /** diff --git a/src/Types/UpdateVonagePhoneNumberDto.php b/src/Types/UpdateVonagePhoneNumberDto.php index 68dce7f..abfb2b0 100644 --- a/src/Types/UpdateVonagePhoneNumberDto.php +++ b/src/Types/UpdateVonagePhoneNumberDto.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Fields used to update a Vonage phone number, including its credential, number, routing, hooks, and server settings. + */ class UpdateVonagePhoneNumberDto extends JsonSerializableType { /** diff --git a/src/Types/UserMessage.php b/src/Types/UserMessage.php index 103331d..00fd9c2 100644 --- a/src/Types/UserMessage.php +++ b/src/Types/UserMessage.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * A user-authored entry in the call message history, including content, timing, security-filter results, and optional speaker metadata. + */ class UserMessage extends JsonSerializableType { /** diff --git a/src/Types/VapiCost.php b/src/Types/VapiCost.php index 6f21e81..1343c58 100644 --- a/src/Types/VapiCost.php +++ b/src/Types/VapiCost.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Vapi platform cost for a call, including cost subtype, billable minutes, and amount. + */ class VapiCost extends JsonSerializableType { /** diff --git a/src/Types/VapiPhoneNumber.php b/src/Types/VapiPhoneNumber.php index fed4826..0da8965 100644 --- a/src/Types/VapiPhoneNumber.php +++ b/src/Types/VapiPhoneNumber.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, server settings, and lifecycle metadata. + */ class VapiPhoneNumber extends JsonSerializableType { /** diff --git a/src/Types/VapiPronunciationDictionaryLocator.php b/src/Types/VapiPronunciationDictionaryLocator.php index 4720945..3ba37b3 100644 --- a/src/Types/VapiPronunciationDictionaryLocator.php +++ b/src/Types/VapiPronunciationDictionaryLocator.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Identifies a pronunciation dictionary and optional version used for voice synthesis. + */ class VapiPronunciationDictionaryLocator extends JsonSerializableType { /** diff --git a/src/Types/VapiSmartEndpointingPlan.php b/src/Types/VapiSmartEndpointingPlan.php index 371d7c2..cadd175 100644 --- a/src/Types/VapiSmartEndpointingPlan.php +++ b/src/Types/VapiSmartEndpointingPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Selects Vapi smart endpointing to determine when customer speech is complete. + */ class VapiSmartEndpointingPlan extends JsonSerializableType { /** diff --git a/src/Types/VapiVoice.php b/src/Types/VapiVoice.php index 360976d..8970c4d 100644 --- a/src/Types/VapiVoice.php +++ b/src/Types/VapiVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, caching, and fallback settings. + */ class VapiVoice extends JsonSerializableType { /** diff --git a/src/Types/VapiVoicemailDetectionPlan.php b/src/Types/VapiVoicemailDetectionPlan.php index f234ed3..2bebee7 100644 --- a/src/Types/VapiVoicemailDetectionPlan.php +++ b/src/Types/VapiVoicemailDetectionPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Configuration for detecting voicemail with Vapi, including detection type, maximum beep wait, and retry backoff. + */ class VapiVoicemailDetectionPlan extends JsonSerializableType { /** diff --git a/src/Types/VariableExtractionAlias.php b/src/Types/VariableExtractionAlias.php index 6582d1b..469d797 100644 --- a/src/Types/VariableExtractionAlias.php +++ b/src/Types/VariableExtractionAlias.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Defines an additional Liquid-based variable from values extracted during a call. + */ class VariableExtractionAlias extends JsonSerializableType { /** diff --git a/src/Types/VariableExtractionPlan.php b/src/Types/VariableExtractionPlan.php index 9d5c3ea..012bb7b 100644 --- a/src/Types/VariableExtractionPlan.php +++ b/src/Types/VariableExtractionPlan.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Defines structured variables to extract and optional aliases made available during and after a call. + */ class VariableExtractionPlan extends JsonSerializableType { /** diff --git a/src/Types/VariableValueGroupBy.php b/src/Types/VariableValueGroupBy.php index 04772ad..a7d8265 100644 --- a/src/Types/VariableValueGroupBy.php +++ b/src/Types/VariableValueGroupBy.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Groups analytics results by a selected assistant variable-value key. + */ class VariableValueGroupBy extends JsonSerializableType { /** diff --git a/src/Types/VoiceCost.php b/src/Types/VoiceCost.php index 7f2910d..9f1bc2e 100644 --- a/src/Types/VoiceCost.php +++ b/src/Types/VoiceCost.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Voice-synthesis cost for a call, including voice, character usage, and amount. + */ class VoiceCost extends JsonSerializableType { /** diff --git a/src/Types/VoicemailDetectionBackoffPlan.php b/src/Types/VoicemailDetectionBackoffPlan.php index 82b9873..de5be8a 100644 --- a/src/Types/VoicemailDetectionBackoffPlan.php +++ b/src/Types/VoicemailDetectionBackoffPlan.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Controls voicemail-detection retry timing, including when retries start, retry frequency, and maximum attempts. + */ class VoicemailDetectionBackoffPlan extends JsonSerializableType { /** diff --git a/src/Types/VoicemailDetectionCost.php b/src/Types/VoicemailDetectionCost.php index d9e2bdf..5f7b210 100644 --- a/src/Types/VoicemailDetectionCost.php +++ b/src/Types/VoicemailDetectionCost.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Voicemail-detection model cost, including provider, model, multimodal token usage, and amount. + */ class VoicemailDetectionCost extends JsonSerializableType { /** diff --git a/src/Types/VoicemailTool.php b/src/Types/VoicemailTool.php index 913a668..dd4e259 100644 --- a/src/Types/VoicemailTool.php +++ b/src/Types/VoicemailTool.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A reusable voicemail-detection tool with optional beep detection for supported calls. + */ class VoicemailTool extends JsonSerializableType { /** diff --git a/src/Types/VonagePhoneNumber.php b/src/Types/VonagePhoneNumber.php index ca6c397..dd885af 100644 --- a/src/Types/VonagePhoneNumber.php +++ b/src/Types/VonagePhoneNumber.php @@ -8,6 +8,9 @@ use DateTime; use Vapi\Core\Types\Date; +/** + * A Vonage phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata. + */ class VonagePhoneNumber extends JsonSerializableType { /** diff --git a/src/Types/WellSaidVoice.php b/src/Types/WellSaidVoice.php index 0964f80..5863cac 100644 --- a/src/Types/WellSaidVoice.php +++ b/src/Types/WellSaidVoice.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, caching, and fallback settings. + */ class WellSaidVoice extends JsonSerializableType { /** diff --git a/src/Types/WorkflowAnthropicBedrockModel.php b/src/Types/WorkflowAnthropicBedrockModel.php index d0fc38b..2a7a289 100644 --- a/src/Types/WorkflowAnthropicBedrockModel.php +++ b/src/Types/WorkflowAnthropicBedrockModel.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Workflow model configuration for Anthropic through Amazon Bedrock, including model selection, thinking, temperature, and maximum output tokens. + */ class WorkflowAnthropicBedrockModel extends JsonSerializableType { /** diff --git a/src/Types/WorkflowAnthropicModel.php b/src/Types/WorkflowAnthropicModel.php index a098c31..f8568e2 100644 --- a/src/Types/WorkflowAnthropicModel.php +++ b/src/Types/WorkflowAnthropicModel.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Workflow model configuration for Anthropic, including model selection, thinking, temperature, and maximum output tokens. + */ class WorkflowAnthropicModel extends JsonSerializableType { /** diff --git a/src/Types/WorkflowCustomModel.php b/src/Types/WorkflowCustomModel.php index 363ae34..b32ed71 100644 --- a/src/Types/WorkflowCustomModel.php +++ b/src/Types/WorkflowCustomModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Workflow model configuration for a custom language model endpoint, including URL, headers, metadata delivery, timeout, model, temperature, and maximum output tokens. + */ class WorkflowCustomModel extends JsonSerializableType { /** diff --git a/src/Types/WorkflowGoogleModel.php b/src/Types/WorkflowGoogleModel.php index aa11496..1d7b8e8 100644 --- a/src/Types/WorkflowGoogleModel.php +++ b/src/Types/WorkflowGoogleModel.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Workflow model configuration for Google, including model selection, temperature, and maximum output tokens. + */ class WorkflowGoogleModel extends JsonSerializableType { /** diff --git a/src/Types/WorkflowOpenAiModel.php b/src/Types/WorkflowOpenAiModel.php index 93a59c3..04164c6 100644 --- a/src/Types/WorkflowOpenAiModel.php +++ b/src/Types/WorkflowOpenAiModel.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Workflow model configuration for OpenAI, including model selection, temperature, and maximum output tokens. + */ class WorkflowOpenAiModel extends JsonSerializableType { /** diff --git a/src/Types/WorkflowOverrides.php b/src/Types/WorkflowOverrides.php index ad4513a..a5a32ba 100644 --- a/src/Types/WorkflowOverrides.php +++ b/src/Types/WorkflowOverrides.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Per-call overrides for values used in workflow template variables. + */ class WorkflowOverrides extends JsonSerializableType { /** diff --git a/src/Types/XaiModel.php b/src/Types/XaiModel.php index 737e80e..5ec36b8 100644 --- a/src/Types/XaiModel.php +++ b/src/Types/XaiModel.php @@ -6,6 +6,9 @@ use Vapi\Core\Json\JsonProperty; use Vapi\Core\Types\ArrayType; +/** + * Configuration for generating assistant responses with xAI, including model, prompts, tools, knowledge-base access, and generation settings. + */ class XaiModel extends JsonSerializableType { /** diff --git a/src/Types/XssSecurityFilter.php b/src/Types/XssSecurityFilter.php index 4f16f59..a074cfe 100644 --- a/src/Types/XssSecurityFilter.php +++ b/src/Types/XssSecurityFilter.php @@ -5,6 +5,9 @@ use Vapi\Core\Json\JsonSerializableType; use Vapi\Core\Json\JsonProperty; +/** + * Filters potential cross-site scripting (XSS) patterns from transcripts. + */ class XssSecurityFilter extends JsonSerializableType { /** diff --git a/src/VapiClient.php b/src/VapiClient.php index 5c415f7..8e71920 100644 --- a/src/VapiClient.php +++ b/src/VapiClient.php @@ -131,8 +131,8 @@ public function __construct( 'Authorization' => "Bearer $token", 'X-Fern-Language' => 'PHP', 'X-Fern-SDK-Name' => 'Vapi', - 'X-Fern-SDK-Version' => '2.0.0', - 'User-Agent' => 'vapi/vapi/2.0.0', + 'X-Fern-SDK-Version' => '2.0.1', + 'User-Agent' => 'vapi/vapi/2.0.1', ]; $this->options = $options ?? [];