vapi_server_sdk 0.2.0 → 0.4.0

data/lib/vapi_server_sdk/blocks/client.rb

@@ -8,10 +8,7 @@ require_relative "types/blocks_create_request"
 require_relative "types/blocks_create_response"
 require_relative "types/blocks_get_response"
 require_relative "types/blocks_delete_response"
-require_relative "types/update_block_dto_messages_item"
-require_relative "../types/json_schema"
-require_relative "types/update_block_dto_tool"
-require_relative "types/update_block_dto_steps_item"
+require_relative "types/blocks_update_request"
 require_relative "types/blocks_update_response"
 require "async"
 
@@ -41,13 +38,6 @@ module Vapi
     #  specified value.
     # @param request_options [Vapi::RequestOptions]
     # @return [Array<Vapi::Blocks::BlocksListResponseItem>]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.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|
@@ -85,13 +75,6 @@ module Vapi
     # @param request [Vapi::Blocks::BlocksCreateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksCreateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.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?
@@ -113,13 +96,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksGetResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.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?
@@ -143,13 +119,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksDeleteResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.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,85 +140,10 @@ module Vapi
     end
 
     # @param id [String]
-    # @param messages [Array<Hash>] These are the pre-configured messages that will be spoken to the user while the
-    #  block is running.Request of type Array<Vapi::Blocks::UpdateBlockDtoMessagesItem>, as a Hash
-    # @param input_schema [Hash] 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 workflowRequest of type Vapi::JsonSchema, as a Hash
-    #   * :type (Vapi::JsonSchemaType)
-    #   * :items (Hash{String => Object})
-    #   * :properties (Hash{String => Object})
-    #   * :description (String)
-    #   * :required (Array<String>)
-    # @param output_schema [Hash] 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.Request of type Vapi::JsonSchema, as a Hash
-    #   * :type (Vapi::JsonSchemaType)
-    #   * :items (Hash{String => Object})
-    #   * :properties (Hash{String => Object})
-    #   * :description (String)
-    #   * :required (Array<String>)
-    # @param tool [Vapi::Blocks::UpdateBlockDtoTool] This is the tool that the block will call. To use an existing tool, use
-    #  `toolId`.
-    # @param steps [Array<Hash>] These are the steps in the workflow.Request of type Array<Vapi::Blocks::UpdateBlockDtoStepsItem>, as a Hash
-    # @param name [String] This is the name of the block. This is just for your reference.
-    # @param instruction [String] This is the instruction to the model.
-    #  You can reference any variable in the context of the current block execution
-    #  (step):
-    #  - "{{input.your-property-name}}" for the current step's input
-    #  - "{{your-step-name.output.your-property-name}}" for another step's output (in
-    #  the same workflow; read caveat #1)
-    #  - "{{your-step-name.input.your-property-name}}" for another step's input (in the
-    #  same workflow; read caveat #1)
-    #  - "{{your-block-name.output.your-property-name}}" for another block's output (in
-    #  the same workflow; read caveat #2)
-    #  - "{{your-block-name.input.your-property-name}}" for another block's input (in
-    #  the same workflow; read caveat #2)
-    #  - "{{workflow.input.your-property-name}}" for the current workflow's input
-    #  - "{{global.your-property-name}}" for the global context
-    #  This can be as simple or as complex as you want it to be.
-    #  - "say hello and ask the user about their day!"
-    #  - "collect the user's first and last name"
-    #  - "user is {{input.firstName}} {{input.lastName}}. their age is {{input.age}}.
-    #  ask them about their salary and if they might be interested in buying a house.
-    #  we offer {{input.offer}}"
-    #  Caveats:
-    #  1. a workflow can execute a step multiple times. example, if a loop is used in
-    #  the graph. {{stepName.output/input.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/input.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_id [String] This is the id of the tool that the block will call. To use a transient tool,
-    #  use `tool`.
+    # @param request [Vapi::Blocks::BlocksUpdateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksUpdateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.update(id: "id")
-    def update(id:, messages: nil, input_schema: nil, output_schema: nil, tool: nil, steps: nil, name: nil,
-               instruction: nil, tool_id: nil, request_options: nil)
+    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?
         req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -261,17 +155,7 @@ module Vapi
         unless request_options.nil? || request_options&.additional_query_parameters.nil?
           req.params = { **(request_options&.additional_query_parameters || {}) }.compact
         end
-        req.body = {
-          **(request_options&.additional_body_parameters || {}),
-          messages: messages,
-          inputSchema: input_schema,
-          outputSchema: output_schema,
-          tool: tool,
-          steps: steps,
-          name: name,
-          instruction: instruction,
-          toolId: tool_id
-        }.compact
+        req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/block/#{id}"
       end
       Vapi::Blocks::BlocksUpdateResponse.from_json(json_object: response.body)
@@ -303,13 +187,6 @@ module Vapi
     #  specified value.
     # @param request_options [Vapi::RequestOptions]
     # @return [Array<Vapi::Blocks::BlocksListResponseItem>]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.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
