vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/make_tool_with_tool_call.rb

@@ -4,19 +4,11 @@ require_relative "make_tool_with_tool_call_messages_item"
 require_relative "tool_call"
 require_relative "make_tool_metadata"
 require_relative "open_ai_function"
-require_relative "server"
 require "ostruct"
 require "json"
 
 module Vapi
   class MakeToolWithToolCall
-    # @return [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
-    attr_reader :async
     # @return [Array<Vapi::MakeToolWithToolCallMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
     #  For some tools, this is auto-filled based on special fields like
     #  `tool.destinations`. For others like the function tool, these can be custom
@@ -36,13 +28,6 @@ module Vapi
     #  "request-complete" messages. One of these messages will be triggered if the
     #  `messages[].conditions` matches the "reason" argument.
     attr_reader :function
-    # @return [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
-    attr_reader :server
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -51,12 +36,6 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param async [Boolean] This determines if the tool is async.
-    #  If async, the assistant will move forward without waiting for your server to
-    #  respond. This is useful if you just want to trigger something on your server.
-    #  If sync, the assistant will wait for your server to respond. This is useful if
-    #  want assistant to respond with the result from your server.
-    #  Defaults to synchronous (`false`).
     # @param messages [Array<Vapi::MakeToolWithToolCallMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
     #  For some tools, this is auto-filled based on special fields like
     #  `tool.destinations`. For others like the function tool, these can be custom
@@ -72,30 +51,19 @@ module Vapi
     #  argument "reason". Then, in `messages` array, you can have many
     #  "request-complete" messages. One of these messages will be triggered if the
     #  `messages[].conditions` matches the "reason" argument.
-    # @param server [Vapi::Server] This is the server that will be hit when this tool is requested by the model.
-    #  All requests will be sent with the call object among other things. You can find
-    #  more details in the Server URL documentation.
-    #  This overrides the serverUrl set on the org and the phoneNumber. Order of
-    #  precedence: highest tool.server.url, then assistant.serverUrl, then
-    #  phoneNumber.serverUrl, then org.serverUrl.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::MakeToolWithToolCall]
-    def initialize(tool_call:, metadata:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
-                   additional_properties: nil)
-      @async = async if async != OMIT
+    def initialize(tool_call:, metadata:, messages: OMIT, function: OMIT, additional_properties: nil)
       @messages = messages if messages != OMIT
       @tool_call = tool_call
       @metadata = metadata
       @function = function if function != OMIT
-      @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "async": async,
         "messages": messages,
         "toolCall": tool_call,
         "metadata": metadata,
-        "function": function,
-        "server": server
+        "function": function
       }.reject do |_k, v|
         v == OMIT
       end
@@ -108,7 +76,6 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      async = parsed_json["async"]
       messages = parsed_json["messages"]&.map do |item|
         item = item.to_json
         Vapi::MakeToolWithToolCallMessagesItem.from_json(json_object: item)
@@ -131,19 +98,11 @@ module Vapi
         function = parsed_json["function"].to_json
         function = Vapi::OpenAiFunction.from_json(json_object: function)
       end
-      if parsed_json["server"].nil?
-        server = nil
-      else
-        server = parsed_json["server"].to_json
-        server = Vapi::Server.from_json(json_object: server)
-      end
       new(
-        async: async,
         messages: messages,
         tool_call: tool_call,
         metadata: metadata,
         function: function,
-        server: server,
         additional_properties: struct
       )
     end
@@ -162,12 +121,10 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.async&.is_a?(Boolean) != false || raise("Passed value for field obj.async is not the expected type, validation failed.")
       obj.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
       Vapi::ToolCall.validate_raw(obj: obj.tool_call)
       Vapi::MakeToolMetadata.validate_raw(obj: obj.metadata)
       obj.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
-      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
     end
   end
 end

