vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/create_web_call_dto.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require_relative "create_assistant_dto"
+require_relative "assistant_overrides"
+require_relative "create_squad_dto"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateWebCallDto
+    # @return [String] This is the assistant that will be used for the call. To use a transient
+    #  assistant, use `assistant` instead.
+    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.
+    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.
+    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.
+    attr_reader :squad
+    # @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 assistant_id [String] This is the assistant that will be used for the call. To use a transient
+    #  assistant, use `assistant` instead.
+    # @param assistant [Vapi::CreateAssistantDto] This is the assistant that will be used for the call. To use an existing
+    #  assistant, use `assistantId` instead.
+    # @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.
+    # @param squad [Vapi::CreateSquadDto] This is a squad that will be used for the call. To use an existing squad, use
+    #  `squadId` instead.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateWebCallDto]
+    def initialize(assistant_id: OMIT, assistant: OMIT, assistant_overrides: OMIT, squad_id: OMIT, squad: OMIT,
+                   additional_properties: nil)
+      @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
+      @additional_properties = additional_properties
+      @_field_set = {
+        "assistantId": assistant_id,
+        "assistant": assistant,
+        "assistantOverrides": assistant_overrides,
+        "squadId": squad_id,
+        "squad": squad
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateWebCallDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWebCallDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      assistant_id = parsed_json["assistantId"]
+      if parsed_json["assistant"].nil?
+        assistant = nil
+      else
+        assistant = parsed_json["assistant"].to_json
+        assistant = Vapi::CreateAssistantDto.from_json(json_object: assistant)
+      end
+      if parsed_json["assistantOverrides"].nil?
+        assistant_overrides = nil
+      else
+        assistant_overrides = parsed_json["assistantOverrides"].to_json
+        assistant_overrides = Vapi::AssistantOverrides.from_json(json_object: assistant_overrides)
+      end
+      squad_id = parsed_json["squadId"]
+      if parsed_json["squad"].nil?
+        squad = nil
+      else
+        squad = parsed_json["squad"].to_json
+        squad = Vapi::CreateSquadDto.from_json(json_object: squad)
+      end
+      new(
+        assistant_id: assistant_id,
+        assistant: assistant,
+        assistant_overrides: assistant_overrides,
+        squad_id: squad_id,
+        squad: squad,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateWebCallDto 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.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)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_workflow_block_dto.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require_relative "create_workflow_block_dto_messages_item"
+require_relative "json_schema"
+require_relative "create_workflow_block_dto_steps_item"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateWorkflowBlockDto
+    # @return [Array<Vapi::CreateWorkflowBlockDtoMessagesItem>] 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 [Array<Vapi::CreateWorkflowBlockDtoStepsItem>] These are the steps in the workflow.
+    attr_reader :steps
+    # @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::CreateWorkflowBlockDtoMessagesItem>] 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 steps [Array<Vapi::CreateWorkflowBlockDtoStepsItem>] These are the steps in the workflow.
+    # @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::CreateWorkflowBlockDto]
+    def initialize(messages: OMIT, input_schema: OMIT, output_schema: OMIT, steps: 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
+      @steps = steps if steps != OMIT
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "inputSchema": input_schema,
+        "outputSchema": output_schema,
+        "steps": steps,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateWorkflowBlockDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWorkflowBlockDto]
+    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::CreateWorkflowBlockDtoMessagesItem.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
+      steps = parsed_json["steps"]&.map do |item|
+        item = item.to_json
+        Vapi::CreateWorkflowBlockDtoStepsItem.from_json(json_object: item)
+      end
+      name = parsed_json["name"]
+      new(
+        messages: messages,
+        input_schema: input_schema,
+        output_schema: output_schema,
+        steps: steps,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateWorkflowBlockDto 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.steps&.is_a?(Array) != false || raise("Passed value for field obj.steps 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_workflow_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 CreateWorkflowBlockDtoMessagesItem
+    # @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::CreateWorkflowBlockDtoMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of CreateWorkflowBlockDtoMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWorkflowBlockDtoMessagesItem]
+    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::CreateWorkflowBlockDtoMessagesItem]
+    def self.block_start(member:)
+      new(member: member, discriminant: "block-start")
+    end
+
+    # @param member [Vapi::BlockCompleteMessage]
+    # @return [Vapi::CreateWorkflowBlockDtoMessagesItem]
+    def self.block_complete(member:)
+      new(member: member, discriminant: "block-complete")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_workflow_block_dto_steps_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "handoff_step"
+require_relative "callback_step"
+
+module Vapi
+  class CreateWorkflowBlockDtoStepsItem
+    # @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::CreateWorkflowBlockDtoStepsItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of CreateWorkflowBlockDtoStepsItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWorkflowBlockDtoStepsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "handoff"
+                 Vapi::HandoffStep.from_json(json_object: json_object)
+               when "callback"
+                 Vapi::CallbackStep.from_json(json_object: json_object)
+               else
+                 Vapi::HandoffStep.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 "handoff"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "callback"
+        { **@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 "handoff"
+        Vapi::HandoffStep.validate_raw(obj: obj)
+      when "callback"
+        Vapi::CallbackStep.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::HandoffStep]
+    # @return [Vapi::CreateWorkflowBlockDtoStepsItem]
+    def self.handoff(member:)
+      new(member: member, discriminant: "handoff")
+    end
+
+    # @param member [Vapi::CallbackStep]
+    # @return [Vapi::CreateWorkflowBlockDtoStepsItem]
+    def self.callback(member:)
+      new(member: member, discriminant: "callback")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/custom_llm_credential.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CustomLlmCredential
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @return [String] This is the unique identifier for the credential.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this credential belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    attr_reader :updated_at
+    # @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 provider [String]
+    # @param api_key [String] This is not returned in the API.
+    # @param id [String] This is the unique identifier for the credential.
+    # @param org_id [String] This is the unique identifier for the org that this credential belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CustomLlmCredential]
+    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @additional_properties = additional_properties
+      @_field_set = {
+        "provider": provider,
+        "apiKey": api_key,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at
+      }
+    end
+
+    # Deserialize a JSON object to an instance of CustomLlmCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::CustomLlmCredential]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      api_key = parsed_json["apiKey"]
+      id = parsed_json["id"]
+      org_id = parsed_json["orgId"]
+      created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
+      updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
+      new(
+        provider: provider,
+        api_key: api_key,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CustomLlmCredential 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.provider.is_a?(String) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key is not the expected type, validation failed.")
+      obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
+      obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+      obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+    end
+  end
+end