vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/call.rb

@@ -14,12 +14,14 @@ require_relative "artifact_plan"
 require_relative "analysis"
 require_relative "monitor"
 require_relative "artifact"
-require_relative "transport"
 require_relative "create_assistant_dto"
 require_relative "assistant_overrides"
 require_relative "create_squad_dto"
+require_relative "create_workflow_dto"
+require_relative "workflow_overrides"
 require_relative "import_twilio_phone_number_dto"
 require_relative "create_customer_dto"
+require_relative "schedule_plan"
 require "ostruct"
 require "json"
 
@@ -71,27 +73,60 @@ module Vapi
     # @return [Vapi::Artifact] These are the artifacts created from the call. Configure in
     #  `assistant.artifactPlan`.
     attr_reader :artifact
-    # @return [Vapi::Transport] This is the transport used for the call.
-    attr_reader :transport
     # @return [String] The ID of the call as provided by the phone number service. callSid in Twilio.
-    #  conversationUuid in Vonage.
+    #  conversationUuid in Vonage. callControlId in Telnyx.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
     attr_reader :phone_call_provider_id
-    # @return [String] This is the assistant that will be used for the call. To use a transient
+    # @return [String] This is the campaign ID that the call belongs to.
+    attr_reader :campaign_id
+    # @return [String] This is the assistant ID that will be used for the call. To use a transient
     #  assistant, use `assistant` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistantId` or `assistant`
+    #  - Squad, use `squadId` or `squad`
+    #  - Workflow, use `workflowId` or `workflow`
     attr_reader :assistant_id
     # @return [Vapi::CreateAssistantDto] This is the assistant that will be used for the call. To use an existing
     #  assistant, use `assistantId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant`
+    #  - Squad, use `squad`
+    #  - Workflow, use `workflow`
     attr_reader :assistant
     # @return [Vapi::AssistantOverrides] These are the overrides for the `assistant` or `assistantId`'s settings and
     #  template variables.
     attr_reader :assistant_overrides
     # @return [String] This is the squad that will be used for the call. To use a transient squad, use
     #  `squad` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
     attr_reader :squad_id
     # @return [Vapi::CreateSquadDto] This is a squad that will be used for the call. To use an existing squad, use
     #  `squadId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
     attr_reader :squad
+    # @return [String] This is the workflow that will be used for the call. To use a transient
+    #  workflow, use `workflow` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    attr_reader :workflow_id
+    # @return [Vapi::CreateWorkflowDto] This is a workflow that will be used for the call. To use an existing workflow,
+    #  use `workflowId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    attr_reader :workflow
+    # @return [Vapi::WorkflowOverrides] These are the overrides for the `workflow` or `workflowId`'s settings and
+    #  template variables.
+    attr_reader :workflow_overrides
     # @return [String] This is the phone number that will be used for the call. To use a transient
     #  number, use `phoneNumber` instead.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -110,6 +145,10 @@ module Vapi
     attr_reader :customer
     # @return [String] This is the name of the call. This is just for your own reference.
     attr_reader :name
+    # @return [Vapi::SchedulePlan] This is the schedule plan of the call.
+    attr_reader :schedule_plan
+    # @return [Hash{String => Object}] This is the transport of the call.
+    attr_reader :transport
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -144,20 +183,50 @@ module Vapi
     # @param monitor [Vapi::Monitor] This is to real-time monitor the call. Configure in `assistant.monitorPlan`.
     # @param artifact [Vapi::Artifact] These are the artifacts created from the call. Configure in
     #  `assistant.artifactPlan`.
-    # @param transport [Vapi::Transport] This is the transport used for the call.
     # @param phone_call_provider_id [String] The ID of the call as provided by the phone number service. callSid in Twilio.
-    #  conversationUuid in Vonage.
+    #  conversationUuid in Vonage. callControlId in Telnyx.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-    # @param assistant_id [String] This is the assistant that will be used for the call. To use a transient
+    # @param campaign_id [String] This is the campaign ID that the call belongs to.
+    # @param assistant_id [String] This is the assistant ID that will be used for the call. To use a transient
     #  assistant, use `assistant` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistantId` or `assistant`
