vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/block_start_message.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "text_content"
-require_relative "block_start_message_conditions_item"
-require "ostruct"
-require "json"
-
-module Vapi
-  class BlockStartMessage
-    # @return [Array<Vapi::TextContent>] This is an alternative to the `content` property. It allows to specify variants
-    #  of the same content, one per language.
-    #  Usage:
-    #  - If your assistants are multilingual, you can provide content for each
-    #  language.
-    #  - If you don't provide content for a language, the first item in the array will
-    #  be automatically translated to the active language at that moment.
-    #  This will override the `content` property.
-    attr_reader :contents
-    # @return [Array<Vapi::BlockStartMessageConditionsItem>] This is an optional array of conditions that must be met for this message to be
-    #  triggered.
-    attr_reader :conditions
-    # @return [String] This is the content that the assistant will say when this message is triggered.
-    attr_reader :content
-    # @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 contents [Array<Vapi::TextContent>] This is an alternative to the `content` property. It allows to specify variants
-    #  of the same content, one per language.
-    #  Usage:
-    #  - If your assistants are multilingual, you can provide content for each
-    #  language.
-    #  - If you don't provide content for a language, the first item in the array will
-    #  be automatically translated to the active language at that moment.
-    #  This will override the `content` property.
-    # @param conditions [Array<Vapi::BlockStartMessageConditionsItem>] This is an optional array of conditions that must be met for this message to be
-    #  triggered.
-    # @param content [String] This is the content that the assistant will say when this message is triggered.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::BlockStartMessage]
-    def initialize(contents: OMIT, conditions: OMIT, content: OMIT, additional_properties: nil)
-      @contents = contents if contents != OMIT
-      @conditions = conditions if conditions != OMIT
-      @content = content if content != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "contents": contents, "conditions": conditions, "content": content }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of BlockStartMessage
-    #
-    # @param json_object [String]
-    # @return [Vapi::BlockStartMessage]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      contents = parsed_json["contents"]&.map do |item|
-        item = item.to_json
-        Vapi::TextContent.from_json(json_object: item)
-      end
-      conditions = parsed_json["conditions"]&.map do |item|
-        item = item.to_json
-        Vapi::BlockStartMessageConditionsItem.from_json(json_object: item)
-      end
-      content = parsed_json["content"]
-      new(
-        contents: contents,
-        conditions: conditions,
-        content: content,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of BlockStartMessage 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.contents&.is_a?(Array) != false || raise("Passed value for field obj.contents is not the expected type, validation failed.")
-      obj.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
-      obj.content&.is_a?(String) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/vapi_server_sdk/types/buy_phone_number_dto.rb

@@ -1,147 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "buy_phone_number_dto_fallback_destination"
-require_relative "server"
-require "ostruct"
-require "json"
-
-module Vapi
-  class BuyPhoneNumberDto
-    # @return [Vapi::BuyPhoneNumberDtoFallbackDestination] This is the fallback destination an inbound call will be transferred to if:
-    #  1. `assistantId` is not set
-    #  2. `squadId` is not set
-    #  3. and, `assistant-request` message to the `serverUrl` fails
-    #  If this is not set and above conditions are met, the inbound call is hung up
-    #  with an error message.
-    attr_reader :fallback_destination
-    # @return [String] This is the area code of the phone number to purchase.
-    attr_reader :area_code
-    # @return [String] This is the name of the phone number. This is just for your own reference.
-    attr_reader :name
-    # @return [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
-    attr_reader :assistant_id
-    # @return [String] This is the squad that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
-    attr_reader :squad_id
-    # @return [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
-    #  with their shape in ServerMessage schema.
-    #  The order of precedence is:
-    #  1. assistant.server
-    #  2. phoneNumber.server
-    #  3. org.server
-    attr_reader :server
-    # @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 fallback_destination [Vapi::BuyPhoneNumberDtoFallbackDestination] This is the fallback destination an inbound call will be transferred to if:
-    #  1. `assistantId` is not set
-    #  2. `squadId` is not set
-    #  3. and, `assistant-request` message to the `serverUrl` fails
-    #  If this is not set and above conditions are met, the inbound call is hung up
-    #  with an error message.
-    # @param area_code [String] This is the area code of the phone number to purchase.
-    # @param name [String] This is the name of the phone number. This is just for your own reference.
-    # @param assistant_id [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
-    # @param squad_id [String] This is the squad that will be used for incoming calls to this phone number.
-    #  If neither `assistantId` nor `squadId` is set, `assistant-request` will be sent
-    #  to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the
-    #  shape of the message and response that is expected.
-    # @param server [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
-    #  with their shape in ServerMessage schema.
-    #  The order of precedence is:
-    #  1. assistant.server
-    #  2. phoneNumber.server
-    #  3. org.server
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::BuyPhoneNumberDto]
-    def initialize(area_code:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT,
-                   server: OMIT, additional_properties: nil)
-      @fallback_destination = fallback_destination if fallback_destination != OMIT
-      @area_code = area_code
-      @name = name if name != OMIT
-      @assistant_id = assistant_id if assistant_id != OMIT
-      @squad_id = squad_id if squad_id != OMIT
-      @server = server if server != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "fallbackDestination": fallback_destination,
-        "areaCode": area_code,
-        "name": name,
-        "assistantId": assistant_id,
-        "squadId": squad_id,
-        "server": server
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of BuyPhoneNumberDto
-    #
-    # @param json_object [String]
-    # @return [Vapi::BuyPhoneNumberDto]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      if parsed_json["fallbackDestination"].nil?
-        fallback_destination = nil
-      else
-        fallback_destination = parsed_json["fallbackDestination"].to_json
-        fallback_destination = Vapi::BuyPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
-      end
-      area_code = parsed_json["areaCode"]
-      name = parsed_json["name"]
-      assistant_id = parsed_json["assistantId"]
-      squad_id = parsed_json["squadId"]
-      if parsed_json["server"].nil?
-        server = nil
-      else
-        server = parsed_json["server"].to_json
-        server = Vapi::Server.from_json(json_object: server)
-      end
-      new(
-        fallback_destination: fallback_destination,
-        area_code: area_code,
-        name: name,
-        assistant_id: assistant_id,
-        squad_id: squad_id,
-        server: server,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of BuyPhoneNumberDto 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.fallback_destination.nil? || Vapi::BuyPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
-      obj.area_code.is_a?(String) != false || raise("Passed value for field obj.area_code 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.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.")
-      obj.squad_id&.is_a?(String) != false || raise("Passed value for field obj.squad_id is not the expected type, validation failed.")
-      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
-    end
-  end
-end

data/lib/vapi_server_sdk/types/callback_step.rb

@@ -1,204 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "callback_step_block"
-require_relative "assignment_mutation"
-require "ostruct"
-require "json"
-
-module Vapi
-  class CallbackStep
-    # @return [Vapi::CallbackStepBlock] This is the block to use. To use an existing block, use `blockId`.
-    attr_reader :block
-    # @return [Array<Vapi::AssignmentMutation>] This is the mutations to apply to the context after the step is done.
-    attr_reader :mutations
-    # @return [String] This is the name of the step.
-    attr_reader :name
-    # @return [String] This is the id of the block to use. To use a transient block, use `block`.
-    attr_reader :block_id
-    # @return [Hash{String => Object}] This is the input to the block. You can use any key-value map as input to the
-    #  block.
-    #  Example:
-    #  {
-    #  "name": "John Doe",
-    #  "age": 20
-    #  }
-    #  You can reference any variable in the context of the current block:
-    #  - "{{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
-    #  Example:
-    #  {
-    #  "name": "{{my-tool-call-step.output.name}}",
-    #  "age": "{{my-tool-call-step.input.age}}",
-    #  "date": "{{workflow.input.date}}"
-    #  }
-    #  You can dynamically change the key name.
-    #  Example:
-    #  {
-    #  "{{my-tool-call-step.output.key-name-for-name}}": "{{name}}",
-    #  "{{my-tool-call-step.input.key-name-for-age}}": "{{age}}",
-    #  "{{workflow.input.key-name-for-date}}": "{{date}}"
-    #  }
-    #  You can represent the value as a string, number, boolean, array, or object.
-    #  Example:
-    #  {
-    #  "name": "john",
-    #  "age": 20,
-    #  "date": "2021-01-01",
-    #  "metadata": {
-    #  "unique-key": "{{my-tool-call-step.output.unique-key}}"
-    #  },
-    #  "array": ["A", "B", "C"],
-    #  }
-    #  Caveats:
-    #  1. a workflow can execute a step multiple times. example, if a loop is used in
-    #  the graph. {{stepName.input/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.input/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.
-    attr_reader :input
-    # @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 block [Vapi::CallbackStepBlock] This is the block to use. To use an existing block, use `blockId`.
-    # @param mutations [Array<Vapi::AssignmentMutation>] This is the mutations to apply to the context after the step is done.
-    # @param name [String] This is the name of the step.
-    # @param block_id [String] This is the id of the block to use. To use a transient block, use `block`.
-    # @param input [Hash{String => Object}] This is the input to the block. You can use any key-value map as input to the
-    #  block.
-    #  Example:
-    #  {
-    #  "name": "John Doe",
-    #  "age": 20
-    #  }
-    #  You can reference any variable in the context of the current block:
-    #  - "{{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
-    #  Example:
-    #  {
-    #  "name": "{{my-tool-call-step.output.name}}",
-    #  "age": "{{my-tool-call-step.input.age}}",
-    #  "date": "{{workflow.input.date}}"
-    #  }
-    #  You can dynamically change the key name.
-    #  Example:
-    #  {
-    #  "{{my-tool-call-step.output.key-name-for-name}}": "{{name}}",
-    #  "{{my-tool-call-step.input.key-name-for-age}}": "{{age}}",
-    #  "{{workflow.input.key-name-for-date}}": "{{date}}"
-    #  }
-    #  You can represent the value as a string, number, boolean, array, or object.
-    #  Example:
-    #  {
-    #  "name": "john",
-    #  "age": 20,
-    #  "date": "2021-01-01",
-    #  "metadata": {
-    #  "unique-key": "{{my-tool-call-step.output.unique-key}}"
-    #  },
-    #  "array": ["A", "B", "C"],
-    #  }
-    #  Caveats:
-    #  1. a workflow can execute a step multiple times. example, if a loop is used in
-    #  the graph. {{stepName.input/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.input/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.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Vapi::CallbackStep]
-    def initialize(name:, block: OMIT, mutations: OMIT, block_id: OMIT, input: OMIT, additional_properties: nil)
-      @block = block if block != OMIT
-      @mutations = mutations if mutations != OMIT
-      @name = name
-      @block_id = block_id if block_id != OMIT
-      @input = input if input != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "block": block,
-        "mutations": mutations,
-        "name": name,
-        "blockId": block_id,
-        "input": input
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of CallbackStep
-    #
-    # @param json_object [String]
-    # @return [Vapi::CallbackStep]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      if parsed_json["block"].nil?
-        block = nil
-      else
-        block = parsed_json["block"].to_json
-        block = Vapi::CallbackStepBlock.from_json(json_object: block)
-      end
-      mutations = parsed_json["mutations"]&.map do |item|
-        item = item.to_json
-        Vapi::AssignmentMutation.from_json(json_object: item)
-      end
-      name = parsed_json["name"]
-      block_id = parsed_json["blockId"]
-      input = parsed_json["input"]
-      new(
-        block: block,
-        mutations: mutations,
-        name: name,
-        block_id: block_id,
-        input: input,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of CallbackStep 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.block.nil? || Vapi::CallbackStepBlock.validate_raw(obj: obj.block)
-      obj.mutations&.is_a?(Array) != false || raise("Passed value for field obj.mutations 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.block_id&.is_a?(String) != false || raise("Passed value for field obj.block_id is not the expected type, validation failed.")
-      obj.input&.is_a?(Hash) != false || raise("Passed value for field obj.input is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/vapi_server_sdk/types/callback_step_block.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require_relative "create_conversation_block_dto"
-require_relative "create_tool_call_block_dto"
-require_relative "create_workflow_block_dto"
-
-module Vapi
-  # This is the block to use. To use an existing block, use `blockId`.
-  class CallbackStepBlock
-    # @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::CallbackStepBlock]
-    def initialize(member:, discriminant:)
-      @member = member
-      @discriminant = discriminant
-    end
-
-    # Deserialize a JSON object to an instance of CallbackStepBlock
-    #
-    # @param json_object [String]
-    # @return [Vapi::CallbackStepBlock]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      member = case struct.type
-               when "conversation"
-                 Vapi::CreateConversationBlockDto.from_json(json_object: json_object)
-               when "tool-call"
-                 Vapi::CreateToolCallBlockDto.from_json(json_object: json_object)
-               when "workflow"
-                 Vapi::CreateWorkflowBlockDto.from_json(json_object: json_object)
-               else
-                 Vapi::CreateConversationBlockDto.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::CreateConversationBlockDto.validate_raw(obj: obj)
-      when "tool-call"
-        Vapi::CreateToolCallBlockDto.validate_raw(obj: obj)
-      when "workflow"
-        Vapi::CreateWorkflowBlockDto.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::CreateConversationBlockDto]
-    # @return [Vapi::CallbackStepBlock]
-    def self.conversation(member:)
-      new(member: member, discriminant: "conversation")
-    end
-
-    # @param member [Vapi::CreateToolCallBlockDto]
-    # @return [Vapi::CallbackStepBlock]
-    def self.tool_call(member:)
-      new(member: member, discriminant: "tool-call")
-    end
-
-    # @param member [Vapi::CreateWorkflowBlockDto]
-    # @return [Vapi::CallbackStepBlock]
-    def self.workflow(member:)
-      new(member: member, discriminant: "workflow")
-    end
-  end
-end