vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/create_tool_call_block_dto.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require_relative "create_tool_call_block_dto_messages_item"
+require_relative "json_schema"
+require_relative "create_tool_call_block_dto_tool"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateToolCallBlockDto
+    # @return [Array<Vapi::CreateToolCallBlockDtoMessagesItem>] These are the pre-configured messages that will be spoken to the user while the
+    #  block is running.
+    attr_reader :messages
+    # @return [Vapi::JsonSchema] This is the input schema for the block. This is the input the block needs to
+    #  run. It's given to the block as `steps[0].input`
+    #  These are accessible as variables:
+    #  - ({{input.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.input.propertyName}}) in context of the workflow
+    attr_reader :input_schema
+    # @return [Vapi::JsonSchema] This is the output schema for the block. This is the output the block will
+    #  return to the workflow (`{{stepName.output}}`).
+    #  These are accessible as variables:
+    #  - ({{output.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1)
+    #  - ({{blockName.output.propertyName}}) in context of the workflow (read caveat
+    #  #2)
+    #  Caveats:
+    #  1. a workflow can execute a step multiple times. example, if a loop is used in
+    #  the graph. {{stepName.output.propertyName}} will reference the latest usage of
+    #  the step.
+    #  2. a workflow can execute a block multiple times. example, if a step is called
+    #  multiple times or if a block is used in multiple steps.
+    #  {{blockName.output.propertyName}} will reference the latest usage of the block.
+    #  this liquid variable is just provided for convenience when creating blocks
+    #  outside of a workflow with steps.
+    attr_reader :output_schema
+    # @return [Vapi::CreateToolCallBlockDtoTool] This is the tool that the block will call. To use an existing tool, use
+    #  `toolId`.
+    attr_reader :tool
+    # @return [String] This is the id of the tool that the block will call. To use a transient tool,
+    #  use `tool`.
+    attr_reader :tool_id
+    # @return [String] This is the name of the block. This is just for your reference.
+    attr_reader :name
+    # @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 messages [Array<Vapi::CreateToolCallBlockDtoMessagesItem>] These are the pre-configured messages that will be spoken to the user while the
+    #  block is running.
+    # @param input_schema [Vapi::JsonSchema] This is the input schema for the block. This is the input the block needs to
+    #  run. It's given to the block as `steps[0].input`
+    #  These are accessible as variables:
+    #  - ({{input.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.input.propertyName}}) in context of the workflow
+    # @param output_schema [Vapi::JsonSchema] This is the output schema for the block. This is the output the block will
+    #  return to the workflow (`{{stepName.output}}`).
+    #  These are accessible as variables:
+    #  - ({{output.propertyName}}) in context of the block execution (step)
+    #  - ({{stepName.output.propertyName}}) in context of the workflow (read caveat #1)
+    #  - ({{blockName.output.propertyName}}) in context of the workflow (read caveat
+    #  #2)
+    #  Caveats:
+    #  1. a workflow can execute a step multiple times. example, if a loop is used in
+    #  the graph. {{stepName.output.propertyName}} will reference the latest usage of
+    #  the step.
+    #  2. a workflow can execute a block multiple times. example, if a step is called
+    #  multiple times or if a block is used in multiple steps.
+    #  {{blockName.output.propertyName}} will reference the latest usage of the block.
+    #  this liquid variable is just provided for convenience when creating blocks
+    #  outside of a workflow with steps.
+    # @param tool [Vapi::CreateToolCallBlockDtoTool] This is the tool that the block will call. To use an existing tool, use
+    #  `toolId`.
+    # @param tool_id [String] This is the id of the tool that the block will call. To use a transient tool,
+    #  use `tool`.
+    # @param name [String] This is the name of the block. This is just for your reference.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateToolCallBlockDto]
+    def initialize(messages: OMIT, input_schema: OMIT, output_schema: OMIT, tool: OMIT, tool_id: OMIT, name: OMIT,
+                   additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @input_schema = input_schema if input_schema != OMIT
+      @output_schema = output_schema if output_schema != OMIT
+      @tool = tool if tool != OMIT
+      @tool_id = tool_id if tool_id != OMIT
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "inputSchema": input_schema,
+        "outputSchema": output_schema,
+        "tool": tool,
+        "toolId": tool_id,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateToolCallBlockDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateToolCallBlockDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::CreateToolCallBlockDtoMessagesItem.from_json(json_object: item)
+      end
+      if parsed_json["inputSchema"].nil?
+        input_schema = nil
+      else
+        input_schema = parsed_json["inputSchema"].to_json
+        input_schema = Vapi::JsonSchema.from_json(json_object: input_schema)
+      end
+      if parsed_json["outputSchema"].nil?
+        output_schema = nil
+      else
+        output_schema = parsed_json["outputSchema"].to_json
+        output_schema = Vapi::JsonSchema.from_json(json_object: output_schema)
+      end
+      if parsed_json["tool"].nil?
+        tool = nil
+      else
+        tool = parsed_json["tool"].to_json
+        tool = Vapi::CreateToolCallBlockDtoTool.from_json(json_object: tool)
+      end
+      tool_id = parsed_json["toolId"]
+      name = parsed_json["name"]
+      new(
+        messages: messages,
+        input_schema: input_schema,
+        output_schema: output_schema,
+        tool: tool,
+        tool_id: tool_id,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateToolCallBlockDto 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.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.input_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.input_schema)
+      obj.output_schema.nil? || Vapi::JsonSchema.validate_raw(obj: obj.output_schema)
+      obj.tool.nil? || Vapi::CreateToolCallBlockDtoTool.validate_raw(obj: obj.tool)
+      obj.tool_id&.is_a?(String) != false || raise("Passed value for field obj.tool_id 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_tool_call_block_dto_messages_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "block_start_message"
+require_relative "block_complete_message"
+
+module Vapi
+  class CreateToolCallBlockDtoMessagesItem
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::CreateToolCallBlockDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of CreateToolCallBlockDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateToolCallBlockDtoMessagesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "block-start"
+                 Vapi::BlockStartMessage.from_json(json_object: json_object)
+               when "block-complete"
+                 Vapi::BlockCompleteMessage.from_json(json_object: json_object)
+               else
+                 Vapi::BlockStartMessage.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "block-start"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "block-complete"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.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:)
+      case obj.type
+      when "block-start"
+        Vapi::BlockStartMessage.validate_raw(obj: obj)
+      when "block-complete"
+        Vapi::BlockCompleteMessage.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::BlockStartMessage]
+    # @return [Vapi::CreateToolCallBlockDtoMessagesItem]
+    def self.block_start(member:)
+      new(member: member, discriminant: "block-start")
+    end
+
+    # @param member [Vapi::BlockCompleteMessage]
+    # @return [Vapi::CreateToolCallBlockDtoMessagesItem]
+    def self.block_complete(member:)
+      new(member: member, discriminant: "block-complete")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_tool_call_block_dto_tool.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "create_dtmf_tool_dto"
+require_relative "create_end_call_tool_dto"
+require_relative "create_voicemail_tool_dto"
+require_relative "create_function_tool_dto"
+require_relative "create_ghl_tool_dto"
+require_relative "create_make_tool_dto"
+require_relative "create_transfer_call_tool_dto"
+
+module Vapi
+  # This is the tool that the block will call. To use an existing tool, use
+  #  `toolId`.
+  class CreateToolCallBlockDtoTool
+    # @return [Object]
+    attr_reader :member
+    # @return [String]
+    attr_reader :discriminant
+
+    private_class_method :new
+    alias kind_of? is_a?
+
+    # @param member [Object]
+    # @param discriminant [String]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of CreateToolCallBlockDtoTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "dtmf"
+                 Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
+               when "endCall"
+                 Vapi::CreateEndCallToolDto.from_json(json_object: json_object)
+               when "voicemail"
+                 Vapi::CreateVoicemailToolDto.from_json(json_object: json_object)
+               when "function"
+                 Vapi::CreateFunctionToolDto.from_json(json_object: json_object)
+               when "ghl"
+                 Vapi::CreateGhlToolDto.from_json(json_object: json_object)
+               when "make"
+                 Vapi::CreateMakeToolDto.from_json(json_object: json_object)
+               when "transferCall"
+                 Vapi::CreateTransferCallToolDto.from_json(json_object: json_object)
+               else
+                 Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "dtmf"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "endCall"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "voicemail"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "function"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "ghl"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "make"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "transferCall"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.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:)
+      case obj.type
+      when "dtmf"
+        Vapi::CreateDtmfToolDto.validate_raw(obj: obj)
+      when "endCall"
+        Vapi::CreateEndCallToolDto.validate_raw(obj: obj)
+      when "voicemail"
+        Vapi::CreateVoicemailToolDto.validate_raw(obj: obj)
+      when "function"
+        Vapi::CreateFunctionToolDto.validate_raw(obj: obj)
+      when "ghl"
+        Vapi::CreateGhlToolDto.validate_raw(obj: obj)
+      when "make"
+        Vapi::CreateMakeToolDto.validate_raw(obj: obj)
+      when "transferCall"
+        Vapi::CreateTransferCallToolDto.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::CreateDtmfToolDto]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.dtmf(member:)
+      new(member: member, discriminant: "dtmf")
+    end
+
+    # @param member [Vapi::CreateEndCallToolDto]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.end_call(member:)
+      new(member: member, discriminant: "endCall")
+    end
+
+    # @param member [Vapi::CreateVoicemailToolDto]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.voicemail(member:)
+      new(member: member, discriminant: "voicemail")
+    end
+
+    # @param member [Vapi::CreateFunctionToolDto]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.function(member:)
+      new(member: member, discriminant: "function")
+    end
+
+    # @param member [Vapi::CreateGhlToolDto]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.ghl(member:)
+      new(member: member, discriminant: "ghl")
+    end
+
+    # @param member [Vapi::CreateMakeToolDto]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.make(member:)
+      new(member: member, discriminant: "make")
+    end
+
+    # @param member [Vapi::CreateTransferCallToolDto]
+    # @return [Vapi::CreateToolCallBlockDtoTool]
+    def self.transfer_call(member:)
+      new(member: member, discriminant: "transferCall")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_tool_template_dto.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require_relative "create_tool_template_dto_details"
+require_relative "create_tool_template_dto_provider_details"
+require_relative "tool_template_metadata"
+require_relative "create_tool_template_dto_visibility"
+require_relative "create_tool_template_dto_provider"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateToolTemplateDto
+    # @return [Vapi::CreateToolTemplateDtoDetails]
+    attr_reader :details
+    # @return [Vapi::CreateToolTemplateDtoProviderDetails]
+    attr_reader :provider_details
+    # @return [Vapi::ToolTemplateMetadata]
+    attr_reader :metadata
+    # @return [Vapi::CreateToolTemplateDtoVisibility]
+    attr_reader :visibility
+    # @return [String]
+    attr_reader :type
+    # @return [String] The name of the template. This is just for your own reference.
+    attr_reader :name
+    # @return [Vapi::CreateToolTemplateDtoProvider]
+    attr_reader :provider
+    # @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 details [Vapi::CreateToolTemplateDtoDetails]
+    # @param provider_details [Vapi::CreateToolTemplateDtoProviderDetails]
+    # @param metadata [Vapi::ToolTemplateMetadata]
+    # @param visibility [Vapi::CreateToolTemplateDtoVisibility]
+    # @param type [String]
+    # @param name [String] The name of the template. This is just for your own reference.
+    # @param provider [Vapi::CreateToolTemplateDtoProvider]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateToolTemplateDto]
+    def initialize(type:, details: OMIT, provider_details: OMIT, metadata: OMIT, visibility: OMIT, name: OMIT,
+                   provider: OMIT, additional_properties: nil)
+      @details = details if details != OMIT
+      @provider_details = provider_details if provider_details != OMIT
+      @metadata = metadata if metadata != OMIT
+      @visibility = visibility if visibility != OMIT
+      @type = type
+      @name = name if name != OMIT
+      @provider = provider if provider != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "details": details,
+        "providerDetails": provider_details,
+        "metadata": metadata,
+        "visibility": visibility,
+        "type": type,
+        "name": name,
+        "provider": provider
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateToolTemplateDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateToolTemplateDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["details"].nil?
+        details = nil
+      else
+        details = parsed_json["details"].to_json
+        details = Vapi::CreateToolTemplateDtoDetails.from_json(json_object: details)
+      end
+      if parsed_json["providerDetails"].nil?
+        provider_details = nil
+      else
+        provider_details = parsed_json["providerDetails"].to_json
+        provider_details = Vapi::CreateToolTemplateDtoProviderDetails.from_json(json_object: provider_details)
+      end
+      if parsed_json["metadata"].nil?
+        metadata = nil
+      else
+        metadata = parsed_json["metadata"].to_json
+        metadata = Vapi::ToolTemplateMetadata.from_json(json_object: metadata)
+      end
+      visibility = parsed_json["visibility"]
+      type = parsed_json["type"]
+      name = parsed_json["name"]
+      provider = parsed_json["provider"]
+      new(
+        details: details,
+        provider_details: provider_details,
+        metadata: metadata,
+        visibility: visibility,
+        type: type,
+        name: name,
+        provider: provider,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateToolTemplateDto 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.details.nil? || Vapi::CreateToolTemplateDtoDetails.validate_raw(obj: obj.details)
+      obj.provider_details.nil? || Vapi::CreateToolTemplateDtoProviderDetails.validate_raw(obj: obj.provider_details)
+      obj.metadata.nil? || Vapi::ToolTemplateMetadata.validate_raw(obj: obj.metadata)
+      obj.visibility&.is_a?(Vapi::CreateToolTemplateDtoVisibility) != false || raise("Passed value for field obj.visibility is not the expected type, validation failed.")
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type 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.provider&.is_a?(Vapi::CreateToolTemplateDtoProvider) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+    end
+  end
+end