+    #  - Squad, use `squadId` or `squad`
+    #  - Workflow, use `workflowId` or `workflow`
     # @param assistant [Vapi::CreateAssistantDto] This is the assistant that will be used for the call. To use an existing
     #  assistant, use `assistantId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant`
+    #  - Squad, use `squad`
+    #  - Workflow, use `workflow`
     # @param assistant_overrides [Vapi::AssistantOverrides] These are the overrides for the `assistant` or `assistantId`'s settings and
     #  template variables.
     # @param squad_id [String] This is the squad that will be used for the call. To use a transient squad, use
     #  `squad` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
     # @param squad [Vapi::CreateSquadDto] This is a squad that will be used for the call. To use an existing squad, use
     #  `squadId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    # @param workflow_id [String] This is the workflow that will be used for the call. To use a transient
+    #  workflow, use `workflow` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    # @param workflow [Vapi::CreateWorkflowDto] This is a workflow that will be used for the call. To use an existing workflow,
+    #  use `workflowId` instead.
+    #  To start a call with:
+    #  - Assistant, use `assistant` or `assistantId`
+    #  - Squad, use `squad` or `squadId`
+    #  - Workflow, use `workflow` or `workflowId`
+    # @param workflow_overrides [Vapi::WorkflowOverrides] These are the overrides for the `workflow` or `workflowId`'s settings and
+    #  template variables.
     # @param phone_number_id [String] This is the phone number that will be used for the call. To use a transient
     #  number, use `phoneNumber` instead.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
@@ -171,10 +240,12 @@ module Vapi
     #  `customerId` instead.
     #  Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
     # @param name [String] This is the name of the call. This is just for your own reference.
+    # @param schedule_plan [Vapi::SchedulePlan] This is the schedule plan of the call.
+    # @param transport [Hash{String => Object}] This is the transport of the call.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::Call]
     def initialize(id:, org_id:, created_at:, updated_at:, type: OMIT, costs: OMIT, messages: OMIT, phone_call_provider: OMIT, phone_call_transport: OMIT,
-                   status: OMIT, ended_reason: OMIT, destination: OMIT, started_at: OMIT, ended_at: OMIT, cost: OMIT, cost_breakdown: OMIT, artifact_plan: OMIT, analysis: OMIT, monitor: OMIT, artifact: OMIT, transport: OMIT, phone_call_provider_id: OMIT, assistant_id: OMIT, assistant: OMIT, assistant_overrides: OMIT, squad_id: OMIT, squad: OMIT, phone_number_id: OMIT, phone_number: OMIT, customer_id: OMIT, customer: OMIT, name: OMIT, additional_properties: nil)
+                   status: OMIT, ended_reason: OMIT, destination: OMIT, started_at: OMIT, ended_at: OMIT, cost: OMIT, cost_breakdown: OMIT, artifact_plan: OMIT, analysis: OMIT, monitor: OMIT, artifact: OMIT, phone_call_provider_id: OMIT, campaign_id: OMIT, assistant_id: OMIT, assistant: OMIT, assistant_overrides: OMIT, squad_id: OMIT, squad: OMIT, workflow_id: OMIT, workflow: OMIT, workflow_overrides: OMIT, phone_number_id: OMIT, phone_number: OMIT, customer_id: OMIT, customer: OMIT, name: OMIT, schedule_plan: OMIT, transport: OMIT, additional_properties: nil)
       @type = type if type != OMIT
       @costs = costs if costs != OMIT
       @messages = messages if messages != OMIT
@@ -195,18 +266,23 @@ module Vapi
       @analysis = analysis if analysis != OMIT
       @monitor = monitor if monitor != OMIT
       @artifact = artifact if artifact != OMIT
