chore: add inline documentation comments to client methods and types

.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"
 }

.fernignore

@@ -3,3 +3,6 @@
 .github/workflows/sdk-release-pr-notification.yml
 README.md
 changelog.md
+.fern/replay.lock
+.fern/replay.yml
+.gitattributes

.gitattributes

@@ -0,0 +1 @@
+.fern/replay.lock linguist-generated=true

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)

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.

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

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

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

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

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}"
         }

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

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