vapi_server_sdk 0.2.0 → 0.3.0

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

data/lib/vapi_server_sdk/types/update_x_ai_credential_dto.rb

@@ -5,9 +5,6 @@ require "json"
 
 module Vapi
   class UpdateXAiCredentialDto
-    # @return [String] This is the api key for Grok in XAi's console. Get it from here:
-    #  https://console.x.ai
-    attr_reader :provider
     # @return [String] This is not returned in the API.
     attr_reader :api_key
     # @return [String] This is the name of credential. This is just for your reference.
@@ -20,18 +17,15 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String] This is the api key for Grok in XAi's console. Get it from here:
-    #  https://console.x.ai
     # @param api_key [String] This is not returned in the API.
     # @param name [String] This is the name of credential. This is just for your reference.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::UpdateXAiCredentialDto]
-    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
-      @provider = provider
-      @api_key = api_key
+    def initialize(api_key: OMIT, name: OMIT, additional_properties: nil)
+      @api_key = api_key if api_key != OMIT
       @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+      @_field_set = { "apiKey": api_key, "name": name }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -43,11 +37,9 @@ 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"]
       api_key = parsed_json["apiKey"]
       name = parsed_json["name"]
       new(
-        provider: provider,
         api_key: api_key,
         name: name,
         additional_properties: struct
@@ -68,8 +60,7 @@ 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.api_key.is_a?(String) != false || raise("Passed value for field obj.api_key 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/vapi_phone_number.rb

@@ -2,6 +2,7 @@
 
 require_relative "vapi_phone_number_fallback_destination"
 require "date"
+require_relative "server"
 require_relative "sip_authentication"
 require "ostruct"
 require "json"
@@ -35,16 +36,13 @@ module Vapi
     #  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 [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] 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.
@@ -80,14 +78,12 @@ module Vapi
     #  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 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 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.
@@ -97,7 +93,7 @@ module Vapi
     # @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, authentication: OMIT, additional_properties: nil)
+                   squad_id: OMIT, server: OMIT, authentication: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
       @id = id
       @org_id = org_id
@@ -106,8 +102,7 @@ module Vapi
       @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
+      @server = server if server != OMIT
       @sip_uri = sip_uri
       @authentication = authentication if authentication != OMIT
       @additional_properties = additional_properties
@@ -120,8 +115,7 @@ module Vapi
         "name": name,
         "assistantId": assistant_id,
         "squadId": squad_id,
-        "serverUrl": server_url,
-        "serverUrlSecret": server_url_secret,
+        "server": server,
         "sipUri": sip_uri,
         "authentication": authentication
       }.reject do |_k, v|
@@ -149,8 +143,12 @@ module Vapi
       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"]
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
       sip_uri = parsed_json["sipUri"]
       if parsed_json["authentication"].nil?
         authentication = nil
@@ -167,8 +165,7 @@ module Vapi
         name: name,
         assistant_id: assistant_id,
         squad_id: squad_id,
-        server_url: server_url,
-        server_url_secret: server_url_secret,
+        server: server,
         sip_uri: sip_uri,
         authentication: authentication,
         additional_properties: struct
@@ -197,8 +194,7 @@ module Vapi
       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.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
       obj.sip_uri.is_a?(String) != false || raise("Passed value for field obj.sip_uri is not the expected type, validation failed.")
       obj.authentication.nil? || Vapi::SipAuthentication.validate_raw(obj: obj.authentication)
     end

data/lib/vapi_server_sdk/types/vonage_phone_number.rb

@@ -2,6 +2,7 @@
 
 require_relative "vonage_phone_number_fallback_destination"
 require "date"
+require_relative "server"
 require "ostruct"
 require "json"
 
@@ -34,16 +35,13 @@ module Vapi
     #  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 [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 Vonage.
     attr_reader :number
     # @return [String] This is the credential that is used to make outgoing calls, and do operations
@@ -76,21 +74,19 @@ module Vapi
     #  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 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 Vonage.
     # @param credential_id [String] This is the credential that is used to make outgoing calls, and do operations
     #  like call transfer and hang up.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::VonagePhoneNumber]
     def initialize(id:, org_id:, created_at:, updated_at:, number:, credential_id:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT,
-                   squad_id: OMIT, server_url: OMIT, server_url_secret: OMIT, additional_properties: nil)
+                   squad_id: OMIT, server: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
       @id = id
       @org_id = org_id
@@ -99,8 +95,7 @@ module Vapi
       @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
+      @server = server if server != OMIT
       @number = number
       @credential_id = credential_id
       @additional_properties = additional_properties
@@ -113,8 +108,7 @@ module Vapi
         "name": name,
         "assistantId": assistant_id,
         "squadId": squad_id,
-        "serverUrl": server_url,
-        "serverUrlSecret": server_url_secret,
+        "server": server,
         "number": number,
         "credentialId": credential_id
       }.reject do |_k, v|
@@ -142,8 +136,12 @@ module Vapi
       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"]
+      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"]
       credential_id = parsed_json["credentialId"]
       new(
@@ -155,8 +153,7 @@ module Vapi
         name: name,
         assistant_id: assistant_id,
         squad_id: squad_id,
-        server_url: server_url,
-        server_url_secret: server_url_secret,
+        server: server,
         number: number,
         credential_id: credential_id,
         additional_properties: struct
@@ -185,8 +182,7 @@ module Vapi
       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.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.credential_id.is_a?(String) != false || raise("Passed value for field obj.credential_id is not the expected type, validation failed.")
     end