vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/vonage_phone_number_fallback_destination.rb

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

data/lib/vapi_server_sdk/types/workflow_block.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require_relative "workflow_block_messages_item"
+require_relative "json_schema"
+require_relative "workflow_block_steps_item"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class WorkflowBlock
+    # @return [Array<Vapi::WorkflowBlockMessagesItem>] 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::WorkflowBlockStepsItem>] These are the steps in the workflow.
+    attr_reader :steps
+    # @return [String] This is the unique identifier for the block.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the organization that this block belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the block was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the block was last updated.
+    attr_reader :updated_at
+    # @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::WorkflowBlockMessagesItem>] 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::WorkflowBlockStepsItem>] These are the steps in the workflow.
+    # @param id [String] This is the unique identifier for the block.
+    # @param org_id [String] This is the unique identifier for the organization that this block belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the block was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the block was last updated.
+    # @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::WorkflowBlock]
+    def initialize(id:, org_id:, created_at:, updated_at:, 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
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "inputSchema": input_schema,
+        "outputSchema": output_schema,
+        "steps": steps,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowBlock
+    #
+    # @param json_object [String]
+    # @return [Vapi::WorkflowBlock]
+    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::WorkflowBlockMessagesItem.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::WorkflowBlockStepsItem.from_json(json_object: item)
+      end
+      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?)
+      name = parsed_json["name"]
+      new(
+        messages: messages,
+        input_schema: input_schema,
+        output_schema: output_schema,
+        steps: steps,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WorkflowBlock 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.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.")
+      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/workflow_block_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 WorkflowBlockMessagesItem
+    # @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::WorkflowBlockMessagesItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowBlockMessagesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::WorkflowBlockMessagesItem]
+    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::WorkflowBlockMessagesItem]
+    def self.block_start(member:)
+      new(member: member, discriminant: "block-start")
+    end
+
+    # @param member [Vapi::BlockCompleteMessage]
+    # @return [Vapi::WorkflowBlockMessagesItem]
+    def self.block_complete(member:)
+      new(member: member, discriminant: "block-complete")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/workflow_block_steps_item.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "handoff_step"
+require_relative "callback_step"
+
+module Vapi
+  class WorkflowBlockStepsItem
+    # @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::WorkflowBlockStepsItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of WorkflowBlockStepsItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::WorkflowBlockStepsItem]
+    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::WorkflowBlockStepsItem]
+    def self.handoff(member:)
+      new(member: member, discriminant: "handoff")
+    end
+
+    # @param member [Vapi::CallbackStep]
+    # @return [Vapi::WorkflowBlockStepsItem]
+    def self.callback(member:)
+      new(member: member, discriminant: "callback")
+    end
+  end
+end

data/lib/vapi_server_sdk.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "environment"
+require_relative "types_export"
+require_relative "requests"
+require_relative "vapi_server_sdk/calls/client"
+require_relative "vapi_server_sdk/assistants/client"
+require_relative "vapi_server_sdk/phone_numbers/client"
+require_relative "vapi_server_sdk/squads/client"
+require_relative "vapi_server_sdk/blocks/client"
+require_relative "vapi_server_sdk/tools/client"
+require_relative "vapi_server_sdk/files/client"
+require_relative "vapi_server_sdk/analytics/client"
+require_relative "vapi_server_sdk/logs/client"
+
+module Vapi
+  class Client
+    # @return [Vapi::CallsClient]
+    attr_reader :calls
+    # @return [Vapi::AssistantsClient]
+    attr_reader :assistants
+    # @return [Vapi::PhoneNumbersClient]
+    attr_reader :phone_numbers
+    # @return [Vapi::SquadsClient]
+    attr_reader :squads
+    # @return [Vapi::BlocksClient]
+    attr_reader :blocks
+    # @return [Vapi::ToolsClient]
+    attr_reader :tools
+    # @return [Vapi::FilesClient]
+    attr_reader :files
+    # @return [Vapi::AnalyticsClient]
+    attr_reader :analytics
+    # @return [Vapi::LogsClient]
+    attr_reader :logs
+
+    # @param base_url [String]
+    # @param environment [Vapi::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param token [String]
+    # @return [Vapi::Client]
+    def initialize(token:, base_url: nil, environment: Vapi::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @request_client = Vapi::RequestClient.new(
+        base_url: base_url,
+        environment: environment,
+        max_retries: max_retries,
+        timeout_in_seconds: timeout_in_seconds,
+        token: token
+      )
+      @calls = Vapi::CallsClient.new(request_client: @request_client)
+      @assistants = Vapi::AssistantsClient.new(request_client: @request_client)
+      @phone_numbers = Vapi::PhoneNumbersClient.new(request_client: @request_client)
+      @squads = Vapi::SquadsClient.new(request_client: @request_client)
+      @blocks = Vapi::BlocksClient.new(request_client: @request_client)
+      @tools = Vapi::ToolsClient.new(request_client: @request_client)
+      @files = Vapi::FilesClient.new(request_client: @request_client)
+      @analytics = Vapi::AnalyticsClient.new(request_client: @request_client)
+      @logs = Vapi::LogsClient.new(request_client: @request_client)
+    end
+  end
+
+  class AsyncClient
+    # @return [Vapi::AsyncCallsClient]
+    attr_reader :calls
+    # @return [Vapi::AsyncAssistantsClient]
+    attr_reader :assistants
+    # @return [Vapi::AsyncPhoneNumbersClient]
+    attr_reader :phone_numbers
+    # @return [Vapi::AsyncSquadsClient]
+    attr_reader :squads
+    # @return [Vapi::AsyncBlocksClient]
+    attr_reader :blocks
+    # @return [Vapi::AsyncToolsClient]
+    attr_reader :tools
+    # @return [Vapi::AsyncFilesClient]
+    attr_reader :files
+    # @return [Vapi::AsyncAnalyticsClient]
+    attr_reader :analytics
+    # @return [Vapi::AsyncLogsClient]
+    attr_reader :logs
+
+    # @param base_url [String]
+    # @param environment [Vapi::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param token [String]
+    # @return [Vapi::AsyncClient]
+    def initialize(token:, base_url: nil, environment: Vapi::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @async_request_client = Vapi::AsyncRequestClient.new(
+        base_url: base_url,
+        environment: environment,
+        max_retries: max_retries,
+        timeout_in_seconds: timeout_in_seconds,
+        token: token
+      )
+      @calls = Vapi::AsyncCallsClient.new(request_client: @async_request_client)
+      @assistants = Vapi::AsyncAssistantsClient.new(request_client: @async_request_client)
+      @phone_numbers = Vapi::AsyncPhoneNumbersClient.new(request_client: @async_request_client)
+      @squads = Vapi::AsyncSquadsClient.new(request_client: @async_request_client)
+      @blocks = Vapi::AsyncBlocksClient.new(request_client: @async_request_client)
+      @tools = Vapi::AsyncToolsClient.new(request_client: @async_request_client)
+      @files = Vapi::AsyncFilesClient.new(request_client: @async_request_client)
+      @analytics = Vapi::AsyncAnalyticsClient.new(request_client: @async_request_client)
+      @logs = Vapi::AsyncLogsClient.new(request_client: @async_request_client)
+    end
+  end
+end