vapi_server_sdk 0.2.0 → 0.4.0

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

data/lib/vapi_server_sdk/types/workflow.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "workflow_nodes_item"
+require "date"
+require_relative "edge"
+require "ostruct"
+require "json"
+
+module Vapi
+  class Workflow
+    # @return [String]
+    attr_reader :type
+    # @return [Array<Vapi::WorkflowNodesItem>]
+    attr_reader :nodes
+    # @return [String]
+    attr_reader :id
+    # @return [String]
+    attr_reader :org_id
+    # @return [DateTime]
+    attr_reader :created_at
+    # @return [DateTime]
+    attr_reader :updated_at
+    # @return [String]
+    attr_reader :name
+    # @return [Array<Vapi::Edge>]
+    attr_reader :edges
+    # @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 type [String]
+    # @param nodes [Array<Vapi::WorkflowNodesItem>]
+    # @param id [String]
+    # @param org_id [String]
+    # @param created_at [DateTime]
+    # @param updated_at [DateTime]
+    # @param name [String]
+    # @param edges [Array<Vapi::Edge>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::Workflow]
+    def initialize(type:, nodes:, id:, org_id:, created_at:, updated_at:, name:, edges:, additional_properties: nil)
+      @type = type
+      @nodes = nodes
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @name = name
+      @edges = edges
+      @additional_properties = additional_properties
+      @_field_set = {
+        "type": type,
+        "nodes": nodes,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "name": name,
+        "edges": edges
+      }
+    end
+
+    # Deserialize a JSON object to an instance of Workflow
+    #
+    # @param json_object [String]
+    # @return [Vapi::Workflow]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      nodes = parsed_json["nodes"]&.map do |item|
+        item = item.to_json
+        Vapi::WorkflowNodesItem.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"]
+      edges = parsed_json["edges"]&.map do |item|
+        item = item.to_json
+        Vapi::Edge.from_json(json_object: item)
+      end
+      new(
+        type: type,
+        nodes: nodes,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        edges: edges,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Workflow 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.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.nodes.is_a?(Array) != false || raise("Passed value for field obj.nodes 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.")
+      obj.edges.is_a?(Array) != false || raise("Passed value for field obj.edges is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/workflow_nodes_item.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "say"
+require_relative "gather"
+require_relative "create_workflow_dto"
+
+module Vapi
+  class WorkflowNodesItem
+    # Deserialize a JSON object to an instance of WorkflowNodesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::WorkflowNodesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vapi::Say.validate_raw(obj: struct)
+        return Vapi::Say.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::Gather.validate_raw(obj: struct)
+        return Vapi::Gather.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(Object) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::CreateWorkflowDto.validate_raw(obj: struct)
+        return Vapi::CreateWorkflowDto.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
+    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:)
+      begin
+        return Vapi::Say.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::Gather.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(Object) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::CreateWorkflowDto.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end