data/lib/vapi_server_sdk/types/mcp_tool.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require_relative "mcp_tool_messages_item"
+require_relative "server"
+require "date"
+require_relative "open_ai_function"
+require_relative "mcp_tool_metadata"
+require "ostruct"
+require "json"
+
+module Vapi
+  class McpTool
+    # @return [Array<Vapi::McpToolMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
+    #  For some tools, this is auto-filled based on special fields like
+    #  `tool.destinations`. For others like the function tool, these can be custom
+    #  configured.
+    attr_reader :messages
+    # @return [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
+    attr_reader :server
+    # @return [String] This is the unique identifier for the tool.
+    attr_reader :id
+    # @return [String] This is the unique identifier for the organization that this tool belongs to.
+    attr_reader :org_id
+    # @return [DateTime] This is the ISO 8601 date-time string of when the tool was created.
+    attr_reader :created_at
+    # @return [DateTime] This is the ISO 8601 date-time string of when the tool was last updated.
+    attr_reader :updated_at
+    # @return [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  argument "reason". Then, in `messages` array, you can have many
+    #  "request-complete" messages. One of these messages will be triggered if the
+    #  `messages[].conditions` matches the "reason" argument.
+    attr_reader :function
+    # @return [Vapi::McpToolMetadata]
+    attr_reader :metadata
+    # @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 messages [Array<Vapi::McpToolMessagesItem>] These are the messages that will be spoken to the user as the tool is running.
+    #  For some tools, this is auto-filled based on special fields like
+    #  `tool.destinations`. For others like the function tool, these can be custom
+    #  configured.
+    # @param server [Vapi::Server]
+    #  This is the server where a `tool-calls` webhook will be sent.
+    #  Notes:
+    #  - Webhook is sent to this server when a tool call is made.
+    #  - Webhook contains the call, assistant, and phone number objects.
+    #  - Webhook contains the variables set on the assistant.
+    #  - Webhook is sent to the first available URL in this order:
+    #  {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}},
+    #  {{org.server.url}}.
+    #  - Webhook expects a response with tool call result.
+    # @param id [String] This is the unique identifier for the tool.
+    # @param org_id [String] This is the unique identifier for the organization that this tool belongs to.
+    # @param created_at [DateTime] This is the ISO 8601 date-time string of when the tool was created.
+    # @param updated_at [DateTime] This is the ISO 8601 date-time string of when the tool was last updated.
+    # @param function [Vapi::OpenAiFunction] This is the function definition of the tool.
+    #  For `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on
+    #  tool-specific fields like `tool.destinations`. But, even in those cases, you can
+    #  provide a custom function definition for advanced use cases.
+    #  An example of an advanced use case is if you want to customize the message
+    #  that's spoken for `endCall` tool. You can specify a function where it returns an
+    #  argument "reason". Then, in `messages` array, you can have many
+    #  "request-complete" messages. One of these messages will be triggered if the
+    #  `messages[].conditions` matches the "reason" argument.
+    # @param metadata [Vapi::McpToolMetadata]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::McpTool]
+    def initialize(id:, org_id:, created_at:, updated_at:, messages: OMIT, server: OMIT, function: OMIT,
+                   metadata: OMIT, additional_properties: nil)
+      @messages = messages if messages != OMIT
+      @server = server if server != OMIT
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @function = function if function != OMIT
+      @metadata = metadata if metadata != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "messages": messages,
+        "server": server,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "function": function,
+        "metadata": metadata
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of McpTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::McpTool]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      messages = parsed_json["messages"]&.map do |item|
+        item = item.to_json
+        Vapi::McpToolMessagesItem.from_json(json_object: item)
+      end
+      if parsed_json["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      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?)
+      if parsed_json["function"].nil?
+        function = nil
+      else
+        function = parsed_json["function"].to_json
+        function = Vapi::OpenAiFunction.from_json(json_object: function)
+      end
+      if parsed_json["metadata"].nil?
+        metadata = nil
+      else
+        metadata = parsed_json["metadata"].to_json
+        metadata = Vapi::McpToolMetadata.from_json(json_object: metadata)
+      end
+      new(
+        messages: messages,
+        server: server,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        function: function,
+        metadata: metadata,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of McpTool 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.messages&.is_a?(Array) != false || raise("Passed value for field obj.messages is not the expected type, validation failed.")
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
+      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.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
+      obj.metadata.nil? || Vapi::McpToolMetadata.validate_raw(obj: obj.metadata)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/{tool_call_result_message_item.rb → mcp_tool_messages_item.rb}

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require "json"
+require_relative "tool_message_start"
 require_relative "tool_message_complete"
 require_relative "tool_message_failed"
+require_relative "tool_message_delayed"
 
 module Vapi
-  class ToolCallResultMessageItem
+  class McpToolMessagesItem
     # @return [Object]
     attr_reader :member
     # @return [String]
@@ -16,25 +18,29 @@ module Vapi
 
     # @param member [Object]
     # @param discriminant [String]
-    # @return [Vapi::ToolCallResultMessageItem]
+    # @return [Vapi::McpToolMessagesItem]
     def initialize(member:, discriminant:)
       @member = member
       @discriminant = discriminant
     end
 
-    # Deserialize a JSON object to an instance of ToolCallResultMessageItem
+    # Deserialize a JSON object to an instance of McpToolMessagesItem
     #
     # @param json_object [String]
-    # @return [Vapi::ToolCallResultMessageItem]
+    # @return [Vapi::McpToolMessagesItem]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       member = case struct.type
+               when "request-start"
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
                when "request-complete"
                  Vapi::ToolMessageComplete.from_json(json_object: json_object)
                when "request-failed"
                  Vapi::ToolMessageFailed.from_json(json_object: json_object)
+               when "request-response-delayed"
+                 Vapi::ToolMessageDelayed.from_json(json_object: json_object)
                else
-                 Vapi::ToolMessageComplete.from_json(json_object: json_object)
+                 Vapi::ToolMessageStart.from_json(json_object: json_object)
                end
       new(member: member, discriminant: struct.type)
     end
@@ -44,10 +50,14 @@ module Vapi
     # @return [String]
     def to_json(*_args)
       case @discriminant
+      when "request-start"
+        { **@member.to_json, type: @discriminant }.to_json
       when "request-complete"
         { **@member.to_json, type: @discriminant }.to_json
       when "request-failed"
         { **@member.to_json, type: @discriminant }.to_json
+      when "request-response-delayed"
+        { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
       end
@@ -62,10 +72,14 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       case obj.type
+      when "request-start"
+        Vapi::ToolMessageStart.validate_raw(obj: obj)
       when "request-complete"
         Vapi::ToolMessageComplete.validate_raw(obj: obj)
       when "request-failed"
         Vapi::ToolMessageFailed.validate_raw(obj: obj)
+      when "request-response-delayed"
+        Vapi::ToolMessageDelayed.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -79,16 +93,28 @@ module Vapi
       @member.is_a?(obj)
     end
 
+    # @param member [Vapi::ToolMessageStart]
+    # @return [Vapi::McpToolMessagesItem]
+    def self.request_start(member:)
+      new(member: member, discriminant: "request-start")
+    end
+
     # @param member [Vapi::ToolMessageComplete]
-    # @return [Vapi::ToolCallResultMessageItem]
+    # @return [Vapi::McpToolMessagesItem]
     def self.request_complete(member:)
       new(member: member, discriminant: "request-complete")
     end
 
     # @param member [Vapi::ToolMessageFailed]
-    # @return [Vapi::ToolCallResultMessageItem]
+    # @return [Vapi::McpToolMessagesItem]
     def self.request_failed(member:)
       new(member: member, discriminant: "request-failed")
     end
+
+    # @param member [Vapi::ToolMessageDelayed]
+    # @return [Vapi::McpToolMessagesItem]
+    def self.request_response_delayed(member:)
+      new(member: member, discriminant: "request-response-delayed")
+    end
   end
 end

data/lib/vapi_server_sdk/types/mcp_tool_metadata.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "mcp_tool_metadata_protocol"
+require "ostruct"
+require "json"
+
+module Vapi
+  class McpToolMetadata
+    # @return [Vapi::McpToolMetadataProtocol] This is the protocol used for MCP communication. Defaults to Streamable HTTP.
+    attr_reader :protocol
+    # @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 protocol [Vapi::McpToolMetadataProtocol] This is the protocol used for MCP communication. Defaults to Streamable HTTP.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::McpToolMetadata]
+    def initialize(protocol: OMIT, additional_properties: nil)
+      @protocol = protocol if protocol != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "protocol": protocol }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of McpToolMetadata
+    #
+    # @param json_object [String]
+    # @return [Vapi::McpToolMetadata]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      protocol = parsed_json["protocol"]
+      new(protocol: protocol, additional_properties: struct)
+    end
+
+    # Serialize an instance of McpToolMetadata 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.protocol&.is_a?(Vapi::McpToolMetadataProtocol) != false || raise("Passed value for field obj.protocol is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/mcp_tool_metadata_protocol.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the protocol used for MCP communication. Defaults to Streamable HTTP.
+  class McpToolMetadataProtocol
+    SSE = "sse"
+    SHTTP = "shttp"
+  end
+end

data/lib/vapi_server_sdk/types/message_plan.rb

@@ -20,6 +20,10 @@ module Vapi
     #  the call.
     #  @default 3
     attr_reader :idle_message_max_spoken_count
+    # @return [Boolean] This determines whether the idle message count is reset whenever the user
+    #  speaks.
+    #  @default false
+    attr_reader :idle_message_reset_count_on_user_speech_enabled
     # @return [Float] This is the timeout in seconds before a message from `idleMessages` is spoken.
     #  The clock starts when the assistant finishes speaking and remains active until
     #  the user speaks.
@@ -49,6 +53,9 @@ module Vapi
     # @param idle_message_max_spoken_count [Float] This determines the maximum number of times `idleMessages` can be spoken during
     #  the call.
     #  @default 3
+    # @param idle_message_reset_count_on_user_speech_enabled [Boolean] This determines whether the idle message count is reset whenever the user
+    #  speaks.
+    #  @default false
     # @param idle_timeout_seconds [Float] This is the timeout in seconds before a message from `idleMessages` is spoken.
     #  The clock starts when the assistant finishes speaking and remains active until
     #  the user speaks.
@@ -57,16 +64,20 @@ module Vapi
     #  If unspecified, it will hang up without saying anything.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::MessagePlan]
-    def initialize(idle_messages: OMIT, idle_message_max_spoken_count: OMIT, idle_timeout_seconds: OMIT,
-                   silence_timeout_message: OMIT, additional_properties: nil)
+    def initialize(idle_messages: OMIT, idle_message_max_spoken_count: OMIT,
+                   idle_message_reset_count_on_user_speech_enabled: OMIT, idle_timeout_seconds: OMIT, silence_timeout_message: OMIT, additional_properties: nil)
       @idle_messages = idle_messages if idle_messages != OMIT
       @idle_message_max_spoken_count = idle_message_max_spoken_count if idle_message_max_spoken_count != OMIT
+      if idle_message_reset_count_on_user_speech_enabled != OMIT
+        @idle_message_reset_count_on_user_speech_enabled = idle_message_reset_count_on_user_speech_enabled
+      end
       @idle_timeout_seconds = idle_timeout_seconds if idle_timeout_seconds != OMIT
       @silence_timeout_message = silence_timeout_message if silence_timeout_message != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "idleMessages": idle_messages,
         "idleMessageMaxSpokenCount": idle_message_max_spoken_count,
+        "idleMessageResetCountOnUserSpeechEnabled": idle_message_reset_count_on_user_speech_enabled,
         "idleTimeoutSeconds": idle_timeout_seconds,
         "silenceTimeoutMessage": silence_timeout_message
       }.reject do |_k, v|
@@ -83,11 +94,13 @@ module Vapi
       parsed_json = JSON.parse(json_object)
       idle_messages = parsed_json["idleMessages"]
       idle_message_max_spoken_count = parsed_json["idleMessageMaxSpokenCount"]
+      idle_message_reset_count_on_user_speech_enabled = parsed_json["idleMessageResetCountOnUserSpeechEnabled"]
       idle_timeout_seconds = parsed_json["idleTimeoutSeconds"]
       silence_timeout_message = parsed_json["silenceTimeoutMessage"]
       new(
         idle_messages: idle_messages,
         idle_message_max_spoken_count: idle_message_max_spoken_count,
+        idle_message_reset_count_on_user_speech_enabled: idle_message_reset_count_on_user_speech_enabled,
         idle_timeout_seconds: idle_timeout_seconds,
         silence_timeout_message: silence_timeout_message,
         additional_properties: struct
@@ -110,6 +123,7 @@ module Vapi
     def self.validate_raw(obj:)
       obj.idle_messages&.is_a?(Array) != false || raise("Passed value for field obj.idle_messages is not the expected type, validation failed.")
       obj.idle_message_max_spoken_count&.is_a?(Float) != false || raise("Passed value for field obj.idle_message_max_spoken_count is not the expected type, validation failed.")
+      obj.idle_message_reset_count_on_user_speech_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.idle_message_reset_count_on_user_speech_enabled is not the expected type, validation failed.")
       obj.idle_timeout_seconds&.is_a?(Float) != false || raise("Passed value for field obj.idle_timeout_seconds is not the expected type, validation failed.")
       obj.silence_timeout_message&.is_a?(String) != false || raise("Passed value for field obj.silence_timeout_message is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/mistral_credential.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module Vapi
+  class MistralCredential
+    # @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::MistralCredential]
+    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 MistralCredential
+    #
+    # @param json_object [String]
+    # @return [Vapi::MistralCredential]
+    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 MistralCredential 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