vapi_server_sdk 0.3.0 → 0.5.0

data/lib/vapi_server_sdk/tools/client.rb

@@ -38,13 +38,6 @@ module Vapi
     #  specified value.
     # @param request_options [Vapi::RequestOptions]
     # @return [Array<Vapi::Tools::ToolsListResponseItem>]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.list
     def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
              updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
       response = @request_client.conn.get do |req|
@@ -82,13 +75,6 @@ module Vapi
     # @param request [Vapi::Tools::ToolsCreateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsCreateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.create
     def create(request:, request_options: nil)
       response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -110,13 +96,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsGetResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.get(id: "id")
     def get(id:, request_options: nil)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -140,13 +119,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsDeleteResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.delete(id: "id")
     def delete(id:, request_options: nil)
       response = @request_client.conn.delete do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -171,13 +143,6 @@ module Vapi
     # @param request [Vapi::Tools::ToolsUpdateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsUpdateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.update(id: "id")
     def update(id:, request:, request_options: nil)
       response = @request_client.conn.patch do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -222,13 +187,6 @@ module Vapi
     #  specified value.
     # @param request_options [Vapi::RequestOptions]
     # @return [Array<Vapi::Tools::ToolsListResponseItem>]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.list
     def list(limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil,
              updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil)
       Async do
