vapi_server_sdk 0.2.0 → 0.4.0

data/lib/vapi_server_sdk/types/create_vonage_phone_number_dto.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "create_vonage_phone_number_dto_fallback_destination"
+require_relative "server"
 require "ostruct"
 require "json"
 
@@ -30,16 +31,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 [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -66,26 +64,23 @@ 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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CreateVonagePhoneNumberDto]
     def initialize(number:, credential_id:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT, squad_id: OMIT,
-                   server_url: OMIT, server_url_secret: OMIT, additional_properties: nil)
+                   server: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
       @number = number
       @credential_id = credential_id
       @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
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
@@ -94,8 +89,7 @@ module Vapi
         "name": name,
         "assistantId": assistant_id,
         "squadId": squad_id,
-        "serverUrl": server_url,
-        "serverUrlSecret": server_url_secret
+        "server": server
       }.reject do |_k, v|
         v == OMIT
       end
@@ -119,8 +113,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
       new(
         fallback_destination: fallback_destination,
         number: number,
@@ -128,8 +126,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,
         additional_properties: struct
       )
     end
@@ -154,8 +151,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)
     end
   end
 end

data/lib/vapi_server_sdk/types/create_webhook_credential_dto.rb

@@ -6,8 +6,6 @@ require "json"
 
 module Vapi
   class CreateWebhookCredentialDto
-    # @return [String]
-    attr_reader :provider
     # @return [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749.
     attr_reader :authentication_plan
     # @return [String] This is the name of credential. This is just for your reference.
@@ -20,21 +18,15 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param provider [String]
     # @param authentication_plan [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749.
     # @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::CreateWebhookCredentialDto]
-    def initialize(provider:, authentication_plan:, name: OMIT, additional_properties: nil)
-      @provider = provider
+    def initialize(authentication_plan:, name: OMIT, additional_properties: nil)
       @authentication_plan = authentication_plan
       @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = {
-        "provider": provider,
-        "authenticationPlan": authentication_plan,
-        "name": name
-      }.reject do |_k, v|
+      @_field_set = { "authenticationPlan": authentication_plan, "name": name }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -46,7 +38,6 @@ 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"]
       if parsed_json["authenticationPlan"].nil?
         authentication_plan = nil
       else
@@ -55,7 +46,6 @@ module Vapi
       end
       name = parsed_json["name"]
       new(
-        provider: provider,
         authentication_plan: authentication_plan,
         name: name,
         additional_properties: struct
@@ -76,7 +66,6 @@ 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.")
       Vapi::OAuth2AuthenticationPlan.validate_raw(obj: obj.authentication_plan)
       obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/create_workflow_dto.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative "create_workflow_dto_nodes_item"
+require_relative "edge"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateWorkflowDto
+    # @return [String]
+    attr_reader :type
+    # @return [Array<Vapi::CreateWorkflowDtoNodesItem>]
+    attr_reader :nodes
+    # @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::CreateWorkflowDtoNodesItem>]
+    # @param name [String]
+    # @param edges [Array<Vapi::Edge>]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateWorkflowDto]
+    def initialize(type:, nodes:, name:, edges:, additional_properties: nil)
+      @type = type
+      @nodes = nodes
+      @name = name
+      @edges = edges
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "nodes": nodes, "name": name, "edges": edges }
+    end
+
+    # Deserialize a JSON object to an instance of CreateWorkflowDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWorkflowDto]
+    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::CreateWorkflowDtoNodesItem.from_json(json_object: item)
+      end
+      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,
+        name: name,
+        edges: edges,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateWorkflowDto 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.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/create_workflow_dto_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 CreateWorkflowDtoNodesItem
+    # Deserialize a JSON object to an instance of CreateWorkflowDtoNodesItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWorkflowDtoNodesItem]
+    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

data/lib/vapi_server_sdk/types/create_x_ai_credential_dto.rb

@@ -5,9 +5,6 @@ require "json"
 
 module Vapi
   class CreateXAiCredentialDto
-    # @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::CreateXAiCredentialDto]
-    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
-      @provider = provider
+    def initialize(api_key:, name: OMIT, additional_properties: nil)
       @api_key = api_key
       @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,7 +60,6 @@ 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/custom_knowledge_base.rb

@@ -6,8 +6,7 @@ require "json"
 
 module Vapi
   class CustomKnowledgeBase
-    # @return [Vapi::Server] /**
-    #  This is where the knowledge base request will be sent.
+    # @return [Vapi::Server] This is where the knowledge base request will be sent.
     #  Request Example:
     #  POST https://{server.url}
     #  Content-Type: application/json
@@ -58,8 +57,7 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param server [Vapi::Server] /**
-    #  This is where the knowledge base request will be sent.
+    # @param server [Vapi::Server] This is where the knowledge base request will be sent.
     #  Request Example:
     #  POST https://{server.url}
     #  Content-Type: application/json

data/lib/vapi_server_sdk/types/deep_seek_credential.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class DeepSeekCredential
+    # @return [String]
+    attr_reader :provider
+    # @return [String] This is not returned in the API.
+    attr_reader :api_key
+    # @return [String] This is the unique identifier for the credential.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the org that this credential belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    attr_reader :updated_at
+    # @return [String] This is the name of credential. 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 provider [String]
+    # @param api_key [String] This is not returned in the API.
+    # @param id [String] This is the unique identifier for the credential.
+    # @param org_id [String] This is the unique identifier for the org that this credential belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the credential was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the assistant was last updated.
+    # @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::DeepSeekCredential]
+    def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, name: OMIT, additional_properties: nil)
+      @provider = provider
+      @api_key = api_key
+      @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 = {
+        "provider": provider,
+        "apiKey": api_key,
+        "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 DeepSeekCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::DeepSeekCredential]
+    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"]
+      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(
+        provider: provider,
+        api_key: api_key,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of DeepSeekCredential 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.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.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