@@ -349,13 +226,6 @@ module Vapi
     # @param request [Vapi::Blocks::BlocksCreateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksCreateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.create
     def create(request:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
@@ -379,13 +249,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksGetResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.get(id: "id")
     def get(id:, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -411,13 +274,6 @@ module Vapi
     # @param id [String]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksDeleteResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.delete(id: "id")
     def delete(id:, request_options: nil)
       Async do
         response = @request_client.conn.delete do |req|
@@ -441,85 +297,10 @@ module Vapi
     end
 
     # @param id [String]
-    # @param messages [Array<Hash>] These are the pre-configured messages that will be spoken to the user while the
-    #  block is running.Request of type Array<Vapi::Blocks::UpdateBlockDtoMessagesItem>, as a Hash
-    # @param input_schema [Hash] 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 workflowRequest of type Vapi::JsonSchema, as a Hash
-    #   * :type (Vapi::JsonSchemaType)
-    #   * :items (Hash{String => Object})
-    #   * :properties (Hash{String => Object})
-    #   * :description (String)
-    #   * :required (Array<String>)
-    # @param output_schema [Hash] 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.Request of type Vapi::JsonSchema, as a Hash
-    #   * :type (Vapi::JsonSchemaType)
-    #   * :items (Hash{String => Object})
-    #   * :properties (Hash{String => Object})
-    #   * :description (String)
-    #   * :required (Array<String>)
-    # @param tool [Vapi::Blocks::UpdateBlockDtoTool] This is the tool that the block will call. To use an existing tool, use
-    #  `toolId`.
-    # @param steps [Array<Hash>] These are the steps in the workflow.Request of type Array<Vapi::Blocks::UpdateBlockDtoStepsItem>, as a Hash
-    # @param name [String] This is the name of the block. This is just for your reference.
-    # @param instruction [String] This is the instruction to the model.
-    #  You can reference any variable in the context of the current block execution
-    #  (step):
-    #  - "{{input.your-property-name}}" for the current step's input
-    #  - "{{your-step-name.output.your-property-name}}" for another step's output (in
-    #  the same workflow; read caveat #1)
-    #  - "{{your-step-name.input.your-property-name}}" for another step's input (in the
-    #  same workflow; read caveat #1)
-    #  - "{{your-block-name.output.your-property-name}}" for another block's output (in
-    #  the same workflow; read caveat #2)
-    #  - "{{your-block-name.input.your-property-name}}" for another block's input (in
-    #  the same workflow; read caveat #2)
-    #  - "{{workflow.input.your-property-name}}" for the current workflow's input
-    #  - "{{global.your-property-name}}" for the global context
-    #  This can be as simple or as complex as you want it to be.
-    #  - "say hello and ask the user about their day!"
-    #  - "collect the user's first and last name"
-    #  - "user is {{input.firstName}} {{input.lastName}}. their age is {{input.age}}.
-    #  ask them about their salary and if they might be interested in buying a house.
-    #  we offer {{input.offer}}"
-    #  Caveats:
-    #  1. a workflow can execute a step multiple times. example, if a loop is used in
-    #  the graph. {{stepName.output/input.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/input.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_id [String] This is the id of the tool that the block will call. To use a transient tool,
-    #  use `tool`.
+    # @param request [Vapi::Blocks::BlocksUpdateRequest]
     # @param request_options [Vapi::RequestOptions]
     # @return [Vapi::Blocks::BlocksUpdateResponse]
-    # @example
-    #  api = Vapi::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: Vapi::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
-    #  )
-    #  api.blocks.update(id: "id")
-    def update(id:, messages: nil, input_schema: nil, output_schema: nil, tool: nil, steps: nil, name: nil,
-               instruction: nil, tool_id: nil, request_options: nil)
+    def update(id:, request:, request_options: nil)
       Async do
         response = @request_client.conn.patch do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -532,17 +313,7 @@ module Vapi
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
           end
-          req.body = {
-            **(request_options&.additional_body_parameters || {}),
-            messages: messages,
-            inputSchema: input_schema,
-            outputSchema: output_schema,
-            tool: tool,
-            steps: steps,
-            name: name,
-            instruction: instruction,
-            toolId: tool_id
-          }.compact
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/block/#{id}"
         end
         Vapi::Blocks::BlocksUpdateResponse.from_json(json_object: response.body)

data/lib/vapi_server_sdk/blocks/types/blocks_update_request.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../types/update_conversation_block_dto"
+require_relative "../../types/update_tool_call_block_dto"
+require_relative "../../types/update_workflow_block_dto"
+
+module Vapi
+  class Blocks
+    class BlocksUpdateRequest
+      # @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::Blocks::BlocksUpdateRequest]
+      def initialize(member:, discriminant:)
+        @member = member
+        @discriminant = discriminant
+      end
+
+      # Deserialize a JSON object to an instance of BlocksUpdateRequest
+      #
+      # @param json_object [String]
+      # @return [Vapi::Blocks::BlocksUpdateRequest]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        member = case struct.type
+                 when "conversation"
+                   Vapi::UpdateConversationBlockDto.from_json(json_object: json_object)
+                 when "tool-call"
+                   Vapi::UpdateToolCallBlockDto.from_json(json_object: json_object)
+                 when "workflow"
+                   Vapi::UpdateWorkflowBlockDto.from_json(json_object: json_object)
+                 else
+                   Vapi::UpdateConversationBlockDto.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 "conversation"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "tool-call"
+          { **@member.to_json, type: @discriminant }.to_json
+        when "workflow"
+          { **@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 "conversation"
+          Vapi::UpdateConversationBlockDto.validate_raw(obj: obj)
+        when "tool-call"
+          Vapi::UpdateToolCallBlockDto.validate_raw(obj: obj)
+        when "workflow"
+          Vapi::UpdateWorkflowBlockDto.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::UpdateConversationBlockDto]
+      # @return [Vapi::Blocks::BlocksUpdateRequest]
+      def self.conversation(member:)
+        new(member: member, discriminant: "conversation")
+      end
+
+      # @param member [Vapi::UpdateToolCallBlockDto]
+      # @return [Vapi::Blocks::BlocksUpdateRequest]
+      def self.tool_call(member:)
+        new(member: member, discriminant: "tool-call")
+      end
+
+      # @param member [Vapi::UpdateWorkflowBlockDto]
+      # @return [Vapi::Blocks::BlocksUpdateRequest]
+      def self.workflow(member:)
+        new(member: member, discriminant: "workflow")
+      end
+    end
+  end
+end