@@ -268,13 +226,6 @@ module Vapi
     # @param request [Vapi::Tools::ToolsCreateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsCreateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.create
     def create(request:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
@@ -298,13 +249,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsGetResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.get(id: "id")
     def get(id:, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -330,13 +274,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsDeleteResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.delete(id: "id")
     def delete(id:, request_options: nil)
       Async do
         response = @request_client.conn.delete do |req|
@@ -363,13 +300,6 @@ module Vapi
     # @param request [Vapi::Tools::ToolsUpdateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Tools::ToolsUpdateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.tools.update(id: "id")
     def update(id:, request:, request_options: nil)
       Async do
         response = @request_client.conn.patch do |req|

data/lib/vapi_server_sdk/types/ai_edge_condition.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class AiEdgeCondition
+    # @return [Array<String>]
+    attr_reader :matches
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param matches [Array<String>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::AiEdgeCondition]
+    def initialize(matches:, additional_properties: nil)
+      @matches = matches
+      @additional_properties = additional_properties
+      @_field_set = { "matches": matches }
+    end
+
+    # Deserialize a JSON object to an instance of AiEdgeCondition
+    #
+    # @param json_object [String]
+    # @return [Vapi::AiEdgeCondition]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      matches = parsed_json["matches"]
+      new(matches: matches, additional_properties: struct)
+    end
+
+    # Serialize an instance of AiEdgeCondition to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.matches.is_a?(Array) != false || raise("Passed value for field obj.matches is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/analytics_operation_column.rb

@@ -13,5 +13,6 @@ module Vapi
     COST_BREAKDOWN_LLM_PROMPT_TOKENS = "costBreakdown.llmPromptTokens"
     COST_BREAKDOWN_LLM_COMPLETION_TOKENS = "costBreakdown.llmCompletionTokens"
     DURATION = "duration"
+    CONCURRENCY = "concurrency"
   end
 end

data/lib/vapi_server_sdk/types/analytics_operation_operation.rb

@@ -8,5 +8,6 @@ module Vapi
     COUNT = "count"
     MIN = "min"
     MAX = "max"
+    HISTORY = "history"
   end
 end

data/lib/vapi_server_sdk/types/analytics_query.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "analytics_query_table"
 require_relative "analytics_query_group_by_item"
 require_relative "time_range"
 require_relative "analytics_operation"
@@ -8,7 +9,7 @@ require "json"
 
 module Vapi
   class AnalyticsQuery
-    # @return [String] This is the table you want to query.
+    # @return [Vapi::AnalyticsQueryTable] This is the table you want to query.
     attr_reader :table
     # @return [Array<Vapi::AnalyticsQueryGroupByItem>] This is the list of columns you want to group by.
     attr_reader :group_by
@@ -27,7 +28,7 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param table [String] This is the table you want to query.
+    # @param table [Vapi::AnalyticsQueryTable] This is the table you want to query.
     # @param group_by [Array<Vapi::AnalyticsQueryGroupByItem>] This is the list of columns you want to group by.
     # @param name [String] This is the name of the query. This will be used to identify the query in the
     #  response.
@@ -97,7 +98,7 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.table.is_a?(String) != false || raise("Passed value for field obj.table is not the expected type, validation failed.")
+      obj.table.is_a?(Vapi::AnalyticsQueryTable) != false || raise("Passed value for field obj.table is not the expected type, validation failed.")
       obj.group_by&.is_a?(Array) != false || raise("Passed value for field obj.group_by is not the expected type, validation failed.")
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.time_range.nil? || Vapi::TimeRange.validate_raw(obj: obj.time_range)

data/lib/vapi_server_sdk/types/analytics_query_table.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the table you want to query.
+  class AnalyticsQueryTable
+    CALL = "call"
+    SUBSCRIPTION = "subscription"
+  end
+end

data/lib/vapi_server_sdk/types/api_request.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require_relative "api_request_method"
+require_relative "json_schema"
+require_relative "api_request_mode"
+require_relative "hook"
+require "ostruct"
+require "json"
+
+module Vapi
+  class ApiRequest
+    # @return [Vapi::ApiRequestMethod]
+    attr_reader :method
+    # @return [String] Api endpoint to send requests to.
+    attr_reader :url
+    # @return [Vapi::JsonSchema] These are the custom headers to include in the Api Request sent.
+    #  Each key-value pair represents a header name and its value.
+    attr_reader :headers
+    # @return [Vapi::JsonSchema] This defined the JSON body of your Api Request. For example, if `body_schema`
+    #  included "my_field": "my_gather_statement.user_age", then the json body sent to
+    #  the server would have that particular value assign to it.
+    #  Right now, only data from gather statements are supported.
+    attr_reader :body
+    # @return [Vapi::ApiRequestMode] This is the mode of the Api Request.
+    #  We only support BLOCKING and BACKGROUND for now.
+    attr_reader :mode
+    # @return [Array<Vapi::Hook>] This is a list of hooks for a task.
+    #  Each hook is a list of tasks to run on a trigger (such as on start, on failure,
+    #  etc).
+    #  Only Say is supported for now.
+    attr_reader :hooks
+    # @return [Vapi::JsonSchema] This is the schema for the outputs of the Api Request.
+    attr_reader :output
+    # @return [String]
+    attr_reader :name
+    # @return [Hash{String => Object}] This is for metadata you want to store on the task.
+    attr_reader :metadata
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param method [Vapi::ApiRequestMethod]
+    # @param url [String] Api endpoint to send requests to.
+    # @param headers [Vapi::JsonSchema] These are the custom headers to include in the Api Request sent.
+    #  Each key-value pair represents a header name and its value.
+    # @param body [Vapi::JsonSchema] This defined the JSON body of your Api Request. For example, if `body_schema`
+    #  included "my_field": "my_gather_statement.user_age", then the json body sent to
+    #  the server would have that particular value assign to it.
+    #  Right now, only data from gather statements are supported.
+    # @param mode [Vapi::ApiRequestMode] This is the mode of the Api Request.
+    #  We only support BLOCKING and BACKGROUND for now.
+    # @param hooks [Array<Vapi::Hook>] This is a list of hooks for a task.
+    #  Each hook is a list of tasks to run on a trigger (such as on start, on failure,
+    #  etc).
+    #  Only Say is supported for now.
+    # @param output [Vapi::JsonSchema] This is the schema for the outputs of the Api Request.
+    # @param name [String]
+    # @param metadata [Hash{String => Object}] This is for metadata you want to store on the task.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::ApiRequest]
+    def initialize(method:, url:, mode:, name:, headers: OMIT, body: OMIT, hooks: OMIT, output: OMIT, metadata: OMIT,
+                   additional_properties: nil)
+      @method = method
+      @url = url
+      @headers = headers if headers != OMIT
+      @body = body if body != OMIT
+      @mode = mode
+      @hooks = hooks if hooks != OMIT
+      @output = output if output != OMIT
+      @name = name
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "method": method,
+        "url": url,
+        "headers": headers,
+        "body": body,
+        "mode": mode,
+        "hooks": hooks,
+        "output": output,
+        "name": name,
+        "metadata": metadata
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of ApiRequest
+    #
+    # @param json_object [String]
+    # @return [Vapi::ApiRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      method = parsed_json["method"]
+      url = parsed_json["url"]
+      if parsed_json["headers"].nil?
+        headers = nil
+      else
+        headers = parsed_json["headers"].to_json
+        headers = Vapi::JsonSchema.from_json(json_object: headers)
+      end
+      if parsed_json["body"].nil?
+        body = nil
+      else
+        body = parsed_json["body"].to_json
+        body = Vapi::JsonSchema.from_json(json_object: body)
+      end
+      mode = parsed_json["mode"]
+      hooks = parsed_json["hooks"]&.map do |item|
+        item = item.to_json
+        Vapi::Hook.from_json(json_object: item)
+      end
+      if parsed_json["output"].nil?
+        output = nil
+      else
+        output = parsed_json["output"].to_json
+        output = Vapi::JsonSchema.from_json(json_object: output)
+      end
+      name = parsed_json["name"]
+      metadata = parsed_json["metadata"]
+      new(
+        method: method,
+        url: url,
+        headers: headers,
+        body: body,
+        mode: mode,
+        hooks: hooks,
+        output: output,
+        name: name,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of ApiRequest to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.method.is_a?(Vapi::ApiRequestMethod) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
+      obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+      obj.headers.nil? || Vapi::JsonSchema.validate_raw(obj: obj.headers)
+      obj.body.nil? || Vapi::JsonSchema.validate_raw(obj: obj.body)
+      obj.mode.is_a?(Vapi::ApiRequestMode) != false || raise("Passed value for field obj.mode is not the expected type, validation failed.")
+      obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
+      obj.output.nil? || Vapi::JsonSchema.validate_raw(obj: obj.output)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/api_request_method.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Vapi
+  class ApiRequestMethod
+    POST = "POST"
+    GET = "GET"
+  end
+end

data/lib/vapi_server_sdk/types/api_request_mode.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the mode of the Api Request.
+  #  We only support BLOCKING and BACKGROUND for now.
+  class ApiRequestMode
+    BLOCKING = "blocking"
+    BACKGROUND = "background"
+  end
+end

data/lib/vapi_server_sdk/types/artifact.rb

@@ -27,6 +27,9 @@ module Vapi
     # @return [String] This is the transcript of the call. This is derived from `artifact.messages` but
     #  provided for convenience.
     attr_reader :transcript
+    # @return [String] This is the packet capture url for the call. This is only available for `phone`
+    #  type calls where phone number's provider is `vapi` or `byo-phone-number`.
+    attr_reader :pcap_url
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -48,10 +51,12 @@ module Vapi
     #  playback of the recording with artifact.messages timestamps.
     # @param transcript [String] This is the transcript of the call. This is derived from `artifact.messages` but
     #  provided for convenience.
+    # @param pcap_url [String] This is the packet capture url for the call. This is only available for `phone`
+    #  type calls where phone number's provider is `vapi` or `byo-phone-number`.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::Artifact]
     def initialize(messages: OMIT, messages_open_ai_formatted: OMIT, recording_url: OMIT, stereo_recording_url: OMIT,
-                   video_recording_url: OMIT, video_recording_start_delay_seconds: OMIT, transcript: OMIT, additional_properties: nil)
+                   video_recording_url: OMIT, video_recording_start_delay_seconds: OMIT, transcript: OMIT, pcap_url: OMIT, additional_properties: nil)
       @messages = messages if messages != OMIT
       @messages_open_ai_formatted = messages_open_ai_formatted if messages_open_ai_formatted != OMIT
       @recording_url = recording_url if recording_url != OMIT
@@ -61,6 +66,7 @@ module Vapi
         @video_recording_start_delay_seconds = video_recording_start_delay_seconds
       end
       @transcript = transcript if transcript != OMIT
+      @pcap_url = pcap_url if pcap_url != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "messages": messages,
@@ -69,7 +75,8 @@ module Vapi
         "stereoRecordingUrl": stereo_recording_url,
         "videoRecordingUrl": video_recording_url,
         "videoRecordingStartDelaySeconds": video_recording_start_delay_seconds,
-        "transcript": transcript
+        "transcript": transcript,
+        "pcapUrl": pcap_url
       }.reject do |_k, v|
         v == OMIT
       end
@@ -95,6 +102,7 @@ module Vapi
       video_recording_url = parsed_json["videoRecordingUrl"]
       video_recording_start_delay_seconds = parsed_json["videoRecordingStartDelaySeconds"]
       transcript = parsed_json["transcript"]
+      pcap_url = parsed_json["pcapUrl"]
       new(
         messages: messages,
         messages_open_ai_formatted: messages_open_ai_formatted,
@@ -103,6 +111,7 @@ module Vapi
         video_recording_url: video_recording_url,
         video_recording_start_delay_seconds: video_recording_start_delay_seconds,
         transcript: transcript,
+        pcap_url: pcap_url,
         additional_properties: struct
       )
     end
@@ -128,6 +137,7 @@ module Vapi
       obj.video_recording_url&.is_a?(String) != false || raise("Passed value for field obj.video_recording_url is not the expected type, validation failed.")
       obj.video_recording_start_delay_seconds&.is_a?(Float) != false || raise("Passed value for field obj.video_recording_start_delay_seconds is not the expected type, validation failed.")
       obj.transcript&.is_a?(String) != false || raise("Passed value for field obj.transcript is not the expected type, validation failed.")
+      obj.pcap_url&.is_a?(String) != false || raise("Passed value for field obj.pcap_url is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/artifact_plan.rb

@@ -9,9 +9,10 @@ module Vapi
     # @return [Boolean] This determines whether assistant's calls are recorded. Defaults to true.
     #  Usage:
     #  - If you don't want to record the calls, set this to false.
-    #  - If you want to record the calls when `assistant.hipaaEnabled`, explicity set
-    #  this to true and make sure to provide S3 or GCP credentials on the Provider
-    #  Credentials page in the Dashboard.
+    #  - If you want to record the calls when `assistant.hipaaEnabled` (deprecated) or
+    #  `assistant.compliancePlan.hipaaEnabled` explicity set this to true and make sure
+    #  to provide S3 or GCP credentials on the Provider Credentials page in the
+    #  Dashboard.
     #  You can find the recording at `call.artifact.recordingUrl` and
     #  `call.artifact.stereoRecordingUrl` after the call is ended.
     #  @default true
@@ -22,6 +23,25 @@ module Vapi
     #  call is ended.
     #  @default false
     attr_reader :video_recording_enabled
+    # @return [Boolean] This determines whether the SIP packet capture is enabled. Defaults to true.
+    #  Only relevant for `phone` type calls where phone number's provider is `vapi` or
+    #  `byo-phone-number`.
+    #  You can find the packet capture at `call.artifact.pcapUrl` after the call is
+    #  ended.
+    #  @default true
+    attr_reader :pcap_enabled
+    # @return [String] This is the path where the SIP packet capture will be uploaded. This is only
+    #  used if you have provided S3 or GCP credentials on the Provider Credentials page
+    #  in the Dashboard.
+    #  If credential.s3PathPrefix or credential.bucketPlan.path is set, this will
+    #  append to it.
+    #  Usage:
+    #  - If you want to upload the packet capture to a specific path, set this to the
+    #  path. Example: `/my-assistant-captures`.
+    #  - If you want to upload the packet capture to the root of the bucket, set this
+    #  to `/`.
+    #  @default '/'
+    attr_reader :pcap_s_3_path_prefix
     # @return [Vapi::TranscriptPlan] This is the plan for `call.artifact.transcript`. To disable, set
     #  `transcriptPlan.enabled` to false.
     attr_reader :transcript_plan
@@ -48,9 +68,10 @@ module Vapi
     # @param recording_enabled [Boolean] This determines whether assistant's calls are recorded. Defaults to true.
     #  Usage:
     #  - If you don't want to record the calls, set this to false.
-    #  - If you want to record the calls when `assistant.hipaaEnabled`, explicity set
-    #  this to true and make sure to provide S3 or GCP credentials on the Provider
-    #  Credentials page in the Dashboard.
+    #  - If you want to record the calls when `assistant.hipaaEnabled` (deprecated) or
+    #  `assistant.compliancePlan.hipaaEnabled` explicity set this to true and make sure
+    #  to provide S3 or GCP credentials on the Provider Credentials page in the
+    #  Dashboard.
     #  You can find the recording at `call.artifact.recordingUrl` and
     #  `call.artifact.stereoRecordingUrl` after the call is ended.
     #  @default true
@@ -59,6 +80,23 @@ module Vapi
     #  You can find the video recording at `call.artifact.videoRecordingUrl` after the
     #  call is ended.
     #  @default false
+    # @param pcap_enabled [Boolean] This determines whether the SIP packet capture is enabled. Defaults to true.
+    #  Only relevant for `phone` type calls where phone number's provider is `vapi` or
+    #  `byo-phone-number`.
+    #  You can find the packet capture at `call.artifact.pcapUrl` after the call is
+    #  ended.
+    #  @default true
+    # @param pcap_s_3_path_prefix [String] This is the path where the SIP packet capture will be uploaded. This is only
+    #  used if you have provided S3 or GCP credentials on the Provider Credentials page
+    #  in the Dashboard.
+    #  If credential.s3PathPrefix or credential.bucketPlan.path is set, this will
+    #  append to it.
+    #  Usage:
+    #  - If you want to upload the packet capture to a specific path, set this to the
+    #  path. Example: `/my-assistant-captures`.
+    #  - If you want to upload the packet capture to the root of the bucket, set this
+    #  to `/`.
+    #  @default '/'
     # @param transcript_plan [Vapi::TranscriptPlan] This is the plan for `call.artifact.transcript`. To disable, set
     #  `transcriptPlan.enabled` to false.
     # @param recording_path [String] This is the path where the recording will be uploaded. This is only used if you
@@ -74,16 +112,20 @@ module Vapi
     #  @default '/'
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ArtifactPlan]
-    def initialize(recording_enabled: OMIT, video_recording_enabled: OMIT, transcript_plan: OMIT, recording_path: OMIT,
-                   additional_properties: nil)
+    def initialize(recording_enabled: OMIT, video_recording_enabled: OMIT, pcap_enabled: OMIT,
+                   pcap_s_3_path_prefix: OMIT, transcript_plan: OMIT, recording_path: OMIT, additional_properties: nil)
       @recording_enabled = recording_enabled if recording_enabled != OMIT
       @video_recording_enabled = video_recording_enabled if video_recording_enabled != OMIT
+      @pcap_enabled = pcap_enabled if pcap_enabled != OMIT
+      @pcap_s_3_path_prefix = pcap_s_3_path_prefix if pcap_s_3_path_prefix != OMIT
       @transcript_plan = transcript_plan if transcript_plan != OMIT
       @recording_path = recording_path if recording_path != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "recordingEnabled": recording_enabled,
         "videoRecordingEnabled": video_recording_enabled,
+        "pcapEnabled": pcap_enabled,
+        "pcapS3PathPrefix": pcap_s_3_path_prefix,
         "transcriptPlan": transcript_plan,
         "recordingPath": recording_path
       }.reject do |_k, v|