-      @transport = transport if transport != OMIT
       @phone_call_provider_id = phone_call_provider_id if phone_call_provider_id != OMIT
+      @campaign_id = campaign_id if campaign_id != OMIT
       @assistant_id = assistant_id if assistant_id != OMIT
       @assistant = assistant if assistant != OMIT
       @assistant_overrides = assistant_overrides if assistant_overrides != OMIT
       @squad_id = squad_id if squad_id != OMIT
       @squad = squad if squad != OMIT
+      @workflow_id = workflow_id if workflow_id != OMIT
+      @workflow = workflow if workflow != OMIT
+      @workflow_overrides = workflow_overrides if workflow_overrides != OMIT
       @phone_number_id = phone_number_id if phone_number_id != OMIT
       @phone_number = phone_number if phone_number != OMIT
       @customer_id = customer_id if customer_id != OMIT
       @customer = customer if customer != OMIT
       @name = name if name != OMIT
+      @schedule_plan = schedule_plan if schedule_plan != OMIT
+      @transport = transport if transport != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "type": type,
@@ -229,18 +305,23 @@ module Vapi
         "analysis": analysis,
         "monitor": monitor,
         "artifact": artifact,
-        "transport": transport,
         "phoneCallProviderId": phone_call_provider_id,
+        "campaignId": campaign_id,
         "assistantId": assistant_id,
         "assistant": assistant,
         "assistantOverrides": assistant_overrides,
         "squadId": squad_id,
         "squad": squad,
+        "workflowId": workflow_id,
+        "workflow": workflow,
+        "workflowOverrides": workflow_overrides,
         "phoneNumberId": phone_number_id,
         "phoneNumber": phone_number,
         "customerId": customer_id,
         "customer": customer,
-        "name": name
+        "name": name,
+        "schedulePlan": schedule_plan,
+        "transport": transport
       }.reject do |_k, v|
         v == OMIT
       end
@@ -309,13 +390,8 @@ module Vapi
         artifact = parsed_json["artifact"].to_json
         artifact = Vapi::Artifact.from_json(json_object: artifact)
       end
-      if parsed_json["transport"].nil?
-        transport = nil
-      else
-        transport = parsed_json["transport"].to_json
-        transport = Vapi::Transport.from_json(json_object: transport)
-      end
       phone_call_provider_id = parsed_json["phoneCallProviderId"]
+      campaign_id = parsed_json["campaignId"]
       assistant_id = parsed_json["assistantId"]
       if parsed_json["assistant"].nil?
         assistant = nil
@@ -336,6 +412,19 @@ module Vapi
         squad = parsed_json["squad"].to_json
         squad = Vapi::CreateSquadDto.from_json(json_object: squad)
       end
+      workflow_id = parsed_json["workflowId"]
+      if parsed_json["workflow"].nil?
+        workflow = nil
+      else
+        workflow = parsed_json["workflow"].to_json
+        workflow = Vapi::CreateWorkflowDto.from_json(json_object: workflow)
+      end
+      if parsed_json["workflowOverrides"].nil?
+        workflow_overrides = nil
+      else
+        workflow_overrides = parsed_json["workflowOverrides"].to_json
+        workflow_overrides = Vapi::WorkflowOverrides.from_json(json_object: workflow_overrides)
+      end
       phone_number_id = parsed_json["phoneNumberId"]
       if parsed_json["phoneNumber"].nil?
         phone_number = nil
@@ -351,6 +440,13 @@ module Vapi
         customer = Vapi::CreateCustomerDto.from_json(json_object: customer)
       end
       name = parsed_json["name"]
