vapi_server_sdk 0.2.0 → 0.4.0

data/lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "trieve_knowledge_base_search_plan"
+require_relative "update_trieve_knowledge_base_dto_create_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class UpdateTrieveKnowledgeBaseDto
+    # @return [String] This is the name of the knowledge base.
+    attr_reader :name
+    # @return [Vapi::TrieveKnowledgeBaseSearchPlan] This is the searching plan used when searching for relevant chunks from the
+    #  vector store.
+    #  You should configure this if you're running into these issues:
+    #  - Too much unnecessary context is being fed as knowledge base context.
+    #  - Not enough relevant context is being fed as knowledge base context.
+    attr_reader :search_plan
+    # @return [Vapi::UpdateTrieveKnowledgeBaseDtoCreatePlan] This is the plan if you want us to create/import a new vector store using
+    #  Trieve.
+    attr_reader :create_plan
+    # @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 name [String] This is the name of the knowledge base.
+    # @param search_plan [Vapi::TrieveKnowledgeBaseSearchPlan] This is the searching plan used when searching for relevant chunks from the
+    #  vector store.
+    #  You should configure this if you're running into these issues:
+    #  - Too much unnecessary context is being fed as knowledge base context.
+    #  - Not enough relevant context is being fed as knowledge base context.
+    # @param create_plan [Vapi::UpdateTrieveKnowledgeBaseDtoCreatePlan] This is the plan if you want us to create/import a new vector store using
+    #  Trieve.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::UpdateTrieveKnowledgeBaseDto]
+    def initialize(name: OMIT, search_plan: OMIT, create_plan: OMIT, additional_properties: nil)
+      @name = name if name != OMIT
+      @search_plan = search_plan if search_plan != OMIT
+      @create_plan = create_plan if create_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "searchPlan": search_plan, "createPlan": create_plan }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateTrieveKnowledgeBaseDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateTrieveKnowledgeBaseDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      if parsed_json["searchPlan"].nil?
+        search_plan = nil
+      else
+        search_plan = parsed_json["searchPlan"].to_json
+        search_plan = Vapi::TrieveKnowledgeBaseSearchPlan.from_json(json_object: search_plan)
+      end
+      if parsed_json["createPlan"].nil?
+        create_plan = nil
+      else
+        create_plan = parsed_json["createPlan"].to_json
+        create_plan = Vapi::UpdateTrieveKnowledgeBaseDtoCreatePlan.from_json(json_object: create_plan)
+      end
+      new(
+        name: name,
+        search_plan: search_plan,
+        create_plan: create_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateTrieveKnowledgeBaseDto 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.search_plan.nil? || Vapi::TrieveKnowledgeBaseSearchPlan.validate_raw(obj: obj.search_plan)
+      obj.create_plan.nil? || Vapi::UpdateTrieveKnowledgeBaseDtoCreatePlan.validate_raw(obj: obj.create_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_trieve_knowledge_base_dto_create_plan.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "trieve_knowledge_base_create"
+require_relative "trieve_knowledge_base_import"
+
+module Vapi
+  # This is the plan if you want us to create/import a new vector store using
+  #  Trieve.
+  class UpdateTrieveKnowledgeBaseDtoCreatePlan
+    # @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::UpdateTrieveKnowledgeBaseDtoCreatePlan]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  UpdateTrieveKnowledgeBaseDtoCreatePlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateTrieveKnowledgeBaseDtoCreatePlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      member = case struct.type
+               when "create"
+                 Vapi::TrieveKnowledgeBaseCreate.from_json(json_object: json_object)
+               when "import"
+                 Vapi::TrieveKnowledgeBaseImport.from_json(json_object: json_object)
+               else
+                 Vapi::TrieveKnowledgeBaseCreate.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 "create"
+        { **@member.to_json, type: @discriminant }.to_json
+      when "import"
+        { **@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 "create"
+        Vapi::TrieveKnowledgeBaseCreate.validate_raw(obj: obj)
+      when "import"
+        Vapi::TrieveKnowledgeBaseImport.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::TrieveKnowledgeBaseCreate]
+    # @return [Vapi::UpdateTrieveKnowledgeBaseDtoCreatePlan]
+    def self.create(member:)
+      new(member: member, discriminant: "create")
+    end
+
+    # @param member [Vapi::TrieveKnowledgeBaseImport]
+    # @return [Vapi::UpdateTrieveKnowledgeBaseDtoCreatePlan]
+    def self.import(member:)
+      new(member: member, discriminant: "import")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_twilio_credential_dto.rb

@@ -5,14 +5,12 @@ require "json"
 
 module Vapi
   class UpdateTwilioCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :auth_token
-    # @return [String]
-    attr_reader :account_sid
     # @return [String] This is the name of credential. This is just for your reference.
     attr_reader :name
+    # @return [String]
+    attr_reader :account_sid
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -21,24 +19,17 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @param auth_token [String] This is not returned in the API.
-    # @param account_sid [String]
     # @param name [String] This is the name of credential. This is just for your reference.
+    # @param account_sid [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::UpdateTwilioCredentialDto]
-    def initialize(provider:, auth_token:, account_sid:, name: OMIT, additional_properties: nil)
-      @provider = provider
-      @auth_token = auth_token
-      @account_sid = account_sid
+    def initialize(auth_token: OMIT, name: OMIT, account_sid: OMIT, additional_properties: nil)
+      @auth_token = auth_token if auth_token != OMIT
       @name = name if name != OMIT
+      @account_sid = account_sid if account_sid != OMIT
       @additional_properties = additional_properties
-      @_field_set = {
-        "provider": provider,
-        "authToken": auth_token,
-        "accountSid": account_sid,
-        "name": name
-      }.reject do |_k, v|
+      @_field_set = { "authToken": auth_token, "name": name, "accountSid": account_sid }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -50,15 +41,13 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      provider = parsed_json["provider"]
       auth_token = parsed_json["authToken"]
-      account_sid = parsed_json["accountSid"]
       name = parsed_json["name"]
+      account_sid = parsed_json["accountSid"]
       new(
-        provider: provider,
         auth_token: auth_token,
-        account_sid: account_sid,
         name: name,
+        account_sid: account_sid,
         additional_properties: struct
       )
     end
@@ -77,10 +66,9 @@ module Vapi
     # @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.auth_token.is_a?(String) != false || raise("Passed value for field obj.auth_token is not the expected type, validation failed.")
-      obj.account_sid.is_a?(String) != false || raise("Passed value for field obj.account_sid is not the expected type, validation failed.")
+      obj.auth_token&.is_a?(String) != false || raise("Passed value for field obj.auth_token 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.account_sid&.is_a?(String) != false || raise("Passed value for field obj.account_sid is not the expected type, validation failed.")
     end
   end
 end

data/lib/vapi_server_sdk/types/update_twilio_phone_number_dto.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require_relative "update_twilio_phone_number_dto_fallback_destination"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class UpdateTwilioPhoneNumberDto
+    # @return [Vapi::UpdateTwilioPhoneNumberDtoFallbackDestination] 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 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 [String] These are the digits of the phone number you own on your Twilio.
+    attr_reader :number
+    # @return [String] This is the Twilio Account SID for the phone number.
+    attr_reader :twilio_account_sid
+    # @return [String] This is the Twilio Auth Token for the phone number.
+    attr_reader :twilio_auth_token
+    # @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::UpdateTwilioPhoneNumberDtoFallbackDestination] 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 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 number [String] These are the digits of the phone number you own on your Twilio.
+    # @param twilio_account_sid [String] This is the Twilio Account SID for the phone number.
+    # @param twilio_auth_token [String] This is the Twilio Auth Token for the phone number.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::UpdateTwilioPhoneNumberDto]
+    def initialize(fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT, server: OMIT,
+                   number: OMIT, twilio_account_sid: OMIT, twilio_auth_token: OMIT, additional_properties: nil)
+      @fallback_destination = fallback_destination if fallback_destination != OMIT
+      @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
+      @number = number if number != OMIT
+      @twilio_account_sid = twilio_account_sid if twilio_account_sid != OMIT
+      @twilio_auth_token = twilio_auth_token if twilio_auth_token != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "fallbackDestination": fallback_destination,
+        "name": name,
+        "assistantId": assistant_id,
+        "squadId": squad_id,
+        "server": server,
+        "number": number,
+        "twilioAccountSid": twilio_account_sid,
+        "twilioAuthToken": twilio_auth_token
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateTwilioPhoneNumberDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateTwilioPhoneNumberDto]
+    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::UpdateTwilioPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
+      end
+      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
+      number = parsed_json["number"]
+      twilio_account_sid = parsed_json["twilioAccountSid"]
+      twilio_auth_token = parsed_json["twilioAuthToken"]
+      new(
+        fallback_destination: fallback_destination,
+        name: name,
+        assistant_id: assistant_id,
+        squad_id: squad_id,
+        server: server,
+        number: number,
+        twilio_account_sid: twilio_account_sid,
+        twilio_auth_token: twilio_auth_token,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateTwilioPhoneNumberDto 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::UpdateTwilioPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
+      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)
+      obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
+      obj.twilio_account_sid&.is_a?(String) != false || raise("Passed value for field obj.twilio_account_sid is not the expected type, validation failed.")
+      obj.twilio_auth_token&.is_a?(String) != false || raise("Passed value for field obj.twilio_auth_token is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/update_twilio_phone_number_dto_fallback_destination.rb

@@ -0,0 +1,101 @@
+# 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 UpdateTwilioPhoneNumberDtoFallbackDestination
+    # @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::UpdateTwilioPhoneNumberDtoFallbackDestination]
+    def initialize(member:, discriminant:)
+      @member = member
+      @discriminant = discriminant
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  UpdateTwilioPhoneNumberDtoFallbackDestination
+    #
+    # @param json_object [String]
+    # @return [Vapi::UpdateTwilioPhoneNumberDtoFallbackDestination]
+    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::UpdateTwilioPhoneNumberDtoFallbackDestination]
+    def self.number(member:)
+      new(member: member, discriminant: "number")
+    end
+
+    # @param member [Vapi::TransferDestinationSip]
+    # @return [Vapi::UpdateTwilioPhoneNumberDtoFallbackDestination]
+    def self.sip(member:)
+      new(member: member, discriminant: "sip")
+    end
+  end
+end