@@ -100,6 +142,8 @@ module Vapi
       parsed_json = JSON.parse(json_object)
       recording_enabled = parsed_json["recordingEnabled"]
       video_recording_enabled = parsed_json["videoRecordingEnabled"]
+      pcap_enabled = parsed_json["pcapEnabled"]
+      pcap_s_3_path_prefix = parsed_json["pcapS3PathPrefix"]
       if parsed_json["transcriptPlan"].nil?
         transcript_plan = nil
       else
@@ -110,6 +154,8 @@ module Vapi
       new(
         recording_enabled: recording_enabled,
         video_recording_enabled: video_recording_enabled,
+        pcap_enabled: pcap_enabled,
+        pcap_s_3_path_prefix: pcap_s_3_path_prefix,
         transcript_plan: transcript_plan,
         recording_path: recording_path,
         additional_properties: struct
@@ -132,6 +178,8 @@ module Vapi
     def self.validate_raw(obj:)
       obj.recording_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.recording_enabled is not the expected type, validation failed.")
       obj.video_recording_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.video_recording_enabled is not the expected type, validation failed.")
+      obj.pcap_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.pcap_enabled is not the expected type, validation failed.")
+      obj.pcap_s_3_path_prefix&.is_a?(String) != false || raise("Passed value for field obj.pcap_s_3_path_prefix is not the expected type, validation failed.")
       obj.transcript_plan.nil? || Vapi::TranscriptPlan.validate_raw(obj: obj.transcript_plan)
       obj.recording_path&.is_a?(String) != false || raise("Passed value for field obj.recording_path is not the expected type, validation failed.")
     end