+      if parsed_json["schedulePlan"].nil?
+        schedule_plan = nil
+      else
+        schedule_plan = parsed_json["schedulePlan"].to_json
+        schedule_plan = Vapi::SchedulePlan.from_json(json_object: schedule_plan)
+      end
+      transport = parsed_json["transport"]
       new(
         type: type,
         costs: costs,
@@ -372,18 +468,23 @@ module Vapi
         analysis: analysis,
         monitor: monitor,
         artifact: artifact,
-        transport: transport,
         phone_call_provider_id: phone_call_provider_id,
+        campaign_id: campaign_id,
         assistant_id: assistant_id,
         assistant: assistant,
         assistant_overrides: assistant_overrides,
         squad_id: squad_id,
         squad: squad,
+        workflow_id: workflow_id,
+        workflow: workflow,
+        workflow_overrides: workflow_overrides,
         phone_number_id: phone_number_id,
         phone_number: phone_number,
         customer_id: customer_id,
         customer: customer,
         name: name,
+        schedule_plan: schedule_plan,
+        transport: transport,
         additional_properties: struct
       )
     end
@@ -422,18 +523,23 @@ module Vapi
       obj.analysis.nil? || Vapi::Analysis.validate_raw(obj: obj.analysis)
       obj.monitor.nil? || Vapi::Monitor.validate_raw(obj: obj.monitor)
       obj.artifact.nil? || Vapi::Artifact.validate_raw(obj: obj.artifact)
-      obj.transport.nil? || Vapi::Transport.validate_raw(obj: obj.transport)
       obj.phone_call_provider_id&.is_a?(String) != false || raise("Passed value for field obj.phone_call_provider_id is not the expected type, validation failed.")
+      obj.campaign_id&.is_a?(String) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
       obj.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.")
       obj.assistant.nil? || Vapi::CreateAssistantDto.validate_raw(obj: obj.assistant)
       obj.assistant_overrides.nil? || Vapi::AssistantOverrides.validate_raw(obj: obj.assistant_overrides)
       obj.squad_id&.is_a?(String) != false || raise("Passed value for field obj.squad_id is not the expected type, validation failed.")
       obj.squad.nil? || Vapi::CreateSquadDto.validate_raw(obj: obj.squad)
+      obj.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_id is not the expected type, validation failed.")
+      obj.workflow.nil? || Vapi::CreateWorkflowDto.validate_raw(obj: obj.workflow)
+      obj.workflow_overrides.nil? || Vapi::WorkflowOverrides.validate_raw(obj: obj.workflow_overrides)
       obj.phone_number_id&.is_a?(String) != false || raise("Passed value for field obj.phone_number_id is not the expected type, validation failed.")
       obj.phone_number.nil? || Vapi::ImportTwilioPhoneNumberDto.validate_raw(obj: obj.phone_number)
       obj.customer_id&.is_a?(String) != false || raise("Passed value for field obj.customer_id is not the expected type, validation failed.")
       obj.customer.nil? || Vapi::CreateCustomerDto.validate_raw(obj: obj.customer)
       obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.schedule_plan.nil? || Vapi::SchedulePlan.validate_raw(obj: obj.schedule_plan)
