vapi_server_sdk 0.0.0.pre.alpha7

data/lib/vapi_server_sdk/types/vapi_model_tools_item.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "create_dtmf_tool_dto"
+require_relative "create_end_call_tool_dto"
+require_relative "create_voicemail_tool_dto"
+require_relative "create_function_tool_dto"
+require_relative "create_ghl_tool_dto"
+require_relative "create_make_tool_dto"
+require_relative "create_transfer_call_tool_dto"
+
+module Vapi
+  class VapiModelToolsItem
+    # @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::VapiModelToolsItem]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of VapiModelToolsItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "dtmf"
+                 Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
+               when "endCall"
+                 Vapi::CreateEndCallToolDto.from_json(json_object: json_object)
+               when "voicemail"
+                 Vapi::CreateVoicemailToolDto.from_json(json_object: json_object)
+               when "function"
+                 Vapi::CreateFunctionToolDto.from_json(json_object: json_object)
+               when "ghl"
+                 Vapi::CreateGhlToolDto.from_json(json_object: json_object)
+               when "make"
+                 Vapi::CreateMakeToolDto.from_json(json_object: json_object)
+               when "transferCall"
+                 Vapi::CreateTransferCallToolDto.from_json(json_object: json_object)
+               else
+                 Vapi::CreateDtmfToolDto.from_json(json_object: json_object)
+               end
+      new(member: member, discriminant: struct.type)
+    end
+
+    # For Union Types, to_json functionality is delegated to the wrapped member.
+    #
+    # @return [String]
+    def to_json(*_args)
+      case @discriminant
+      when "dtmf"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "endCall"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "voicemail"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "function"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "ghl"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "make"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "transferCall"
+        { **@member.to_json, type: @discriminant }.to_json
+      else
+        { "type": @discriminant, value: @member }.to_json
+      end
+      @member.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      case obj.type
+      when "dtmf"
+        Vapi::CreateDtmfToolDto.validate_raw(obj: obj)
+      when "endCall"
+        Vapi::CreateEndCallToolDto.validate_raw(obj: obj)
+      when "voicemail"
+        Vapi::CreateVoicemailToolDto.validate_raw(obj: obj)
+      when "function"
+        Vapi::CreateFunctionToolDto.validate_raw(obj: obj)
+      when "ghl"
+        Vapi::CreateGhlToolDto.validate_raw(obj: obj)
+      when "make"
+        Vapi::CreateMakeToolDto.validate_raw(obj: obj)
+      when "transferCall"
+        Vapi::CreateTransferCallToolDto.validate_raw(obj: obj)
+      else
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+
+    # For Union Types, is_a? functionality is delegated to the wrapped member.
+    #
+    # @param obj [Object]
+    # @return [Boolean]
+    def is_a?(obj)
+      @member.is_a?(obj)
+    end
+
+    # @param member [Vapi::CreateDtmfToolDto]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.dtmf(member:)
+      new(member: member, discriminant: "dtmf")
+    end
+
+    # @param member [Vapi::CreateEndCallToolDto]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.end_call(member:)
+      new(member: member, discriminant: "endCall")
+    end
+
+    # @param member [Vapi::CreateVoicemailToolDto]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.voicemail(member:)
+      new(member: member, discriminant: "voicemail")
+    end
+
+    # @param member [Vapi::CreateFunctionToolDto]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.function(member:)
+      new(member: member, discriminant: "function")
+    end
+
+    # @param member [Vapi::CreateGhlToolDto]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.ghl(member:)
+      new(member: member, discriminant: "ghl")
+    end
+
+    # @param member [Vapi::CreateMakeToolDto]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.make(member:)
+      new(member: member, discriminant: "make")
+    end
+
+    # @param member [Vapi::CreateTransferCallToolDto]
+    # @return [Vapi::VapiModelToolsItem]
+    def self.transfer_call(member:)
+      new(member: member, discriminant: "transferCall")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/vapi_phone_number.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require_relative "vapi_phone_number_fallback_destination"
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class VapiPhoneNumber
+    # @return [Vapi::VapiPhoneNumberFallbackDestination] 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 unique identifier for the phone number.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this phone number belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the phone number was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the phone number was last updated.
+    attr_reader :updated_at
+    # @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 [String] This is the server URL where messages will be sent for calls on this number.
+    #  This includes the `assistant-request` message.
+    #  You can see the shape of the messages sent in `ServerMessage`.
+    #  This overrides the `org.serverUrl`. Order of precedence: tool.server.url >
+    #  assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
+    attr_reader :server_url
+    # @return [String] This is the secret Vapi will send with every message to your server. It's sent
+    #  as a header called x-vapi-secret.
+    #  Same precedence logic as serverUrl.
+    attr_reader :server_url_secret
+    # @return [String] This is the SIP URI of the phone number. You can SIP INVITE this. The assistant
+    #  attached to this number will answer.
+    #  This is case-insensitive.
+    attr_reader :sip_uri
+    # @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::VapiPhoneNumberFallbackDestination] 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 id [String] This is the unique identifier for the phone number.
+    # @param org_id [String] This is the unique identifier for the org that this phone number belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the phone number was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the phone number was last updated.
+    # @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_url [String] This is the server URL where messages will be sent for calls on this number.
+    #  This includes the `assistant-request` message.
+    #  You can see the shape of the messages sent in `ServerMessage`.
+    #  This overrides the `org.serverUrl`. Order of precedence: tool.server.url >
+    #  assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
+    # @param server_url_secret [String] This is the secret Vapi will send with every message to your server. It's sent
+    #  as a header called x-vapi-secret.
+    #  Same precedence logic as serverUrl.
+    # @param sip_uri [String] This is the SIP URI of the phone number. You can SIP INVITE this. The assistant
+    #  attached to this number will answer.
+    #  This is case-insensitive.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VapiPhoneNumber]
+    def initialize(id:, org_id:, created_at:, updated_at:, sip_uri:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT,
+                   squad_id: OMIT, server_url: OMIT, server_url_secret: OMIT, additional_properties: nil)
+      @fallback_destination = fallback_destination if fallback_destination != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @name = name if name != OMIT
+      @assistant_id = assistant_id if assistant_id != OMIT
+      @squad_id = squad_id if squad_id != OMIT
+      @server_url = server_url if server_url != OMIT
+      @server_url_secret = server_url_secret if server_url_secret != OMIT
+      @sip_uri = sip_uri
+      @additional_properties = additional_properties
+      @_field_set = {
+        "fallbackDestination": fallback_destination,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name,
+        "assistantId": assistant_id,
+        "squadId": squad_id,
+        "serverUrl": server_url,
+        "serverUrlSecret": server_url_secret,
+        "sipUri": sip_uri
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of VapiPhoneNumber
+    #
+    # @param json_object [String]
+    # @return [Vapi::VapiPhoneNumber]
+    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::VapiPhoneNumberFallbackDestination.from_json(json_object: fallback_destination)
+      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"]
+      assistant_id = parsed_json["assistantId"]
+      squad_id = parsed_json["squadId"]
+      server_url = parsed_json["serverUrl"]
+      server_url_secret = parsed_json["serverUrlSecret"]
+      sip_uri = parsed_json["sipUri"]
+      new(
+        fallback_destination: fallback_destination,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        assistant_id: assistant_id,
+        squad_id: squad_id,
+        server_url: server_url,
+        server_url_secret: server_url_secret,
+        sip_uri: sip_uri,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VapiPhoneNumber 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::VapiPhoneNumberFallbackDestination.validate_raw(obj: obj.fallback_destination)
+      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.")
+      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_url&.is_a?(String) != false || raise("Passed value for field obj.server_url is not the expected type, validation failed.")
+      obj.server_url_secret&.is_a?(String) != false || raise("Passed value for field obj.server_url_secret is not the expected type, validation failed.")
+      obj.sip_uri.is_a?(String) != false || raise("Passed value for field obj.sip_uri is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/vapi_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 VapiPhoneNumberFallbackDestination
+    # @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::VapiPhoneNumberFallbackDestination]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of VapiPhoneNumberFallbackDestination
+    #
+    # @param json_object [String]
+    # @return [Vapi::VapiPhoneNumberFallbackDestination]
+    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::VapiPhoneNumberFallbackDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
+    end
+
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::VapiPhoneNumberFallbackDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/voice_cost.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class VoiceCost
+    # @return [Hash{String => Object}] This is the voice that was used during the call.
+    #  This matches one of the following:
+    #  - `call.assistant.voice`,
+    #  - `call.assistantId->voice`,
+    #  - `call.squad[n].assistant.voice`,
+    #  - `call.squad[n].assistantId->voice`,
+    #  - `call.squadId->[n].assistant.voice`,
+    #  - `call.squadId->[n].assistantId->voice`.
+    attr_reader :voice
+    # @return [Float] This is the number of characters that were generated during the call. These
+    #  should be total characters used in the call for single assistant calls, while
+    #  squad calls will have multiple voice costs one for each assistant that was used.
+    attr_reader :characters
+    # @return [Float] This is the cost of the component in USD.
+    attr_reader :cost
+    # @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 voice [Hash{String => Object}] This is the voice that was used during the call.
+    #  This matches one of the following:
+    #  - `call.assistant.voice`,
+    #  - `call.assistantId->voice`,
+    #  - `call.squad[n].assistant.voice`,
+    #  - `call.squad[n].assistantId->voice`,
+    #  - `call.squadId->[n].assistant.voice`,
+    #  - `call.squadId->[n].assistantId->voice`.
+    # @param characters [Float] This is the number of characters that were generated during the call. These
+    #  should be total characters used in the call for single assistant calls, while
+    #  squad calls will have multiple voice costs one for each assistant that was used.
+    # @param cost [Float] This is the cost of the component in USD.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::VoiceCost]
+    def initialize(voice:, characters:, cost:, additional_properties: nil)
+      @voice = voice
+      @characters = characters
+      @cost = cost
+      @additional_properties = additional_properties
+      @_field_set = { "voice": voice, "characters": characters, "cost": cost }
+    end
+
+    # Deserialize a JSON object to an instance of VoiceCost
+    #
+    # @param json_object [String]
+    # @return [Vapi::VoiceCost]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      voice = parsed_json["voice"]
+      characters = parsed_json["characters"]
+      cost = parsed_json["cost"]
+      new(
+        voice: voice,
+        characters: characters,
+        cost: cost,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of VoiceCost 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.voice.is_a?(Hash) != false || raise("Passed value for field obj.voice is not the expected type, validation failed.")
+      obj.characters.is_a?(Float) != false || raise("Passed value for field obj.characters is not the expected type, validation failed.")
+      obj.cost.is_a?(Float) != false || raise("Passed value for field obj.cost is not the expected type, validation failed.")
+    end
+  end
+end