diff --git a/.fern/metadata.json b/.fern/metadata.json index 36e4fcdb..e33a6275 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -1,11 +1,11 @@ { - "cliVersion": "5.51.2", + "cliVersion": "5.75.6", "generatorName": "fernapi/fern-ruby-sdk", "generatorVersion": "1.1.13", "generatorConfig": { "clientClassName": "Vapi", "rubocopVariableNumberStyle": "disabled" }, - "originGitCommit": "5a015aa01196915bea6110904c69d5804f457ff5", - "sdkVersion": "2.0.0" + "originGitCommit": "5bfd858800a83849a00a0db760c7cce860f37da6", + "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 00000000..72694c3b --- /dev/null +++ b/.fern/replay.lock @@ -0,0 +1,16 @@ +# DO NOT EDIT MANUALLY - Managed by Fern Replay +version: "1.0" +generations: + - commit_sha: caafff76234c021adc32f2c1a74e286394bc8b77 + tree_hash: 231edd13c9f4cb05cc6c24a0533392798b053746 + timestamp: 2026-07-21T02:26:11.525Z + cli_version: unknown + generator_versions: {} + - commit_sha: 2aaf5351b55b71445662d5b920adc2a31865fa5d + tree_hash: f17a7f08aa105a2d3fd3b29418faac58342db08d + timestamp: 2026-07-21T02:26:11.846Z + cli_version: unknown + generator_versions: + fernapi/fern-ruby-sdk: 1.1.13 +current_generation: 2aaf5351b55b71445662d5b920adc2a31865fa5d +patches: [] diff --git a/.fernignore b/.fernignore index 82e7de06..fad339e2 100644 --- a/.fernignore +++ b/.fernignore @@ -3,3 +3,6 @@ .github/workflows/sdk-release-pr-notification.yml README.md changelog.md +.fern/replay.lock +.fern/replay.yml +.gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..74928d6a --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +.fern/replay.lock linguist-generated=true diff --git a/Gemfile.lock b/Gemfile.lock index 0c3e13fc..ee64d044 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -16,15 +16,15 @@ GEM rexml hashdiff (1.2.1) io-console (0.8.2) - json (2.20.0) - language_server-protocol (3.17.0.5) + json (2.21.1) + language_server-protocol (3.17.0.6) lint_roller (1.1.0) method_source (1.1.0) minitest (5.27.0) minitest-rg (5.4.0) minitest (>= 5.0, < 7) parallel (2.1.0) - parser (3.3.11.1) + parser (3.3.12.0) ast (~> 2.4.1) racc prism (1.9.0) @@ -40,7 +40,7 @@ GEM reline (0.6.3) io-console (~> 0.5) rexml (3.4.4) - rubocop (1.88.0) + rubocop (1.88.2) json (~> 2.3) language_server-protocol (~> 3.17.0.2) lint_roller (~> 1.1.0) @@ -51,10 +51,10 @@ GEM rubocop-ast (>= 1.49.0, < 2.0) ruby-progressbar (~> 1.7) unicode-display_width (>= 2.4.0, < 4.0) - rubocop-ast (1.49.1) + rubocop-ast (1.50.0) parser (>= 3.3.7.2) prism (~> 1.7) - rubocop-minitest (0.39.1) + rubocop-minitest (0.40.0) lint_roller (~> 1.1) rubocop (>= 1.75.0, < 2.0) rubocop-ast (>= 1.38.0, < 2.0) diff --git a/changelog.md b/changelog.md index 997d09ec..06602a23 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 * **`Vapi::Types::CartesiaExperimentalControlsSpeedZero`** has been renamed to **`Vapi::Types::CartesiaSpeedControlZero`**. Update any references to use the new name. diff --git a/lib/vapi/analytics/client.rb b/lib/vapi/analytics/client.rb index 3b8a839e..dab7d2d0 100644 --- a/lib/vapi/analytics/client.rb +++ b/lib/vapi/analytics/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Runs one or more metric queries against call or subscription data using the requested time range, groupings, and + # aggregate operations. + # # @param request_options [Hash] # @param params [Vapi::Analytics::Types::AnalyticsQueryDto] # @option request_options [String] :base_url diff --git a/lib/vapi/assistants/client.rb b/lib/vapi/assistants/client.rb index 77b0a233..2bd2be8c 100644 --- a/lib/vapi/assistants/client.rb +++ b/lib/vapi/assistants/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit + # the number returned. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -62,6 +65,9 @@ def list(request_options: {}, **params) raise error_class.new(response.body, code: code) end + # Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call + # behavior. + # # @param request_options [Hash] # @param params [Vapi::Types::CreateAssistantDto] # @option request_options [String] :base_url @@ -94,6 +100,8 @@ def create(request_options: {}, **params) end end + # Returns the assistant identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -126,6 +134,8 @@ def get(request_options: {}, **params) end end + # Deletes the assistant identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -158,6 +168,8 @@ def delete(request_options: {}, **params) end end + # Updates the specified fields of the assistant identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Assistants::Types::UpdateAssistantDto] # @option request_options [String] :base_url diff --git a/lib/vapi/calls/client.rb b/lib/vapi/calls/client.rb index 776044c1..7d5618ee 100644 --- a/lib/vapi/calls/client.rb +++ b/lib/vapi/calls/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or + # creation and update timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -68,6 +71,9 @@ def list(request_options: {}, **params) raise error_class.new(response.body, code: code) end + # Creates a call using an assistant or squad. The request can reference saved resources or include transient + # configurations. + # # @param request_options [Hash] # @param params [Vapi::Calls::Types::CreateCallDto] # @option request_options [String] :base_url @@ -100,6 +106,8 @@ def create(request_options: {}, **params) end end + # Returns the call identified by its ID, including its status, configuration, and available call data. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -132,6 +140,8 @@ def get(request_options: {}, **params) end end + # Deletes the call identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Calls::Types::DeleteCallDto] # @option request_options [String] :base_url @@ -169,6 +179,8 @@ def delete(request_options: {}, **params) end end + # Updates the call identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Calls::Types::UpdateCallDto] # @option request_options [String] :base_url diff --git a/lib/vapi/campaigns/client.rb b/lib/vapi/campaigns/client.rb index 34fd0b76..444eaf95 100644 --- a/lib/vapi/campaigns/client.rb +++ b/lib/vapi/campaigns/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or + # creation and update timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -72,6 +75,8 @@ def campaign_controller_find_all(request_options: {}, **params) end end + # Creates an outbound calling campaign that calls a set of customers. + # # @param request_options [Hash] # @param params [Vapi::Campaigns::Types::CreateCampaignDto] # @option request_options [String] :base_url @@ -104,6 +109,8 @@ def campaign_controller_create(request_options: {}, **params) end end + # Returns the outbound calling campaign identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -136,6 +143,8 @@ def campaign_controller_find_one(request_options: {}, **params) end end + # Deletes the outbound calling campaign identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -168,6 +177,9 @@ def campaign_controller_remove(request_options: {}, **params) end end + # Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to + # `ended`. + # # @param request_options [Hash] # @param params [Vapi::Campaigns::Types::UpdateCampaignDto] # @option request_options [String] :base_url diff --git a/lib/vapi/client.rb b/lib/vapi/client.rb index 9287dd22..ecc4e4e3 100644 --- a/lib/vapi/client.rb +++ b/lib/vapi/client.rb @@ -10,7 +10,7 @@ def initialize(token:, base_url: nil) @raw_client = Vapi::Internal::Http::RawClient.new( base_url: base_url || Vapi::Environment::DEFAULT, headers: { - "User-Agent" => "vapi_server_sdk/2.0.0", + "User-Agent" => "vapi_server_sdk/2.0.1", "X-Fern-Language" => "Ruby", Authorization: "Bearer #{token}" } diff --git a/lib/vapi/eval/client.rb b/lib/vapi/eval/client.rb index 55b231b3..707e8d3b 100644 --- a/lib/vapi/eval/client.rb +++ b/lib/vapi/eval/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns eval definitions for the authenticated organization. Filter results by ID or creation and update + # timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -70,6 +73,9 @@ def eval_controller_get_paginated(request_options: {}, **params) end end + # Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and + # tool calls. + # # @param request_options [Hash] # @param params [Vapi::Types::CreateEvalDto] # @option request_options [String] :base_url @@ -102,6 +108,8 @@ def eval_controller_create(request_options: {}, **params) end end + # Returns the eval definition identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -134,6 +142,8 @@ def eval_controller_get(request_options: {}, **params) end end + # Deletes the eval definition identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -166,6 +176,8 @@ def eval_controller_remove(request_options: {}, **params) end end + # Updates the eval definition identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Eval::Types::UpdateEvalDto] # @option request_options [String] :base_url @@ -203,6 +215,8 @@ def eval_controller_update(request_options: {}, **params) end end + # Returns the eval run identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -235,6 +249,8 @@ def eval_controller_get_run(request_options: {}, **params) end end + # Deletes the eval run identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -267,6 +283,8 @@ def eval_controller_remove_run(request_options: {}, **params) end end + # Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -327,6 +345,9 @@ def eval_controller_get_runs_paginated(request_options: {}, **params) end end + # Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the + # results. + # # @param request_options [Hash] # @param params [Vapi::Eval::Types::CreateEvalRunDto] # @option request_options [String] :base_url diff --git a/lib/vapi/files/client.rb b/lib/vapi/files/client.rb index aedeb396..0d71716d 100644 --- a/lib/vapi/files/client.rb +++ b/lib/vapi/files/client.rb @@ -10,6 +10,8 @@ def initialize(client:) @client = client end + # Returns files uploaded to the authenticated organization. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -39,6 +41,8 @@ def list(request_options: {}, **params) raise error_class.new(response.body, code: code) end + # Uploads a file for use with a Vapi knowledge base. + # # @param request_options [Hash] # @param params [void] # @option request_options [String] :base_url @@ -75,6 +79,8 @@ def create(request_options: {}, **params) end end + # Returns the uploaded file identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -107,6 +113,8 @@ def get(request_options: {}, **params) end end + # Deletes the uploaded file identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -139,6 +147,8 @@ def delete(request_options: {}, **params) end end + # Updates the name of the uploaded file identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Files::Types::UpdateFileDto] # @option request_options [String] :base_url diff --git a/lib/vapi/insight/client.rb b/lib/vapi/insight/client.rb index f335a22a..6852d3c7 100644 --- a/lib/vapi/insight/client.rb +++ b/lib/vapi/insight/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update + # timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -70,6 +73,9 @@ def insight_controller_find_all(request_options: {}, **params) end end + # 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 request_options [Hash] # @param params [Vapi::Insight::Types::InsightControllerCreateRequest] # @option request_options [String] :base_url @@ -102,6 +108,8 @@ def insight_controller_create(request_options: {}, **params) end end + # Returns the reporting insight identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -134,6 +142,8 @@ def insight_controller_find_one(request_options: {}, **params) end end + # Deletes the reporting insight identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -166,6 +176,8 @@ def insight_controller_remove(request_options: {}, **params) end end + # Updates the reporting insight identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Insight::Types::InsightControllerUpdateRequestBody] # @option request_options [String] :base_url @@ -202,6 +214,8 @@ def insight_controller_update(request_options: {}, **params) end end + # Runs a saved reporting insight, optionally overriding its time range and response format. + # # @param request_options [Hash] # @param params [Vapi::Insight::Types::InsightRunDto] # @option request_options [String] :base_url @@ -239,6 +253,8 @@ def insight_controller_run(request_options: {}, **params) end end + # Runs an insight definition without first saving it, returning a preview of the resulting chart or text value. + # # @param request_options [Hash] # @param params [Vapi::Insight::Types::InsightControllerPreviewRequest] # @option request_options [String] :base_url diff --git a/lib/vapi/observability_scorecard/client.rb b/lib/vapi/observability_scorecard/client.rb index b54c680b..f3356cac 100644 --- a/lib/vapi/observability_scorecard/client.rb +++ b/lib/vapi/observability_scorecard/client.rb @@ -10,6 +10,8 @@ def initialize(client:) @client = client end + # Returns the scorecard identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -42,6 +44,8 @@ def scorecard_controller_get(request_options: {}, **params) end end + # Deletes the scorecard identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -74,6 +78,8 @@ def scorecard_controller_remove(request_options: {}, **params) end end + # Updates the scorecard identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::ObservabilityScorecard::Types::UpdateScorecardDto] # @option request_options [String] :base_url @@ -111,6 +117,8 @@ def scorecard_controller_update(request_options: {}, **params) end end + # Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -171,6 +179,9 @@ def scorecard_controller_get_paginated(request_options: {}, **params) end end + # Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should + # be evaluated. + # # @param request_options [Hash] # @param params [Vapi::Types::CreateScorecardDto] # @option request_options [String] :base_url diff --git a/lib/vapi/phone_numbers/client.rb b/lib/vapi/phone_numbers/client.rb index 174138ec..96a0c941 100644 --- a/lib/vapi/phone_numbers/client.rb +++ b/lib/vapi/phone_numbers/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and + # limit the number returned. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -62,6 +65,9 @@ def list(request_options: {}, **params) raise error_class.new(response.body, code: code) end + # 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 request_options [Hash] # @param params [Vapi::PhoneNumbers::Types::CreatePhoneNumbersRequest] # @option request_options [String] :base_url @@ -94,6 +100,9 @@ def create(request_options: {}, **params) end end + # 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 request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -154,6 +163,8 @@ def phone_number_controller_find_all_paginated(request_options: {}, **params) end end + # Returns the phone number resource identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -186,6 +197,8 @@ def get(request_options: {}, **params) end end + # Deletes the phone number resource identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -218,6 +231,8 @@ def delete(request_options: {}, **params) end end + # Updates the specified fields of the phone number resource identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::PhoneNumbers::Types::UpdatePhoneNumbersRequestBody] # @option request_options [String] :base_url diff --git a/lib/vapi/provider_resources/client.rb b/lib/vapi/provider_resources/client.rb index 5e7c3016..9b5c58f6 100644 --- a/lib/vapi/provider_resources/client.rb +++ b/lib/vapi/provider_resources/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation + # dictionaries by provider, resource ID, or creation and update timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -74,6 +77,8 @@ def provider_resource_controller_get_provider_resources_paginated(request_option end end + # Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -107,6 +112,8 @@ def provider_resource_controller_create_provider_resource(request_options: {}, * end end + # Returns the provider resource identified by its Vapi resource ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -141,6 +148,8 @@ def provider_resource_controller_get_provider_resource(request_options: {}, **pa end end + # Deletes the provider resource identified by its Vapi resource ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -175,6 +184,8 @@ def provider_resource_controller_delete_provider_resource(request_options: {}, * end end + # Updates the provider resource identified by its Vapi resource ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url diff --git a/lib/vapi/squads/client.rb b/lib/vapi/squads/client.rb index 9837213a..b4b064e3 100644 --- a/lib/vapi/squads/client.rb +++ b/lib/vapi/squads/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the + # number returned. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -62,6 +65,8 @@ def list(request_options: {}, **params) raise error_class.new(response.body, code: code) end + # Creates a squad that coordinates multiple assistants and their handoffs during a conversation. + # # @param request_options [Hash] # @param params [Vapi::Types::CreateSquadDto] # @option request_options [String] :base_url @@ -94,6 +99,8 @@ def create(request_options: {}, **params) end end + # Returns the squad identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -126,6 +133,8 @@ def get(request_options: {}, **params) end end + # Deletes the squad identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -158,6 +167,8 @@ def delete(request_options: {}, **params) end end + # Updates the specified fields of the squad identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Squads::Types::UpdateSquadDto] # @option request_options [String] :base_url diff --git a/lib/vapi/structured_outputs/client.rb b/lib/vapi/structured_outputs/client.rb index e97503e3..874cf9d9 100644 --- a/lib/vapi/structured_outputs/client.rb +++ b/lib/vapi/structured_outputs/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or + # creation and update timestamps. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -72,6 +75,9 @@ def structured_output_controller_find_all(request_options: {}, **params) end end + # Creates a reusable definition for extracting validated data from conversations using an AI model or regular + # expression. + # # @param request_options [Hash] # @param params [Vapi::Types::CreateStructuredOutputDto] # @option request_options [String] :base_url @@ -104,6 +110,8 @@ def structured_output_controller_create(request_options: {}, **params) end end + # Returns the structured-output definition identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -136,6 +144,8 @@ def structured_output_controller_find_one(request_options: {}, **params) end end + # Deletes the structured-output definition identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -168,6 +178,8 @@ def structured_output_controller_remove(request_options: {}, **params) end end + # Updates the structured-output definition identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::StructuredOutputs::Types::UpdateStructuredOutputDto] # @option request_options [String] :base_url @@ -212,6 +224,9 @@ def structured_output_controller_update(request_options: {}, **params) end end + # Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview + # without updating call artifacts. + # # @param request_options [Hash] # @param params [Vapi::StructuredOutputs::Types::StructuredOutputRunDto] # @option request_options [String] :base_url diff --git a/lib/vapi/tools/client.rb b/lib/vapi/tools/client.rb index 7384ec2b..4b939487 100644 --- a/lib/vapi/tools/client.rb +++ b/lib/vapi/tools/client.rb @@ -10,6 +10,9 @@ def initialize(client:) @client = client end + # Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and + # limit the number returned. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -62,6 +65,8 @@ def list(request_options: {}, **params) raise error_class.new(response.body, code: code) end + # Creates a reusable tool that assistants can invoke during conversations. + # # @param request_options [Hash] # @param params [Vapi::Tools::Types::CreateToolsRequest] # @option request_options [String] :base_url @@ -94,6 +99,8 @@ def create(request_options: {}, **params) end end + # Returns the tool identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -126,6 +133,8 @@ def get(request_options: {}, **params) end end + # Deletes the tool identified by its ID. + # # @param request_options [Hash] # @param params [Hash] # @option request_options [String] :base_url @@ -158,6 +167,8 @@ def delete(request_options: {}, **params) end end + # Updates the specified fields of the tool identified by its ID. + # # @param request_options [Hash] # @param params [Vapi::Tools::Types::UpdateToolsRequestBody] # @option request_options [String] :base_url diff --git a/lib/vapi/types/ai_edge_condition.rb b/lib/vapi/types/ai_edge_condition.rb index 05272e7a..a3cfd4aa 100644 --- a/lib/vapi/types/ai_edge_condition.rb +++ b/lib/vapi/types/ai_edge_condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An AI-evaluated boolean condition that determines whether a workflow follows an edge. class AiEdgeCondition < Internal::Types::Model field :type, -> { Vapi::Types::AiEdgeConditionType }, optional: false, nullable: false field :prompt, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/analysis.rb b/lib/vapi/types/analysis.rb index 428287ee..5446f23f 100644 --- a/lib/vapi/types/analysis.rb +++ b/lib/vapi/types/analysis.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Post-call analysis results, including summary, structured data, and success evaluation outputs. class Analysis < Internal::Types::Model field :summary, -> { String }, optional: true, nullable: false field :structured_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "structuredData" diff --git a/lib/vapi/types/analysis_cost.rb b/lib/vapi/types/analysis_cost.rb index e3183041..fefa94fa 100644 --- a/lib/vapi/types/analysis_cost.rb +++ b/lib/vapi/types/analysis_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Cost for an individual analysis request, including analysis type, model, token usage, and amount. class AnalysisCost < Internal::Types::Model field :analysis_type, -> { Vapi::Types::AnalysisCostAnalysisType }, optional: false, nullable: false, api_name: "analysisType" field :model, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false diff --git a/lib/vapi/types/analysis_cost_breakdown.rb b/lib/vapi/types/analysis_cost_breakdown.rb index 1bdf37ed..f5a0afaf 100644 --- a/lib/vapi/types/analysis_cost_breakdown.rb +++ b/lib/vapi/types/analysis_cost_breakdown.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Analysis costs and token usage grouped by summary, structured data, success evaluation, and structured-output + # generation. class AnalysisCostBreakdown < Internal::Types::Model field :summary, -> { Integer }, optional: true, nullable: false field :summary_prompt_tokens, -> { Integer }, optional: true, nullable: false, api_name: "summaryPromptTokens" diff --git a/lib/vapi/types/analysis_plan.rb b/lib/vapi/types/analysis_plan.rb index 9a7a4674..5086a368 100644 --- a/lib/vapi/types/analysis_plan.rb +++ b/lib/vapi/types/analysis_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for post-call analysis of summaries, structured-data extraction, success evaluation, and outcomes. class AnalysisPlan < Internal::Types::Model field :min_messages_threshold, -> { Integer }, optional: true, nullable: false, api_name: "minMessagesThreshold" field :summary_plan, -> { Vapi::Types::SummaryPlan }, optional: true, nullable: false, api_name: "summaryPlan" diff --git a/lib/vapi/types/analytics_operation.rb b/lib/vapi/types/analytics_operation.rb index 67bd6858..da4d472b 100644 --- a/lib/vapi/types/analytics_operation.rb +++ b/lib/vapi/types/analytics_operation.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An aggregation or history operation applied to an analytics column, with an optional response alias. class AnalyticsOperation < Internal::Types::Model field :operation, -> { Vapi::Types::AnalyticsOperationOperation }, optional: false, nullable: false field :column, -> { Vapi::Types::AnalyticsOperationColumn }, optional: false, nullable: false diff --git a/lib/vapi/types/analytics_query.rb b/lib/vapi/types/analytics_query.rb index 790c2349..34b9c85e 100644 --- a/lib/vapi/types/analytics_query.rb +++ b/lib/vapi/types/analytics_query.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A named analytics query against call or subscription data, including grouping, time range, and aggregation + # operations. class AnalyticsQuery < Internal::Types::Model field :table, -> { Vapi::Types::AnalyticsQueryTable }, optional: false, nullable: false field :group_by, -> { Internal::Types::Array[Vapi::Types::AnalyticsQueryGroupByItem] }, optional: true, nullable: false, api_name: "groupBy" diff --git a/lib/vapi/types/analytics_query_result.rb b/lib/vapi/types/analytics_query_result.rb index 7ec69e30..0e0606ad 100644 --- a/lib/vapi/types/analytics_query_result.rb +++ b/lib/vapi/types/analytics_query_result.rb @@ -2,6 +2,7 @@ module Vapi module Types + # The result of a named analytics query, including the evaluated time range and returned metric data. class AnalyticsQueryResult < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :time_range, -> { Vapi::Types::TimeRange }, optional: false, nullable: false, api_name: "timeRange" diff --git a/lib/vapi/types/anthropic_bedrock_model.rb b/lib/vapi/types/anthropic_bedrock_model.rb index 7f1fda36..0f118b8e 100644 --- a/lib/vapi/types/anthropic_bedrock_model.rb +++ b/lib/vapi/types/anthropic_bedrock_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Anthropic models through Amazon Bedrock, including model, + # prompts, tools, knowledge-base access, reasoning, and generation settings. class AnthropicBedrockModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::AnthropicBedrockModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/anthropic_model.rb b/lib/vapi/types/anthropic_model.rb index d4f44bbc..670b031a 100644 --- a/lib/vapi/types/anthropic_model.rb +++ b/lib/vapi/types/anthropic_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Anthropic, including model, prompts, tools, knowledge-base + # access, reasoning, and generation settings. class AnthropicModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::AnthropicModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/anthropic_thinking_config.rb b/lib/vapi/types/anthropic_thinking_config.rb index 75b3a9b8..cd00d592 100644 --- a/lib/vapi/types/anthropic_thinking_config.rb +++ b/lib/vapi/types/anthropic_thinking_config.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Enables Anthropic extended thinking with a maximum thinking-token budget. class AnthropicThinkingConfig < Internal::Types::Model field :type, -> { Vapi::Types::AnthropicThinkingConfigType }, optional: false, nullable: false field :budget_tokens, -> { Integer }, optional: false, nullable: false, api_name: "budgetTokens" diff --git a/lib/vapi/types/anyscale_model.rb b/lib/vapi/types/anyscale_model.rb index f396d41e..b916a31f 100644 --- a/lib/vapi/types/anyscale_model.rb +++ b/lib/vapi/types/anyscale_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Anyscale, including model, prompts, tools, knowledge-base + # access, and generation settings. class AnyscaleModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::AnyscaleModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/api_request_tool.rb b/lib/vapi/types/api_request_tool.rb index 9824409c..e1c9e50b 100644 --- a/lib/vapi/types/api_request_tool.rb +++ b/lib/vapi/types/api_request_tool.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract + # variables from responses. class ApiRequestTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::ApiRequestToolMessagesItem] }, optional: true, nullable: false field :method_, -> { Vapi::Types::ApiRequestToolMethod }, optional: false, nullable: false, api_name: "method" diff --git a/lib/vapi/types/artifact.rb b/lib/vapi/types/artifact.rb index dcd389fd..ff9b9aeb 100644 --- a/lib/vapi/types/artifact.rb +++ b/lib/vapi/types/artifact.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::ArtifactMessagesItem] }, optional: true, nullable: false field :messages_open_ai_formatted, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false, api_name: "messagesOpenAIFormatted" diff --git a/lib/vapi/types/artifact_plan.rb b/lib/vapi/types/artifact_plan.rb index 9d33dd43..c66da13b 100644 --- a/lib/vapi/types/artifact_plan.rb +++ b/lib/vapi/types/artifact_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls artifacts generated and stored for calls, including recordings, packet captures, logs, transcripts, + # structured outputs, scorecards, and custom storage paths. class ArtifactPlan < Internal::Types::Model field :recording_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "recordingEnabled" field :recording_format, -> { Vapi::Types::ArtifactPlanRecordingFormat }, optional: true, nullable: false, api_name: "recordingFormat" diff --git a/lib/vapi/types/assembly_ai_transcriber.rb b/lib/vapi/types/assembly_ai_transcriber.rb index e71da35c..df918e2e 100644 --- a/lib/vapi/types/assembly_ai_transcriber.rb +++ b/lib/vapi/types/assembly_ai_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with AssemblyAI, including language, + # streaming model, endpointing, vocabulary, and fallback settings. class AssemblyAiTranscriber < Internal::Types::Model field :language, -> { Vapi::Types::AssemblyAiTranscriberLanguage }, optional: true, nullable: false field :confidence_threshold, -> { Integer }, optional: true, nullable: false, api_name: "confidenceThreshold" diff --git a/lib/vapi/types/assistant.rb b/lib/vapi/types/assistant.rb index 705e13c7..e20cdc57 100644 --- a/lib/vapi/types/assistant.rb +++ b/lib/vapi/types/assistant.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :transcriber, -> { Vapi::Types::AssistantTranscriber }, optional: true, nullable: false field :model, -> { Vapi::Types::AssistantModel }, optional: true, nullable: false diff --git a/lib/vapi/types/assistant_activation.rb b/lib/vapi/types/assistant_activation.rb index 7e3ed4b5..73081264 100644 --- a/lib/vapi/types/assistant_activation.rb +++ b/lib/vapi/types/assistant_activation.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Identifies an assistant that became active during a call. class AssistantActivation < Internal::Types::Model field :assistant_name, -> { String }, optional: false, nullable: false, api_name: "assistantName" field :assistant_id, -> { String }, optional: true, nullable: false, api_name: "assistantId" diff --git a/lib/vapi/types/assistant_custom_endpointing_rule.rb b/lib/vapi/types/assistant_custom_endpointing_rule.rb index 445fab76..5ca380b6 100644 --- a/lib/vapi/types/assistant_custom_endpointing_rule.rb +++ b/lib/vapi/types/assistant_custom_endpointing_rule.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A custom endpointing rule that matches the assistant's last message and applies a configured timeout. class AssistantCustomEndpointingRule < Internal::Types::Model field :regex, -> { String }, optional: false, nullable: false field :regex_options, -> { Internal::Types::Array[Vapi::Types::RegexOption] }, optional: true, nullable: false, api_name: "regexOptions" diff --git a/lib/vapi/types/assistant_message.rb b/lib/vapi/types/assistant_message.rb index 9284c477..06ac85ff 100644 --- a/lib/vapi/types/assistant_message.rb +++ b/lib/vapi/types/assistant_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An assistant-authored message, including content, refusal text, tool calls, participant name, and metadata. class AssistantMessage < Internal::Types::Model field :role, -> { Vapi::Types::AssistantMessageRole }, optional: false, nullable: false field :content, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/assistant_message_evaluation_continue_plan.rb b/lib/vapi/types/assistant_message_evaluation_continue_plan.rb index 07d5fea7..6b7d0eda 100644 --- a/lib/vapi/types/assistant_message_evaluation_continue_plan.rb +++ b/lib/vapi/types/assistant_message_evaluation_continue_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls how an evaluation proceeds after judging an assistant message, including failure handling and optional + # message overrides. class AssistantMessageEvaluationContinuePlan < Internal::Types::Model field :exit_on_failure_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "exitOnFailureEnabled" field :content_override, -> { String }, optional: true, nullable: false, api_name: "contentOverride" diff --git a/lib/vapi/types/assistant_message_judge_plan_ai.rb b/lib/vapi/types/assistant_message_judge_plan_ai.rb index 5e820c84..0d2647b1 100644 --- a/lib/vapi/types/assistant_message_judge_plan_ai.rb +++ b/lib/vapi/types/assistant_message_judge_plan_ai.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Evaluates an assistant message with an LLM judge and a configured evaluation model. class AssistantMessageJudgePlanAi < Internal::Types::Model field :model, -> { Vapi::Types::AssistantMessageJudgePlanAiModel }, optional: false, nullable: false field :type, -> { Vapi::Types::AssistantMessageJudgePlanAiType }, optional: false, nullable: false diff --git a/lib/vapi/types/assistant_message_judge_plan_exact.rb b/lib/vapi/types/assistant_message_judge_plan_exact.rb index a7ef0955..e5df0c12 100644 --- a/lib/vapi/types/assistant_message_judge_plan_exact.rb +++ b/lib/vapi/types/assistant_message_judge_plan_exact.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Evaluates an assistant message using case-insensitive exact content matching and expected tool calls. class AssistantMessageJudgePlanExact < Internal::Types::Model field :content, -> { String }, optional: false, nullable: false field :tool_calls, -> { Internal::Types::Array[Vapi::Types::ChatEvalAssistantMessageMockToolCall] }, optional: true, nullable: false, api_name: "toolCalls" diff --git a/lib/vapi/types/assistant_message_judge_plan_regex.rb b/lib/vapi/types/assistant_message_judge_plan_regex.rb index acefdaaf..07e7b813 100644 --- a/lib/vapi/types/assistant_message_judge_plan_regex.rb +++ b/lib/vapi/types/assistant_message_judge_plan_regex.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Evaluates assistant-message content and tool-call arguments using regular-expression patterns. class AssistantMessageJudgePlanRegex < Internal::Types::Model field :content, -> { String }, optional: false, nullable: false field :tool_calls, -> { Internal::Types::Array[Vapi::Types::ChatEvalAssistantMessageMockToolCall] }, optional: true, nullable: false, api_name: "toolCalls" diff --git a/lib/vapi/types/assistant_overrides.rb b/lib/vapi/types/assistant_overrides.rb index 41101a8a..f1b53721 100644 --- a/lib/vapi/types/assistant_overrides.rb +++ b/lib/vapi/types/assistant_overrides.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Per-call or handoff overrides for an assistant's providers, messages, tools, credentials, call behavior, and + # server configuration. class AssistantOverrides < Internal::Types::Model field :transcriber, -> { Vapi::Types::AssistantOverridesTranscriber }, optional: true, nullable: false field :model, -> { Vapi::Types::AssistantOverridesModel }, optional: true, nullable: false diff --git a/lib/vapi/types/aws_sts_authentication_plan.rb b/lib/vapi/types/aws_sts_authentication_plan.rb index a8877281..95f360e1 100644 --- a/lib/vapi/types/aws_sts_authentication_plan.rb +++ b/lib/vapi/types/aws_sts_authentication_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # AWS Security Token Service role-assumption configuration used to authenticate requests. class AwsStsAuthenticationPlan < Internal::Types::Model field :role_arn, -> { String }, optional: false, nullable: false, api_name: "roleArn" field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId" diff --git a/lib/vapi/types/awsiam_credentials_authentication_plan.rb b/lib/vapi/types/awsiam_credentials_authentication_plan.rb index 28b47c95..e9040cbb 100644 --- a/lib/vapi/types/awsiam_credentials_authentication_plan.rb +++ b/lib/vapi/types/awsiam_credentials_authentication_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Direct AWS IAM credentials used to authenticate requests. class AwsiamCredentialsAuthenticationPlan < Internal::Types::Model field :aws_access_key_id, -> { String }, optional: false, nullable: false, api_name: "awsAccessKeyId" field :aws_secret_access_key, -> { String }, optional: false, nullable: false, api_name: "awsSecretAccessKey" diff --git a/lib/vapi/types/azure_blob_storage_bucket_plan.rb b/lib/vapi/types/azure_blob_storage_bucket_plan.rb index db439bca..d0aec19b 100644 --- a/lib/vapi/types/azure_blob_storage_bucket_plan.rb +++ b/lib/vapi/types/azure_blob_storage_bucket_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Azure Blob Storage container configuration for call artifacts, including its connection string, container name, + # and storage path. class AzureBlobStorageBucketPlan < Internal::Types::Model field :connection_string, -> { String }, optional: false, nullable: false, api_name: "connectionString" field :container_name, -> { String }, optional: false, nullable: false, api_name: "containerName" diff --git a/lib/vapi/types/azure_speech_transcriber.rb b/lib/vapi/types/azure_speech_transcriber.rb index 13ac7cf2..31a56879 100644 --- a/lib/vapi/types/azure_speech_transcriber.rb +++ b/lib/vapi/types/azure_speech_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Azure Speech, including language, + # segmentation, and fallback settings. class AzureSpeechTranscriber < Internal::Types::Model field :language, -> { Vapi::Types::AzureSpeechTranscriberLanguage }, optional: true, nullable: false field :segmentation_strategy, -> { Vapi::Types::AzureSpeechTranscriberSegmentationStrategy }, optional: true, nullable: false, api_name: "segmentationStrategy" diff --git a/lib/vapi/types/azure_voice.rb b/lib/vapi/types/azure_voice.rb index 15edd4b5..9b0ecd28 100644 --- a/lib/vapi/types/azure_voice.rb +++ b/lib/vapi/types/azure_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, caching, + # and fallback settings. class AzureVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::AzureVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/background_speech_denoising_plan.rb b/lib/vapi/types/background_speech_denoising_plan.rb index 1307612f..f2e6f91d 100644 --- a/lib/vapi/types/background_speech_denoising_plan.rb +++ b/lib/vapi/types/background_speech_denoising_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls smart and Fourier denoising applied to customer audio before transcription. class BackgroundSpeechDenoisingPlan < Internal::Types::Model field :smart_denoising_plan, -> { Vapi::Types::SmartDenoisingPlan }, optional: true, nullable: false, api_name: "smartDenoisingPlan" field :fourier_denoising_plan, -> { Vapi::Types::FourierDenoisingPlan }, optional: true, nullable: false, api_name: "fourierDenoisingPlan" diff --git a/lib/vapi/types/backoff_plan.rb b/lib/vapi/types/backoff_plan.rb index bb918f63..31e20974 100644 --- a/lib/vapi/types/backoff_plan.rb +++ b/lib/vapi/types/backoff_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls retry behavior for failed server requests, including strategy, maximum retries, base delay, and status + # codes excluded from retries. class BackoffPlan < Internal::Types::Model field :type, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false field :max_retries, -> { Integer }, optional: false, nullable: false, api_name: "maxRetries" diff --git a/lib/vapi/types/bar_insight.rb b/lib/vapi/types/bar_insight.rb index 7bcd5be6..ca3a0843 100644 --- a/lib/vapi/types/bar_insight.rb +++ b/lib/vapi/types/bar_insight.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved bar-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and + # lifecycle information. class BarInsight < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/bar_insight_metadata.rb b/lib/vapi/types/bar_insight_metadata.rb index fd5cfef9..b2a15901 100644 --- a/lib/vapi/types/bar_insight_metadata.rb +++ b/lib/vapi/types/bar_insight_metadata.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Display settings for a bar insight, including chart name, axis labels, and optional y-axis bounds. class BarInsightMetadata < Internal::Types::Model field :x_axis_label, -> { String }, optional: true, nullable: false, api_name: "xAxisLabel" field :y_axis_label, -> { String }, optional: true, nullable: false, api_name: "yAxisLabel" diff --git a/lib/vapi/types/bash_tool.rb b/lib/vapi/types/bash_tool.rb index c7567216..6fdfda10 100644 --- a/lib/vapi/types/bash_tool.rb +++ b/lib/vapi/types/bash_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that executes shell commands in a configured environment. class BashTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::BashToolMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::BashToolSubType }, optional: false, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/bearer_authentication_plan.rb b/lib/vapi/types/bearer_authentication_plan.rb index 0490a9bd..acd97622 100644 --- a/lib/vapi/types/bearer_authentication_plan.rb +++ b/lib/vapi/types/bearer_authentication_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for authenticating outbound requests with a bearer token, including header name and optional + # `Bearer` prefix. class BearerAuthenticationPlan < Internal::Types::Model field :token, -> { String }, optional: false, nullable: false field :header_name, -> { String }, optional: true, nullable: false, api_name: "headerName" diff --git a/lib/vapi/types/bot_message.rb b/lib/vapi/types/bot_message.rb index 492ef100..08cce844 100644 --- a/lib/vapi/types/bot_message.rb +++ b/lib/vapi/types/bot_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An assistant-authored entry in the call message history, including content, timing, source, and duration. class BotMessage < Internal::Types::Model field :role, -> { String }, optional: false, nullable: false field :message, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/both_custom_endpointing_rule.rb b/lib/vapi/types/both_custom_endpointing_rule.rb index aeb6aed0..fdbdc93b 100644 --- a/lib/vapi/types/both_custom_endpointing_rule.rb +++ b/lib/vapi/types/both_custom_endpointing_rule.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :assistant_regex, -> { String }, optional: false, nullable: false, api_name: "assistantRegex" field :assistant_regex_options, -> { Internal::Types::Array[Vapi::Types::RegexOption] }, optional: true, nullable: false, api_name: "assistantRegexOptions" diff --git a/lib/vapi/types/bucket_plan.rb b/lib/vapi/types/bucket_plan.rb index 54181e94..47494b96 100644 --- a/lib/vapi/types/bucket_plan.rb +++ b/lib/vapi/types/bucket_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Google Cloud Storage bucket configuration for call artifacts, including bucket name, region, path, and optional + # HMAC credentials. class BucketPlan < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :region, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/byo_phone_number.rb b/lib/vapi/types/byo_phone_number.rb index daa6ca25..bff21fea 100644 --- a/lib/vapi/types/byo_phone_number.rb +++ b/lib/vapi/types/byo_phone_number.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::ByoPhoneNumberFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::ByoPhoneNumberHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/call.rb b/lib/vapi/types/call.rb index 1dd5b2f1..e0bea0a1 100644 --- a/lib/vapi/types/call.rb +++ b/lib/vapi/types/call.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :type, -> { Vapi::Types::CallType }, optional: true, nullable: false field :costs, -> { Internal::Types::Array[Vapi::Types::CallCostsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/call_batch_error.rb b/lib/vapi/types/call_batch_error.rb index 177e1f6b..7aa64f50 100644 --- a/lib/vapi/types/call_batch_error.rb +++ b/lib/vapi/types/call_batch_error.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Error returned for one customer entry in a batch call request. class CallBatchError < Internal::Types::Model field :customer, -> { Vapi::Types::CreateCustomerDto }, optional: false, nullable: false field :error, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/call_batch_response.rb b/lib/vapi/types/call_batch_response.rb index 129afac8..119bef1b 100644 --- a/lib/vapi/types/call_batch_response.rb +++ b/lib/vapi/types/call_batch_response.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :subscription_limits, -> { Vapi::Types::SubscriptionLimits }, optional: true, nullable: false, api_name: "subscriptionLimits" field :results, -> { Internal::Types::Array[Vapi::Types::Call] }, optional: false, nullable: false diff --git a/lib/vapi/types/call_hook_assistant_speech_interrupted.rb b/lib/vapi/types/call_hook_assistant_speech_interrupted.rb index af1dcdc6..0beb5177 100644 --- a/lib/vapi/types/call_hook_assistant_speech_interrupted.rb +++ b/lib/vapi/types/call_hook_assistant_speech_interrupted.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Runs configured actions when the customer's speech interrupts the assistant. class CallHookAssistantSpeechInterrupted < Internal::Types::Model field :on, -> { Vapi::Types::CallHookAssistantSpeechInterruptedOn }, optional: false, nullable: false field :do_, -> { Internal::Types::Array[Vapi::Types::CallHookAssistantSpeechInterruptedDoItem] }, optional: false, nullable: false, api_name: "do" diff --git a/lib/vapi/types/call_hook_call_ending.rb b/lib/vapi/types/call_hook_call_ending.rb index 91e09bf6..c403bff2 100644 --- a/lib/vapi/types/call_hook_call_ending.rb +++ b/lib/vapi/types/call_hook_call_ending.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Runs configured actions when a call is ending, optionally only when its filters match. class CallHookCallEnding < Internal::Types::Model field :on, -> { Vapi::Types::CallHookCallEndingOn }, optional: false, nullable: false field :do_, -> { Internal::Types::Array[Vapi::Types::CallHookCallEndingDoItem] }, optional: false, nullable: false, api_name: "do" diff --git a/lib/vapi/types/call_hook_customer_speech_interrupted.rb b/lib/vapi/types/call_hook_customer_speech_interrupted.rb index f1520273..fafe01e2 100644 --- a/lib/vapi/types/call_hook_customer_speech_interrupted.rb +++ b/lib/vapi/types/call_hook_customer_speech_interrupted.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Runs configured actions when the assistant interrupts the customer's speech. class CallHookCustomerSpeechInterrupted < Internal::Types::Model field :on, -> { Vapi::Types::CallHookCustomerSpeechInterruptedOn }, optional: false, nullable: false field :do_, -> { Internal::Types::Array[Vapi::Types::CallHookCustomerSpeechInterruptedDoItem] }, optional: false, nullable: false, api_name: "do" diff --git a/lib/vapi/types/call_hook_customer_speech_timeout.rb b/lib/vapi/types/call_hook_customer_speech_timeout.rb index 8f53b1e1..d807485f 100644 --- a/lib/vapi/types/call_hook_customer_speech_timeout.rb +++ b/lib/vapi/types/call_hook_customer_speech_timeout.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Runs configured actions when the customer does not speak before the configured timeout, with support for trigger + # limits and named instances. class CallHookCustomerSpeechTimeout < Internal::Types::Model field :on, -> { String }, optional: false, nullable: false field :do_, -> { Internal::Types::Array[Vapi::Types::CallHookCustomerSpeechTimeoutDoItem] }, optional: false, nullable: false, api_name: "do" diff --git a/lib/vapi/types/call_hook_filter.rb b/lib/vapi/types/call_hook_filter.rb index e101729a..f9bc911d 100644 --- a/lib/vapi/types/call_hook_filter.rb +++ b/lib/vapi/types/call_hook_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Matches a call field against one or more allowed values to determine whether a hook runs. class CallHookFilter < Internal::Types::Model field :type, -> { Vapi::Types::CallHookFilterType }, optional: false, nullable: false field :key, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/call_hook_model_response_timeout.rb b/lib/vapi/types/call_hook_model_response_timeout.rb index 23544b38..d4738d4f 100644 --- a/lib/vapi/types/call_hook_model_response_timeout.rb +++ b/lib/vapi/types/call_hook_model_response_timeout.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Runs configured actions when the language model does not respond before its timeout. class CallHookModelResponseTimeout < Internal::Types::Model field :on, -> { Vapi::Types::CallHookModelResponseTimeoutOn }, optional: false, nullable: false field :do_, -> { Internal::Types::Array[Vapi::Types::CallHookModelResponseTimeoutDoItem] }, optional: false, nullable: false, api_name: "do" diff --git a/lib/vapi/types/campaign.rb b/lib/vapi/types/campaign.rb index 61961088..3ea863ea 100644 --- a/lib/vapi/types/campaign.rb +++ b/lib/vapi/types/campaign.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved outbound calling campaign, including its calling configuration, schedule, status, customers, calls, and + # call-progress counters. class Campaign < Internal::Types::Model field :status, -> { Vapi::Types::CampaignStatus }, optional: false, nullable: false field :ended_reason, -> { Vapi::Types::CampaignEndedReason }, optional: true, nullable: false, api_name: "endedReason" diff --git a/lib/vapi/types/campaign_paginated_response.rb b/lib/vapi/types/campaign_paginated_response.rb index 3adba4a9..d6c68fd0 100644 --- a/lib/vapi/types/campaign_paginated_response.rb +++ b/lib/vapi/types/campaign_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of outbound calling campaigns and metadata describing the result set. class CampaignPaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::Campaign] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/cartesia_experimental_controls.rb b/lib/vapi/types/cartesia_experimental_controls.rb index 0dd63994..d3389dae 100644 --- a/lib/vapi/types/cartesia_experimental_controls.rb +++ b/lib/vapi/types/cartesia_experimental_controls.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Cartesia voice controls for speed and emotion. class CartesiaExperimentalControls < Internal::Types::Model field :speed, -> { Vapi::Types::CartesiaSpeedControl }, optional: true, nullable: false field :emotion, -> { Vapi::Types::CartesiaExperimentalControlsEmotion }, optional: true, nullable: false diff --git a/lib/vapi/types/cartesia_generation_config.rb b/lib/vapi/types/cartesia_generation_config.rb index 27276e30..06359f5f 100644 --- a/lib/vapi/types/cartesia_generation_config.rb +++ b/lib/vapi/types/cartesia_generation_config.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Generation controls for Cartesia Sonic 3 voices, including speed, volume, and accent localization. class CartesiaGenerationConfig < Internal::Types::Model field :speed, -> { Integer }, optional: true, nullable: false field :volume, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/cartesia_generation_config_experimental.rb b/lib/vapi/types/cartesia_generation_config_experimental.rb index 2bc2090a..6a4a0347 100644 --- a/lib/vapi/types/cartesia_generation_config_experimental.rb +++ b/lib/vapi/types/cartesia_generation_config_experimental.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Cartesia Sonic 3 generation controls, including accent localization. class CartesiaGenerationConfigExperimental < Internal::Types::Model field :accent_localization, -> { Integer }, optional: true, nullable: false, api_name: "accentLocalization" end diff --git a/lib/vapi/types/cartesia_speed_control.rb b/lib/vapi/types/cartesia_speed_control.rb index cab210b9..700d4492 100644 --- a/lib/vapi/types/cartesia_speed_control.rb +++ b/lib/vapi/types/cartesia_speed_control.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Speaking-speed control expressed as a preset or a value from -1 to 1. class CartesiaSpeedControl < Internal::Types::Model extend Vapi::Internal::Types::Union diff --git a/lib/vapi/types/cartesia_transcriber.rb b/lib/vapi/types/cartesia_transcriber.rb index 148ca762..431f6da0 100644 --- a/lib/vapi/types/cartesia_transcriber.rb +++ b/lib/vapi/types/cartesia_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Cartesia, including model, language, and + # fallback settings. class CartesiaTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::CartesiaTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::CartesiaTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/cartesia_voice.rb b/lib/vapi/types/cartesia_voice.rb index 3fd41ec7..04974de9 100644 --- a/lib/vapi/types/cartesia_voice.rb +++ b/lib/vapi/types/cartesia_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, + # generation controls, pronunciation dictionaries, chunking, caching, and fallback settings. class CartesiaVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/cerebras_model.rb b/lib/vapi/types/cerebras_model.rb index 79e895bd..0c244e50 100644 --- a/lib/vapi/types/cerebras_model.rb +++ b/lib/vapi/types/cerebras_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Cerebras, including model, prompts, tools, knowledge-base + # access, and generation settings. class CerebrasModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::CerebrasModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/chat_eval_assistant_message_evaluation.rb b/lib/vapi/types/chat_eval_assistant_message_evaluation.rb index 1e0a283c..cce14069 100644 --- a/lib/vapi/types/chat_eval_assistant_message_evaluation.rb +++ b/lib/vapi/types/chat_eval_assistant_message_evaluation.rb @@ -2,6 +2,8 @@ module Vapi module Types + # An expected assistant turn in an evaluation, including the judge plan and how the evaluation should continue + # afterward. class ChatEvalAssistantMessageEvaluation < Internal::Types::Model field :role, -> { Vapi::Types::ChatEvalAssistantMessageEvaluationRole }, optional: false, nullable: false field :judge_plan, -> { Vapi::Types::ChatEvalAssistantMessageEvaluationJudgePlan }, optional: false, nullable: false, api_name: "judgePlan" diff --git a/lib/vapi/types/chat_eval_assistant_message_mock.rb b/lib/vapi/types/chat_eval_assistant_message_mock.rb index 22a74732..73a89f5e 100644 --- a/lib/vapi/types/chat_eval_assistant_message_mock.rb +++ b/lib/vapi/types/chat_eval_assistant_message_mock.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A simulated assistant turn in an evaluation conversation, with optional message content and tool calls. class ChatEvalAssistantMessageMock < Internal::Types::Model field :role, -> { Vapi::Types::ChatEvalAssistantMessageMockRole }, optional: false, nullable: false field :content, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/chat_eval_assistant_message_mock_tool_call.rb b/lib/vapi/types/chat_eval_assistant_message_mock_tool_call.rb index 893dba5c..cad78b82 100644 --- a/lib/vapi/types/chat_eval_assistant_message_mock_tool_call.rb +++ b/lib/vapi/types/chat_eval_assistant_message_mock_tool_call.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A simulated assistant tool call with the tool name and optional arguments. class ChatEvalAssistantMessageMockToolCall < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :arguments, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false diff --git a/lib/vapi/types/chat_eval_system_message_mock.rb b/lib/vapi/types/chat_eval_system_message_mock.rb index e253597f..d1096fb3 100644 --- a/lib/vapi/types/chat_eval_system_message_mock.rb +++ b/lib/vapi/types/chat_eval_system_message_mock.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A simulated system message in an evaluation conversation. class ChatEvalSystemMessageMock < Internal::Types::Model field :role, -> { Vapi::Types::ChatEvalSystemMessageMockRole }, optional: false, nullable: false field :content, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/chat_eval_tool_response_message_evaluation.rb b/lib/vapi/types/chat_eval_tool_response_message_evaluation.rb index cb6260d6..7952f800 100644 --- a/lib/vapi/types/chat_eval_tool_response_message_evaluation.rb +++ b/lib/vapi/types/chat_eval_tool_response_message_evaluation.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An expected tool-response turn evaluated by a configured LLM judge. class ChatEvalToolResponseMessageEvaluation < Internal::Types::Model field :role, -> { Vapi::Types::ChatEvalToolResponseMessageEvaluationRole }, optional: false, nullable: false field :judge_plan, -> { Vapi::Types::AssistantMessageJudgePlanAi }, optional: false, nullable: false, api_name: "judgePlan" diff --git a/lib/vapi/types/chat_eval_tool_response_message_mock.rb b/lib/vapi/types/chat_eval_tool_response_message_mock.rb index 056cb371..eaccdd66 100644 --- a/lib/vapi/types/chat_eval_tool_response_message_mock.rb +++ b/lib/vapi/types/chat_eval_tool_response_message_mock.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A simulated tool response in an evaluation conversation. class ChatEvalToolResponseMessageMock < Internal::Types::Model field :role, -> { Vapi::Types::ChatEvalToolResponseMessageMockRole }, optional: false, nullable: false field :content, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/chat_eval_user_message_mock.rb b/lib/vapi/types/chat_eval_user_message_mock.rb index 0705dea2..24756d19 100644 --- a/lib/vapi/types/chat_eval_user_message_mock.rb +++ b/lib/vapi/types/chat_eval_user_message_mock.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A simulated user message in an evaluation conversation. class ChatEvalUserMessageMock < Internal::Types::Model field :role, -> { Vapi::Types::ChatEvalUserMessageMockRole }, optional: false, nullable: false field :content, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/chunk_plan.rb b/lib/vapi/types/chunk_plan.rb index b77743ed..b64d0b23 100644 --- a/lib/vapi/types/chunk_plan.rb +++ b/lib/vapi/types/chunk_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls how model output is split into chunks before voice synthesis, including minimum length, punctuation + # boundaries, and formatting. class ChunkPlan < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false field :min_characters, -> { Integer }, optional: true, nullable: false, api_name: "minCharacters" diff --git a/lib/vapi/types/cloudflare_r_2_bucket_plan.rb b/lib/vapi/types/cloudflare_r_2_bucket_plan.rb index 70f96a0e..65bd8ebe 100644 --- a/lib/vapi/types/cloudflare_r_2_bucket_plan.rb +++ b/lib/vapi/types/cloudflare_r_2_bucket_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Cloudflare R2 bucket configuration for call-artifact storage, including access keys, base URL, bucket name, and + # path. class CloudflareR2BucketPlan < Internal::Types::Model field :access_key_id, -> { String }, optional: true, nullable: false, api_name: "accessKeyId" field :secret_access_key, -> { String }, optional: true, nullable: false, api_name: "secretAccessKey" diff --git a/lib/vapi/types/code_tool.rb b/lib/vapi/types/code_tool.rb index 7cc043d2..d3fc6b87 100644 --- a/lib/vapi/types/code_tool.rb +++ b/lib/vapi/types/code_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout. class CodeTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CodeToolMessagesItem] }, optional: true, nullable: false field :async, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/code_tool_environment_variable.rb b/lib/vapi/types/code_tool_environment_variable.rb index d083b009..062eeb1b 100644 --- a/lib/vapi/types/code_tool_environment_variable.rb +++ b/lib/vapi/types/code_tool_environment_variable.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An environment variable supplied to code-tool execution, with support for Liquid templates in its value. class CodeToolEnvironmentVariable < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :value, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/compliance.rb b/lib/vapi/types/compliance.rb index 26ad645d..81ed6aa0 100644 --- a/lib/vapi/types/compliance.rb +++ b/lib/vapi/types/compliance.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Compliance information captured for a call, including recording consent. class Compliance < Internal::Types::Model field :recording_consent, -> { Vapi::Types::RecordingConsent }, optional: true, nullable: false, api_name: "recordingConsent" end diff --git a/lib/vapi/types/compliance_override.rb b/lib/vapi/types/compliance_override.rb index 543434ed..e34ebc63 100644 --- a/lib/vapi/types/compliance_override.rb +++ b/lib/vapi/types/compliance_override.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Overrides storage behavior for an output when HIPAA compliance is enabled. class ComplianceOverride < Internal::Types::Model field :force_store_on_hipaa_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "forceStoreOnHipaaEnabled" end diff --git a/lib/vapi/types/compliance_plan.rb b/lib/vapi/types/compliance_plan.rb index aee369e5..b5cfcc05 100644 --- a/lib/vapi/types/compliance_plan.rb +++ b/lib/vapi/types/compliance_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls HIPAA and PCI requirements, transcript security filtering, and recording-consent handling for assistant + # calls. class CompliancePlan < Internal::Types::Model field :hipaa_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "hipaaEnabled" field :pci_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "pciEnabled" diff --git a/lib/vapi/types/compliance_plan_recording_consent_plan.rb b/lib/vapi/types/compliance_plan_recording_consent_plan.rb index ec8aa820..4a1643bb 100644 --- a/lib/vapi/types/compliance_plan_recording_consent_plan.rb +++ b/lib/vapi/types/compliance_plan_recording_consent_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls how recording consent is requested before the assistant joins the call. class CompliancePlanRecordingConsentPlan < Internal::Types::Model extend Vapi::Internal::Types::Union diff --git a/lib/vapi/types/computer_tool.rb b/lib/vapi/types/computer_tool.rb index 28ffafd4..2f260735 100644 --- a/lib/vapi/types/computer_tool.rb +++ b/lib/vapi/types/computer_tool.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A reusable tool that lets the model interact with a computer display through screen, pointer, and keyboard + # actions. class ComputerTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::ComputerToolMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::ComputerToolSubType }, optional: false, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/condition.rb b/lib/vapi/types/condition.rb index ade5f899..56fb5fb1 100644 --- a/lib/vapi/types/condition.rb +++ b/lib/vapi/types/condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Compares a named parameter with a value using the selected comparison operator. class Condition < Internal::Types::Model field :operator, -> { Vapi::Types::ConditionOperator }, optional: false, nullable: false field :param, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/context_engineering_plan_all.rb b/lib/vapi/types/context_engineering_plan_all.rb index 312a36e3..c61c557b 100644 --- a/lib/vapi/types/context_engineering_plan_all.rb +++ b/lib/vapi/types/context_engineering_plan_all.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Includes all available messages when constructing context for a handoff. class ContextEngineeringPlanAll < Internal::Types::Model; end end end diff --git a/lib/vapi/types/context_engineering_plan_last_n_messages.rb b/lib/vapi/types/context_engineering_plan_last_n_messages.rb index 12fe76cb..ee5f718c 100644 --- a/lib/vapi/types/context_engineering_plan_last_n_messages.rb +++ b/lib/vapi/types/context_engineering_plan_last_n_messages.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Includes a configured number of the most recent messages when constructing context for a handoff. class ContextEngineeringPlanLastNMessages < Internal::Types::Model field :max_messages, -> { Integer }, optional: false, nullable: false, api_name: "maxMessages" end diff --git a/lib/vapi/types/context_engineering_plan_none.rb b/lib/vapi/types/context_engineering_plan_none.rb index 7dcbbb80..edc9ac7c 100644 --- a/lib/vapi/types/context_engineering_plan_none.rb +++ b/lib/vapi/types/context_engineering_plan_none.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Excludes prior conversation messages when constructing context for a handoff. class ContextEngineeringPlanNone < Internal::Types::Model; end end end diff --git a/lib/vapi/types/context_engineering_plan_user_and_assistant_messages.rb b/lib/vapi/types/context_engineering_plan_user_and_assistant_messages.rb index 2e0930ea..8b42b3e1 100644 --- a/lib/vapi/types/context_engineering_plan_user_and_assistant_messages.rb +++ b/lib/vapi/types/context_engineering_plan_user_and_assistant_messages.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Includes only user and assistant messages when constructing context for a handoff. class ContextEngineeringPlanUserAndAssistantMessages < Internal::Types::Model; end end end diff --git a/lib/vapi/types/conversation_node.rb b/lib/vapi/types/conversation_node.rb index 45c52695..f13f5bb8 100644 --- a/lib/vapi/types/conversation_node.rb +++ b/lib/vapi/types/conversation_node.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A workflow node where the assistant conducts a conversation using optional node-specific providers, tools, prompt, + # and variable extraction. class ConversationNode < Internal::Types::Model field :model, -> { Vapi::Types::ConversationNodeModel }, optional: true, nullable: false field :transcriber, -> { Vapi::Types::ConversationNodeTranscriber }, optional: true, nullable: false diff --git a/lib/vapi/types/cost_breakdown.rb b/lib/vapi/types/cost_breakdown.rb index 35778618..32bd5510 100644 --- a/lib/vapi/types/cost_breakdown.rb +++ b/lib/vapi/types/cost_breakdown.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Aggregated call costs and usage, including transport, transcription, model, voice, Vapi, analysis, token, and + # character totals. class CostBreakdown < Internal::Types::Model field :transport, -> { Integer }, optional: true, nullable: false field :stt, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/create_anthropic_bedrock_credential_dto.rb b/lib/vapi/types/create_anthropic_bedrock_credential_dto.rb index d172c145..4ec1e998 100644 --- a/lib/vapi/types/create_anthropic_bedrock_credential_dto.rb +++ b/lib/vapi/types/create_anthropic_bedrock_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for authenticating Anthropic model requests through Amazon Bedrock, including AWS region and + # authentication method. class CreateAnthropicBedrockCredentialDto < Internal::Types::Model field :region, -> { Vapi::Types::CreateAnthropicBedrockCredentialDtoRegion }, optional: false, nullable: false field :authentication_plan, -> { Vapi::Types::CreateAnthropicBedrockCredentialDtoAuthenticationPlan }, optional: false, nullable: false, api_name: "authenticationPlan" diff --git a/lib/vapi/types/create_anthropic_credential_dto.rb b/lib/vapi/types/create_anthropic_credential_dto.rb index 0cb92e68..154c0c6d 100644 --- a/lib/vapi/types/create_anthropic_credential_dto.rb +++ b/lib/vapi/types/create_anthropic_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Anthropic. class CreateAnthropicCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_anyscale_credential_dto.rb b/lib/vapi/types/create_anyscale_credential_dto.rb index db388401..77bd9b44 100644 --- a/lib/vapi/types/create_anyscale_credential_dto.rb +++ b/lib/vapi/types/create_anyscale_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Anyscale. class CreateAnyscaleCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_api_request_tool_dto.rb b/lib/vapi/types/create_api_request_tool_dto.rb index 705fdca0..6dc923ee 100644 --- a/lib/vapi/types/create_api_request_tool_dto.rb +++ b/lib/vapi/types/create_api_request_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateApiRequestToolDtoMessagesItem] }, optional: true, nullable: false field :method_, -> { Vapi::Types::CreateApiRequestToolDtoMethod }, optional: false, nullable: false, api_name: "method" diff --git a/lib/vapi/types/create_assembly_ai_credential_dto.rb b/lib/vapi/types/create_assembly_ai_credential_dto.rb index b0ab525f..f6268cfa 100644 --- a/lib/vapi/types/create_assembly_ai_credential_dto.rb +++ b/lib/vapi/types/create_assembly_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating transcription requests with AssemblyAI. class CreateAssemblyAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_assistant_dto.rb b/lib/vapi/types/create_assistant_dto.rb index 4c4d6956..31dbf317 100644 --- a/lib/vapi/types/create_assistant_dto.rb +++ b/lib/vapi/types/create_assistant_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create an assistant, including its model, voice, transcriber, prompts, tools, messaging, and + # conversation behavior. class CreateAssistantDto < Internal::Types::Model field :transcriber, -> { Vapi::Types::CreateAssistantDtoTranscriber }, optional: true, nullable: false field :model, -> { Vapi::Types::CreateAssistantDtoModel }, optional: true, nullable: false diff --git a/lib/vapi/types/create_azure_credential_dto.rb b/lib/vapi/types/create_azure_credential_dto.rb index bbe307f0..43a5e423 100644 --- a/lib/vapi/types/create_azure_credential_dto.rb +++ b/lib/vapi/types/create_azure_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for Azure Speech or Blob Storage, including service, region, and optional storage bucket settings. class CreateAzureCredentialDto < Internal::Types::Model field :service, -> { Vapi::Types::CreateAzureCredentialDtoService }, optional: false, nullable: false field :region, -> { Vapi::Types::CreateAzureCredentialDtoRegion }, optional: true, nullable: false diff --git a/lib/vapi/types/create_azure_open_ai_credential_dto.rb b/lib/vapi/types/create_azure_open_ai_credential_dto.rb index 52ab80d6..317cb758 100644 --- a/lib/vapi/types/create_azure_open_ai_credential_dto.rb +++ b/lib/vapi/types/create_azure_open_ai_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Azure OpenAI, including region, endpoint, and + # available models. class CreateAzureOpenAiCredentialDto < Internal::Types::Model field :region, -> { Vapi::Types::CreateAzureOpenAiCredentialDtoRegion }, optional: false, nullable: false field :models, -> { Internal::Types::Array[Vapi::Types::CreateAzureOpenAiCredentialDtoModelsItem] }, optional: false, nullable: false diff --git a/lib/vapi/types/create_bar_insight_from_call_table_dto.rb b/lib/vapi/types/create_bar_insight_from_call_table_dto.rb index 40c78329..9041e3f5 100644 --- a/lib/vapi/types/create_bar_insight_from_call_table_dto.rb +++ b/lib/vapi/types/create_bar_insight_from_call_table_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a bar-chart insight from call data using metric queries, formulas, grouping, and a + # stepped time range. class CreateBarInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_bash_tool_dto.rb b/lib/vapi/types/create_bash_tool_dto.rb index 6c06e7b5..bea250ce 100644 --- a/lib/vapi/types/create_bash_tool_dto.rb +++ b/lib/vapi/types/create_bash_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that executes shell commands in a configured environment. class CreateBashToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateBashToolDtoMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::CreateBashToolDtoSubType }, optional: false, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/create_byo_phone_number_dto.rb b/lib/vapi/types/create_byo_phone_number_dto.rb index f016b6cf..79c1a11f 100644 --- a/lib/vapi/types/create_byo_phone_number_dto.rb +++ b/lib/vapi/types/create_byo_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to connect a bring-your-own phone number to Vapi with a stored telephony credential and routing + # settings. class CreateByoPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::CreateByoPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::CreateByoPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_byo_sip_trunk_credential_dto.rb b/lib/vapi/types/create_byo_sip_trunk_credential_dto.rb index fb5af3a9..38145205 100644 --- a/lib/vapi/types/create_byo_sip_trunk_credential_dto.rb +++ b/lib/vapi/types/create_byo_sip_trunk_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :gateways, -> { Internal::Types::Array[Vapi::Types::SipTrunkGateway] }, optional: false, nullable: false field :outbound_authentication_plan, -> { Vapi::Types::SipTrunkOutboundAuthenticationPlan }, optional: true, nullable: false, api_name: "outboundAuthenticationPlan" diff --git a/lib/vapi/types/create_cartesia_credential_dto.rb b/lib/vapi/types/create_cartesia_credential_dto.rb index f7253f99..98a8708d 100644 --- a/lib/vapi/types/create_cartesia_credential_dto.rb +++ b/lib/vapi/types/create_cartesia_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating speech recognition and voice synthesis requests with Cartesia. class CreateCartesiaCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_cerebras_credential_dto.rb b/lib/vapi/types/create_cerebras_credential_dto.rb index e5c5d5d6..2fb59ea9 100644 --- a/lib/vapi/types/create_cerebras_credential_dto.rb +++ b/lib/vapi/types/create_cerebras_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Cerebras. class CreateCerebrasCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_cloudflare_credential_dto.rb b/lib/vapi/types/create_cloudflare_credential_dto.rb index 825b8d44..164b5e60 100644 --- a/lib/vapi/types/create_cloudflare_credential_dto.rb +++ b/lib/vapi/types/create_cloudflare_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for storing call artifacts in Cloudflare R2, including account details, bucket configuration, and + # upload fallback order. class CreateCloudflareCredentialDto < Internal::Types::Model field :account_id, -> { String }, optional: true, nullable: false, api_name: "accountId" field :api_key, -> { String }, optional: true, nullable: false, api_name: "apiKey" diff --git a/lib/vapi/types/create_code_tool_dto.rb b/lib/vapi/types/create_code_tool_dto.rb index 6c9821ee..0d4c9d02 100644 --- a/lib/vapi/types/create_code_tool_dto.rb +++ b/lib/vapi/types/create_code_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a reusable tool that executes TypeScript code with configured credentials, + # environment variables, and timeout. class CreateCodeToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateCodeToolDtoMessagesItem] }, optional: true, nullable: false field :async, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/create_computer_tool_dto.rb b/lib/vapi/types/create_computer_tool_dto.rb index f8cef6b2..fc21e568 100644 --- a/lib/vapi/types/create_computer_tool_dto.rb +++ b/lib/vapi/types/create_computer_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a tool that lets the model interact with a computer display through screen, pointer, + # and keyboard actions. class CreateComputerToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateComputerToolDtoMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::CreateComputerToolDtoSubType }, optional: false, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/create_custom_credential_dto.rb b/lib/vapi/types/create_custom_credential_dto.rb index a9e7fd50..cb4dd8da 100644 --- a/lib/vapi/types/create_custom_credential_dto.rb +++ b/lib/vapi/types/create_custom_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Reusable custom credentials for authenticating outbound requests, with optional public-key encryption for + # sensitive request data. class CreateCustomCredentialDto < Internal::Types::Model field :authentication_plan, -> { Vapi::Types::CreateCustomCredentialDtoAuthenticationPlan }, optional: false, nullable: false, api_name: "authenticationPlan" field :encryption_plan, -> { Vapi::Types::CreateCustomCredentialDtoEncryptionPlan }, optional: true, nullable: false, api_name: "encryptionPlan" diff --git a/lib/vapi/types/create_custom_knowledge_base_dto.rb b/lib/vapi/types/create_custom_knowledge_base_dto.rb index bc0ec390..603a1c31 100644 --- a/lib/vapi/types/create_custom_knowledge_base_dto.rb +++ b/lib/vapi/types/create_custom_knowledge_base_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for connecting a custom knowledge-base implementation through a customer-hosted server. class CreateCustomKnowledgeBaseDto < Internal::Types::Model field :provider, -> { Vapi::Types::CreateCustomKnowledgeBaseDtoProvider }, optional: false, nullable: false field :server, -> { Vapi::Types::Server }, optional: false, nullable: false diff --git a/lib/vapi/types/create_custom_llm_credential_dto.rb b/lib/vapi/types/create_custom_llm_credential_dto.rb index 30d633fd..4959c6c7 100644 --- a/lib/vapi/types/create_custom_llm_credential_dto.rb +++ b/lib/vapi/types/create_custom_llm_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for authenticating requests to a custom language model with an API key or OAuth 2.0 authentication + # plan. class CreateCustomLlmCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :authentication_plan, -> { Vapi::Types::OAuth2AuthenticationPlan }, optional: true, nullable: false, api_name: "authenticationPlan" diff --git a/lib/vapi/types/create_customer_dto.rb b/lib/vapi/types/create_customer_dto.rb index 0adaac03..f4c38dac 100644 --- a/lib/vapi/types/create_customer_dto.rb +++ b/lib/vapi/types/create_customer_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Customer details used for call delivery and assistant personalization, including phone or SIP destination, contact + # identifiers, extension, and assistant overrides. class CreateCustomerDto < Internal::Types::Model field :number_e_164_check_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "numberE164CheckEnabled" field :extension, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_deep_infra_credential_dto.rb b/lib/vapi/types/create_deep_infra_credential_dto.rb index 7e091bc5..bd3ebd58 100644 --- a/lib/vapi/types/create_deep_infra_credential_dto.rb +++ b/lib/vapi/types/create_deep_infra_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with DeepInfra. class CreateDeepInfraCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_deep_seek_credential_dto.rb b/lib/vapi/types/create_deep_seek_credential_dto.rb index cdb14402..150c66a9 100644 --- a/lib/vapi/types/create_deep_seek_credential_dto.rb +++ b/lib/vapi/types/create_deep_seek_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with DeepSeek. class CreateDeepSeekCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_deepgram_credential_dto.rb b/lib/vapi/types/create_deepgram_credential_dto.rb index 4005dd1f..77d8f87b 100644 --- a/lib/vapi/types/create_deepgram_credential_dto.rb +++ b/lib/vapi/types/create_deepgram_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for authenticating speech recognition and voice synthesis requests with Deepgram, with an optional API + # URL for an on-premises instance. class CreateDeepgramCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :api_url, -> { String }, optional: true, nullable: false, api_name: "apiUrl" diff --git a/lib/vapi/types/create_dtmf_tool_dto.rb b/lib/vapi/types/create_dtmf_tool_dto.rb index f123b97d..3452aca5 100644 --- a/lib/vapi/types/create_dtmf_tool_dto.rb +++ b/lib/vapi/types/create_dtmf_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that lets an assistant send DTMF keypad tones during a call. class CreateDtmfToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateDtmfToolDtoMessagesItem] }, optional: true, nullable: false field :sip_info_dtmf_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "sipInfoDtmfEnabled" diff --git a/lib/vapi/types/create_eleven_labs_credential_dto.rb b/lib/vapi/types/create_eleven_labs_credential_dto.rb index ed1e9648..7c77169a 100644 --- a/lib/vapi/types/create_eleven_labs_credential_dto.rb +++ b/lib/vapi/types/create_eleven_labs_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating speech recognition and voice synthesis requests with ElevenLabs. class CreateElevenLabsCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_email_credential_dto.rb b/lib/vapi/types/create_email_credential_dto.rb index 6c02ca54..d069a58c 100644 --- a/lib/vapi/types/create_email_credential_dto.rb +++ b/lib/vapi/types/create_email_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Destination configuration for sending Vapi alerts to an email address. class CreateEmailCredentialDto < Internal::Types::Model field :email, -> { String }, optional: false, nullable: false field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_end_call_tool_dto.rb b/lib/vapi/types/create_end_call_tool_dto.rb index bc690527..216acbd5 100644 --- a/lib/vapi/types/create_end_call_tool_dto.rb +++ b/lib/vapi/types/create_end_call_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that lets an assistant end the active call. class CreateEndCallToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateEndCallToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_eval_dto.rb b/lib/vapi/types/create_eval_dto.rb index 6381d506..f645556f 100644 --- a/lib/vapi/types/create_eval_dto.rb +++ b/lib/vapi/types/create_eval_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a reusable eval containing a mock conversation and checkpoints for assessing + # assistant responses and tool calls. class CreateEvalDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateEvalDtoMessagesItem] }, optional: false, nullable: false field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_function_tool_dto.rb b/lib/vapi/types/create_function_tool_dto.rb index 8b0ff6b5..7a33cacd 100644 --- a/lib/vapi/types/create_function_tool_dto.rb +++ b/lib/vapi/types/create_function_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateFunctionToolDtoMessagesItem] }, optional: true, nullable: false field :async, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/create_gcp_credential_dto.rb b/lib/vapi/types/create_gcp_credential_dto.rb index 5f6f3d01..6c321178 100644 --- a/lib/vapi/types/create_gcp_credential_dto.rb +++ b/lib/vapi/types/create_gcp_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Service-account credentials for Google Cloud resources and optional call-artifact storage, including region, + # bucket configuration, and upload fallback order. class CreateGcpCredentialDto < Internal::Types::Model field :fallback_index, -> { Integer }, optional: true, nullable: false, api_name: "fallbackIndex" field :gcp_key, -> { Vapi::Types::GcpKey }, optional: false, nullable: false, api_name: "gcpKey" diff --git a/lib/vapi/types/create_gladia_credential_dto.rb b/lib/vapi/types/create_gladia_credential_dto.rb index 2072c4c1..8964d016 100644 --- a/lib/vapi/types/create_gladia_credential_dto.rb +++ b/lib/vapi/types/create_gladia_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating transcription requests with Gladia. class CreateGladiaCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_go_high_level_calendar_availability_tool_dto.rb b/lib/vapi/types/create_go_high_level_calendar_availability_tool_dto.rb index f2134de4..cbcbbd18 100644 --- a/lib/vapi/types/create_go_high_level_calendar_availability_tool_dto.rb +++ b/lib/vapi/types/create_go_high_level_calendar_availability_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that checks calendar availability in a connected GoHighLevel account. class CreateGoHighLevelCalendarAvailabilityToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateGoHighLevelCalendarAvailabilityToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_go_high_level_calendar_event_create_tool_dto.rb b/lib/vapi/types/create_go_high_level_calendar_event_create_tool_dto.rb index a237f3d6..62e21547 100644 --- a/lib/vapi/types/create_go_high_level_calendar_event_create_tool_dto.rb +++ b/lib/vapi/types/create_go_high_level_calendar_event_create_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that adds calendar events to a connected GoHighLevel account. class CreateGoHighLevelCalendarEventCreateToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateGoHighLevelCalendarEventCreateToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_go_high_level_contact_create_tool_dto.rb b/lib/vapi/types/create_go_high_level_contact_create_tool_dto.rb index a5b9d83a..9867fc2c 100644 --- a/lib/vapi/types/create_go_high_level_contact_create_tool_dto.rb +++ b/lib/vapi/types/create_go_high_level_contact_create_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that adds contacts to a connected GoHighLevel account. class CreateGoHighLevelContactCreateToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateGoHighLevelContactCreateToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_go_high_level_contact_get_tool_dto.rb b/lib/vapi/types/create_go_high_level_contact_get_tool_dto.rb index 0feb4a45..6da945b6 100644 --- a/lib/vapi/types/create_go_high_level_contact_get_tool_dto.rb +++ b/lib/vapi/types/create_go_high_level_contact_get_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that retrieves contacts from a connected GoHighLevel account. class CreateGoHighLevelContactGetToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateGoHighLevelContactGetToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_go_high_level_credential_dto.rb b/lib/vapi/types/create_go_high_level_credential_dto.rb index e6e290b7..0434953b 100644 --- a/lib/vapi/types/create_go_high_level_credential_dto.rb +++ b/lib/vapi/types/create_go_high_level_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating Vapi integrations with GoHighLevel. class CreateGoHighLevelCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_go_high_level_mcp_credential_dto.rb b/lib/vapi/types/create_go_high_level_mcp_credential_dto.rb index 050c6c52..b01dcc50 100644 --- a/lib/vapi/types/create_go_high_level_mcp_credential_dto.rb +++ b/lib/vapi/types/create_go_high_level_mcp_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # OAuth 2.0 session credentials for authenticating GoHighLevel MCP requests. class CreateGoHighLevelMcpCredentialDto < Internal::Types::Model field :authentication_session, -> { Vapi::Types::Oauth2AuthenticationSession }, optional: false, nullable: false, api_name: "authenticationSession" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_google_calendar_check_availability_tool_dto.rb b/lib/vapi/types/create_google_calendar_check_availability_tool_dto.rb index d6859139..1cb37939 100644 --- a/lib/vapi/types/create_google_calendar_check_availability_tool_dto.rb +++ b/lib/vapi/types/create_google_calendar_check_availability_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that checks availability in a connected Google Calendar. class CreateGoogleCalendarCheckAvailabilityToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateGoogleCalendarCheckAvailabilityToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_google_calendar_create_event_tool_dto.rb b/lib/vapi/types/create_google_calendar_create_event_tool_dto.rb index 6d890f0d..f635a3a6 100644 --- a/lib/vapi/types/create_google_calendar_create_event_tool_dto.rb +++ b/lib/vapi/types/create_google_calendar_create_event_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that adds events to a connected Google Calendar. class CreateGoogleCalendarCreateEventToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateGoogleCalendarCreateEventToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.rb b/lib/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.rb index c53f66f7..a7bdad6e 100644 --- a/lib/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.rb +++ b/lib/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Stored OAuth 2.0 authorization for Google Calendar operations. class CreateGoogleCalendarOAuth2AuthorizationCredentialDto < Internal::Types::Model field :authorization_id, -> { String }, optional: false, nullable: false, api_name: "authorizationId" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.rb b/lib/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.rb index 579567a4..10382f4c 100644 --- a/lib/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.rb +++ b/lib/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # OAuth 2.0 client credential for Google Calendar integrations. class CreateGoogleCalendarOAuth2ClientCredentialDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false end diff --git a/lib/vapi/types/create_google_credential_dto.rb b/lib/vapi/types/create_google_credential_dto.rb index 25a985f8..35d62324 100644 --- a/lib/vapi/types/create_google_credential_dto.rb +++ b/lib/vapi/types/create_google_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Google AI. class CreateGoogleCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.rb b/lib/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.rb index fd20f6ce..9dc70d6d 100644 --- a/lib/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.rb +++ b/lib/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Stored OAuth 2.0 authorization for Google Sheets operations. class CreateGoogleSheetsOAuth2AuthorizationCredentialDto < Internal::Types::Model field :authorization_id, -> { String }, optional: false, nullable: false, api_name: "authorizationId" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_google_sheets_row_append_tool_dto.rb b/lib/vapi/types/create_google_sheets_row_append_tool_dto.rb index 5e20c497..185f143e 100644 --- a/lib/vapi/types/create_google_sheets_row_append_tool_dto.rb +++ b/lib/vapi/types/create_google_sheets_row_append_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that appends rows to a connected Google Sheet. class CreateGoogleSheetsRowAppendToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateGoogleSheetsRowAppendToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_groq_credential_dto.rb b/lib/vapi/types/create_groq_credential_dto.rb index 202fcba0..146920fc 100644 --- a/lib/vapi/types/create_groq_credential_dto.rb +++ b/lib/vapi/types/create_groq_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Groq. class CreateGroqCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_handoff_tool_dto.rb b/lib/vapi/types/create_handoff_tool_dto.rb index 6bec4135..c8b2a5f1 100644 --- a/lib/vapi/types/create_handoff_tool_dto.rb +++ b/lib/vapi/types/create_handoff_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a tool that hands a conversation to another assistant, squad, or dynamically selected + # destination. class CreateHandoffToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateHandoffToolDtoMessagesItem] }, optional: true, nullable: false field :default_result, -> { String }, optional: true, nullable: false, api_name: "defaultResult" diff --git a/lib/vapi/types/create_hume_credential_dto.rb b/lib/vapi/types/create_hume_credential_dto.rb index 1f7a056c..37494ec8 100644 --- a/lib/vapi/types/create_hume_credential_dto.rb +++ b/lib/vapi/types/create_hume_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with Hume. class CreateHumeCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_inflection_ai_credential_dto.rb b/lib/vapi/types/create_inflection_ai_credential_dto.rb index 41509a72..22145052 100644 --- a/lib/vapi/types/create_inflection_ai_credential_dto.rb +++ b/lib/vapi/types/create_inflection_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Inflection AI. class CreateInflectionAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_inworld_credential_dto.rb b/lib/vapi/types/create_inworld_credential_dto.rb index 73637868..dc9c44af 100644 --- a/lib/vapi/types/create_inworld_credential_dto.rb +++ b/lib/vapi/types/create_inworld_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with Inworld. class CreateInworldCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_langfuse_credential_dto.rb b/lib/vapi/types/create_langfuse_credential_dto.rb index b76dce1e..dfae9f38 100644 --- a/lib/vapi/types/create_langfuse_credential_dto.rb +++ b/lib/vapi/types/create_langfuse_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for sending assistant call traces to a Langfuse project, including its public key, secret key, and + # host URL. class CreateLangfuseCredentialDto < Internal::Types::Model field :public_key, -> { String }, optional: false, nullable: false, api_name: "publicKey" field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" diff --git a/lib/vapi/types/create_line_insight_from_call_table_dto.rb b/lib/vapi/types/create_line_insight_from_call_table_dto.rb index 86e9d9fc..7ab556e5 100644 --- a/lib/vapi/types/create_line_insight_from_call_table_dto.rb +++ b/lib/vapi/types/create_line_insight_from_call_table_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a line-chart insight from call data using metric queries, formulas, grouping, and a + # stepped time range. class CreateLineInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_lmnt_credential_dto.rb b/lib/vapi/types/create_lmnt_credential_dto.rb index 4ff6639e..26083657 100644 --- a/lib/vapi/types/create_lmnt_credential_dto.rb +++ b/lib/vapi/types/create_lmnt_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with LMNT. class CreateLmntCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_make_credential_dto.rb b/lib/vapi/types/create_make_credential_dto.rb index 06fce435..43ac76e2 100644 --- a/lib/vapi/types/create_make_credential_dto.rb +++ b/lib/vapi/types/create_make_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating Vapi integrations with Make, including team, region, and API key. class CreateMakeCredentialDto < Internal::Types::Model field :team_id, -> { String }, optional: false, nullable: false, api_name: "teamId" field :region, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/create_mcp_tool_dto.rb b/lib/vapi/types/create_mcp_tool_dto.rb index 83ae6591..cba4fa9f 100644 --- a/lib/vapi/types/create_mcp_tool_dto.rb +++ b/lib/vapi/types/create_mcp_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a tool that connects an assistant to a Model Context Protocol server and exposes its + # available tools. class CreateMcpToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateMcpToolDtoMessagesItem] }, optional: true, nullable: false field :server, -> { Vapi::Types::Server }, optional: true, nullable: false diff --git a/lib/vapi/types/create_minimax_credential_dto.rb b/lib/vapi/types/create_minimax_credential_dto.rb index 531c0e44..fac9a69a 100644 --- a/lib/vapi/types/create_minimax_credential_dto.rb +++ b/lib/vapi/types/create_minimax_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for authenticating assistant model and voice synthesis requests with MiniMax, including the MiniMax + # group identifier. class CreateMinimaxCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :group_id, -> { String }, optional: false, nullable: false, api_name: "groupId" diff --git a/lib/vapi/types/create_mistral_credential_dto.rb b/lib/vapi/types/create_mistral_credential_dto.rb index 198005fd..a5087c14 100644 --- a/lib/vapi/types/create_mistral_credential_dto.rb +++ b/lib/vapi/types/create_mistral_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Mistral. class CreateMistralCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_neuphonic_credential_dto.rb b/lib/vapi/types/create_neuphonic_credential_dto.rb index 84a50a58..f9328409 100644 --- a/lib/vapi/types/create_neuphonic_credential_dto.rb +++ b/lib/vapi/types/create_neuphonic_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with Neuphonic. class CreateNeuphonicCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_open_ai_credential_dto.rb b/lib/vapi/types/create_open_ai_credential_dto.rb index a9e4c5ec..06e5dafc 100644 --- a/lib/vapi/types/create_open_ai_credential_dto.rb +++ b/lib/vapi/types/create_open_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model, transcription, and voice synthesis requests with OpenAI. class CreateOpenAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_open_router_credential_dto.rb b/lib/vapi/types/create_open_router_credential_dto.rb index 32af3118..4e84135f 100644 --- a/lib/vapi/types/create_open_router_credential_dto.rb +++ b/lib/vapi/types/create_open_router_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with OpenRouter. class CreateOpenRouterCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_perplexity_ai_credential_dto.rb b/lib/vapi/types/create_perplexity_ai_credential_dto.rb index 3f9f61d9..6cbda7d4 100644 --- a/lib/vapi/types/create_perplexity_ai_credential_dto.rb +++ b/lib/vapi/types/create_perplexity_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Perplexity AI. class CreatePerplexityAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_pie_insight_from_call_table_dto.rb b/lib/vapi/types/create_pie_insight_from_call_table_dto.rb index 544e2bc5..e0bb4bc0 100644 --- a/lib/vapi/types/create_pie_insight_from_call_table_dto.rb +++ b/lib/vapi/types/create_pie_insight_from_call_table_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a pie-chart insight from call data using metric queries, formulas, grouping, and a + # time range. class CreatePieInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_play_ht_credential_dto.rb b/lib/vapi/types/create_play_ht_credential_dto.rb index e8ceb322..b00cf6a2 100644 --- a/lib/vapi/types/create_play_ht_credential_dto.rb +++ b/lib/vapi/types/create_play_ht_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with PlayHT, including the PlayHT user identifier. class CreatePlayHtCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :user_id, -> { String }, optional: false, nullable: false, api_name: "userId" diff --git a/lib/vapi/types/create_query_tool_dto.rb b/lib/vapi/types/create_query_tool_dto.rb index dd47bdfb..dfafbc3c 100644 --- a/lib/vapi/types/create_query_tool_dto.rb +++ b/lib/vapi/types/create_query_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a tool that searches configured knowledge bases and returns relevant content to the + # assistant. class CreateQueryToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateQueryToolDtoMessagesItem] }, optional: true, nullable: false field :knowledge_bases, -> { Internal::Types::Array[Vapi::Types::KnowledgeBase] }, optional: true, nullable: false, api_name: "knowledgeBases" diff --git a/lib/vapi/types/create_rime_ai_credential_dto.rb b/lib/vapi/types/create_rime_ai_credential_dto.rb index 7614e52d..6f4d83d5 100644 --- a/lib/vapi/types/create_rime_ai_credential_dto.rb +++ b/lib/vapi/types/create_rime_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with Rime AI. class CreateRimeAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_runpod_credential_dto.rb b/lib/vapi/types/create_runpod_credential_dto.rb index e81bc718..a48b73ca 100644 --- a/lib/vapi/types/create_runpod_credential_dto.rb +++ b/lib/vapi/types/create_runpod_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests through Runpod. class CreateRunpodCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_s_3_credential_dto.rb b/lib/vapi/types/create_s_3_credential_dto.rb index 7a3dd32f..0c35f0b7 100644 --- a/lib/vapi/types/create_s_3_credential_dto.rb +++ b/lib/vapi/types/create_s_3_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for storing call artifacts in Amazon S3, including access keys, region, bucket, path prefix, and + # upload fallback order. class CreateS3CredentialDto < Internal::Types::Model field :aws_access_key_id, -> { String }, optional: false, nullable: false, api_name: "awsAccessKeyId" field :aws_secret_access_key, -> { String }, optional: false, nullable: false, api_name: "awsSecretAccessKey" diff --git a/lib/vapi/types/create_scorecard_dto.rb b/lib/vapi/types/create_scorecard_dto.rb index 2a28053a..963f3163 100644 --- a/lib/vapi/types/create_scorecard_dto.rb +++ b/lib/vapi/types/create_scorecard_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a scorecard containing evaluation metrics, scoring conditions, and optional assistant + # associations. class CreateScorecardDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :description, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_sip_request_tool_dto.rb b/lib/vapi/types/create_sip_request_tool_dto.rb index acd1cb04..8fa2ff83 100644 --- a/lib/vapi/types/create_sip_request_tool_dto.rb +++ b/lib/vapi/types/create_sip_request_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers + # and body. class CreateSipRequestToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateSipRequestToolDtoMessagesItem] }, optional: true, nullable: false field :verb, -> { Vapi::Types::CreateSipRequestToolDtoVerb }, optional: false, nullable: false diff --git a/lib/vapi/types/create_slack_o_auth_2_authorization_credential_dto.rb b/lib/vapi/types/create_slack_o_auth_2_authorization_credential_dto.rb index 7e05c6bd..6028e8ee 100644 --- a/lib/vapi/types/create_slack_o_auth_2_authorization_credential_dto.rb +++ b/lib/vapi/types/create_slack_o_auth_2_authorization_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Stored OAuth 2.0 authorization for Slack operations. class CreateSlackOAuth2AuthorizationCredentialDto < Internal::Types::Model field :authorization_id, -> { String }, optional: false, nullable: false, api_name: "authorizationId" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_slack_send_message_tool_dto.rb b/lib/vapi/types/create_slack_send_message_tool_dto.rb index 29cff8ac..2de2418b 100644 --- a/lib/vapi/types/create_slack_send_message_tool_dto.rb +++ b/lib/vapi/types/create_slack_send_message_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that lets an assistant send a message to Slack. class CreateSlackSendMessageToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateSlackSendMessageToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_slack_webhook_credential_dto.rb b/lib/vapi/types/create_slack_webhook_credential_dto.rb index e9f91b8c..823dd12e 100644 --- a/lib/vapi/types/create_slack_webhook_credential_dto.rb +++ b/lib/vapi/types/create_slack_webhook_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for sending Vapi alerts through a Slack incoming webhook. class CreateSlackWebhookCredentialDto < Internal::Types::Model field :webhook_url, -> { String }, optional: false, nullable: false, api_name: "webhookUrl" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_smallest_ai_credential_dto.rb b/lib/vapi/types/create_smallest_ai_credential_dto.rb index 56dca3b1..03d64aad 100644 --- a/lib/vapi/types/create_smallest_ai_credential_dto.rb +++ b/lib/vapi/types/create_smallest_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with Smallest AI. class CreateSmallestAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_sms_tool_dto.rb b/lib/vapi/types/create_sms_tool_dto.rb index 21ade03b..cd24382c 100644 --- a/lib/vapi/types/create_sms_tool_dto.rb +++ b/lib/vapi/types/create_sms_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that lets an assistant send an SMS message during a call. class CreateSmsToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateSmsToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/create_soniox_credential_dto.rb b/lib/vapi/types/create_soniox_credential_dto.rb index 49a0517e..6c3e2ce6 100644 --- a/lib/vapi/types/create_soniox_credential_dto.rb +++ b/lib/vapi/types/create_soniox_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating transcription requests with Soniox. class CreateSonioxCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_speechmatics_credential_dto.rb b/lib/vapi/types/create_speechmatics_credential_dto.rb index 8f0a0379..6382c1f5 100644 --- a/lib/vapi/types/create_speechmatics_credential_dto.rb +++ b/lib/vapi/types/create_speechmatics_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating transcription requests with Speechmatics. class CreateSpeechmaticsCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_squad_dto.rb b/lib/vapi/types/create_squad_dto.rb index 6989519c..fccdbdc0 100644 --- a/lib/vapi/types/create_squad_dto.rb +++ b/lib/vapi/types/create_squad_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :members, -> { Internal::Types::Array[Vapi::Types::SquadMemberDto] }, optional: false, nullable: false diff --git a/lib/vapi/types/create_structured_output_dto.rb b/lib/vapi/types/create_structured_output_dto.rb index 37649da7..a757a002 100644 --- a/lib/vapi/types/create_structured_output_dto.rb +++ b/lib/vapi/types/create_structured_output_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a structured-output definition that extracts validated data from calls using an AI + # model or regular expression. class CreateStructuredOutputDto < Internal::Types::Model field :type, -> { Vapi::Types::CreateStructuredOutputDtoType }, optional: true, nullable: false field :regex, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_supabase_credential_dto.rb b/lib/vapi/types/create_supabase_credential_dto.rb index 08edc364..1a463bd6 100644 --- a/lib/vapi/types/create_supabase_credential_dto.rb +++ b/lib/vapi/types/create_supabase_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for storing call artifacts in Supabase's S3-compatible storage, including bucket configuration and + # upload fallback order. class CreateSupabaseCredentialDto < Internal::Types::Model field :fallback_index, -> { Integer }, optional: true, nullable: false, api_name: "fallbackIndex" field :bucket_plan, -> { Vapi::Types::SupabaseBucketPlan }, optional: true, nullable: false, api_name: "bucketPlan" diff --git a/lib/vapi/types/create_tavus_credential_dto.rb b/lib/vapi/types/create_tavus_credential_dto.rb index be5aa2fc..1339d2e9 100644 --- a/lib/vapi/types/create_tavus_credential_dto.rb +++ b/lib/vapi/types/create_tavus_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with Tavus. class CreateTavusCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_telnyx_phone_number_dto.rb b/lib/vapi/types/create_telnyx_phone_number_dto.rb index f9e422fb..f1cd8e29 100644 --- a/lib/vapi/types/create_telnyx_phone_number_dto.rb +++ b/lib/vapi/types/create_telnyx_phone_number_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to import a Telnyx phone number into Vapi with a stored credential and routing settings. class CreateTelnyxPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::CreateTelnyxPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::CreateTelnyxPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_text_editor_tool_dto.rb b/lib/vapi/types/create_text_editor_tool_dto.rb index 32ccb3e4..21835bca 100644 --- a/lib/vapi/types/create_text_editor_tool_dto.rb +++ b/lib/vapi/types/create_text_editor_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that reads and edits text files in a configured environment. class CreateTextEditorToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateTextEditorToolDtoMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::CreateTextEditorToolDtoSubType }, optional: false, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/create_text_insight_from_call_table_dto.rb b/lib/vapi/types/create_text_insight_from_call_table_dto.rb index eb8a2f24..3e7b9d36 100644 --- a/lib/vapi/types/create_text_insight_from_call_table_dto.rb +++ b/lib/vapi/types/create_text_insight_from_call_table_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to create a text-value insight from call data using metric queries, a formula, and a time + # range. class CreateTextInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formula, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_together_ai_credential_dto.rb b/lib/vapi/types/create_together_ai_credential_dto.rb index f385fdae..0885b59d 100644 --- a/lib/vapi/types/create_together_ai_credential_dto.rb +++ b/lib/vapi/types/create_together_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with Together AI. class CreateTogetherAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_transfer_call_tool_dto.rb b/lib/vapi/types/create_transfer_call_tool_dto.rb index efb41e54..65c54c33 100644 --- a/lib/vapi/types/create_transfer_call_tool_dto.rb +++ b/lib/vapi/types/create_transfer_call_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a tool that transfers the active call to one of its configured destinations. class CreateTransferCallToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateTransferCallToolDtoMessagesItem] }, optional: true, nullable: false field :destinations, -> { Internal::Types::Array[Vapi::Types::CreateTransferCallToolDtoDestinationsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_trieve_credential_dto.rb b/lib/vapi/types/create_trieve_credential_dto.rb index 3fa091c7..4ba5fccd 100644 --- a/lib/vapi/types/create_trieve_credential_dto.rb +++ b/lib/vapi/types/create_trieve_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating knowledge-base requests with Trieve. class CreateTrieveCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_twilio_credential_dto.rb b/lib/vapi/types/create_twilio_credential_dto.rb index 2fb39bcf..e1bca09d 100644 --- a/lib/vapi/types/create_twilio_credential_dto.rb +++ b/lib/vapi/types/create_twilio_credential_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Credentials for authenticating telephony requests with Twilio using an account SID and either an auth token or API + # key credentials. class CreateTwilioCredentialDto < Internal::Types::Model field :auth_token, -> { String }, optional: true, nullable: false, api_name: "authToken" field :api_key, -> { String }, optional: true, nullable: false, api_name: "apiKey" diff --git a/lib/vapi/types/create_twilio_phone_number_dto.rb b/lib/vapi/types/create_twilio_phone_number_dto.rb index 7ccad504..2c40d85e 100644 --- a/lib/vapi/types/create_twilio_phone_number_dto.rb +++ b/lib/vapi/types/create_twilio_phone_number_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to import a Twilio phone number into Vapi with its account credentials and routing settings. class CreateTwilioPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::CreateTwilioPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::CreateTwilioPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_vapi_phone_number_dto.rb b/lib/vapi/types/create_vapi_phone_number_dto.rb index f11be109..f1ff94ee 100644 --- a/lib/vapi/types/create_vapi_phone_number_dto.rb +++ b/lib/vapi/types/create_vapi_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration used to provision a Vapi-managed phone number or connect a SIP URI, with optional routing and + # authentication settings. class CreateVapiPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::CreateVapiPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::CreateVapiPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_voicemail_tool_dto.rb b/lib/vapi/types/create_voicemail_tool_dto.rb index d2303741..6f319827 100644 --- a/lib/vapi/types/create_voicemail_tool_dto.rb +++ b/lib/vapi/types/create_voicemail_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to create a voicemail-detection tool with optional beep detection for supported calls. class CreateVoicemailToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::CreateVoicemailToolDtoMessagesItem] }, optional: true, nullable: false field :beep_detection_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "beepDetectionEnabled" diff --git a/lib/vapi/types/create_vonage_credential_dto.rb b/lib/vapi/types/create_vonage_credential_dto.rb index b1cd14da..9cb95d9b 100644 --- a/lib/vapi/types/create_vonage_credential_dto.rb +++ b/lib/vapi/types/create_vonage_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating telephony requests with Vonage. class CreateVonageCredentialDto < Internal::Types::Model field :api_secret, -> { String }, optional: false, nullable: false, api_name: "apiSecret" field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" diff --git a/lib/vapi/types/create_vonage_phone_number_dto.rb b/lib/vapi/types/create_vonage_phone_number_dto.rb index ccafdf75..9ca252f2 100644 --- a/lib/vapi/types/create_vonage_phone_number_dto.rb +++ b/lib/vapi/types/create_vonage_phone_number_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration used to import a Vonage phone number into Vapi with a stored credential and routing settings. class CreateVonagePhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::CreateVonagePhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::CreateVonagePhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/create_well_said_credential_dto.rb b/lib/vapi/types/create_well_said_credential_dto.rb index c94e0176..27a1269d 100644 --- a/lib/vapi/types/create_well_said_credential_dto.rb +++ b/lib/vapi/types/create_well_said_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating voice synthesis requests with WellSaid. class CreateWellSaidCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/create_workflow_dto.rb b/lib/vapi/types/create_workflow_dto.rb index de82d4db..6ae7894b 100644 --- a/lib/vapi/types/create_workflow_dto.rb +++ b/lib/vapi/types/create_workflow_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :nodes, -> { Internal::Types::Array[Vapi::Types::CreateWorkflowDtoNodesItem] }, optional: false, nullable: false field :model, -> { Vapi::Types::CreateWorkflowDtoModel }, optional: true, nullable: false diff --git a/lib/vapi/types/create_x_ai_credential_dto.rb b/lib/vapi/types/create_x_ai_credential_dto.rb index 134b933a..1752b4a1 100644 --- a/lib/vapi/types/create_x_ai_credential_dto.rb +++ b/lib/vapi/types/create_x_ai_credential_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials for authenticating assistant model requests with xAI. class CreateXAiCredentialDto < Internal::Types::Model field :api_key, -> { String }, optional: false, nullable: false, api_name: "apiKey" field :name, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/custom_endpointing_model_smart_endpointing_plan.rb b/lib/vapi/types/custom_endpointing_model_smart_endpointing_plan.rb index 5ad61f46..8c4b814f 100644 --- a/lib/vapi/types/custom_endpointing_model_smart_endpointing_plan.rb +++ b/lib/vapi/types/custom_endpointing_model_smart_endpointing_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for using a custom endpointing model, including its provider identifier and server connection. class CustomEndpointingModelSmartEndpointingPlan < Internal::Types::Model field :provider, -> { Vapi::Types::CustomEndpointingModelSmartEndpointingPlanProvider }, optional: false, nullable: false field :server, -> { Vapi::Types::Server }, optional: true, nullable: false diff --git a/lib/vapi/types/custom_llm_model.rb b/lib/vapi/types/custom_llm_model.rb index c5f0b198..5fed4cd9 100644 --- a/lib/vapi/types/custom_llm_model.rb +++ b/lib/vapi/types/custom_llm_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses through a custom language model endpoint, including server URL, + # headers, metadata, prompts, tools, and generation settings. class CustomLlmModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::CustomLlmModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/custom_message.rb b/lib/vapi/types/custom_message.rb index b61955ac..67fb2a44 100644 --- a/lib/vapi/types/custom_message.rb +++ b/lib/vapi/types/custom_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A message spoken by the assistant with optional language-specific content variants. class CustomMessage < Internal::Types::Model field :contents, -> { Internal::Types::Array[Vapi::Types::TextContent] }, optional: true, nullable: false field :type, -> { Vapi::Types::CustomMessageType }, optional: false, nullable: false diff --git a/lib/vapi/types/custom_transcriber.rb b/lib/vapi/types/custom_transcriber.rb index 238b582a..3d2594d4 100644 --- a/lib/vapi/types/custom_transcriber.rb +++ b/lib/vapi/types/custom_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for sending conversation audio to a custom WebSocket transcription server. class CustomTranscriber < Internal::Types::Model field :server, -> { Vapi::Types::Server }, optional: false, nullable: false field :fallback_plan, -> { Vapi::Types::FallbackTranscriberPlan }, optional: true, nullable: false, api_name: "fallbackPlan" diff --git a/lib/vapi/types/custom_voice.rb b/lib/vapi/types/custom_voice.rb index 38a53cd8..28296f79 100644 --- a/lib/vapi/types/custom_voice.rb +++ b/lib/vapi/types/custom_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech through a custom server, including voice selection, server + # connection, chunking, caching, and fallback settings. class CustomVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: true, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/customer_custom_endpointing_rule.rb b/lib/vapi/types/customer_custom_endpointing_rule.rb index 86337f9f..d900bd04 100644 --- a/lib/vapi/types/customer_custom_endpointing_rule.rb +++ b/lib/vapi/types/customer_custom_endpointing_rule.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A custom endpointing rule that matches the customer's current speech and applies a configured timeout. class CustomerCustomEndpointingRule < Internal::Types::Model field :regex, -> { String }, optional: false, nullable: false field :regex_options, -> { Internal::Types::Array[Vapi::Types::RegexOption] }, optional: true, nullable: false, api_name: "regexOptions" diff --git a/lib/vapi/types/customer_speech_timeout_options.rb b/lib/vapi/types/customer_speech_timeout_options.rb index 2014c08c..98186e6f 100644 --- a/lib/vapi/types/customer_speech_timeout_options.rb +++ b/lib/vapi/types/customer_speech_timeout_options.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls how long a hook waits for customer speech, how often it can trigger, and when its trigger counter resets. class CustomerSpeechTimeoutOptions < Internal::Types::Model field :timeout_seconds, -> { Integer }, optional: false, nullable: false, api_name: "timeoutSeconds" field :trigger_max_count, -> { Integer }, optional: true, nullable: false, api_name: "triggerMaxCount" diff --git a/lib/vapi/types/deep_infra_model.rb b/lib/vapi/types/deep_infra_model.rb index 442234c9..2b03985b 100644 --- a/lib/vapi/types/deep_infra_model.rb +++ b/lib/vapi/types/deep_infra_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with DeepInfra, including model, prompts, tools, knowledge-base + # access, and generation settings. class DeepInfraModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::DeepInfraModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/deep_seek_model.rb b/lib/vapi/types/deep_seek_model.rb index d2864cd7..431311a2 100644 --- a/lib/vapi/types/deep_seek_model.rb +++ b/lib/vapi/types/deep_seek_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with DeepSeek, including model, prompts, tools, knowledge-base + # access, and generation settings. class DeepSeekModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::DeepSeekModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/deepgram_transcriber.rb b/lib/vapi/types/deepgram_transcriber.rb index 433e04e3..95cfbaee 100644 --- a/lib/vapi/types/deepgram_transcriber.rb +++ b/lib/vapi/types/deepgram_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Deepgram, including model, language, + # formatting, endpointing, vocabulary, and fallback settings. class DeepgramTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::DeepgramTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::DeepgramTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/deepgram_voice.rb b/lib/vapi/types/deepgram_voice.rb index 444bacbe..1784f432 100644 --- a/lib/vapi/types/deepgram_voice.rb +++ b/lib/vapi/types/deepgram_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Deepgram, including voice and model selection, + # model-improvement preferences, chunking, caching, and fallback settings. class DeepgramVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::DeepgramVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/developer_message.rb b/lib/vapi/types/developer_message.rb index 3a9aebe8..0b00c2bb 100644 --- a/lib/vapi/types/developer_message.rb +++ b/lib/vapi/types/developer_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A developer-authored instruction message supplied to the language model. class DeveloperMessage < Internal::Types::Model field :role, -> { Vapi::Types::DeveloperMessageRole }, optional: false, nullable: false field :content, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/dial_plan_entry.rb b/lib/vapi/types/dial_plan_entry.rb index 8c4a9c66..7095d7a0 100644 --- a/lib/vapi/types/dial_plan_entry.rb +++ b/lib/vapi/types/dial_plan_entry.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Associates a phone number with the customers to dial through that number in a batch call plan. class DialPlanEntry < Internal::Types::Model field :phone_number_id, -> { String }, optional: false, nullable: false, api_name: "phoneNumberId" field :customers, -> { Internal::Types::Array[Vapi::Types::CreateCustomerDto] }, optional: false, nullable: false diff --git a/lib/vapi/types/dtmf_tool.rb b/lib/vapi/types/dtmf_tool.rb index e5c9d265..23becbbe 100644 --- a/lib/vapi/types/dtmf_tool.rb +++ b/lib/vapi/types/dtmf_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that lets an assistant send DTMF keypad tones during a call. class DtmfTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::DtmfToolMessagesItem] }, optional: true, nullable: false field :sip_info_dtmf_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "sipInfoDtmfEnabled" diff --git a/lib/vapi/types/edge.rb b/lib/vapi/types/edge.rb index 73bada15..20572008 100644 --- a/lib/vapi/types/edge.rb +++ b/lib/vapi/types/edge.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A directed connection between two workflow nodes, with an optional AI-evaluated transition condition. class Edge < Internal::Types::Model field :condition, -> { Vapi::Types::AiEdgeCondition }, optional: true, nullable: false field :from, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/eleven_labs_pronunciation_dictionary_locator.rb b/lib/vapi/types/eleven_labs_pronunciation_dictionary_locator.rb index f26d045e..b4e943c0 100644 --- a/lib/vapi/types/eleven_labs_pronunciation_dictionary_locator.rb +++ b/lib/vapi/types/eleven_labs_pronunciation_dictionary_locator.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Identifies a specific version of an ElevenLabs pronunciation dictionary. class ElevenLabsPronunciationDictionaryLocator < Internal::Types::Model field :pronunciation_dictionary_id, -> { String }, optional: false, nullable: false, api_name: "pronunciationDictionaryId" field :version_id, -> { String }, optional: false, nullable: false, api_name: "versionId" diff --git a/lib/vapi/types/eleven_labs_transcriber.rb b/lib/vapi/types/eleven_labs_transcriber.rb index b70c84a6..ee7bc9ca 100644 --- a/lib/vapi/types/eleven_labs_transcriber.rb +++ b/lib/vapi/types/eleven_labs_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with ElevenLabs, including model, language, + # speech thresholds, and fallback settings. class ElevenLabsTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::ElevenLabsTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::ElevenLabsTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/eleven_labs_voice.rb b/lib/vapi/types/eleven_labs_voice.rb index d6dcf371..51fe71db 100644 --- a/lib/vapi/types/eleven_labs_voice.rb +++ b/lib/vapi/types/eleven_labs_voice.rb @@ -2,6 +2,9 @@ module Vapi module Types + # 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 < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::ElevenLabsVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/end_call_tool.rb b/lib/vapi/types/end_call_tool.rb index 66ff5f8f..b7af924d 100644 --- a/lib/vapi/types/end_call_tool.rb +++ b/lib/vapi/types/end_call_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that lets an assistant end the active call. class EndCallTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::EndCallToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/eval.rb b/lib/vapi/types/eval.rb index bdde018e..e3da1451 100644 --- a/lib/vapi/types/eval.rb +++ b/lib/vapi/types/eval.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved eval definition containing its mock conversation, checkpoints, descriptive metadata, type, and lifecycle + # information. class Eval < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::EvalMessagesItem] }, optional: false, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/eval_anthropic_model.rb b/lib/vapi/types/eval_anthropic_model.rb index 0d3f2718..1cf4f87e 100644 --- a/lib/vapi/types/eval_anthropic_model.rb +++ b/lib/vapi/types/eval_anthropic_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Anthropic model configuration for an LLM judge, including its messages, generation settings, and optional extended + # thinking. class EvalAnthropicModel < Internal::Types::Model field :model, -> { Vapi::Types::EvalAnthropicModelModel }, optional: false, nullable: false field :thinking, -> { Vapi::Types::AnthropicThinkingConfig }, optional: true, nullable: false diff --git a/lib/vapi/types/eval_custom_model.rb b/lib/vapi/types/eval_custom_model.rb index 37a1020d..b56d63e9 100644 --- a/lib/vapi/types/eval_custom_model.rb +++ b/lib/vapi/types/eval_custom_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # OpenAI-compatible custom model configuration for an LLM judge, including its endpoint, headers, messages, and + # generation settings. class EvalCustomModel < Internal::Types::Model field :url, -> { String }, optional: false, nullable: false field :headers, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false diff --git a/lib/vapi/types/eval_google_model.rb b/lib/vapi/types/eval_google_model.rb index ca65ccc5..6be4cd93 100644 --- a/lib/vapi/types/eval_google_model.rb +++ b/lib/vapi/types/eval_google_model.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Google model configuration for an LLM judge, including its messages and generation settings. class EvalGoogleModel < Internal::Types::Model field :model, -> { Vapi::Types::EvalGoogleModelModel }, optional: false, nullable: false field :temperature, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/eval_open_ai_model.rb b/lib/vapi/types/eval_open_ai_model.rb index 19a6ca9e..24890f7e 100644 --- a/lib/vapi/types/eval_open_ai_model.rb +++ b/lib/vapi/types/eval_open_ai_model.rb @@ -2,6 +2,7 @@ module Vapi module Types + # OpenAI model configuration for an LLM judge, including its messages and generation settings. class EvalOpenAiModel < Internal::Types::Model field :model, -> { Vapi::Types::EvalOpenAiModelModel }, optional: false, nullable: false field :temperature, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/eval_paginated_response.rb b/lib/vapi/types/eval_paginated_response.rb index 05a08218..1ee73b54 100644 --- a/lib/vapi/types/eval_paginated_response.rb +++ b/lib/vapi/types/eval_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of saved eval definitions and metadata describing the result set. class EvalPaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::Eval] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/eval_run.rb b/lib/vapi/types/eval_run.rb index 76522f95..51fb237d 100644 --- a/lib/vapi/types/eval_run.rb +++ b/lib/vapi/types/eval_run.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A record of an eval execution, including its target, status, results, costs, completion details, and lifecycle + # timestamps. class EvalRun < Internal::Types::Model field :status, -> { Vapi::Types::EvalRunStatus }, optional: false, nullable: false field :ended_reason, -> { Vapi::Types::EvalRunEndedReason }, optional: false, nullable: false, api_name: "endedReason" diff --git a/lib/vapi/types/eval_run_paginated_response.rb b/lib/vapi/types/eval_run_paginated_response.rb index fbfba098..d2d990b7 100644 --- a/lib/vapi/types/eval_run_paginated_response.rb +++ b/lib/vapi/types/eval_run_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of eval runs and metadata describing the result set. class EvalRunPaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::EvalRun] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/eval_run_result.rb b/lib/vapi/types/eval_run_result.rb index e504c6bd..0ecbbc18 100644 --- a/lib/vapi/types/eval_run_result.rb +++ b/lib/vapi/types/eval_run_result.rb @@ -2,6 +2,7 @@ module Vapi module Types + # The pass or fail result of an evaluation run, including its conversation messages and timing. class EvalRunResult < Internal::Types::Model field :status, -> { Vapi::Types::EvalRunResultStatus }, optional: false, nullable: false field :messages, -> { Internal::Types::Array[Vapi::Types::EvalRunResultMessagesItem] }, optional: false, nullable: false diff --git a/lib/vapi/types/eval_run_target_assistant.rb b/lib/vapi/types/eval_run_target_assistant.rb index 47a8d32e..e3aad741 100644 --- a/lib/vapi/types/eval_run_target_assistant.rb +++ b/lib/vapi/types/eval_run_target_assistant.rb @@ -2,6 +2,8 @@ module Vapi module Types + # An assistant evaluation target provided as a saved assistant ID or a transient assistant, with optional assistant + # overrides. class EvalRunTargetAssistant < Internal::Types::Model field :assistant, -> { Vapi::Types::CreateAssistantDto }, optional: true, nullable: false field :assistant_overrides, -> { Vapi::Types::AssistantOverrides }, optional: true, nullable: false, api_name: "assistantOverrides" diff --git a/lib/vapi/types/eval_run_target_squad.rb b/lib/vapi/types/eval_run_target_squad.rb index c46a45a5..9006c8a6 100644 --- a/lib/vapi/types/eval_run_target_squad.rb +++ b/lib/vapi/types/eval_run_target_squad.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A squad evaluation target provided as a saved squad ID or a transient squad, with optional assistant overrides. class EvalRunTargetSquad < Internal::Types::Model field :squad, -> { Vapi::Types::CreateSquadDto }, optional: true, nullable: false field :assistant_overrides, -> { Vapi::Types::AssistantOverrides }, optional: true, nullable: false, api_name: "assistantOverrides" diff --git a/lib/vapi/types/events_table_boolean_condition.rb b/lib/vapi/types/events_table_boolean_condition.rb index 065d9479..d78ad617 100644 --- a/lib/vapi/types/events_table_boolean_condition.rb +++ b/lib/vapi/types/events_table_boolean_condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters event data by comparing a boolean field with an expected value. class EventsTableBooleanCondition < Internal::Types::Model field :column, -> { String }, optional: false, nullable: false field :operator, -> { Vapi::Types::EventsTableBooleanConditionOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/events_table_number_condition.rb b/lib/vapi/types/events_table_number_condition.rb index ee5f1506..72f4cfe3 100644 --- a/lib/vapi/types/events_table_number_condition.rb +++ b/lib/vapi/types/events_table_number_condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters event data by comparing a numeric field with a value. class EventsTableNumberCondition < Internal::Types::Model field :column, -> { String }, optional: false, nullable: false field :operator, -> { Vapi::Types::EventsTableNumberConditionOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/events_table_string_condition.rb b/lib/vapi/types/events_table_string_condition.rb index 866d9c66..f7c80a2b 100644 --- a/lib/vapi/types/events_table_string_condition.rb +++ b/lib/vapi/types/events_table_string_condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters event data by comparing or searching a string field. class EventsTableStringCondition < Internal::Types::Model field :column, -> { String }, optional: false, nullable: false field :operator, -> { Vapi::Types::EventsTableStringConditionOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/exact_replacement.rb b/lib/vapi/types/exact_replacement.rb index 8af0d3af..3a352897 100644 --- a/lib/vapi/types/exact_replacement.rb +++ b/lib/vapi/types/exact_replacement.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Replaces an exact word or phrase before text is sent to a voice provider. class ExactReplacement < Internal::Types::Model field :replace_all_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "replaceAllEnabled" field :key, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/fallback_assembly_ai_transcriber.rb b/lib/vapi/types/fallback_assembly_ai_transcriber.rb index c87534d2..e73398ab 100644 --- a/lib/vapi/types/fallback_assembly_ai_transcriber.rb +++ b/lib/vapi/types/fallback_assembly_ai_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for transcribing speech with AssemblyAI, including language, streaming model, endpointing, + # and vocabulary. class FallbackAssemblyAiTranscriber < Internal::Types::Model field :language, -> { Vapi::Types::FallbackAssemblyAiTranscriberLanguage }, optional: true, nullable: false field :confidence_threshold, -> { Integer }, optional: true, nullable: false, api_name: "confidenceThreshold" diff --git a/lib/vapi/types/fallback_azure_speech_transcriber.rb b/lib/vapi/types/fallback_azure_speech_transcriber.rb index 3a20a1ab..375739ed 100644 --- a/lib/vapi/types/fallback_azure_speech_transcriber.rb +++ b/lib/vapi/types/fallback_azure_speech_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Azure Speech, including language and segmentation. class FallbackAzureSpeechTranscriber < Internal::Types::Model field :language, -> { Vapi::Types::FallbackAzureSpeechTranscriberLanguage }, optional: true, nullable: false field :segmentation_strategy, -> { Vapi::Types::FallbackAzureSpeechTranscriberSegmentationStrategy }, optional: true, nullable: false, api_name: "segmentationStrategy" diff --git a/lib/vapi/types/fallback_azure_voice.rb b/lib/vapi/types/fallback_azure_voice.rb index e2b22864..1b683306 100644 --- a/lib/vapi/types/fallback_azure_voice.rb +++ b/lib/vapi/types/fallback_azure_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, + # and caching. class FallbackAzureVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackAzureVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_cartesia_transcriber.rb b/lib/vapi/types/fallback_cartesia_transcriber.rb index 7b9d0981..81554296 100644 --- a/lib/vapi/types/fallback_cartesia_transcriber.rb +++ b/lib/vapi/types/fallback_cartesia_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Cartesia, including model and language. class FallbackCartesiaTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackCartesiaTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::FallbackCartesiaTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_cartesia_voice.rb b/lib/vapi/types/fallback_cartesia_voice.rb index 094f66f6..18ccdfbb 100644 --- a/lib/vapi/types/fallback_cartesia_voice.rb +++ b/lib/vapi/types/fallback_cartesia_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Cartesia, including voice and model selection, + # language, generation controls, pronunciation dictionaries, chunking, and caching. class FallbackCartesiaVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_custom_transcriber.rb b/lib/vapi/types/fallback_custom_transcriber.rb index 9f17ba43..dc89a0f9 100644 --- a/lib/vapi/types/fallback_custom_transcriber.rb +++ b/lib/vapi/types/fallback_custom_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fallback configuration for sending conversation audio to a custom WebSocket transcription server. class FallbackCustomTranscriber < Internal::Types::Model field :server, -> { Vapi::Types::Server }, optional: false, nullable: false end diff --git a/lib/vapi/types/fallback_custom_voice.rb b/lib/vapi/types/fallback_custom_voice.rb index 77fb660a..0cb1b4d9 100644 --- a/lib/vapi/types/fallback_custom_voice.rb +++ b/lib/vapi/types/fallback_custom_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech through a custom server, including voice selection, + # server connection, chunking, and caching. class FallbackCustomVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: true, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_deepgram_transcriber.rb b/lib/vapi/types/fallback_deepgram_transcriber.rb index d597067e..4352587d 100644 --- a/lib/vapi/types/fallback_deepgram_transcriber.rb +++ b/lib/vapi/types/fallback_deepgram_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Deepgram, including model, language, formatting, endpointing, + # and vocabulary. class FallbackDeepgramTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::DeepgramTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::DeepgramTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_deepgram_voice.rb b/lib/vapi/types/fallback_deepgram_voice.rb index acfc896e..f8299995 100644 --- a/lib/vapi/types/fallback_deepgram_voice.rb +++ b/lib/vapi/types/fallback_deepgram_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Deepgram, including voice and model selection, + # model-improvement preferences, chunking, and caching. class FallbackDeepgramVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackDeepgramVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_eleven_labs_transcriber.rb b/lib/vapi/types/fallback_eleven_labs_transcriber.rb index eeb48679..76895b1c 100644 --- a/lib/vapi/types/fallback_eleven_labs_transcriber.rb +++ b/lib/vapi/types/fallback_eleven_labs_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fallback configuration for transcribing speech with ElevenLabs, including model, language, and speech thresholds. class FallbackElevenLabsTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackElevenLabsTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::FallbackElevenLabsTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_eleven_labs_voice.rb b/lib/vapi/types/fallback_eleven_labs_voice.rb index 144bfd6d..45d757ae 100644 --- a/lib/vapi/types/fallback_eleven_labs_voice.rb +++ b/lib/vapi/types/fallback_eleven_labs_voice.rb @@ -2,6 +2,9 @@ module Vapi module Types + # 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 < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackElevenLabsVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_gladia_transcriber.rb b/lib/vapi/types/fallback_gladia_transcriber.rb index ec14e51f..45d0d5b2 100644 --- a/lib/vapi/types/fallback_gladia_transcriber.rb +++ b/lib/vapi/types/fallback_gladia_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Gladia, including language behavior, audio processing, + # endpointing, vocabulary, and region. class FallbackGladiaTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackGladiaTranscriberModel }, optional: true, nullable: false field :language_behaviour, -> { Vapi::Types::FallbackGladiaTranscriberLanguageBehaviour }, optional: true, nullable: false, api_name: "languageBehaviour" diff --git a/lib/vapi/types/fallback_google_transcriber.rb b/lib/vapi/types/fallback_google_transcriber.rb index 70ca7b0b..f3128103 100644 --- a/lib/vapi/types/fallback_google_transcriber.rb +++ b/lib/vapi/types/fallback_google_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Google, including model and language. class FallbackGoogleTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackGoogleTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::FallbackGoogleTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_hume_voice.rb b/lib/vapi/types/fallback_hume_voice.rb index d1a38477..39bd096c 100644 --- a/lib/vapi/types/fallback_hume_voice.rb +++ b/lib/vapi/types/fallback_hume_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Hume, including model and voice selection, custom + # voice metadata, chunking, and caching. class FallbackHumeVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :model, -> { Vapi::Types::FallbackHumeVoiceModel }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_inworld_voice.rb b/lib/vapi/types/fallback_inworld_voice.rb index ee8e549a..cb233e42 100644 --- a/lib/vapi/types/fallback_inworld_voice.rb +++ b/lib/vapi/types/fallback_inworld_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Inworld, including voice and model selection, + # language, temperature, speaking rate, chunking, and caching. class FallbackInworldVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackInworldVoiceVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_lmnt_voice.rb b/lib/vapi/types/fallback_lmnt_voice.rb index 9d06da57..bbdcfccc 100644 --- a/lib/vapi/types/fallback_lmnt_voice.rb +++ b/lib/vapi/types/fallback_lmnt_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, + # chunking, and caching. class FallbackLmntVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackLmntVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_neuphonic_voice.rb b/lib/vapi/types/fallback_neuphonic_voice.rb index 2758d872..fd8e2d46 100644 --- a/lib/vapi/types/fallback_neuphonic_voice.rb +++ b/lib/vapi/types/fallback_neuphonic_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, + # language, speed, chunking, and caching. class FallbackNeuphonicVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_open_ai_transcriber.rb b/lib/vapi/types/fallback_open_ai_transcriber.rb index b50e6d16..f52526b6 100644 --- a/lib/vapi/types/fallback_open_ai_transcriber.rb +++ b/lib/vapi/types/fallback_open_ai_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fallback configuration for transcribing speech with OpenAI, including model and language. class FallbackOpenAiTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackOpenAiTranscriberModel }, optional: false, nullable: false field :language, -> { Vapi::Types::FallbackOpenAiTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_open_ai_voice.rb b/lib/vapi/types/fallback_open_ai_voice.rb index 555dc34d..ec3ef185 100644 --- a/lib/vapi/types/fallback_open_ai_voice.rb +++ b/lib/vapi/types/fallback_open_ai_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with OpenAI, including voice and model selection, + # delivery instructions, speed, chunking, and caching. class FallbackOpenAiVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackOpenAiVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_plan.rb b/lib/vapi/types/fallback_plan.rb index ec515152..19539eb8 100644 --- a/lib/vapi/types/fallback_plan.rb +++ b/lib/vapi/types/fallback_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Lists backup voice configurations that can be used if the primary voice provider fails. class FallbackPlan < Internal::Types::Model field :voices, -> { Internal::Types::Array[Vapi::Types::FallbackPlanVoicesItem] }, optional: false, nullable: false end diff --git a/lib/vapi/types/fallback_play_ht_voice.rb b/lib/vapi/types/fallback_play_ht_voice.rb index 9c6ddd11..bc409594 100644 --- a/lib/vapi/types/fallback_play_ht_voice.rb +++ b/lib/vapi/types/fallback_play_ht_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with PlayHT, including voice and model selection, + # language, emotion and style guidance, chunking, and caching. class FallbackPlayHtVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackPlayHtVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_rime_ai_voice.rb b/lib/vapi/types/fallback_rime_ai_voice.rb index d65a03fd..e2ff1499 100644 --- a/lib/vapi/types/fallback_rime_ai_voice.rb +++ b/lib/vapi/types/fallback_rime_ai_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Rime AI, including voice and model selection, + # language, speed, pauses, phonemization, latency, chunking, and caching. class FallbackRimeAiVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackRimeAiVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_sesame_voice.rb b/lib/vapi/types/fallback_sesame_voice.rb index 13b48964..29c14461 100644 --- a/lib/vapi/types/fallback_sesame_voice.rb +++ b/lib/vapi/types/fallback_sesame_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Sesame, including voice and model selection, + # chunking, and caching. class FallbackSesameVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_smallest_ai_voice.rb b/lib/vapi/types/fallback_smallest_ai_voice.rb index 04274d93..e9fa7f71 100644 --- a/lib/vapi/types/fallback_smallest_ai_voice.rb +++ b/lib/vapi/types/fallback_smallest_ai_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, + # speed, chunking, and caching. class FallbackSmallestAiVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackSmallestAiVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_soniox_transcriber.rb b/lib/vapi/types/fallback_soniox_transcriber.rb index d5c33419..395b8a0c 100644 --- a/lib/vapi/types/fallback_soniox_transcriber.rb +++ b/lib/vapi/types/fallback_soniox_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Soniox, including model, language detection, endpointing, and + # vocabulary. class FallbackSonioxTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackSonioxTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::FallbackSonioxTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_speechmatics_transcriber.rb b/lib/vapi/types/fallback_speechmatics_transcriber.rb index 0c270c5f..b685276b 100644 --- a/lib/vapi/types/fallback_speechmatics_transcriber.rb +++ b/lib/vapi/types/fallback_speechmatics_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Speechmatics, including language, region, diarization, + # vocabulary, endpointing, and formatting. class FallbackSpeechmaticsTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackSpeechmaticsTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::FallbackSpeechmaticsTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_talkscriber_transcriber.rb b/lib/vapi/types/fallback_talkscriber_transcriber.rb index 8f3ef9be..42adcac9 100644 --- a/lib/vapi/types/fallback_talkscriber_transcriber.rb +++ b/lib/vapi/types/fallback_talkscriber_transcriber.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fallback configuration for transcribing speech with Talkscriber, including model and language. class FallbackTalkscriberTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::FallbackTalkscriberTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::FallbackTalkscriberTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/fallback_tavus_voice.rb b/lib/vapi/types/fallback_tavus_voice.rb index e201c26b..4e4cc393 100644 --- a/lib/vapi/types/fallback_tavus_voice.rb +++ b/lib/vapi/types/fallback_tavus_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for using Tavus as the assistant's voice provider, including persona, callback, context, + # greeting, conversation properties, chunking, and caching. class FallbackTavusVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackTavusVoiceVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_transcriber_plan.rb b/lib/vapi/types/fallback_transcriber_plan.rb index 70eadbfd..4e6a1d8e 100644 --- a/lib/vapi/types/fallback_transcriber_plan.rb +++ b/lib/vapi/types/fallback_transcriber_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Lists backup transcriber configurations that can be used if the primary transcriber fails. class FallbackTranscriberPlan < Internal::Types::Model field :transcribers, -> { Internal::Types::Array[Vapi::Types::FallbackTranscriberPlanTranscribersItem] }, optional: false, nullable: false end diff --git a/lib/vapi/types/fallback_vapi_voice.rb b/lib/vapi/types/fallback_vapi_voice.rb index 170b3a34..a33e9c42 100644 --- a/lib/vapi/types/fallback_vapi_voice.rb +++ b/lib/vapi/types/fallback_vapi_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fallback configuration for synthesizing assistant speech with Vapi, including voice selection, speed, + # pronunciation dictionary, chunking, and caching. class FallbackVapiVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::FallbackVapiVoiceVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/fallback_well_said_voice.rb b/lib/vapi/types/fallback_well_said_voice.rb index 0780470e..e6eef9cf 100644 --- a/lib/vapi/types/fallback_well_said_voice.rb +++ b/lib/vapi/types/fallback_well_said_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/file.rb b/lib/vapi/types/file.rb index 3b55f3f6..31c9bd33 100644 --- a/lib/vapi/types/file.rb +++ b/lib/vapi/types/file.rb @@ -2,6 +2,8 @@ module Vapi module Types + # An uploaded file record, including its processing status, storage details, extracted-text location, metadata, and + # lifecycle timestamps. class File < Internal::Types::Model field :object, -> { Vapi::Types::FileObject }, optional: true, nullable: false field :status, -> { Vapi::Types::FileStatus }, optional: true, nullable: false diff --git a/lib/vapi/types/filter_date_type_column_on_call_table.rb b/lib/vapi/types/filter_date_type_column_on_call_table.rb index face9fec..75572bf8 100644 --- a/lib/vapi/types/filter_date_type_column_on_call_table.rb +++ b/lib/vapi/types/filter_date_type_column_on_call_table.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters call records by comparing a start or end timestamp with a date. class FilterDateTypeColumnOnCallTable < Internal::Types::Model field :column, -> { Vapi::Types::FilterDateTypeColumnOnCallTableColumn }, optional: false, nullable: false field :operator, -> { Vapi::Types::FilterDateTypeColumnOnCallTableOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/filter_number_array_type_column_on_call_table.rb b/lib/vapi/types/filter_number_array_type_column_on_call_table.rb index 0692b043..b51a7e3c 100644 --- a/lib/vapi/types/filter_number_array_type_column_on_call_table.rb +++ b/lib/vapi/types/filter_number_array_type_column_on_call_table.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters numeric call fields using a list of values or an emptiness test. class FilterNumberArrayTypeColumnOnCallTable < Internal::Types::Model field :column, -> { Vapi::Types::FilterNumberArrayTypeColumnOnCallTableColumn }, optional: false, nullable: false field :operator, -> { Vapi::Types::FilterNumberArrayTypeColumnOnCallTableOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/filter_number_type_column_on_call_table.rb b/lib/vapi/types/filter_number_type_column_on_call_table.rb index d9dd8c18..bc98c17a 100644 --- a/lib/vapi/types/filter_number_type_column_on_call_table.rb +++ b/lib/vapi/types/filter_number_type_column_on_call_table.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters call records by comparing a numeric field with a value. class FilterNumberTypeColumnOnCallTable < Internal::Types::Model field :column, -> { Vapi::Types::FilterNumberTypeColumnOnCallTableColumn }, optional: false, nullable: false field :operator, -> { Vapi::Types::FilterNumberTypeColumnOnCallTableOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/filter_string_array_type_column_on_call_table.rb b/lib/vapi/types/filter_string_array_type_column_on_call_table.rb index 518f6102..e585a91e 100644 --- a/lib/vapi/types/filter_string_array_type_column_on_call_table.rb +++ b/lib/vapi/types/filter_string_array_type_column_on_call_table.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters string-valued call fields using a list of values or an emptiness test. class FilterStringArrayTypeColumnOnCallTable < Internal::Types::Model field :column, -> { Vapi::Types::FilterStringArrayTypeColumnOnCallTableColumn }, optional: false, nullable: false field :operator, -> { Vapi::Types::FilterStringArrayTypeColumnOnCallTableOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/filter_string_type_column_on_call_table.rb b/lib/vapi/types/filter_string_type_column_on_call_table.rb index 6e2e0c11..8e8a871e 100644 --- a/lib/vapi/types/filter_string_type_column_on_call_table.rb +++ b/lib/vapi/types/filter_string_type_column_on_call_table.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters call records by comparing or searching a string-valued field. class FilterStringTypeColumnOnCallTable < Internal::Types::Model field :column, -> { Vapi::Types::FilterStringTypeColumnOnCallTableColumn }, optional: false, nullable: false field :operator, -> { Vapi::Types::FilterStringTypeColumnOnCallTableOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/filter_structured_output_column_on_call_table.rb b/lib/vapi/types/filter_structured_output_column_on_call_table.rb index 8bc8d622..77a9f79e 100644 --- a/lib/vapi/types/filter_structured_output_column_on_call_table.rb +++ b/lib/vapi/types/filter_structured_output_column_on_call_table.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Filters a structured-output value stored on a call using comparison, membership, containment, or emptiness + # operators. class FilterStructuredOutputColumnOnCallTable < Internal::Types::Model field :column, -> { Vapi::Types::FilterStructuredOutputColumnOnCallTableColumn }, optional: false, nullable: false field :operator, -> { Vapi::Types::FilterStructuredOutputColumnOnCallTableOperator }, optional: false, nullable: false diff --git a/lib/vapi/types/format_plan.rb b/lib/vapi/types/format_plan.rb index 4bf6fe8e..2a41d0a3 100644 --- a/lib/vapi/types/format_plan.rb +++ b/lib/vapi/types/format_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls text normalization before voice synthesis, including built-in formatters, number handling, and custom + # replacements. class FormatPlan < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false field :number_to_digits_cutoff, -> { Integer }, optional: true, nullable: false, api_name: "numberToDigitsCutoff" diff --git a/lib/vapi/types/fourier_denoising_plan.rb b/lib/vapi/types/fourier_denoising_plan.rb index 6b6091c9..eaa94069 100644 --- a/lib/vapi/types/fourier_denoising_plan.rb +++ b/lib/vapi/types/fourier_denoising_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for Fourier denoising, including media detection, thresholds, baseline calculation, and analysis + # window. class FourierDenoisingPlan < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false field :media_detection_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "mediaDetectionEnabled" diff --git a/lib/vapi/types/function_tool.rb b/lib/vapi/types/function_tool.rb index a7cde977..a8f90d39 100644 --- a/lib/vapi/types/function_tool.rb +++ b/lib/vapi/types/function_tool.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A reusable custom function tool that sends model-generated arguments to a configured server and returns the result + # to the assistant. class FunctionTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::FunctionToolMessagesItem] }, optional: true, nullable: false field :async, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/gcp_key.rb b/lib/vapi/types/gcp_key.rb index e440a8a1..7f74997c 100644 --- a/lib/vapi/types/gcp_key.rb +++ b/lib/vapi/types/gcp_key.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Google Cloud service-account key used to authenticate access to Google Cloud resources. class GcpKey < Internal::Types::Model field :type, -> { String }, optional: false, nullable: false field :project_id, -> { String }, optional: false, nullable: false, api_name: "projectId" diff --git a/lib/vapi/types/gemini_multimodal_live_prebuilt_voice_config.rb b/lib/vapi/types/gemini_multimodal_live_prebuilt_voice_config.rb index b103adc2..985686db 100644 --- a/lib/vapi/types/gemini_multimodal_live_prebuilt_voice_config.rb +++ b/lib/vapi/types/gemini_multimodal_live_prebuilt_voice_config.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Selects a prebuilt voice for Gemini Multimodal Live audio output. class GeminiMultimodalLivePrebuiltVoiceConfig < Internal::Types::Model field :voice_name, -> { Vapi::Types::GeminiMultimodalLivePrebuiltVoiceConfigVoiceName }, optional: false, nullable: false, api_name: "voiceName" end diff --git a/lib/vapi/types/gemini_multimodal_live_speech_config.rb b/lib/vapi/types/gemini_multimodal_live_speech_config.rb index 665eb6d2..9840fd5c 100644 --- a/lib/vapi/types/gemini_multimodal_live_speech_config.rb +++ b/lib/vapi/types/gemini_multimodal_live_speech_config.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Speech-output configuration for Gemini Multimodal Live. class GeminiMultimodalLiveSpeechConfig < Internal::Types::Model field :voice_config, -> { Vapi::Types::GeminiMultimodalLiveVoiceConfig }, optional: false, nullable: false, api_name: "voiceConfig" end diff --git a/lib/vapi/types/gemini_multimodal_live_voice_config.rb b/lib/vapi/types/gemini_multimodal_live_voice_config.rb index 1321914c..29f4722c 100644 --- a/lib/vapi/types/gemini_multimodal_live_voice_config.rb +++ b/lib/vapi/types/gemini_multimodal_live_voice_config.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Voice selection configuration for Gemini Multimodal Live. class GeminiMultimodalLiveVoiceConfig < Internal::Types::Model field :prebuilt_voice_config, -> { Vapi::Types::GeminiMultimodalLivePrebuiltVoiceConfig }, optional: false, nullable: false, api_name: "prebuiltVoiceConfig" end diff --git a/lib/vapi/types/ghl_tool_metadata.rb b/lib/vapi/types/ghl_tool_metadata.rb index 248d147a..f93a7d65 100644 --- a/lib/vapi/types/ghl_tool_metadata.rb +++ b/lib/vapi/types/ghl_tool_metadata.rb @@ -2,6 +2,7 @@ module Vapi module Types + # GHL workflow and location identifiers attached to a tool. class GhlToolMetadata < Internal::Types::Model field :workflow_id, -> { String }, optional: true, nullable: false, api_name: "workflowId" field :location_id, -> { String }, optional: true, nullable: false, api_name: "locationId" diff --git a/lib/vapi/types/gladia_custom_vocabulary_config_dto.rb b/lib/vapi/types/gladia_custom_vocabulary_config_dto.rb index ed9f31c3..142b7283 100644 --- a/lib/vapi/types/gladia_custom_vocabulary_config_dto.rb +++ b/lib/vapi/types/gladia_custom_vocabulary_config_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Custom vocabulary configuration for Gladia transcription, including vocabulary items and default recognition + # intensity. class GladiaCustomVocabularyConfigDto < Internal::Types::Model field :vocabulary, -> { Internal::Types::Array[Vapi::Types::GladiaCustomVocabularyConfigDtoVocabularyItem] }, optional: false, nullable: false field :default_intensity, -> { Integer }, optional: true, nullable: false, api_name: "defaultIntensity" diff --git a/lib/vapi/types/gladia_transcriber.rb b/lib/vapi/types/gladia_transcriber.rb index 2bc833d0..1afb6203 100644 --- a/lib/vapi/types/gladia_transcriber.rb +++ b/lib/vapi/types/gladia_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Gladia, including language behavior, + # audio processing, endpointing, vocabulary, region, and fallback settings. class GladiaTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::GladiaTranscriberModel }, optional: true, nullable: false field :language_behaviour, -> { Vapi::Types::GladiaTranscriberLanguageBehaviour }, optional: true, nullable: false, api_name: "languageBehaviour" diff --git a/lib/vapi/types/gladia_vocabulary_item_dto.rb b/lib/vapi/types/gladia_vocabulary_item_dto.rb index 6df6389a..19f18697 100644 --- a/lib/vapi/types/gladia_vocabulary_item_dto.rb +++ b/lib/vapi/types/gladia_vocabulary_item_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A Gladia custom vocabulary word or phrase with optional pronunciations, intensity, and language. class GladiaVocabularyItemDto < Internal::Types::Model field :value, -> { String }, optional: false, nullable: false field :pronunciations, -> { Internal::Types::Array[String] }, optional: true, nullable: false diff --git a/lib/vapi/types/global_node_plan.rb b/lib/vapi/types/global_node_plan.rb index 5bf1fa1c..0255ccf9 100644 --- a/lib/vapi/types/global_node_plan.rb +++ b/lib/vapi/types/global_node_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls whether a conversation node can be entered globally and the condition evaluated before that node runs. class GlobalNodePlan < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false field :enter_condition, -> { String }, optional: true, nullable: false, api_name: "enterCondition" diff --git a/lib/vapi/types/go_high_level_calendar_availability_tool.rb b/lib/vapi/types/go_high_level_calendar_availability_tool.rb index a5c468eb..33596a49 100644 --- a/lib/vapi/types/go_high_level_calendar_availability_tool.rb +++ b/lib/vapi/types/go_high_level_calendar_availability_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that checks calendar availability in a connected GoHighLevel account. class GoHighLevelCalendarAvailabilityTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::GoHighLevelCalendarAvailabilityToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/go_high_level_calendar_event_create_tool.rb b/lib/vapi/types/go_high_level_calendar_event_create_tool.rb index 2f8c0b11..5ccf6c2e 100644 --- a/lib/vapi/types/go_high_level_calendar_event_create_tool.rb +++ b/lib/vapi/types/go_high_level_calendar_event_create_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that adds calendar events to a connected GoHighLevel account. class GoHighLevelCalendarEventCreateTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::GoHighLevelCalendarEventCreateToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/go_high_level_contact_create_tool.rb b/lib/vapi/types/go_high_level_contact_create_tool.rb index f0fb6e91..8420eab0 100644 --- a/lib/vapi/types/go_high_level_contact_create_tool.rb +++ b/lib/vapi/types/go_high_level_contact_create_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that adds contacts to a connected GoHighLevel account. class GoHighLevelContactCreateTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::GoHighLevelContactCreateToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/go_high_level_contact_get_tool.rb b/lib/vapi/types/go_high_level_contact_get_tool.rb index 1b34c633..86f6ec12 100644 --- a/lib/vapi/types/go_high_level_contact_get_tool.rb +++ b/lib/vapi/types/go_high_level_contact_get_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that retrieves contacts from a connected GoHighLevel account. class GoHighLevelContactGetTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::GoHighLevelContactGetToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/google_calendar_check_availability_tool.rb b/lib/vapi/types/google_calendar_check_availability_tool.rb index 12759fcd..5f94ac3a 100644 --- a/lib/vapi/types/google_calendar_check_availability_tool.rb +++ b/lib/vapi/types/google_calendar_check_availability_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that checks availability in a connected Google Calendar. class GoogleCalendarCheckAvailabilityTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::GoogleCalendarCheckAvailabilityToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/google_calendar_create_event_tool.rb b/lib/vapi/types/google_calendar_create_event_tool.rb index 91879a57..b51bbd4c 100644 --- a/lib/vapi/types/google_calendar_create_event_tool.rb +++ b/lib/vapi/types/google_calendar_create_event_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that adds events to a connected Google Calendar. class GoogleCalendarCreateEventTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::GoogleCalendarCreateEventToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/google_model.rb b/lib/vapi/types/google_model.rb index fc4f420c..49170537 100644 --- a/lib/vapi/types/google_model.rb +++ b/lib/vapi/types/google_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Google, including model, prompts, tools, knowledge-base + # access, realtime settings, and generation settings. class GoogleModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::GoogleModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/google_realtime_config.rb b/lib/vapi/types/google_realtime_config.rb index 4b88c4e7..65aad963 100644 --- a/lib/vapi/types/google_realtime_config.rb +++ b/lib/vapi/types/google_realtime_config.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Realtime Gemini generation and speech-output settings, including sampling, repetition penalties, and voice + # configuration. class GoogleRealtimeConfig < Internal::Types::Model field :top_p, -> { Integer }, optional: true, nullable: false, api_name: "topP" field :top_k, -> { Integer }, optional: true, nullable: false, api_name: "topK" diff --git a/lib/vapi/types/google_sheets_row_append_tool.rb b/lib/vapi/types/google_sheets_row_append_tool.rb index c98b7ea0..f314f365 100644 --- a/lib/vapi/types/google_sheets_row_append_tool.rb +++ b/lib/vapi/types/google_sheets_row_append_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that appends rows to a connected Google Sheet. class GoogleSheetsRowAppendTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::GoogleSheetsRowAppendToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/google_transcriber.rb b/lib/vapi/types/google_transcriber.rb index eb109467..a05c7f81 100644 --- a/lib/vapi/types/google_transcriber.rb +++ b/lib/vapi/types/google_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Google, including model, language, and + # fallback settings. class GoogleTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::GoogleTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::GoogleTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/google_voicemail_detection_plan.rb b/lib/vapi/types/google_voicemail_detection_plan.rb index 459d305f..9acdb79d 100644 --- a/lib/vapi/types/google_voicemail_detection_plan.rb +++ b/lib/vapi/types/google_voicemail_detection_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for detecting voicemail with Google, including detection type, maximum beep wait, and retry backoff. class GoogleVoicemailDetectionPlan < Internal::Types::Model field :beep_max_await_seconds, -> { Integer }, optional: true, nullable: false, api_name: "beepMaxAwaitSeconds" field :provider, -> { Vapi::Types::GoogleVoicemailDetectionPlanProvider }, optional: false, nullable: false diff --git a/lib/vapi/types/groq_model.rb b/lib/vapi/types/groq_model.rb index f4d58af8..5d55eab8 100644 --- a/lib/vapi/types/groq_model.rb +++ b/lib/vapi/types/groq_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Groq, including model, prompts, tools, knowledge-base + # access, and generation settings. class GroqModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::GroqModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/group_condition.rb b/lib/vapi/types/group_condition.rb index e27a2564..f288fcc1 100644 --- a/lib/vapi/types/group_condition.rb +++ b/lib/vapi/types/group_condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Combines nested regular-expression, Liquid, or grouped conditions with an `AND` or `OR` operator. class GroupCondition < Internal::Types::Model field :operator, -> { Vapi::Types::GroupConditionOperator }, optional: false, nullable: false field :conditions, -> { Internal::Types::Array[Vapi::Types::GroupConditionConditionsItem] }, optional: false, nullable: false diff --git a/lib/vapi/types/handoff_destination_assistant.rb b/lib/vapi/types/handoff_destination_assistant.rb index 0d31a368..6afc224d 100644 --- a/lib/vapi/types/handoff_destination_assistant.rb +++ b/lib/vapi/types/handoff_destination_assistant.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Routes a handoff to a saved or transient assistant, with optional context engineering, variable extraction, and + # assistant overrides. class HandoffDestinationAssistant < Internal::Types::Model field :type, -> { Vapi::Types::HandoffDestinationAssistantType }, optional: false, nullable: false field :context_engineering_plan, -> { Vapi::Types::HandoffDestinationAssistantContextEngineeringPlan }, optional: true, nullable: false, api_name: "contextEngineeringPlan" diff --git a/lib/vapi/types/handoff_destination_dynamic.rb b/lib/vapi/types/handoff_destination_dynamic.rb index 27abbccf..8f431ce0 100644 --- a/lib/vapi/types/handoff_destination_dynamic.rb +++ b/lib/vapi/types/handoff_destination_dynamic.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Uses a webhook response to select the handoff destination at runtime. class HandoffDestinationDynamic < Internal::Types::Model field :server, -> { Vapi::Types::Server }, optional: true, nullable: false field :description, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/handoff_destination_squad.rb b/lib/vapi/types/handoff_destination_squad.rb index 7fd97c82..a0baba65 100644 --- a/lib/vapi/types/handoff_destination_squad.rb +++ b/lib/vapi/types/handoff_destination_squad.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Routes a handoff to a saved or transient squad, with optional entry assistant, context engineering, variable + # extraction, and overrides. class HandoffDestinationSquad < Internal::Types::Model field :context_engineering_plan, -> { Vapi::Types::HandoffDestinationSquadContextEngineeringPlan }, optional: true, nullable: false, api_name: "contextEngineeringPlan" field :squad_id, -> { String }, optional: true, nullable: false, api_name: "squadId" diff --git a/lib/vapi/types/handoff_tool.rb b/lib/vapi/types/handoff_tool.rb index e1a7d9c1..5ec98e7a 100644 --- a/lib/vapi/types/handoff_tool.rb +++ b/lib/vapi/types/handoff_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that hands a conversation to another assistant, squad, or dynamically selected destination. class HandoffTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::HandoffToolMessagesItem] }, optional: true, nullable: false field :default_result, -> { String }, optional: true, nullable: false, api_name: "defaultResult" diff --git a/lib/vapi/types/hmac_authentication_plan.rb b/lib/vapi/types/hmac_authentication_plan.rb index 67ac6a46..3cf0e06b 100644 --- a/lib/vapi/types/hmac_authentication_plan.rb +++ b/lib/vapi/types/hmac_authentication_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for signing outbound requests with an HMAC secret, including algorithm, headers, payload format, and + # signature encoding. class HmacAuthenticationPlan < Internal::Types::Model field :secret_key, -> { String }, optional: false, nullable: false, api_name: "secretKey" field :algorithm, -> { Vapi::Types::HmacAuthenticationPlanAlgorithm }, optional: false, nullable: false diff --git a/lib/vapi/types/hume_voice.rb b/lib/vapi/types/hume_voice.rb index e32cd11a..fe907aa3 100644 --- a/lib/vapi/types/hume_voice.rb +++ b/lib/vapi/types/hume_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice + # metadata, chunking, caching, and fallback settings. class HumeVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :model, -> { Vapi::Types::HumeVoiceModel }, optional: true, nullable: false diff --git a/lib/vapi/types/import_twilio_phone_number_dto.rb b/lib/vapi/types/import_twilio_phone_number_dto.rb index a777b224..fe17b42c 100644 --- a/lib/vapi/types/import_twilio_phone_number_dto.rb +++ b/lib/vapi/types/import_twilio_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for importing a Twilio phone number into Vapi, including Twilio credentials, routing target, + # fallback destination, hooks, SMS, and server settings. class ImportTwilioPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::ImportTwilioPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::ImportTwilioPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/inflection_ai_model.rb b/lib/vapi/types/inflection_ai_model.rb index 5c87ba92..5c303d1f 100644 --- a/lib/vapi/types/inflection_ai_model.rb +++ b/lib/vapi/types/inflection_ai_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Inflection AI, including model, prompts, tools, + # knowledge-base access, and generation settings. class InflectionAiModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::InflectionAiModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/insight.rb b/lib/vapi/types/insight.rb index 993480be..cb91d9c3 100644 --- a/lib/vapi/types/insight.rb +++ b/lib/vapi/types/insight.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved insight returned by the API, including its visualization type, identity, organization, and lifecycle + # timestamps. class Insight < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :type, -> { Vapi::Types::InsightType }, optional: false, nullable: false diff --git a/lib/vapi/types/insight_formula.rb b/lib/vapi/types/insight_formula.rb index 4a7cf492..651d9c97 100644 --- a/lib/vapi/types/insight_formula.rb +++ b/lib/vapi/types/insight_formula.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A formula used to calculate an insight from its query results, with an optional display name. class InsightFormula < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formula, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/insight_paginated_response.rb b/lib/vapi/types/insight_paginated_response.rb index e5398b10..fe54e988 100644 --- a/lib/vapi/types/insight_paginated_response.rb +++ b/lib/vapi/types/insight_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of saved reporting insights and metadata describing the result set. class InsightPaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::Insight] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/insight_run_format_plan.rb b/lib/vapi/types/insight_run_format_plan.rb index f10db117..8b627923 100644 --- a/lib/vapi/types/insight_run_format_plan.rb +++ b/lib/vapi/types/insight_run_format_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Selects whether an insight run returns raw data or Recharts-formatted data. class InsightRunFormatPlan < Internal::Types::Model field :format, -> { Vapi::Types::InsightRunFormatPlanFormat }, optional: true, nullable: false end diff --git a/lib/vapi/types/insight_run_response.rb b/lib/vapi/types/insight_run_response.rb index 719c94fb..36dd1d32 100644 --- a/lib/vapi/types/insight_run_response.rb +++ b/lib/vapi/types/insight_run_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Metadata identifying a saved insight run and its lifecycle timestamps. class InsightRunResponse < Internal::Types::Model field :id, -> { String }, optional: false, nullable: false field :insight_id, -> { String }, optional: false, nullable: false, api_name: "insightId" diff --git a/lib/vapi/types/insight_time_range.rb b/lib/vapi/types/insight_time_range.rb index 217359f6..9b57d8ca 100644 --- a/lib/vapi/types/insight_time_range.rb +++ b/lib/vapi/types/insight_time_range.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Start, end, and timezone used to limit an insight query by time. class InsightTimeRange < Internal::Types::Model field :start, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false field :end_, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "end" diff --git a/lib/vapi/types/insight_time_range_with_step.rb b/lib/vapi/types/insight_time_range_with_step.rb index 6985e989..81577e48 100644 --- a/lib/vapi/types/insight_time_range_with_step.rb +++ b/lib/vapi/types/insight_time_range_with_step.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Start, end, timezone, and aggregation step used for a time-series insight query. class InsightTimeRangeWithStep < Internal::Types::Model field :step, -> { Vapi::Types::InsightTimeRangeWithStepStep }, optional: true, nullable: false field :start, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false diff --git a/lib/vapi/types/inworld_voice.rb b/lib/vapi/types/inworld_voice.rb index a8cc5170..882081ce 100644 --- a/lib/vapi/types/inworld_voice.rb +++ b/lib/vapi/types/inworld_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, + # temperature, speaking rate, chunking, caching, and fallback settings. class InworldVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::InworldVoiceVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/json_query_on_call_table_with_number_type_column.rb b/lib/vapi/types/json_query_on_call_table_with_number_type_column.rb index 4a482d26..5af46493 100644 --- a/lib/vapi/types/json_query_on_call_table_with_number_type_column.rb +++ b/lib/vapi/types/json_query_on_call_table_with_number_type_column.rb @@ -2,6 +2,7 @@ module Vapi module Types + # VapiQL JSON query that aggregates a numeric call-table column with optional call filters. class JsonQueryOnCallTableWithNumberTypeColumn < Internal::Types::Model field :type, -> { Vapi::Types::JsonQueryOnCallTableWithNumberTypeColumnType }, optional: false, nullable: false field :table, -> { Vapi::Types::JsonQueryOnCallTableWithNumberTypeColumnTable }, optional: false, nullable: false diff --git a/lib/vapi/types/json_query_on_call_table_with_string_type_column.rb b/lib/vapi/types/json_query_on_call_table_with_string_type_column.rb index 929192d0..e04e2e25 100644 --- a/lib/vapi/types/json_query_on_call_table_with_string_type_column.rb +++ b/lib/vapi/types/json_query_on_call_table_with_string_type_column.rb @@ -2,6 +2,7 @@ module Vapi module Types + # VapiQL JSON query that counts values from a string-valued call-table column with optional call filters. class JsonQueryOnCallTableWithStringTypeColumn < Internal::Types::Model field :type, -> { Vapi::Types::JsonQueryOnCallTableWithStringTypeColumnType }, optional: false, nullable: false field :table, -> { Vapi::Types::JsonQueryOnCallTableWithStringTypeColumnTable }, optional: false, nullable: false diff --git a/lib/vapi/types/json_query_on_call_table_with_structured_output_column.rb b/lib/vapi/types/json_query_on_call_table_with_structured_output_column.rb index be6bef07..7ce0bfed 100644 --- a/lib/vapi/types/json_query_on_call_table_with_structured_output_column.rb +++ b/lib/vapi/types/json_query_on_call_table_with_structured_output_column.rb @@ -2,6 +2,7 @@ module Vapi module Types + # VapiQL JSON query that aggregates or counts a structured-output value stored on call records. class JsonQueryOnCallTableWithStructuredOutputColumn < Internal::Types::Model field :type, -> { Vapi::Types::JsonQueryOnCallTableWithStructuredOutputColumnType }, optional: false, nullable: false field :table, -> { Vapi::Types::JsonQueryOnCallTableWithStructuredOutputColumnTable }, optional: false, nullable: false diff --git a/lib/vapi/types/json_query_on_events_table.rb b/lib/vapi/types/json_query_on_events_table.rb index d0ca7664..2be22c6f 100644 --- a/lib/vapi/types/json_query_on_events_table.rb +++ b/lib/vapi/types/json_query_on_events_table.rb @@ -2,6 +2,8 @@ module Vapi module Types + # VapiQL JSON query that counts or calculates the percentage of matching events using optional typed event-data + # filters. class JsonQueryOnEventsTable < Internal::Types::Model field :type, -> { Vapi::Types::JsonQueryOnEventsTableType }, optional: false, nullable: false field :table, -> { Vapi::Types::JsonQueryOnEventsTableTable }, optional: false, nullable: false diff --git a/lib/vapi/types/json_schema.rb b/lib/vapi/types/json_schema.rb index 38954e77..0ff5274c 100644 --- a/lib/vapi/types/json_schema.rb +++ b/lib/vapi/types/json_schema.rb @@ -2,6 +2,7 @@ module Vapi module Types + # JSON Schema definition used to describe structured data for extraction, validation, or model output. class JsonSchema < Internal::Types::Model field :type, -> { Vapi::Types::JsonSchemaType }, optional: false, nullable: false field :items, -> { Vapi::Types::JsonSchema }, optional: true, nullable: false diff --git a/lib/vapi/types/keypad_input_plan.rb b/lib/vapi/types/keypad_input_plan.rb index 33183902..dc5c3c6e 100644 --- a/lib/vapi/types/keypad_input_plan.rb +++ b/lib/vapi/types/keypad_input_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls collection of dual-tone multi-frequency (DTMF) keypad input, including enablement, processing timeout, + # and delimiters. class KeypadInputPlan < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false field :timeout_seconds, -> { Integer }, optional: true, nullable: false, api_name: "timeoutSeconds" diff --git a/lib/vapi/types/knowledge_base.rb b/lib/vapi/types/knowledge_base.rb index 7435da36..2684b5dd 100644 --- a/lib/vapi/types/knowledge_base.rb +++ b/lib/vapi/types/knowledge_base.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A knowledge-base configuration, including its provider, model, description, and associated files. class KnowledgeBase < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :provider, -> { Vapi::Types::KnowledgeBaseProvider }, optional: false, nullable: false diff --git a/lib/vapi/types/knowledge_base_cost.rb b/lib/vapi/types/knowledge_base_cost.rb index 62eae7fb..51b44e1a 100644 --- a/lib/vapi/types/knowledge_base_cost.rb +++ b/lib/vapi/types/knowledge_base_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Knowledge-base model cost, including model, token usage, and amount. class KnowledgeBaseCost < Internal::Types::Model field :model, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false field :prompt_tokens, -> { Integer }, optional: false, nullable: false, api_name: "promptTokens" diff --git a/lib/vapi/types/langfuse_observability_plan.rb b/lib/vapi/types/langfuse_observability_plan.rb index 2b0f3cc7..a0758f70 100644 --- a/lib/vapi/types/langfuse_observability_plan.rb +++ b/lib/vapi/types/langfuse_observability_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for sending assistant call traces to Langfuse, including prompt version linkage, trace naming, tags, + # and metadata. class LangfuseObservabilityPlan < Internal::Types::Model field :provider, -> { Vapi::Types::LangfuseObservabilityPlanProvider }, optional: false, nullable: false field :prompt_name, -> { String }, optional: true, nullable: false, api_name: "promptName" diff --git a/lib/vapi/types/line_insight.rb b/lib/vapi/types/line_insight.rb index 616f2c83..e4c24eee 100644 --- a/lib/vapi/types/line_insight.rb +++ b/lib/vapi/types/line_insight.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved line-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and + # lifecycle information. class LineInsight < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/line_insight_metadata.rb b/lib/vapi/types/line_insight_metadata.rb index 1fc9e6fd..39fa7ed8 100644 --- a/lib/vapi/types/line_insight_metadata.rb +++ b/lib/vapi/types/line_insight_metadata.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Display settings for a line insight, including chart name, axis labels, and optional y-axis bounds. class LineInsightMetadata < Internal::Types::Model field :x_axis_label, -> { String }, optional: true, nullable: false, api_name: "xAxisLabel" field :y_axis_label, -> { String }, optional: true, nullable: false, api_name: "yAxisLabel" diff --git a/lib/vapi/types/liquid_condition.rb b/lib/vapi/types/liquid_condition.rb index 0e641af3..9e975878 100644 --- a/lib/vapi/types/liquid_condition.rb +++ b/lib/vapi/types/liquid_condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Evaluates a Liquid template that must return `true` or `false`. class LiquidCondition < Internal::Types::Model field :liquid, -> { String }, optional: false, nullable: false end diff --git a/lib/vapi/types/livekit_smart_endpointing_plan.rb b/lib/vapi/types/livekit_smart_endpointing_plan.rb index cf3e744b..ac4101f3 100644 --- a/lib/vapi/types/livekit_smart_endpointing_plan.rb +++ b/lib/vapi/types/livekit_smart_endpointing_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for using LiveKit smart endpointing, including provider selection and wait-function behavior. class LivekitSmartEndpointingPlan < Internal::Types::Model field :provider, -> { Vapi::Types::LivekitSmartEndpointingPlanProvider }, optional: false, nullable: false field :wait_function, -> { String }, optional: true, nullable: false, api_name: "waitFunction" diff --git a/lib/vapi/types/lmnt_voice.rb b/lib/vapi/types/lmnt_voice.rb index a1d73a64..63e8fdee 100644 --- a/lib/vapi/types/lmnt_voice.rb +++ b/lib/vapi/types/lmnt_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, + # caching, and fallback settings. class LmntVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::LmntVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/mcp_tool.rb b/lib/vapi/types/mcp_tool.rb index 0aba0c02..16dd8a88 100644 --- a/lib/vapi/types/mcp_tool.rb +++ b/lib/vapi/types/mcp_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that connects an assistant to a Model Context Protocol server and exposes its available tools. class McpTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::McpToolMessagesItem] }, optional: true, nullable: false field :server, -> { Vapi::Types::Server }, optional: true, nullable: false diff --git a/lib/vapi/types/mcp_tool_messages.rb b/lib/vapi/types/mcp_tool_messages.rb index 97dddcd5..9f8ebfe3 100644 --- a/lib/vapi/types/mcp_tool_messages.rb +++ b/lib/vapi/types/mcp_tool_messages.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Per-tool message overrides for a tool discovered through an MCP server. class McpToolMessages < Internal::Types::Model field :name, -> { String }, optional: false, nullable: false field :messages, -> { Internal::Types::Array[Vapi::Types::McpToolMessagesMessagesItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/mcp_tool_metadata.rb b/lib/vapi/types/mcp_tool_metadata.rb index 2daeab0a..1ea420fa 100644 --- a/lib/vapi/types/mcp_tool_metadata.rb +++ b/lib/vapi/types/mcp_tool_metadata.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Protocol metadata used to communicate with an MCP server. class McpToolMetadata < Internal::Types::Model field :protocol, -> { Vapi::Types::McpToolMetadataProtocol }, optional: true, nullable: false end diff --git a/lib/vapi/types/message_add_hook_action.rb b/lib/vapi/types/message_add_hook_action.rb index 139d5689..eed3e533 100644 --- a/lib/vapi/types/message_add_hook_action.rb +++ b/lib/vapi/types/message_add_hook_action.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A hook action that adds an OpenAI-format message to the conversation and can trigger an assistant response. class MessageAddHookAction < Internal::Types::Model field :message, -> { Vapi::Types::OpenAiMessage }, optional: false, nullable: false field :trigger_response_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "triggerResponseEnabled" diff --git a/lib/vapi/types/message_target.rb b/lib/vapi/types/message_target.rb index ce048b20..9de3fb1c 100644 --- a/lib/vapi/types/message_target.rb +++ b/lib/vapi/types/message_target.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Selects a conversation message by participant role and position for condition evaluation. class MessageTarget < Internal::Types::Model field :role, -> { Vapi::Types::MessageTargetRole }, optional: true, nullable: false field :position, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/minimax_llm_model.rb b/lib/vapi/types/minimax_llm_model.rb index 104ba934..2ebfbb68 100644 --- a/lib/vapi/types/minimax_llm_model.rb +++ b/lib/vapi/types/minimax_llm_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with MiniMax, including model, prompts, tools, knowledge-base + # access, and generation settings. class MinimaxLlmModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::MinimaxLlmModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/minimax_voice.rb b/lib/vapi/types/minimax_voice.rb index 14340ce7..5d0646d3 100644 --- a/lib/vapi/types/minimax_voice.rb +++ b/lib/vapi/types/minimax_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/model_cost.rb b/lib/vapi/types/model_cost.rb index 7f58e619..f3679d32 100644 --- a/lib/vapi/types/model_cost.rb +++ b/lib/vapi/types/model_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Language-model cost for a call, including model, token usage, and amount. class ModelCost < Internal::Types::Model field :model, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false field :prompt_tokens, -> { Integer }, optional: false, nullable: false, api_name: "promptTokens" diff --git a/lib/vapi/types/monitor.rb b/lib/vapi/types/monitor.rb index 9324f44e..5d22dae2 100644 --- a/lib/vapi/types/monitor.rb +++ b/lib/vapi/types/monitor.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Live monitoring data for a call, including attached monitor results and listening and control URLs. class Monitor < Internal::Types::Model field :monitors, -> { Internal::Types::Array[Vapi::Types::MonitorResult] }, optional: true, nullable: false field :listen_url, -> { String }, optional: true, nullable: false, api_name: "listenUrl" diff --git a/lib/vapi/types/monitor_plan.rb b/lib/vapi/types/monitor_plan.rb index c586bc2b..a88dc185 100644 --- a/lib/vapi/types/monitor_plan.rb +++ b/lib/vapi/types/monitor_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls real-time listening and control for assistant calls, authentication requirements for monitor URLs, and + # attached monitors. class MonitorPlan < Internal::Types::Model field :listen_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "listenEnabled" field :listen_authentication_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "listenAuthenticationEnabled" diff --git a/lib/vapi/types/monitor_result.rb b/lib/vapi/types/monitor_result.rb index 74272d52..a4cad87e 100644 --- a/lib/vapi/types/monitor_result.rb +++ b/lib/vapi/types/monitor_result.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Result of evaluating an attached monitor's filter for a call. class MonitorResult < Internal::Types::Model field :monitor_id, -> { String }, optional: false, nullable: false, api_name: "monitorId" field :filter_passed, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "filterPassed" diff --git a/lib/vapi/types/mono.rb b/lib/vapi/types/mono.rb index 79bb3931..30486078 100644 --- a/lib/vapi/types/mono.rb +++ b/lib/vapi/types/mono.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Mono recording URLs for the combined call and isolated assistant and customer audio. class Mono < Internal::Types::Model field :combined_url, -> { String }, optional: true, nullable: false, api_name: "combinedUrl" field :assistant_url, -> { String }, optional: true, nullable: false, api_name: "assistantUrl" diff --git a/lib/vapi/types/neuphonic_voice.rb b/lib/vapi/types/neuphonic_voice.rb index c38b27d3..9dccc9da 100644 --- a/lib/vapi/types/neuphonic_voice.rb +++ b/lib/vapi/types/neuphonic_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, + # speed, chunking, caching, and fallback settings. class NeuphonicVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/node_artifact.rb b/lib/vapi/types/node_artifact.rb index 08b068bb..340db28a 100644 --- a/lib/vapi/types/node_artifact.rb +++ b/lib/vapi/types/node_artifact.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Messages and variable values captured while a workflow node was active. class NodeArtifact < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::NodeArtifactMessagesItem] }, optional: true, nullable: false field :node_name, -> { String }, optional: true, nullable: false, api_name: "nodeName" diff --git a/lib/vapi/types/o_auth_2_authentication_plan.rb b/lib/vapi/types/o_auth_2_authentication_plan.rb index d20e0c3d..2f4e68c2 100644 --- a/lib/vapi/types/o_auth_2_authentication_plan.rb +++ b/lib/vapi/types/o_auth_2_authentication_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Client-credentials configuration for obtaining an OAuth 2.0 access token used to authenticate outbound requests. class OAuth2AuthenticationPlan < Internal::Types::Model field :type, -> { Vapi::Types::OAuth2AuthenticationPlanType }, optional: false, nullable: false field :url, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/oauth_2_authentication_session.rb b/lib/vapi/types/oauth_2_authentication_session.rb index 661b3e86..8d17544b 100644 --- a/lib/vapi/types/oauth_2_authentication_session.rb +++ b/lib/vapi/types/oauth_2_authentication_session.rb @@ -2,6 +2,7 @@ module Vapi module Types + # OAuth 2.0 session tokens and expiration used to authenticate integration requests. class Oauth2AuthenticationSession < Internal::Types::Model field :access_token, -> { String }, optional: true, nullable: false, api_name: "accessToken" field :expires_at, -> { String }, optional: true, nullable: false, api_name: "expiresAt" diff --git a/lib/vapi/types/open_ai_function.rb b/lib/vapi/types/open_ai_function.rb index 352dafe8..e8afba35 100644 --- a/lib/vapi/types/open_ai_function.rb +++ b/lib/vapi/types/open_ai_function.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Function definition exposed to a language model, including its name, purpose, parameter schema, and strict-schema + # behavior. class OpenAiFunction < Internal::Types::Model field :strict, -> { Internal::Types::Boolean }, optional: true, nullable: false field :name, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/open_ai_function_parameters.rb b/lib/vapi/types/open_ai_function_parameters.rb index 3e67b787..ce2d06a8 100644 --- a/lib/vapi/types/open_ai_function_parameters.rb +++ b/lib/vapi/types/open_ai_function_parameters.rb @@ -2,6 +2,7 @@ module Vapi module Types + # JSON object schema defining the properties accepted by a function and which properties are required. class OpenAiFunctionParameters < Internal::Types::Model field :type, -> { Vapi::Types::OpenAiFunctionParametersType }, optional: false, nullable: false field :properties, -> { Internal::Types::Hash[String, Vapi::Types::JsonSchema] }, optional: false, nullable: false diff --git a/lib/vapi/types/open_ai_message.rb b/lib/vapi/types/open_ai_message.rb index 2332103a..6ddd1d3f 100644 --- a/lib/vapi/types/open_ai_message.rb +++ b/lib/vapi/types/open_ai_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A conversation message represented in OpenAI chat format. class OpenAiMessage < Internal::Types::Model field :content, -> { String }, optional: false, nullable: true field :role, -> { Vapi::Types::OpenAiMessageRole }, optional: false, nullable: false diff --git a/lib/vapi/types/open_ai_model.rb b/lib/vapi/types/open_ai_model.rb index 162cfc37..5d3cb3bf 100644 --- a/lib/vapi/types/open_ai_model.rb +++ b/lib/vapi/types/open_ai_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with OpenAI, including model selection, fallback models, prompts, + # tools, prompt caching, and generation settings. class OpenAiModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::OpenAiModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/open_ai_transcriber.rb b/lib/vapi/types/open_ai_transcriber.rb index de4a19db..0c17f988 100644 --- a/lib/vapi/types/open_ai_transcriber.rb +++ b/lib/vapi/types/open_ai_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with OpenAI, including model, language, and + # fallback settings. class OpenAiTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::OpenAiTranscriberModel }, optional: false, nullable: false field :language, -> { Vapi::Types::OpenAiTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/open_ai_voice.rb b/lib/vapi/types/open_ai_voice.rb index 302b0082..a363f339 100644 --- a/lib/vapi/types/open_ai_voice.rb +++ b/lib/vapi/types/open_ai_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery + # instructions, speed, chunking, caching, and fallback settings. class OpenAiVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::OpenAiVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/open_ai_voicemail_detection_plan.rb b/lib/vapi/types/open_ai_voicemail_detection_plan.rb index 7ca148ff..ca448919 100644 --- a/lib/vapi/types/open_ai_voicemail_detection_plan.rb +++ b/lib/vapi/types/open_ai_voicemail_detection_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for detecting voicemail with OpenAI, including detection type, maximum beep wait, and retry backoff. class OpenAiVoicemailDetectionPlan < Internal::Types::Model field :beep_max_await_seconds, -> { Integer }, optional: true, nullable: false, api_name: "beepMaxAwaitSeconds" field :provider, -> { Vapi::Types::OpenAiVoicemailDetectionPlanProvider }, optional: false, nullable: false diff --git a/lib/vapi/types/open_router_model.rb b/lib/vapi/types/open_router_model.rb index a75c7d47..b807bd79 100644 --- a/lib/vapi/types/open_router_model.rb +++ b/lib/vapi/types/open_router_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses through OpenRouter, including routed model selection, prompts, + # tools, knowledge-base access, and generation settings. class OpenRouterModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::OpenRouterModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/pagination_meta.rb b/lib/vapi/types/pagination_meta.rb index e3495110..eba7ec7f 100644 --- a/lib/vapi/types/pagination_meta.rb +++ b/lib/vapi/types/pagination_meta.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Pagination and retention metadata returned with a paginated list of phone numbers. class PaginationMeta < Internal::Types::Model field :items_per_page, -> { Integer }, optional: false, nullable: false, api_name: "itemsPerPage" field :total_items, -> { Integer }, optional: false, nullable: false, api_name: "totalItems" diff --git a/lib/vapi/types/performance_metrics.rb b/lib/vapi/types/performance_metrics.rb index 77c48c26..9dcfd14d 100644 --- a/lib/vapi/types/performance_metrics.rb +++ b/lib/vapi/types/performance_metrics.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Call performance measurements, including per-turn and average provider, endpointing, transport, and interruption + # metrics. class PerformanceMetrics < Internal::Types::Model field :turn_latencies, -> { Internal::Types::Array[Vapi::Types::TurnLatency] }, optional: true, nullable: false, api_name: "turnLatencies" field :model_latency_average, -> { Integer }, optional: true, nullable: false, api_name: "modelLatencyAverage" diff --git a/lib/vapi/types/perplexity_ai_model.rb b/lib/vapi/types/perplexity_ai_model.rb index aab8efcf..2b9107e3 100644 --- a/lib/vapi/types/perplexity_ai_model.rb +++ b/lib/vapi/types/perplexity_ai_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Perplexity AI, including model, prompts, tools, + # knowledge-base access, and generation settings. class PerplexityAiModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::PerplexityAiModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/phone_number_call_ending_hook_filter.rb b/lib/vapi/types/phone_number_call_ending_hook_filter.rb index 3fa33ac6..f3ba020e 100644 --- a/lib/vapi/types/phone_number_call_ending_hook_filter.rb +++ b/lib/vapi/types/phone_number_call_ending_hook_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Matches the call's ended reason against configured assistant-request failure reasons before an ending hook runs. class PhoneNumberCallEndingHookFilter < Internal::Types::Model field :type, -> { Vapi::Types::PhoneNumberCallEndingHookFilterType }, optional: false, nullable: false field :key, -> { Vapi::Types::PhoneNumberCallEndingHookFilterKey }, optional: false, nullable: false diff --git a/lib/vapi/types/phone_number_call_ringing_hook_filter.rb b/lib/vapi/types/phone_number_call_ringing_hook_filter.rb index 5e9e96b4..f0e86800 100644 --- a/lib/vapi/types/phone_number_call_ringing_hook_filter.rb +++ b/lib/vapi/types/phone_number_call_ringing_hook_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Matches an incoming caller's phone number against one or more prefixes before a ringing hook runs. class PhoneNumberCallRingingHookFilter < Internal::Types::Model field :type, -> { Vapi::Types::PhoneNumberCallRingingHookFilterType }, optional: false, nullable: false field :key, -> { Vapi::Types::PhoneNumberCallRingingHookFilterKey }, optional: false, nullable: false diff --git a/lib/vapi/types/phone_number_hook_call_ending.rb b/lib/vapi/types/phone_number_hook_call_ending.rb index 33707559..4b81ffcc 100644 --- a/lib/vapi/types/phone_number_hook_call_ending.rb +++ b/lib/vapi/types/phone_number_hook_call_ending.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Runs configured transfer or message actions when a call ends with a matching assistant-request failure reason. class PhoneNumberHookCallEnding < Internal::Types::Model field :filters, -> { Internal::Types::Array[Vapi::Types::PhoneNumberCallEndingHookFilter] }, optional: true, nullable: false field :do_, -> { Vapi::Types::PhoneNumberHookCallEndingDo }, optional: true, nullable: false, api_name: "do" diff --git a/lib/vapi/types/phone_number_hook_call_ringing.rb b/lib/vapi/types/phone_number_hook_call_ringing.rb index b4d2e5a0..7814cf3a 100644 --- a/lib/vapi/types/phone_number_hook_call_ringing.rb +++ b/lib/vapi/types/phone_number_hook_call_ringing.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Runs configured transfer or message actions when an incoming call rings and its caller-number prefix filters + # match. class PhoneNumberHookCallRinging < Internal::Types::Model field :filters, -> { Internal::Types::Array[Vapi::Types::PhoneNumberCallRingingHookFilter] }, optional: true, nullable: false field :do_, -> { Internal::Types::Array[Vapi::Types::PhoneNumberHookCallRingingDoItem] }, optional: false, nullable: false, api_name: "do" diff --git a/lib/vapi/types/phone_number_paginated_response.rb b/lib/vapi/types/phone_number_paginated_response.rb index b2975df8..2da208d0 100644 --- a/lib/vapi/types/phone_number_paginated_response.rb +++ b/lib/vapi/types/phone_number_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of phone numbers and metadata describing the result set. class PhoneNumberPaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::PhoneNumberPaginatedResponseResultsItem] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/pie_insight.rb b/lib/vapi/types/pie_insight.rb index 0e3cab31..b5940932 100644 --- a/lib/vapi/types/pie_insight.rb +++ b/lib/vapi/types/pie_insight.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved pie-chart insight containing its call-data queries, formulas, grouping, time range, and lifecycle + # information. class PieInsight < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/play_ht_voice.rb b/lib/vapi/types/play_ht_voice.rb index 2a47f62a..095813bb 100644 --- a/lib/vapi/types/play_ht_voice.rb +++ b/lib/vapi/types/play_ht_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, + # emotion and style guidance, chunking, caching, and fallback settings. class PlayHtVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::PlayHtVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/prompt_injection_security_filter.rb b/lib/vapi/types/prompt_injection_security_filter.rb index afb41e38..8e820509 100644 --- a/lib/vapi/types/prompt_injection_security_filter.rb +++ b/lib/vapi/types/prompt_injection_security_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters potential prompt-injection patterns from transcripts. class PromptInjectionSecurityFilter < Internal::Types::Model field :type, -> { Vapi::Types::PromptInjectionSecurityFilterType }, optional: false, nullable: false end diff --git a/lib/vapi/types/provider_resource.rb b/lib/vapi/types/provider_resource.rb index 822f1e4a..8569140e 100644 --- a/lib/vapi/types/provider_resource.rb +++ b/lib/vapi/types/provider_resource.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A provider-managed pronunciation-dictionary resource mirrored in Vapi, including its provider identifiers, + # resource data, and lifecycle information. class ProviderResource < Internal::Types::Model field :id, -> { String }, optional: false, nullable: false field :org_id, -> { String }, optional: false, nullable: false, api_name: "orgId" diff --git a/lib/vapi/types/provider_resource_paginated_response.rb b/lib/vapi/types/provider_resource_paginated_response.rb index 04b2ebb3..ddf11ef8 100644 --- a/lib/vapi/types/provider_resource_paginated_response.rb +++ b/lib/vapi/types/provider_resource_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of provider resources and metadata describing the result set. class ProviderResourcePaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::ProviderResource] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/public_key_encryption_plan.rb b/lib/vapi/types/public_key_encryption_plan.rb index 3449a60b..eefab5e1 100644 --- a/lib/vapi/types/public_key_encryption_plan.rb +++ b/lib/vapi/types/public_key_encryption_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for encrypting sensitive outbound request data with a public key. class PublicKeyEncryptionPlan < Internal::Types::Model field :algorithm, -> { Vapi::Types::PublicKeyEncryptionPlanAlgorithm }, optional: false, nullable: false field :public_key, -> { Vapi::Types::PublicKeyEncryptionPlanPublicKey }, optional: false, nullable: false, api_name: "publicKey" diff --git a/lib/vapi/types/query_tool.rb b/lib/vapi/types/query_tool.rb index 28e2b28c..f90e6efd 100644 --- a/lib/vapi/types/query_tool.rb +++ b/lib/vapi/types/query_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that searches configured knowledge bases and returns relevant content to the assistant. class QueryTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::QueryToolMessagesItem] }, optional: true, nullable: false field :knowledge_bases, -> { Internal::Types::Array[Vapi::Types::KnowledgeBase] }, optional: true, nullable: false, api_name: "knowledgeBases" diff --git a/lib/vapi/types/rce_security_filter.rb b/lib/vapi/types/rce_security_filter.rb index 3ef808e1..84a0303b 100644 --- a/lib/vapi/types/rce_security_filter.rb +++ b/lib/vapi/types/rce_security_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters potential remote code execution (RCE) patterns from transcripts. class RceSecurityFilter < Internal::Types::Model field :type, -> { Vapi::Types::RceSecurityFilterType }, optional: false, nullable: false end diff --git a/lib/vapi/types/recording.rb b/lib/vapi/types/recording.rb index faddc02c..ae95baba 100644 --- a/lib/vapi/types/recording.rb +++ b/lib/vapi/types/recording.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Call recording locations, including stereo, video, and separated mono recording URLs. class Recording < Internal::Types::Model field :stereo_url, -> { String }, optional: true, nullable: false, api_name: "stereoUrl" field :video_url, -> { String }, optional: true, nullable: false, api_name: "videoUrl" diff --git a/lib/vapi/types/recording_consent.rb b/lib/vapi/types/recording_consent.rb index 928a178a..c6d94e67 100644 --- a/lib/vapi/types/recording_consent.rb +++ b/lib/vapi/types/recording_consent.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Result of the recording-consent flow, including consent type and the time consent was granted. class RecordingConsent < Internal::Types::Model field :type, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false field :granted_at, -> { String }, optional: true, nullable: false, api_name: "grantedAt" diff --git a/lib/vapi/types/recording_consent_plan_stay_on_line.rb b/lib/vapi/types/recording_consent_plan_stay_on_line.rb index 3ab68c3c..f5635537 100644 --- a/lib/vapi/types/recording_consent_plan_stay_on_line.rb +++ b/lib/vapi/types/recording_consent_plan_stay_on_line.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for requesting recording consent by treating continued presence on the call as consent, including + # the announcement voice and wait time. class RecordingConsentPlanStayOnLine < Internal::Types::Model field :message, -> { String }, optional: false, nullable: false field :voice, -> { Vapi::Types::RecordingConsentPlanStayOnLineVoice }, optional: true, nullable: false diff --git a/lib/vapi/types/recording_consent_plan_verbal.rb b/lib/vapi/types/recording_consent_plan_verbal.rb index a0e5c3c8..9b8f1624 100644 --- a/lib/vapi/types/recording_consent_plan_verbal.rb +++ b/lib/vapi/types/recording_consent_plan_verbal.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for requesting explicit verbal recording consent, including the announcement voice and action to + # take when the customer declines. class RecordingConsentPlanVerbal < Internal::Types::Model field :message, -> { String }, optional: false, nullable: false field :voice, -> { Vapi::Types::RecordingConsentPlanVerbalVoice }, optional: true, nullable: false diff --git a/lib/vapi/types/regex_condition.rb b/lib/vapi/types/regex_condition.rb index d13f042f..6aeaff1c 100644 --- a/lib/vapi/types/regex_condition.rb +++ b/lib/vapi/types/regex_condition.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Evaluates whether targeted conversation-message content matches a regular expression. class RegexCondition < Internal::Types::Model field :regex, -> { String }, optional: false, nullable: false field :target, -> { Vapi::Types::MessageTarget }, optional: true, nullable: false diff --git a/lib/vapi/types/regex_option.rb b/lib/vapi/types/regex_option.rb index 8065def0..9c4c3f1f 100644 --- a/lib/vapi/types/regex_option.rb +++ b/lib/vapi/types/regex_option.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Enables or disables one regular-expression matching option for a text replacement. class RegexOption < Internal::Types::Model field :type, -> { Vapi::Types::RegexOptionType }, optional: false, nullable: false field :enabled, -> { Internal::Types::Boolean }, optional: false, nullable: false diff --git a/lib/vapi/types/regex_replacement.rb b/lib/vapi/types/regex_replacement.rb index 3776ee19..47a59ecb 100644 --- a/lib/vapi/types/regex_replacement.rb +++ b/lib/vapi/types/regex_replacement.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Replaces text matching a regular expression before it is sent to a voice provider. class RegexReplacement < Internal::Types::Model field :regex, -> { String }, optional: false, nullable: false field :options, -> { Internal::Types::Array[Vapi::Types::RegexOption] }, optional: true, nullable: false diff --git a/lib/vapi/types/regex_security_filter.rb b/lib/vapi/types/regex_security_filter.rb index 787140ea..bbb74cfc 100644 --- a/lib/vapi/types/regex_security_filter.rb +++ b/lib/vapi/types/regex_security_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters transcript content that matches a custom regular expression. class RegexSecurityFilter < Internal::Types::Model field :type, -> { Vapi::Types::RegexSecurityFilterType }, optional: false, nullable: false field :regex, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/rime_ai_voice.rb b/lib/vapi/types/rime_ai_voice.rb index 77824a84..07a99879 100644 --- a/lib/vapi/types/rime_ai_voice.rb +++ b/lib/vapi/types/rime_ai_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::RimeAiVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/say_hook_action.rb b/lib/vapi/types/say_hook_action.rb index 05ccb17b..2c35d3e4 100644 --- a/lib/vapi/types/say_hook_action.rb +++ b/lib/vapi/types/say_hook_action.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A hook action that makes the assistant speak exact text or generate a response from a prompt. class SayHookAction < Internal::Types::Model field :prompt, -> { Vapi::Types::SayHookActionPrompt }, optional: true, nullable: false field :exact, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false diff --git a/lib/vapi/types/say_phone_number_hook_action.rb b/lib/vapi/types/say_phone_number_hook_action.rb index 0bf2b9ed..7659be72 100644 --- a/lib/vapi/types/say_phone_number_hook_action.rb +++ b/lib/vapi/types/say_phone_number_hook_action.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A phone-number hook action that speaks an exact message to the caller. class SayPhoneNumberHookAction < Internal::Types::Model field :exact, -> { String }, optional: false, nullable: false end diff --git a/lib/vapi/types/sbc_configuration.rb b/lib/vapi/types/sbc_configuration.rb index 05383862..7e37c58d 100644 --- a/lib/vapi/types/sbc_configuration.rb +++ b/lib/vapi/types/sbc_configuration.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Routes bring-your-own SIP traffic through an on-premises session border controller instead of Vapi's managed + # controller. class SbcConfiguration < Internal::Types::Model; end end end diff --git a/lib/vapi/types/schedule_plan.rb b/lib/vapi/types/schedule_plan.rb index a79e6895..ac78fcfa 100644 --- a/lib/vapi/types/schedule_plan.rb +++ b/lib/vapi/types/schedule_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Time window that controls the earliest and latest time a call may begin. class SchedulePlan < Internal::Types::Model field :earliest_at, -> { String }, optional: false, nullable: false, api_name: "earliestAt" field :latest_at, -> { String }, optional: true, nullable: false, api_name: "latestAt" diff --git a/lib/vapi/types/scorecard.rb b/lib/vapi/types/scorecard.rb index 9cefd483..d8a79687 100644 --- a/lib/vapi/types/scorecard.rb +++ b/lib/vapi/types/scorecard.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved scorecard containing its evaluation metrics, scoring conditions, assistant associations, descriptive + # metadata, and lifecycle information. class Scorecard < Internal::Types::Model field :id, -> { String }, optional: false, nullable: false field :org_id, -> { String }, optional: false, nullable: false, api_name: "orgId" diff --git a/lib/vapi/types/scorecard_metric.rb b/lib/vapi/types/scorecard_metric.rb index e69bb7b6..4d9dca6f 100644 --- a/lib/vapi/types/scorecard_metric.rb +++ b/lib/vapi/types/scorecard_metric.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A scorecard metric that awards points when a structured output meets its configured conditions. class ScorecardMetric < Internal::Types::Model field :structured_output_id, -> { String }, optional: false, nullable: false, api_name: "structuredOutputId" field :conditions, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: false, nullable: false diff --git a/lib/vapi/types/scorecard_paginated_response.rb b/lib/vapi/types/scorecard_paginated_response.rb index fd3dbbde..5203adb1 100644 --- a/lib/vapi/types/scorecard_paginated_response.rb +++ b/lib/vapi/types/scorecard_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of scorecards and metadata describing the result set. class ScorecardPaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::Scorecard] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/security_filter_base.rb b/lib/vapi/types/security_filter_base.rb index 0df5da7c..ab092d02 100644 --- a/lib/vapi/types/security_filter_base.rb +++ b/lib/vapi/types/security_filter_base.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Base configuration for a security filter applied to transcripts before model processing. class SecurityFilterBase < Internal::Types::Model; end end end diff --git a/lib/vapi/types/security_filter_plan.rb b/lib/vapi/types/security_filter_plan.rb index 16f986e7..e7dfa46e 100644 --- a/lib/vapi/types/security_filter_plan.rb +++ b/lib/vapi/types/security_filter_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false field :filters, -> { Internal::Types::Array[Vapi::Types::SecurityFilterBase] }, optional: true, nullable: false diff --git a/lib/vapi/types/server.rb b/lib/vapi/types/server.rb index d1f1caa8..b893e603 100644 --- a/lib/vapi/types/server.rb +++ b/lib/vapi/types/server.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for requests Vapi sends to a customer server, including URL, authentication, headers, timeout, + # encryption, static IP addresses, and retry behavior. class Server < Internal::Types::Model field :timeout_seconds, -> { Integer }, optional: true, nullable: false, api_name: "timeoutSeconds" field :credential_id, -> { String }, optional: true, nullable: false, api_name: "credentialId" diff --git a/lib/vapi/types/sesame_voice.rb b/lib/vapi/types/sesame_voice.rb index fed154d2..742b59ad 100644 --- a/lib/vapi/types/sesame_voice.rb +++ b/lib/vapi/types/sesame_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, + # caching, and fallback settings. class SesameVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/sip_authentication.rb b/lib/vapi/types/sip_authentication.rb index e94944f1..e4a6e8ba 100644 --- a/lib/vapi/types/sip_authentication.rb +++ b/lib/vapi/types/sip_authentication.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Realm, username, and password used to authenticate SIP requests. class SipAuthentication < Internal::Types::Model field :realm, -> { String }, optional: true, nullable: false field :username, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/sip_request_tool.rb b/lib/vapi/types/sip_request_tool.rb index 5a487ea7..df7124ce 100644 --- a/lib/vapi/types/sip_request_tool.rb +++ b/lib/vapi/types/sip_request_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body. class SipRequestTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::SipRequestToolMessagesItem] }, optional: true, nullable: false field :verb, -> { Vapi::Types::SipRequestToolVerb }, optional: false, nullable: false diff --git a/lib/vapi/types/sip_trunk_gateway.rb b/lib/vapi/types/sip_trunk_gateway.rb index d423115d..f6ac17ab 100644 --- a/lib/vapi/types/sip_trunk_gateway.rb +++ b/lib/vapi/types/sip_trunk_gateway.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :ip, -> { String }, optional: false, nullable: false field :port, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/sip_trunk_outbound_authentication_plan.rb b/lib/vapi/types/sip_trunk_outbound_authentication_plan.rb index 213b9624..822116db 100644 --- a/lib/vapi/types/sip_trunk_outbound_authentication_plan.rb +++ b/lib/vapi/types/sip_trunk_outbound_authentication_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Credentials and optional SIP REGISTER settings used to authenticate outbound calls with a SIP trunk. class SipTrunkOutboundAuthenticationPlan < Internal::Types::Model field :auth_password, -> { String }, optional: true, nullable: false, api_name: "authPassword" field :auth_username, -> { String }, optional: true, nullable: false, api_name: "authUsername" diff --git a/lib/vapi/types/sip_trunk_outbound_sip_register_plan.rb b/lib/vapi/types/sip_trunk_outbound_sip_register_plan.rb index a2357441..7ae2a212 100644 --- a/lib/vapi/types/sip_trunk_outbound_sip_register_plan.rb +++ b/lib/vapi/types/sip_trunk_outbound_sip_register_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Registration settings used when the SIP trunk requires SIP REGISTER. class SipTrunkOutboundSipRegisterPlan < Internal::Types::Model field :domain, -> { String }, optional: true, nullable: false field :username, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/slack_send_message_tool.rb b/lib/vapi/types/slack_send_message_tool.rb index 40ddb933..11c148dd 100644 --- a/lib/vapi/types/slack_send_message_tool.rb +++ b/lib/vapi/types/slack_send_message_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that lets an assistant send a message to Slack. class SlackSendMessageTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::SlackSendMessageToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/smallest_ai_voice.rb b/lib/vapi/types/smallest_ai_voice.rb index 4930e3b8..6ae7ebaf 100644 --- a/lib/vapi/types/smallest_ai_voice.rb +++ b/lib/vapi/types/smallest_ai_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, + # chunking, caching, and fallback settings. class SmallestAiVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::SmallestAiVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/smart_denoising_plan.rb b/lib/vapi/types/smart_denoising_plan.rb index f85aba8f..f5b6c290 100644 --- a/lib/vapi/types/smart_denoising_plan.rb +++ b/lib/vapi/types/smart_denoising_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls whether Krisp smart denoising filters background speech and noise. class SmartDenoisingPlan < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false end diff --git a/lib/vapi/types/sms_tool.rb b/lib/vapi/types/sms_tool.rb index bf8b6e8f..3f84ea9f 100644 --- a/lib/vapi/types/sms_tool.rb +++ b/lib/vapi/types/sms_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that lets an assistant send an SMS message during a call. class SmsTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::SmsToolMessagesItem] }, optional: true, nullable: false field :id, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/soniox_transcriber.rb b/lib/vapi/types/soniox_transcriber.rb index cd7f5394..f9effc08 100644 --- a/lib/vapi/types/soniox_transcriber.rb +++ b/lib/vapi/types/soniox_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Soniox, including model, language + # detection, endpointing, vocabulary, and fallback settings. class SonioxTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::SonioxTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::SonioxTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/speechmatics_custom_vocabulary_item.rb b/lib/vapi/types/speechmatics_custom_vocabulary_item.rb index 9c5536ca..5b343de4 100644 --- a/lib/vapi/types/speechmatics_custom_vocabulary_item.rb +++ b/lib/vapi/types/speechmatics_custom_vocabulary_item.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A word or phrase to prioritize during Speechmatics transcription, with optional phonetic alternatives. class SpeechmaticsCustomVocabularyItem < Internal::Types::Model field :content, -> { String }, optional: false, nullable: false field :sounds_like, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "soundsLike" diff --git a/lib/vapi/types/speechmatics_transcriber.rb b/lib/vapi/types/speechmatics_transcriber.rb index 2c93b51c..56d30ce6 100644 --- a/lib/vapi/types/speechmatics_transcriber.rb +++ b/lib/vapi/types/speechmatics_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Speechmatics, including language, + # region, diarization, vocabulary, endpointing, formatting, and fallback settings. class SpeechmaticsTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::SpeechmaticsTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::SpeechmaticsTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/spki_pem_public_key_config.rb b/lib/vapi/types/spki_pem_public_key_config.rb index ebb8bf51..07e536d4 100644 --- a/lib/vapi/types/spki_pem_public_key_config.rb +++ b/lib/vapi/types/spki_pem_public_key_config.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An SPKI public key in PEM format used to encrypt sensitive request data. class SpkiPemPublicKeyConfig < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :pem, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/sql_injection_security_filter.rb b/lib/vapi/types/sql_injection_security_filter.rb index 0c36a8eb..1053c278 100644 --- a/lib/vapi/types/sql_injection_security_filter.rb +++ b/lib/vapi/types/sql_injection_security_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters potential SQL injection patterns from transcripts. class SqlInjectionSecurityFilter < Internal::Types::Model field :type, -> { Vapi::Types::SqlInjectionSecurityFilterType }, optional: false, nullable: false end diff --git a/lib/vapi/types/squad.rb b/lib/vapi/types/squad.rb index a427448b..31a17a1a 100644 --- a/lib/vapi/types/squad.rb +++ b/lib/vapi/types/squad.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :members, -> { Internal::Types::Array[Vapi::Types::SquadMemberDto] }, optional: false, nullable: false diff --git a/lib/vapi/types/squad_member_dto.rb b/lib/vapi/types/squad_member_dto.rb index 09698553..446bfafb 100644 --- a/lib/vapi/types/squad_member_dto.rb +++ b/lib/vapi/types/squad_member_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :assistant_destinations, -> { Internal::Types::Array[Vapi::Types::SquadMemberDtoAssistantDestinationsItem] }, optional: true, nullable: false, api_name: "assistantDestinations" field :assistant_id, -> { String }, optional: true, nullable: false, api_name: "assistantId" diff --git a/lib/vapi/types/ssrf_security_filter.rb b/lib/vapi/types/ssrf_security_filter.rb index 08fe398a..8a50ec3f 100644 --- a/lib/vapi/types/ssrf_security_filter.rb +++ b/lib/vapi/types/ssrf_security_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters potential server-side request forgery (SSRF) patterns from transcripts. class SsrfSecurityFilter < Internal::Types::Model field :type, -> { Vapi::Types::SsrfSecurityFilterType }, optional: false, nullable: false end diff --git a/lib/vapi/types/start_speaking_plan.rb b/lib/vapi/types/start_speaking_plan.rb index 27f47b5b..3647288f 100644 --- a/lib/vapi/types/start_speaking_plan.rb +++ b/lib/vapi/types/start_speaking_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls when the assistant begins speaking after customer speech, including the minimum wait, endpointing + # strategy, and custom endpointing rules. class StartSpeakingPlan < Internal::Types::Model field :wait_seconds, -> { Integer }, optional: true, nullable: false, api_name: "waitSeconds" field :smart_endpointing_enabled, -> { Vapi::Types::StartSpeakingPlanSmartEndpointingEnabled }, optional: true, nullable: false, api_name: "smartEndpointingEnabled" diff --git a/lib/vapi/types/stop_speaking_plan.rb b/lib/vapi/types/stop_speaking_plan.rb index 58efb5a7..b5209825 100644 --- a/lib/vapi/types/stop_speaking_plan.rb +++ b/lib/vapi/types/stop_speaking_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls when the assistant stops speaking after a customer interruption, including word and voice thresholds, + # restart delay, and phrase exceptions. class StopSpeakingPlan < Internal::Types::Model field :num_words, -> { Integer }, optional: true, nullable: false, api_name: "numWords" field :voice_seconds, -> { Integer }, optional: true, nullable: false, api_name: "voiceSeconds" diff --git a/lib/vapi/types/structured_data_multi_plan.rb b/lib/vapi/types/structured_data_multi_plan.rb index 8ccf4c7b..fa2191f1 100644 --- a/lib/vapi/types/structured_data_multi_plan.rb +++ b/lib/vapi/types/structured_data_multi_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Associates a catalog key with a structured data extraction plan. class StructuredDataMultiPlan < Internal::Types::Model field :key, -> { String }, optional: false, nullable: false field :plan, -> { Vapi::Types::StructuredDataPlan }, optional: false, nullable: false diff --git a/lib/vapi/types/structured_data_plan.rb b/lib/vapi/types/structured_data_plan.rb index 662ddf35..d5c79199 100644 --- a/lib/vapi/types/structured_data_plan.rb +++ b/lib/vapi/types/structured_data_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls extraction of post-call structured data, including prompt messages, JSON schema, enablement, and request + # timeout. class StructuredDataPlan < Internal::Types::Model field :messages, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: true, nullable: false field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/structured_output.rb b/lib/vapi/types/structured_output.rb index c48a206f..e79d56ed 100644 --- a/lib/vapi/types/structured_output.rb +++ b/lib/vapi/types/structured_output.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A saved structured-output definition containing its extraction schema, execution method, model or regular + # expression, linked resources, and lifecycle metadata. class StructuredOutput < Internal::Types::Model field :type, -> { Vapi::Types::StructuredOutputType }, optional: true, nullable: false field :regex, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/structured_output_paginated_response.rb b/lib/vapi/types/structured_output_paginated_response.rb index 29952af0..b12a152e 100644 --- a/lib/vapi/types/structured_output_paginated_response.rb +++ b/lib/vapi/types/structured_output_paginated_response.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A paginated collection of structured-output definitions and metadata describing the result set. class StructuredOutputPaginatedResponse < Internal::Types::Model field :results, -> { Internal::Types::Array[Vapi::Types::StructuredOutput] }, optional: false, nullable: false field :metadata, -> { Vapi::Types::PaginationMeta }, optional: false, nullable: false diff --git a/lib/vapi/types/subscription_limits.rb b/lib/vapi/types/subscription_limits.rb index 3857d8a9..e9b348b4 100644 --- a/lib/vapi/types/subscription_limits.rb +++ b/lib/vapi/types/subscription_limits.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Organization concurrency limits and remaining concurrent call capacity. class SubscriptionLimits < Internal::Types::Model field :concurrency_blocked, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "concurrencyBlocked" field :concurrency_limit, -> { Integer }, optional: true, nullable: false, api_name: "concurrencyLimit" diff --git a/lib/vapi/types/success_evaluation_plan.rb b/lib/vapi/types/success_evaluation_plan.rb index 375e5750..d56b1bf1 100644 --- a/lib/vapi/types/success_evaluation_plan.rb +++ b/lib/vapi/types/success_evaluation_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls post-call success evaluation, including the rubric, prompt messages, enablement, and request timeout. class SuccessEvaluationPlan < Internal::Types::Model field :rubric, -> { Vapi::Types::SuccessEvaluationPlanRubric }, optional: true, nullable: false field :messages, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: true, nullable: false diff --git a/lib/vapi/types/summary_plan.rb b/lib/vapi/types/summary_plan.rb index 9026b635..97cb0c00 100644 --- a/lib/vapi/types/summary_plan.rb +++ b/lib/vapi/types/summary_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls generation of a post-call summary, including prompt messages, enablement, and request timeout. class SummaryPlan < Internal::Types::Model field :messages, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: true, nullable: false field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/supabase_bucket_plan.rb b/lib/vapi/types/supabase_bucket_plan.rb index f66890cf..70f79ee7 100644 --- a/lib/vapi/types/supabase_bucket_plan.rb +++ b/lib/vapi/types/supabase_bucket_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Supabase S3-compatible bucket configuration for call artifacts, including region, endpoint, access keys, bucket + # name, and path. class SupabaseBucketPlan < Internal::Types::Model field :region, -> { Vapi::Types::SupabaseBucketPlanRegion }, optional: false, nullable: false field :url, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/system_message.rb b/lib/vapi/types/system_message.rb index 975c87fc..6732b0c1 100644 --- a/lib/vapi/types/system_message.rb +++ b/lib/vapi/types/system_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A system-authored entry in the call message history, including its content and timing. class SystemMessage < Internal::Types::Model field :role, -> { String }, optional: false, nullable: false field :message, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/talkscriber_transcriber.rb b/lib/vapi/types/talkscriber_transcriber.rb index 2802c3c2..87376f7b 100644 --- a/lib/vapi/types/talkscriber_transcriber.rb +++ b/lib/vapi/types/talkscriber_transcriber.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for transcribing speech during assistant conversations with Talkscriber, including model, language, + # and fallback settings. class TalkscriberTranscriber < Internal::Types::Model field :model, -> { Vapi::Types::TalkscriberTranscriberModel }, optional: true, nullable: false field :language, -> { Vapi::Types::TalkscriberTranscriberLanguage }, optional: true, nullable: false diff --git a/lib/vapi/types/tavus_conversation_properties.rb b/lib/vapi/types/tavus_conversation_properties.rb index 20d3a02d..d4f7821d 100644 --- a/lib/vapi/types/tavus_conversation_properties.rb +++ b/lib/vapi/types/tavus_conversation_properties.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Tavus conversation behavior and media settings, including duration, participant timeouts, recording, + # transcription, background, language, and recording storage. class TavusConversationProperties < Internal::Types::Model field :max_call_duration, -> { Integer }, optional: true, nullable: false, api_name: "maxCallDuration" field :participant_left_timeout, -> { Integer }, optional: true, nullable: false, api_name: "participantLeftTimeout" diff --git a/lib/vapi/types/tavus_voice.rb b/lib/vapi/types/tavus_voice.rb index ad332560..feeb3568 100644 --- a/lib/vapi/types/tavus_voice.rb +++ b/lib/vapi/types/tavus_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, + # conversation properties, chunking, caching, and fallback settings. class TavusVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::TavusVoiceVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/telnyx_phone_number.rb b/lib/vapi/types/telnyx_phone_number.rb index 3a4a555c..72dcd271 100644 --- a/lib/vapi/types/telnyx_phone_number.rb +++ b/lib/vapi/types/telnyx_phone_number.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A Telnyx phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle + # metadata. class TelnyxPhoneNumber < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::TelnyxPhoneNumberFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::TelnyxPhoneNumberHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/text_content.rb b/lib/vapi/types/text_content.rb index e08fb14c..82b985de 100644 --- a/lib/vapi/types/text_content.rb +++ b/lib/vapi/types/text_content.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Localized text content used as a language-specific message variant. class TextContent < Internal::Types::Model field :type, -> { Vapi::Types::TextContentType }, optional: false, nullable: false field :text, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/text_editor_tool.rb b/lib/vapi/types/text_editor_tool.rb index 6a3cff00..c2951bba 100644 --- a/lib/vapi/types/text_editor_tool.rb +++ b/lib/vapi/types/text_editor_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that reads and edits text files in a configured environment. class TextEditorTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::TextEditorToolMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::TextEditorToolSubType }, optional: false, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/text_insight.rb b/lib/vapi/types/text_insight.rb index b88d8497..90651616 100644 --- a/lib/vapi/types/text_insight.rb +++ b/lib/vapi/types/text_insight.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A saved text-value insight containing its call-data queries, formula, time range, and lifecycle information. class TextInsight < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formula, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false diff --git a/lib/vapi/types/time_range.rb b/lib/vapi/types/time_range.rb index a3aaf34e..8530a29d 100644 --- a/lib/vapi/types/time_range.rb +++ b/lib/vapi/types/time_range.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Start, end, timezone, and time step used for analytics aggregation. class TimeRange < Internal::Types::Model field :step, -> { Vapi::Types::TimeRangeStep }, optional: true, nullable: false field :start, -> { String }, optional: true, nullable: false diff --git a/lib/vapi/types/together_ai_model.rb b/lib/vapi/types/together_ai_model.rb index 5fc360f4..7994e10b 100644 --- a/lib/vapi/types/together_ai_model.rb +++ b/lib/vapi/types/together_ai_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with Together AI, including model, prompts, tools, knowledge-base + # access, and generation settings. class TogetherAiModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::TogetherAiModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/tool_call.rb b/lib/vapi/types/tool_call.rb index bbc2ad6c..837ea7c2 100644 --- a/lib/vapi/types/tool_call.rb +++ b/lib/vapi/types/tool_call.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A tool invocation requested by the assistant, including its identifier, type, and function details. class ToolCall < Internal::Types::Model field :id, -> { String }, optional: false, nullable: false field :type, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/tool_call_function.rb b/lib/vapi/types/tool_call_function.rb index 085f5bbd..0d85c1fd 100644 --- a/lib/vapi/types/tool_call_function.rb +++ b/lib/vapi/types/tool_call_function.rb @@ -2,6 +2,7 @@ module Vapi module Types + # The function name and serialized arguments associated with a tool call. class ToolCallFunction < Internal::Types::Model field :arguments, -> { String }, optional: false, nullable: false field :name, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/tool_call_hook_action.rb b/lib/vapi/types/tool_call_hook_action.rb index 3938564d..d7b85043 100644 --- a/lib/vapi/types/tool_call_hook_action.rb +++ b/lib/vapi/types/tool_call_hook_action.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A hook action that invokes an inline tool or an existing tool when the hook triggers. class ToolCallHookAction < Internal::Types::Model field :type, -> { Vapi::Types::ToolCallHookActionType }, optional: false, nullable: false field :tool, -> { Vapi::Types::ToolCallHookActionTool }, optional: true, nullable: false diff --git a/lib/vapi/types/tool_call_message.rb b/lib/vapi/types/tool_call_message.rb index dd5946eb..8f5ae525 100644 --- a/lib/vapi/types/tool_call_message.rb +++ b/lib/vapi/types/tool_call_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An entry in the call message history that records one or more tool calls requested during the conversation. class ToolCallMessage < Internal::Types::Model field :role, -> { String }, optional: false, nullable: false field :tool_calls, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: false, nullable: false, api_name: "toolCalls" diff --git a/lib/vapi/types/tool_call_result_message.rb b/lib/vapi/types/tool_call_result_message.rb index aa047370..f4170131 100644 --- a/lib/vapi/types/tool_call_result_message.rb +++ b/lib/vapi/types/tool_call_result_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # An entry in the call message history that records the result and metadata for a completed tool call. class ToolCallResultMessage < Internal::Types::Model field :role, -> { String }, optional: false, nullable: false field :tool_call_id, -> { String }, optional: false, nullable: false, api_name: "toolCallId" diff --git a/lib/vapi/types/tool_message.rb b/lib/vapi/types/tool_message.rb index 66df278b..6e4b0e7d 100644 --- a/lib/vapi/types/tool_message.rb +++ b/lib/vapi/types/tool_message.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A tool-result message associated with a specific tool call. class ToolMessage < Internal::Types::Model field :role, -> { Vapi::Types::ToolMessageRole }, optional: false, nullable: false field :content, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/tool_message_complete.rb b/lib/vapi/types/tool_message_complete.rb index cb65d03f..bf12248c 100644 --- a/lib/vapi/types/tool_message_complete.rb +++ b/lib/vapi/types/tool_message_complete.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Message spoken when a tool call completes, with optional language variants, argument conditions, role, and + # end-call behavior. class ToolMessageComplete < Internal::Types::Model field :contents, -> { Internal::Types::Array[Vapi::Types::TextContent] }, optional: true, nullable: false field :role, -> { Vapi::Types::ToolMessageCompleteRole }, optional: true, nullable: false diff --git a/lib/vapi/types/tool_message_delayed.rb b/lib/vapi/types/tool_message_delayed.rb index 29fd54d4..55556caf 100644 --- a/lib/vapi/types/tool_message_delayed.rb +++ b/lib/vapi/types/tool_message_delayed.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Message spoken when a tool call exceeds a configured response delay, with optional language variants and argument + # conditions. class ToolMessageDelayed < Internal::Types::Model field :contents, -> { Internal::Types::Array[Vapi::Types::TextContent] }, optional: true, nullable: false field :timing_milliseconds, -> { Integer }, optional: true, nullable: false, api_name: "timingMilliseconds" diff --git a/lib/vapi/types/tool_message_failed.rb b/lib/vapi/types/tool_message_failed.rb index bbe6b6b8..e0d4f53b 100644 --- a/lib/vapi/types/tool_message_failed.rb +++ b/lib/vapi/types/tool_message_failed.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Message spoken when a tool call fails, with optional language variants, argument conditions, and end-call + # behavior. class ToolMessageFailed < Internal::Types::Model field :contents, -> { Internal::Types::Array[Vapi::Types::TextContent] }, optional: true, nullable: false field :end_call_after_spoken_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "endCallAfterSpokenEnabled" diff --git a/lib/vapi/types/tool_message_start.rb b/lib/vapi/types/tool_message_start.rb index de719c30..470adc3e 100644 --- a/lib/vapi/types/tool_message_start.rb +++ b/lib/vapi/types/tool_message_start.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Message spoken when a tool call starts, with optional language variants, argument conditions, and blocking + # behavior. class ToolMessageStart < Internal::Types::Model field :contents, -> { Internal::Types::Array[Vapi::Types::TextContent] }, optional: true, nullable: false field :blocking, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/tool_node.rb b/lib/vapi/types/tool_node.rb index 9c391946..1dee2070 100644 --- a/lib/vapi/types/tool_node.rb +++ b/lib/vapi/types/tool_node.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A workflow node that invokes an inline tool or an existing saved tool. class ToolNode < Internal::Types::Model field :tool, -> { Vapi::Types::ToolNodeTool }, optional: true, nullable: false field :tool_id, -> { String }, optional: true, nullable: false, api_name: "toolId" diff --git a/lib/vapi/types/tool_parameter.rb b/lib/vapi/types/tool_parameter.rb index a1cb7bd6..9ae86dea 100644 --- a/lib/vapi/types/tool_parameter.rb +++ b/lib/vapi/types/tool_parameter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Static key-value parameter added to a tool request, with Liquid template support for string values. class ToolParameter < Internal::Types::Model field :key, -> { String }, optional: false, nullable: false field :value, -> { Vapi::Types::ToolParameterValue }, optional: false, nullable: false diff --git a/lib/vapi/types/tool_rejection_plan.rb b/lib/vapi/types/tool_rejection_plan.rb index 573436bb..dcd3d670 100644 --- a/lib/vapi/types/tool_rejection_plan.rb +++ b/lib/vapi/types/tool_rejection_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Conditions evaluated to determine whether a requested tool call should be rejected. class ToolRejectionPlan < Internal::Types::Model field :conditions, -> { Internal::Types::Array[Vapi::Types::ToolRejectionPlanConditionsItem] }, optional: true, nullable: false end diff --git a/lib/vapi/types/transcriber_cost.rb b/lib/vapi/types/transcriber_cost.rb index 42471013..da31b584 100644 --- a/lib/vapi/types/transcriber_cost.rb +++ b/lib/vapi/types/transcriber_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Speech-to-text cost for a call, including transcriber, billable minutes, and amount. class TranscriberCost < Internal::Types::Model field :transcriber, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false field :minutes, -> { Integer }, optional: false, nullable: false diff --git a/lib/vapi/types/transcript_plan.rb b/lib/vapi/types/transcript_plan.rb index 67ed7f29..1137418f 100644 --- a/lib/vapi/types/transcript_plan.rb +++ b/lib/vapi/types/transcript_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls whether the call transcript is stored and the speaker names used in the transcript. class TranscriptPlan < Internal::Types::Model field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false field :assistant_name, -> { String }, optional: true, nullable: false, api_name: "assistantName" diff --git a/lib/vapi/types/transcription_endpointing_plan.rb b/lib/vapi/types/transcription_endpointing_plan.rb index 1cb1030f..506e8ac6 100644 --- a/lib/vapi/types/transcription_endpointing_plan.rb +++ b/lib/vapi/types/transcription_endpointing_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Controls endpointing delays based on whether customer speech ends with punctuation, without punctuation, or with a + # number. class TranscriptionEndpointingPlan < Internal::Types::Model field :on_punctuation_seconds, -> { Integer }, optional: true, nullable: false, api_name: "onPunctuationSeconds" field :on_no_punctuation_seconds, -> { Integer }, optional: true, nullable: false, api_name: "onNoPunctuationSeconds" diff --git a/lib/vapi/types/transfer_call_tool.rb b/lib/vapi/types/transfer_call_tool.rb index 64398090..2725a17c 100644 --- a/lib/vapi/types/transfer_call_tool.rb +++ b/lib/vapi/types/transfer_call_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable tool that transfers the active call to one of its configured destinations. class TransferCallTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::TransferCallToolMessagesItem] }, optional: true, nullable: false field :destinations, -> { Internal::Types::Array[Vapi::Types::TransferCallToolDestinationsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/transfer_destination_assistant.rb b/lib/vapi/types/transfer_destination_assistant.rb index f06fe33a..08a95d7f 100644 --- a/lib/vapi/types/transfer_destination_assistant.rb +++ b/lib/vapi/types/transfer_destination_assistant.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Transfers a call to another assistant by name, with an optional message and assistant-transfer mode. class TransferDestinationAssistant < Internal::Types::Model field :message, -> { Vapi::Types::TransferDestinationAssistantMessage }, optional: true, nullable: false field :type, -> { Vapi::Types::TransferDestinationAssistantType }, optional: false, nullable: false diff --git a/lib/vapi/types/transfer_destination_number.rb b/lib/vapi/types/transfer_destination_number.rb index 2d2a6314..bd8c3c67 100644 --- a/lib/vapi/types/transfer_destination_number.rb +++ b/lib/vapi/types/transfer_destination_number.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Transfers a call to a phone number, with optional extension, caller ID, message, transfer plan, and number + # validation. class TransferDestinationNumber < Internal::Types::Model field :message, -> { Vapi::Types::TransferDestinationNumberMessage }, optional: true, nullable: false field :number_e_164_check_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "numberE164CheckEnabled" diff --git a/lib/vapi/types/transfer_destination_sip.rb b/lib/vapi/types/transfer_destination_sip.rb index d999a298..545dde5e 100644 --- a/lib/vapi/types/transfer_destination_sip.rb +++ b/lib/vapi/types/transfer_destination_sip.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Transfers a call to a SIP URI, with optional caller ID, headers, message, and transfer plan. class TransferDestinationSip < Internal::Types::Model field :message, -> { Vapi::Types::TransferDestinationSipMessage }, optional: true, nullable: false field :sip_uri, -> { String }, optional: false, nullable: false, api_name: "sipUri" diff --git a/lib/vapi/types/transfer_fallback_plan.rb b/lib/vapi/types/transfer_fallback_plan.rb index dccc3329..8d02ae9c 100644 --- a/lib/vapi/types/transfer_fallback_plan.rb +++ b/lib/vapi/types/transfer_fallback_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls the message and end-call behavior used when a call transfer fails. class TransferFallbackPlan < Internal::Types::Model field :message, -> { Vapi::Types::TransferFallbackPlanMessage }, optional: false, nullable: false field :end_call_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "endCallEnabled" diff --git a/lib/vapi/types/transfer_phone_number_hook_action.rb b/lib/vapi/types/transfer_phone_number_hook_action.rb index 3b636e20..8f8cd437 100644 --- a/lib/vapi/types/transfer_phone_number_hook_action.rb +++ b/lib/vapi/types/transfer_phone_number_hook_action.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A phone-number hook action that transfers the call to a phone number or SIP destination. class TransferPhoneNumberHookAction < Internal::Types::Model field :destination, -> { Vapi::Types::TransferPhoneNumberHookActionDestination }, optional: true, nullable: false end diff --git a/lib/vapi/types/transfer_plan.rb b/lib/vapi/types/transfer_plan.rb index 7f1cfd41..86c32c2f 100644 --- a/lib/vapi/types/transfer_plan.rb +++ b/lib/vapi/types/transfer_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :mode, -> { Vapi::Types::TransferPlanMode }, optional: false, nullable: false field :message, -> { Vapi::Types::TransferPlanMessage }, optional: true, nullable: false diff --git a/lib/vapi/types/transport_configuration_twilio.rb b/lib/vapi/types/transport_configuration_twilio.rb index 12345524..06d24ebb 100644 --- a/lib/vapi/types/transport_configuration_twilio.rb +++ b/lib/vapi/types/transport_configuration_twilio.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration passed to Twilio for assistant calls, including ring timeout and Twilio recording behavior. class TransportConfigurationTwilio < Internal::Types::Model field :provider, -> { Vapi::Types::TransportConfigurationTwilioProvider }, optional: false, nullable: false field :timeout, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/transport_cost.rb b/lib/vapi/types/transport_cost.rb index abbb9a5e..6eb6cd83 100644 --- a/lib/vapi/types/transport_cost.rb +++ b/lib/vapi/types/transport_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Telephony transport cost for a call, including provider, billable minutes, and amount. class TransportCost < Internal::Types::Model field :provider, -> { Vapi::Types::TransportCostProvider }, optional: true, nullable: false field :minutes, -> { Integer }, optional: false, nullable: false diff --git a/lib/vapi/types/turn_latency.rb b/lib/vapi/types/turn_latency.rb index 5c58a2b1..bad2c774 100644 --- a/lib/vapi/types/turn_latency.rb +++ b/lib/vapi/types/turn_latency.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Model, voice, transcription, endpointing, and total latency measurements for a conversation turn. class TurnLatency < Internal::Types::Model field :model_latency, -> { Integer }, optional: true, nullable: false, api_name: "modelLatency" field :voice_latency, -> { Integer }, optional: true, nullable: false, api_name: "voiceLatency" diff --git a/lib/vapi/types/twilio_phone_number.rb b/lib/vapi/types/twilio_phone_number.rb index c4e86bb7..7bf4f37a 100644 --- a/lib/vapi/types/twilio_phone_number.rb +++ b/lib/vapi/types/twilio_phone_number.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, + # server settings, and lifecycle metadata. class TwilioPhoneNumber < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::TwilioPhoneNumberFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::TwilioPhoneNumberHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/twilio_voicemail_detection_plan.rb b/lib/vapi/types/twilio_voicemail_detection_plan.rb index df828797..582b0a30 100644 --- a/lib/vapi/types/twilio_voicemail_detection_plan.rb +++ b/lib/vapi/types/twilio_voicemail_detection_plan.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for Twilio answering-machine detection, including recognized outcomes, enablement, timeout, speech + # thresholds, and silence timeout. class TwilioVoicemailDetectionPlan < Internal::Types::Model field :provider, -> { Vapi::Types::TwilioVoicemailDetectionPlanProvider }, optional: false, nullable: false field :voicemail_detection_types, -> { Internal::Types::Array[Vapi::Types::TwilioVoicemailDetectionPlanVoicemailDetectionTypesItem] }, optional: true, nullable: false, api_name: "voicemailDetectionTypes" diff --git a/lib/vapi/types/update_api_request_tool_dto.rb b/lib/vapi/types/update_api_request_tool_dto.rb index 73b83593..1ddfb725 100644 --- a/lib/vapi/types/update_api_request_tool_dto.rb +++ b/lib/vapi/types/update_api_request_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update an API-request tool, including its URL, HTTP method, authentication, request data, retries, + # and response handling. class UpdateApiRequestToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateApiRequestToolDtoMessagesItem] }, optional: true, nullable: false field :method_, -> { Vapi::Types::UpdateApiRequestToolDtoMethod }, optional: true, nullable: false, api_name: "method" diff --git a/lib/vapi/types/update_bar_insight_from_call_table_dto.rb b/lib/vapi/types/update_bar_insight_from_call_table_dto.rb index 4a7129de..387226bb 100644 --- a/lib/vapi/types/update_bar_insight_from_call_table_dto.rb +++ b/lib/vapi/types/update_bar_insight_from_call_table_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a bar-chart insight, including its queries, formulas, grouping, time range, metadata, and + # name. class UpdateBarInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_bash_tool_dto.rb b/lib/vapi/types/update_bash_tool_dto.rb index a84c3e68..8c00a8f2 100644 --- a/lib/vapi/types/update_bash_tool_dto.rb +++ b/lib/vapi/types/update_bash_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a Bash tool, including its name, environment subtype, server, messages, and rejection plan. class UpdateBashToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateBashToolDtoMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::UpdateBashToolDtoSubType }, optional: true, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/update_byo_phone_number_dto.rb b/lib/vapi/types/update_byo_phone_number_dto.rb index 4d75ba6d..3e752d08 100644 --- a/lib/vapi/types/update_byo_phone_number_dto.rb +++ b/lib/vapi/types/update_byo_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a bring-your-own phone number, including its credential, number, routing, hooks, and server + # settings. class UpdateByoPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::UpdateByoPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::UpdateByoPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_computer_tool_dto.rb b/lib/vapi/types/update_computer_tool_dto.rb index 81e93836..6f931aa7 100644 --- a/lib/vapi/types/update_computer_tool_dto.rb +++ b/lib/vapi/types/update_computer_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a computer tool, including its display settings, environment subtype, server, messages, and + # rejection plan. class UpdateComputerToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateComputerToolDtoMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::UpdateComputerToolDtoSubType }, optional: true, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/update_dtmf_tool_dto.rb b/lib/vapi/types/update_dtmf_tool_dto.rb index 68bb2886..30d41f52 100644 --- a/lib/vapi/types/update_dtmf_tool_dto.rb +++ b/lib/vapi/types/update_dtmf_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a DTMF tool, including its spoken messages, rejection plan, and SIP INFO behavior. class UpdateDtmfToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateDtmfToolDtoMessagesItem] }, optional: true, nullable: false field :sip_info_dtmf_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "sipInfoDtmfEnabled" diff --git a/lib/vapi/types/update_end_call_tool_dto.rb b/lib/vapi/types/update_end_call_tool_dto.rb index 7629bae8..917b9f93 100644 --- a/lib/vapi/types/update_end_call_tool_dto.rb +++ b/lib/vapi/types/update_end_call_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update an end-call tool, including its spoken messages and rejection plan. class UpdateEndCallToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateEndCallToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_function_tool_dto.rb b/lib/vapi/types/update_function_tool_dto.rb index 13dda5bf..1c6aca83 100644 --- a/lib/vapi/types/update_function_tool_dto.rb +++ b/lib/vapi/types/update_function_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a custom function tool, including its function definition, server, parameters, messages, and + # execution behavior. class UpdateFunctionToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateFunctionToolDtoMessagesItem] }, optional: true, nullable: false field :async, -> { Internal::Types::Boolean }, optional: true, nullable: false diff --git a/lib/vapi/types/update_go_high_level_calendar_availability_tool_dto.rb b/lib/vapi/types/update_go_high_level_calendar_availability_tool_dto.rb index 59325308..c430ad4d 100644 --- a/lib/vapi/types/update_go_high_level_calendar_availability_tool_dto.rb +++ b/lib/vapi/types/update_go_high_level_calendar_availability_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a GoHighLevel calendar-availability tool, including its spoken messages and rejection plan. class UpdateGoHighLevelCalendarAvailabilityToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateGoHighLevelCalendarAvailabilityToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_go_high_level_calendar_event_create_tool_dto.rb b/lib/vapi/types/update_go_high_level_calendar_event_create_tool_dto.rb index 3b508a5c..afab37cf 100644 --- a/lib/vapi/types/update_go_high_level_calendar_event_create_tool_dto.rb +++ b/lib/vapi/types/update_go_high_level_calendar_event_create_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a GoHighLevel calendar-event tool, including its spoken messages and rejection plan. class UpdateGoHighLevelCalendarEventCreateToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateGoHighLevelCalendarEventCreateToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_go_high_level_contact_create_tool_dto.rb b/lib/vapi/types/update_go_high_level_contact_create_tool_dto.rb index 7ffee2ec..d772480c 100644 --- a/lib/vapi/types/update_go_high_level_contact_create_tool_dto.rb +++ b/lib/vapi/types/update_go_high_level_contact_create_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a GoHighLevel contact-creation tool, including its spoken messages and rejection plan. class UpdateGoHighLevelContactCreateToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateGoHighLevelContactCreateToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_go_high_level_contact_get_tool_dto.rb b/lib/vapi/types/update_go_high_level_contact_get_tool_dto.rb index 28df79af..8dbf46d9 100644 --- a/lib/vapi/types/update_go_high_level_contact_get_tool_dto.rb +++ b/lib/vapi/types/update_go_high_level_contact_get_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a GoHighLevel contact-retrieval tool, including its spoken messages and rejection plan. class UpdateGoHighLevelContactGetToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateGoHighLevelContactGetToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_google_calendar_check_availability_tool_dto.rb b/lib/vapi/types/update_google_calendar_check_availability_tool_dto.rb index 05946eec..461f07df 100644 --- a/lib/vapi/types/update_google_calendar_check_availability_tool_dto.rb +++ b/lib/vapi/types/update_google_calendar_check_availability_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a Google Calendar availability tool, including its spoken messages and rejection plan. class UpdateGoogleCalendarCheckAvailabilityToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateGoogleCalendarCheckAvailabilityToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_google_calendar_create_event_tool_dto.rb b/lib/vapi/types/update_google_calendar_create_event_tool_dto.rb index f15e895b..0da54ddb 100644 --- a/lib/vapi/types/update_google_calendar_create_event_tool_dto.rb +++ b/lib/vapi/types/update_google_calendar_create_event_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a Google Calendar event-creation tool, including its spoken messages and rejection plan. class UpdateGoogleCalendarCreateEventToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateGoogleCalendarCreateEventToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_google_sheets_row_append_tool_dto.rb b/lib/vapi/types/update_google_sheets_row_append_tool_dto.rb index c3a46b03..f88d58d0 100644 --- a/lib/vapi/types/update_google_sheets_row_append_tool_dto.rb +++ b/lib/vapi/types/update_google_sheets_row_append_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a Google Sheets row-append tool, including its spoken messages and rejection plan. class UpdateGoogleSheetsRowAppendToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateGoogleSheetsRowAppendToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_handoff_tool_dto.rb b/lib/vapi/types/update_handoff_tool_dto.rb index d7be2b8a..806a67eb 100644 --- a/lib/vapi/types/update_handoff_tool_dto.rb +++ b/lib/vapi/types/update_handoff_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a handoff tool, including its destinations, function definition, default result, messages, + # and rejection plan. class UpdateHandoffToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateHandoffToolDtoMessagesItem] }, optional: true, nullable: false field :default_result, -> { String }, optional: true, nullable: false, api_name: "defaultResult" diff --git a/lib/vapi/types/update_line_insight_from_call_table_dto.rb b/lib/vapi/types/update_line_insight_from_call_table_dto.rb index 3db94f1c..4baef133 100644 --- a/lib/vapi/types/update_line_insight_from_call_table_dto.rb +++ b/lib/vapi/types/update_line_insight_from_call_table_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a line-chart insight, including its queries, formulas, grouping, time range, metadata, and + # name. class UpdateLineInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_mcp_tool_dto.rb b/lib/vapi/types/update_mcp_tool_dto.rb index 11317091..66041039 100644 --- a/lib/vapi/types/update_mcp_tool_dto.rb +++ b/lib/vapi/types/update_mcp_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update an MCP tool, including its server, connection metadata, exposed tool messages, and rejection + # plan. class UpdateMcpToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateMcpToolDtoMessagesItem] }, optional: true, nullable: false field :server, -> { Vapi::Types::Server }, optional: true, nullable: false diff --git a/lib/vapi/types/update_pie_insight_from_call_table_dto.rb b/lib/vapi/types/update_pie_insight_from_call_table_dto.rb index 2c7b474b..d61cec6a 100644 --- a/lib/vapi/types/update_pie_insight_from_call_table_dto.rb +++ b/lib/vapi/types/update_pie_insight_from_call_table_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a pie-chart insight, including its queries, formulas, grouping, time range, and name. class UpdatePieInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formulas, -> { Internal::Types::Array[Vapi::Types::InsightFormula] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_query_tool_dto.rb b/lib/vapi/types/update_query_tool_dto.rb index 77202cf5..2cb64350 100644 --- a/lib/vapi/types/update_query_tool_dto.rb +++ b/lib/vapi/types/update_query_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a query tool, including its knowledge bases, spoken messages, and rejection plan. class UpdateQueryToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateQueryToolDtoMessagesItem] }, optional: true, nullable: false field :knowledge_bases, -> { Internal::Types::Array[Vapi::Types::KnowledgeBase] }, optional: true, nullable: false, api_name: "knowledgeBases" diff --git a/lib/vapi/types/update_sip_request_tool_dto.rb b/lib/vapi/types/update_sip_request_tool_dto.rb index 680a7295..47f94d3f 100644 --- a/lib/vapi/types/update_sip_request_tool_dto.rb +++ b/lib/vapi/types/update_sip_request_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a SIP-request tool, including its method, headers, body, spoken messages, and rejection + # plan. class UpdateSipRequestToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateSipRequestToolDtoMessagesItem] }, optional: true, nullable: false field :verb, -> { Vapi::Types::UpdateSipRequestToolDtoVerb }, optional: true, nullable: false diff --git a/lib/vapi/types/update_slack_send_message_tool_dto.rb b/lib/vapi/types/update_slack_send_message_tool_dto.rb index 2881aee8..acb29bdb 100644 --- a/lib/vapi/types/update_slack_send_message_tool_dto.rb +++ b/lib/vapi/types/update_slack_send_message_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a Slack message tool, including its spoken messages and rejection plan. class UpdateSlackSendMessageToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateSlackSendMessageToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_sms_tool_dto.rb b/lib/vapi/types/update_sms_tool_dto.rb index 5ac50e70..0cf154ab 100644 --- a/lib/vapi/types/update_sms_tool_dto.rb +++ b/lib/vapi/types/update_sms_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update an SMS tool, including its spoken messages and rejection plan. class UpdateSmsToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateSmsToolDtoMessagesItem] }, optional: true, nullable: false field :rejection_plan, -> { Vapi::Types::ToolRejectionPlan }, optional: true, nullable: false, api_name: "rejectionPlan" diff --git a/lib/vapi/types/update_telnyx_phone_number_dto.rb b/lib/vapi/types/update_telnyx_phone_number_dto.rb index 9d858b4e..74c4b059 100644 --- a/lib/vapi/types/update_telnyx_phone_number_dto.rb +++ b/lib/vapi/types/update_telnyx_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a Telnyx phone number, including its credential, number, routing, hooks, and server + # settings. class UpdateTelnyxPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::UpdateTelnyxPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::UpdateTelnyxPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_text_editor_tool_dto.rb b/lib/vapi/types/update_text_editor_tool_dto.rb index 184a24bc..70b374b3 100644 --- a/lib/vapi/types/update_text_editor_tool_dto.rb +++ b/lib/vapi/types/update_text_editor_tool_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a text-editor tool, including its name, environment subtype, server, messages, and rejection + # plan. class UpdateTextEditorToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateTextEditorToolDtoMessagesItem] }, optional: true, nullable: false field :sub_type, -> { Vapi::Types::UpdateTextEditorToolDtoSubType }, optional: true, nullable: false, api_name: "subType" diff --git a/lib/vapi/types/update_text_insight_from_call_table_dto.rb b/lib/vapi/types/update_text_insight_from_call_table_dto.rb index 099e81b1..968645fc 100644 --- a/lib/vapi/types/update_text_insight_from_call_table_dto.rb +++ b/lib/vapi/types/update_text_insight_from_call_table_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a text-value insight, including its queries, formula, time range, and name. class UpdateTextInsightFromCallTableDto < Internal::Types::Model field :name, -> { String }, optional: true, nullable: false field :formula, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_transfer_call_tool_dto.rb b/lib/vapi/types/update_transfer_call_tool_dto.rb index 3da1582c..ef0f0812 100644 --- a/lib/vapi/types/update_transfer_call_tool_dto.rb +++ b/lib/vapi/types/update_transfer_call_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a call-transfer tool, including its destinations, spoken messages, and rejection plan. class UpdateTransferCallToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateTransferCallToolDtoMessagesItem] }, optional: true, nullable: false field :destinations, -> { Internal::Types::Array[Vapi::Types::UpdateTransferCallToolDtoDestinationsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_twilio_phone_number_dto.rb b/lib/vapi/types/update_twilio_phone_number_dto.rb index 57ad4dcd..fcd37918 100644 --- a/lib/vapi/types/update_twilio_phone_number_dto.rb +++ b/lib/vapi/types/update_twilio_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, + # and server settings. class UpdateTwilioPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::UpdateTwilioPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::UpdateTwilioPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_vapi_phone_number_dto.rb b/lib/vapi/types/update_vapi_phone_number_dto.rb index 2cc640a8..72bc8b86 100644 --- a/lib/vapi/types/update_vapi_phone_number_dto.rb +++ b/lib/vapi/types/update_vapi_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, and + # server settings. class UpdateVapiPhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::UpdateVapiPhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::UpdateVapiPhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/update_voicemail_tool_dto.rb b/lib/vapi/types/update_voicemail_tool_dto.rb index edc83ed8..42587611 100644 --- a/lib/vapi/types/update_voicemail_tool_dto.rb +++ b/lib/vapi/types/update_voicemail_tool_dto.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Fields used to update a voicemail-detection tool, including beep detection, spoken messages, and rejection plan. class UpdateVoicemailToolDto < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::UpdateVoicemailToolDtoMessagesItem] }, optional: true, nullable: false field :beep_detection_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "beepDetectionEnabled" diff --git a/lib/vapi/types/update_vonage_phone_number_dto.rb b/lib/vapi/types/update_vonage_phone_number_dto.rb index b6778dea..9e22d583 100644 --- a/lib/vapi/types/update_vonage_phone_number_dto.rb +++ b/lib/vapi/types/update_vonage_phone_number_dto.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Fields used to update a Vonage phone number, including its credential, number, routing, hooks, and server + # settings. class UpdateVonagePhoneNumberDto < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::UpdateVonagePhoneNumberDtoFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::UpdateVonagePhoneNumberDtoHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/user_message.rb b/lib/vapi/types/user_message.rb index fd423086..00645811 100644 --- a/lib/vapi/types/user_message.rb +++ b/lib/vapi/types/user_message.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A user-authored entry in the call message history, including content, timing, security-filter results, and + # optional speaker metadata. class UserMessage < Internal::Types::Model field :role, -> { String }, optional: false, nullable: false field :message, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/vapi_cost.rb b/lib/vapi/types/vapi_cost.rb index 02faaf1a..e6c9789e 100644 --- a/lib/vapi/types/vapi_cost.rb +++ b/lib/vapi/types/vapi_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Vapi platform cost for a call, including cost subtype, billable minutes, and amount. class VapiCost < Internal::Types::Model field :sub_type, -> { Vapi::Types::VapiCostSubType }, optional: false, nullable: false, api_name: "subType" field :minutes, -> { Integer }, optional: false, nullable: false diff --git a/lib/vapi/types/vapi_phone_number.rb b/lib/vapi/types/vapi_phone_number.rb index 8e08c3c6..337c2d03 100644 --- a/lib/vapi/types/vapi_phone_number.rb +++ b/lib/vapi/types/vapi_phone_number.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, server settings, and + # lifecycle metadata. class VapiPhoneNumber < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::VapiPhoneNumberFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::VapiPhoneNumberHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/vapi_pronunciation_dictionary_locator.rb b/lib/vapi/types/vapi_pronunciation_dictionary_locator.rb index 23765778..ab36655e 100644 --- a/lib/vapi/types/vapi_pronunciation_dictionary_locator.rb +++ b/lib/vapi/types/vapi_pronunciation_dictionary_locator.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Identifies a pronunciation dictionary and optional version used for voice synthesis. class VapiPronunciationDictionaryLocator < Internal::Types::Model field :pronunciation_dict_id, -> { String }, optional: false, nullable: false, api_name: "pronunciationDictId" field :version_id, -> { String }, optional: true, nullable: false, api_name: "versionId" diff --git a/lib/vapi/types/vapi_smart_endpointing_plan.rb b/lib/vapi/types/vapi_smart_endpointing_plan.rb index e7248238..0aea3119 100644 --- a/lib/vapi/types/vapi_smart_endpointing_plan.rb +++ b/lib/vapi/types/vapi_smart_endpointing_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Selects Vapi smart endpointing to determine when customer speech is complete. class VapiSmartEndpointingPlan < Internal::Types::Model field :provider, -> { Vapi::Types::VapiSmartEndpointingPlanProvider }, optional: false, nullable: false end diff --git a/lib/vapi/types/vapi_voice.rb b/lib/vapi/types/vapi_voice.rb index 81dc8928..cf8131ea 100644 --- a/lib/vapi/types/vapi_voice.rb +++ b/lib/vapi/types/vapi_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation + # dictionary, chunking, caching, and fallback settings. class VapiVoice < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { Vapi::Types::VapiVoiceVoiceId }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/vapi_voicemail_detection_plan.rb b/lib/vapi/types/vapi_voicemail_detection_plan.rb index 487b9bf9..deee70cc 100644 --- a/lib/vapi/types/vapi_voicemail_detection_plan.rb +++ b/lib/vapi/types/vapi_voicemail_detection_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Configuration for detecting voicemail with Vapi, including detection type, maximum beep wait, and retry backoff. class VapiVoicemailDetectionPlan < Internal::Types::Model field :beep_max_await_seconds, -> { Integer }, optional: true, nullable: false, api_name: "beepMaxAwaitSeconds" field :provider, -> { Vapi::Types::VapiVoicemailDetectionPlanProvider }, optional: false, nullable: false diff --git a/lib/vapi/types/variable_extraction_alias.rb b/lib/vapi/types/variable_extraction_alias.rb index 1031d35e..af13c05c 100644 --- a/lib/vapi/types/variable_extraction_alias.rb +++ b/lib/vapi/types/variable_extraction_alias.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Defines an additional Liquid-based variable from values extracted during a call. class VariableExtractionAlias < Internal::Types::Model field :key, -> { String }, optional: false, nullable: false field :value, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/variable_extraction_plan.rb b/lib/vapi/types/variable_extraction_plan.rb index c3814db2..8238b695 100644 --- a/lib/vapi/types/variable_extraction_plan.rb +++ b/lib/vapi/types/variable_extraction_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Defines structured variables to extract and optional aliases made available during and after a call. class VariableExtractionPlan < Internal::Types::Model field :schema, -> { Vapi::Types::JsonSchema }, optional: true, nullable: false field :aliases, -> { Internal::Types::Array[Vapi::Types::VariableExtractionAlias] }, optional: true, nullable: false diff --git a/lib/vapi/types/variable_value_group_by.rb b/lib/vapi/types/variable_value_group_by.rb index 3f44c5b6..8901ed1a 100644 --- a/lib/vapi/types/variable_value_group_by.rb +++ b/lib/vapi/types/variable_value_group_by.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Groups analytics results by a selected assistant variable-value key. class VariableValueGroupBy < Internal::Types::Model field :key, -> { String }, optional: false, nullable: false end diff --git a/lib/vapi/types/voice_cost.rb b/lib/vapi/types/voice_cost.rb index b760b391..9e40d810 100644 --- a/lib/vapi/types/voice_cost.rb +++ b/lib/vapi/types/voice_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Voice-synthesis cost for a call, including voice, character usage, and amount. class VoiceCost < Internal::Types::Model field :voice, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false field :characters, -> { Integer }, optional: false, nullable: false diff --git a/lib/vapi/types/voicemail_detection_backoff_plan.rb b/lib/vapi/types/voicemail_detection_backoff_plan.rb index 03c8d8dc..85c384e7 100644 --- a/lib/vapi/types/voicemail_detection_backoff_plan.rb +++ b/lib/vapi/types/voicemail_detection_backoff_plan.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Controls voicemail-detection retry timing, including when retries start, retry frequency, and maximum attempts. class VoicemailDetectionBackoffPlan < Internal::Types::Model field :start_at_seconds, -> { Integer }, optional: true, nullable: false, api_name: "startAtSeconds" field :frequency_seconds, -> { Integer }, optional: true, nullable: false, api_name: "frequencySeconds" diff --git a/lib/vapi/types/voicemail_detection_cost.rb b/lib/vapi/types/voicemail_detection_cost.rb index b9162334..c9a1ca11 100644 --- a/lib/vapi/types/voicemail_detection_cost.rb +++ b/lib/vapi/types/voicemail_detection_cost.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Voicemail-detection model cost, including provider, model, multimodal token usage, and amount. class VoicemailDetectionCost < Internal::Types::Model field :model, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false field :provider, -> { Vapi::Types::VoicemailDetectionCostProvider }, optional: false, nullable: false diff --git a/lib/vapi/types/voicemail_tool.rb b/lib/vapi/types/voicemail_tool.rb index 2851227a..8827a670 100644 --- a/lib/vapi/types/voicemail_tool.rb +++ b/lib/vapi/types/voicemail_tool.rb @@ -2,6 +2,7 @@ module Vapi module Types + # A reusable voicemail-detection tool with optional beep detection for supported calls. class VoicemailTool < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::VoicemailToolMessagesItem] }, optional: true, nullable: false field :beep_detection_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "beepDetectionEnabled" diff --git a/lib/vapi/types/vonage_phone_number.rb b/lib/vapi/types/vonage_phone_number.rb index bd9c730e..3e0fe577 100644 --- a/lib/vapi/types/vonage_phone_number.rb +++ b/lib/vapi/types/vonage_phone_number.rb @@ -2,6 +2,8 @@ module Vapi module Types + # A Vonage phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle + # metadata. class VonagePhoneNumber < Internal::Types::Model field :fallback_destination, -> { Vapi::Types::VonagePhoneNumberFallbackDestination }, optional: true, nullable: false, api_name: "fallbackDestination" field :hooks, -> { Internal::Types::Array[Vapi::Types::VonagePhoneNumberHooksItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/well_said_voice.rb b/lib/vapi/types/well_said_voice.rb index c479aaea..df971ae8 100644 --- a/lib/vapi/types/well_said_voice.rb +++ b/lib/vapi/types/well_said_voice.rb @@ -2,6 +2,8 @@ module Vapi module Types + # 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 < Internal::Types::Model field :caching_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "cachingEnabled" field :voice_id, -> { String }, optional: false, nullable: false, api_name: "voiceId" diff --git a/lib/vapi/types/workflow_anthropic_bedrock_model.rb b/lib/vapi/types/workflow_anthropic_bedrock_model.rb index 006d2073..173d5703 100644 --- a/lib/vapi/types/workflow_anthropic_bedrock_model.rb +++ b/lib/vapi/types/workflow_anthropic_bedrock_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Workflow model configuration for Anthropic through Amazon Bedrock, including model selection, thinking, + # temperature, and maximum output tokens. class WorkflowAnthropicBedrockModel < Internal::Types::Model field :model, -> { Vapi::Types::WorkflowAnthropicBedrockModelModel }, optional: false, nullable: false field :thinking, -> { Vapi::Types::AnthropicThinkingConfig }, optional: true, nullable: false diff --git a/lib/vapi/types/workflow_anthropic_model.rb b/lib/vapi/types/workflow_anthropic_model.rb index 22b4381f..171a6e53 100644 --- a/lib/vapi/types/workflow_anthropic_model.rb +++ b/lib/vapi/types/workflow_anthropic_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Workflow model configuration for Anthropic, including model selection, thinking, temperature, and maximum output + # tokens. class WorkflowAnthropicModel < Internal::Types::Model field :model, -> { Vapi::Types::WorkflowAnthropicModelModel }, optional: false, nullable: false field :thinking, -> { Vapi::Types::AnthropicThinkingConfig }, optional: true, nullable: false diff --git a/lib/vapi/types/workflow_custom_model.rb b/lib/vapi/types/workflow_custom_model.rb index d1bb7b4f..1f25b7e8 100644 --- a/lib/vapi/types/workflow_custom_model.rb +++ b/lib/vapi/types/workflow_custom_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Workflow model configuration for a custom language model endpoint, including URL, headers, metadata delivery, + # timeout, model, temperature, and maximum output tokens. class WorkflowCustomModel < Internal::Types::Model field :metadata_send_mode, -> { Vapi::Types::WorkflowCustomModelMetadataSendMode }, optional: true, nullable: false, api_name: "metadataSendMode" field :url, -> { String }, optional: false, nullable: false diff --git a/lib/vapi/types/workflow_google_model.rb b/lib/vapi/types/workflow_google_model.rb index d82ecda3..9075b5a6 100644 --- a/lib/vapi/types/workflow_google_model.rb +++ b/lib/vapi/types/workflow_google_model.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Workflow model configuration for Google, including model selection, temperature, and maximum output tokens. class WorkflowGoogleModel < Internal::Types::Model field :model, -> { Vapi::Types::WorkflowGoogleModelModel }, optional: false, nullable: false field :temperature, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/workflow_open_ai_model.rb b/lib/vapi/types/workflow_open_ai_model.rb index 086fe554..a8eedf7c 100644 --- a/lib/vapi/types/workflow_open_ai_model.rb +++ b/lib/vapi/types/workflow_open_ai_model.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Workflow model configuration for OpenAI, including model selection, temperature, and maximum output tokens. class WorkflowOpenAiModel < Internal::Types::Model field :model, -> { Vapi::Types::WorkflowOpenAiModelModel }, optional: false, nullable: false field :temperature, -> { Integer }, optional: true, nullable: false diff --git a/lib/vapi/types/workflow_overrides.rb b/lib/vapi/types/workflow_overrides.rb index d26171b7..78747de8 100644 --- a/lib/vapi/types/workflow_overrides.rb +++ b/lib/vapi/types/workflow_overrides.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Per-call overrides for values used in workflow template variables. class WorkflowOverrides < Internal::Types::Model field :variable_values, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "variableValues" end diff --git a/lib/vapi/types/xai_model.rb b/lib/vapi/types/xai_model.rb index 59b7a3d6..11f9bdbd 100644 --- a/lib/vapi/types/xai_model.rb +++ b/lib/vapi/types/xai_model.rb @@ -2,6 +2,8 @@ module Vapi module Types + # Configuration for generating assistant responses with xAI, including model, prompts, tools, knowledge-base access, + # and generation settings. class XaiModel < Internal::Types::Model field :messages, -> { Internal::Types::Array[Vapi::Types::OpenAiMessage] }, optional: true, nullable: false field :tools, -> { Internal::Types::Array[Vapi::Types::XaiModelToolsItem] }, optional: true, nullable: false diff --git a/lib/vapi/types/xss_security_filter.rb b/lib/vapi/types/xss_security_filter.rb index 987cdc03..81825726 100644 --- a/lib/vapi/types/xss_security_filter.rb +++ b/lib/vapi/types/xss_security_filter.rb @@ -2,6 +2,7 @@ module Vapi module Types + # Filters potential cross-site scripting (XSS) patterns from transcripts. class XssSecurityFilter < Internal::Types::Model field :type, -> { Vapi::Types::XssSecurityFilterType }, optional: false, nullable: false end diff --git a/lib/vapi/version.rb b/lib/vapi/version.rb index e9df04c3..fd820e25 100644 --- a/lib/vapi/version.rb +++ b/lib/vapi/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Vapi - VERSION = "2.0.0" + VERSION = "2.0.1" end