+      obj.transport&.is_a?(Hash) != false || raise("Passed value for field obj.transport is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/call_batch_error.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "create_customer_dto"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CallBatchError
+    # @return [Vapi::CreateCustomerDto]
+    attr_reader :customer
+    # @return [String]
+    attr_reader :error
+    # @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 customer [Vapi::CreateCustomerDto]
+    # @param error [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CallBatchError]
+    def initialize(customer:, error:, additional_properties: nil)
+      @customer = customer
+      @error = error
+      @additional_properties = additional_properties
+      @_field_set = { "customer": customer, "error": error }
+    end
+
+    # Deserialize a JSON object to an instance of CallBatchError
+    #
+    # @param json_object [String]
+    # @return [Vapi::CallBatchError]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["customer"].nil?
+        customer = nil
+      else
+        customer = parsed_json["customer"].to_json
+        customer = Vapi::CreateCustomerDto.from_json(json_object: customer)
+      end
+      error = parsed_json["error"]
+      new(
+        customer: customer,
+        error: error,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CallBatchError 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:)
+      Vapi::CreateCustomerDto.validate_raw(obj: obj.customer)
+      obj.error.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/call_batch_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "call"
+require_relative "call_batch_error"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CallBatchResponse
+    # @return [Array<Vapi::Call>] This is the list of calls that were created.
+    attr_reader :results
+    # @return [Array<Vapi::CallBatchError>] This is the list of calls that failed to be created.
+    attr_reader :errors
+    # @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 results [Array<Vapi::Call>] This is the list of calls that were created.
+    # @param errors [Array<Vapi::CallBatchError>] This is the list of calls that failed to be created.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CallBatchResponse]
+    def initialize(results:, errors:, additional_properties: nil)
+      @results = results
+      @errors = errors
+      @additional_properties = additional_properties
+      @_field_set = { "results": results, "errors": errors }
+    end
+
+    # Deserialize a JSON object to an instance of CallBatchResponse
+    #
+    # @param json_object [String]
+    # @return [Vapi::CallBatchResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      results = parsed_json["results"]&.map do |item|
+        item = item.to_json
+        Vapi::Call.from_json(json_object: item)
+      end
+      errors = parsed_json["errors"]&.map do |item|
+        item = item.to_json
+        Vapi::CallBatchError.from_json(json_object: item)
+      end
+      new(
+        results: results,
+        errors: errors,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CallBatchResponse 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.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
+      obj.errors.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/call_costs_item.rb

@@ -6,7 +6,9 @@ require_relative "transcriber_cost"
 require_relative "model_cost"
 require_relative "voice_cost"
 require_relative "vapi_cost"
+require_relative "voicemail_detection_cost"
 require_relative "analysis_cost"
+require_relative "knowledge_base_cost"
 
 module Vapi
   class CallCostsItem
@@ -43,8 +45,12 @@ module Vapi
                  Vapi::VoiceCost.from_json(json_object: json_object)
                when "vapi"
                  Vapi::VapiCost.from_json(json_object: json_object)
+               when "voicemail-detection"
+                 Vapi::VoicemailDetectionCost.from_json(json_object: json_object)
                when "analysis"
                  Vapi::AnalysisCost.from_json(json_object: json_object)
+               when "knowledge-base"
+                 Vapi::KnowledgeBaseCost.from_json(json_object: json_object)
                else
                  Vapi::TransportCost.from_json(json_object: json_object)
                end
@@ -66,8 +72,12 @@ module Vapi
         { **@member.to_json, type: @discriminant }.to_json
       when "vapi"
         { **@member.to_json, type: @discriminant }.to_json
+      when "voicemail-detection"
+        { **@member.to_json, type: @discriminant }.to_json
       when "analysis"
         { **@member.to_json, type: @discriminant }.to_json
+      when "knowledge-base"
+        { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
       end
@@ -92,8 +102,12 @@ module Vapi
         Vapi::VoiceCost.validate_raw(obj: obj)
       when "vapi"
         Vapi::VapiCost.validate_raw(obj: obj)
+      when "voicemail-detection"
+        Vapi::VoicemailDetectionCost.validate_raw(obj: obj)
       when "analysis"
         Vapi::AnalysisCost.validate_raw(obj: obj)
+      when "knowledge-base"
+        Vapi::KnowledgeBaseCost.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -137,10 +151,22 @@ module Vapi
       new(member: member, discriminant: "vapi")
     end
 
+    # @param member [Vapi::VoicemailDetectionCost]
+    # @return [Vapi::CallCostsItem]
+    def self.voicemail_detection(member:)
+      new(member: member, discriminant: "voicemail-detection")
+    end
+
     # @param member [Vapi::AnalysisCost]
     # @return [Vapi::CallCostsItem]
     def self.analysis(member:)
       new(member: member, discriminant: "analysis")
     end
+
+    # @param member [Vapi::KnowledgeBaseCost]
+    # @return [Vapi::CallCostsItem]
+    def self.knowledge_base(member:)
+      new(member: member, discriminant: "knowledge-base")
+    end
   end
 end