vapi_server_sdk 0.1.0 → 0.2.0

data/lib/vapi_server_sdk/types/create_open_router_credential_dto.rb

@@ -9,6 +9,8 @@ module Vapi
     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.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -19,13 +21,17 @@ module Vapi
 
     # @param provider [String]
     # @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::CreateOpenRouterCredentialDto]
-    def initialize(provider:, api_key:, additional_properties: nil)
+    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
       @provider = provider
       @api_key = api_key
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key }
+      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CreateOpenRouterCredentialDto
@@ -37,9 +43,11 @@ module Vapi
       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
       )
     end
@@ -60,6 +68,7 @@ module Vapi
     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
   end
 end

data/lib/vapi_server_sdk/types/create_org_dto.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "create_org_dto_channel"
 require "ostruct"
 require "json"
 
@@ -13,8 +14,13 @@ module Vapi
     #  This is due to the compliance requirements of HIPAA. Other providers may not
     #  meet these requirements.
     attr_reader :hipaa_enabled
+    # @return [String] This is the ID of the subscription the org belongs to.
+    attr_reader :subscription_id
     # @return [String] This is the name of the org. This is just for your own reference.
     attr_reader :name
+    # @return [Vapi::CreateOrgDtoChannel] This is the channel of the org. There is the cluster the API traffic for the org
+    #  will be directed.
+    attr_reader :channel
     # @return [Float] This is the monthly billing limit for the org. To go beyond $1000/mo, please
     #  contact us at support@vapi.ai.
     attr_reader :billing_limit
@@ -45,7 +51,10 @@ module Vapi
     #  available for LLM and Voice respectively.
     #  This is due to the compliance requirements of HIPAA. Other providers may not
     #  meet these requirements.
+    # @param subscription_id [String] This is the ID of the subscription the org belongs to.
     # @param name [String] This is the name of the org. This is just for your own reference.
+    # @param channel [Vapi::CreateOrgDtoChannel] This is the channel of the org. There is the cluster the API traffic for the org
+    #  will be directed.
     # @param billing_limit [Float] This is the monthly billing limit for the org. To go beyond $1000/mo, please
     #  contact us at support@vapi.ai.
     # @param server_url [String] This is the URL Vapi will communicate with via HTTP GET and POST Requests. This
@@ -59,10 +68,12 @@ module Vapi
     #  support@vapi.ai.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::CreateOrgDto]
-    def initialize(hipaa_enabled: OMIT, name: OMIT, billing_limit: OMIT, server_url: OMIT, server_url_secret: OMIT,
-                   concurrency_limit: OMIT, additional_properties: nil)
+    def initialize(hipaa_enabled: OMIT, subscription_id: OMIT, name: OMIT, channel: OMIT, billing_limit: OMIT,
+                   server_url: OMIT, server_url_secret: OMIT, concurrency_limit: OMIT, additional_properties: nil)
       @hipaa_enabled = hipaa_enabled if hipaa_enabled != OMIT
+      @subscription_id = subscription_id if subscription_id != OMIT
       @name = name if name != OMIT
+      @channel = channel if channel != OMIT
       @billing_limit = billing_limit if billing_limit != OMIT
       @server_url = server_url if server_url != OMIT
       @server_url_secret = server_url_secret if server_url_secret != OMIT
@@ -70,7 +81,9 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "hipaaEnabled": hipaa_enabled,
+        "subscriptionId": subscription_id,
         "name": name,
+        "channel": channel,
         "billingLimit": billing_limit,
         "serverUrl": server_url,
         "serverUrlSecret": server_url_secret,
@@ -88,14 +101,18 @@ module Vapi
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
       hipaa_enabled = parsed_json["hipaaEnabled"]
+      subscription_id = parsed_json["subscriptionId"]
       name = parsed_json["name"]
+      channel = parsed_json["channel"]
       billing_limit = parsed_json["billingLimit"]
       server_url = parsed_json["serverUrl"]
       server_url_secret = parsed_json["serverUrlSecret"]
       concurrency_limit = parsed_json["concurrencyLimit"]
       new(
         hipaa_enabled: hipaa_enabled,
+        subscription_id: subscription_id,
         name: name,
+        channel: channel,
         billing_limit: billing_limit,
         server_url: server_url,
         server_url_secret: server_url_secret,
@@ -119,7 +136,9 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.hipaa_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.hipaa_enabled is not the expected type, validation failed.")
+      obj.subscription_id&.is_a?(String) != false || raise("Passed value for field obj.subscription_id 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.channel&.is_a?(Vapi::CreateOrgDtoChannel) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
       obj.billing_limit&.is_a?(Float) != false || raise("Passed value for field obj.billing_limit 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.")

data/lib/vapi_server_sdk/types/create_org_dto_channel.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the channel of the org. There is the cluster the API traffic for the org
+  #  will be directed.
+  class CreateOrgDtoChannel
+    DEFAULT = "default"
+    WEEKLY = "weekly"
+  end
+end

data/lib/vapi_server_sdk/types/create_perplexity_ai_credential_dto.rb

@@ -9,6 +9,8 @@ module Vapi
     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.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -19,13 +21,17 @@ module Vapi
 
     # @param provider [String]
     # @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::CreatePerplexityAiCredentialDto]
-    def initialize(provider:, api_key:, additional_properties: nil)
+    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
       @provider = provider
       @api_key = api_key
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key }
+      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CreatePerplexityAiCredentialDto
@@ -37,9 +43,11 @@ module Vapi
       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
       )
     end
@@ -60,6 +68,7 @@ module Vapi
     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
   end
 end

data/lib/vapi_server_sdk/types/create_play_ht_credential_dto.rb

@@ -11,6 +11,8 @@ module Vapi
     attr_reader :api_key
     # @return [String]
     attr_reader :user_id
+    # @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]
@@ -22,14 +24,18 @@ module Vapi
     # @param provider [String]
     # @param api_key [String] This is not returned in the API.
     # @param user_id [String]
+    # @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::CreatePlayHtCredentialDto]
-    def initialize(provider:, api_key:, user_id:, additional_properties: nil)
+    def initialize(provider:, api_key:, user_id:, name: OMIT, additional_properties: nil)
       @provider = provider
       @api_key = api_key
       @user_id = user_id
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key, "userId": user_id }
+      @_field_set = { "provider": provider, "apiKey": api_key, "userId": user_id, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CreatePlayHtCredentialDto
@@ -42,10 +48,12 @@ module Vapi
       provider = parsed_json["provider"]
       api_key = parsed_json["apiKey"]
       user_id = parsed_json["userId"]
+      name = parsed_json["name"]
       new(
         provider: provider,
         api_key: api_key,
         user_id: user_id,
+        name: name,
         additional_properties: struct
       )
     end
@@ -67,6 +75,7 @@ module Vapi
       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.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id 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

data/lib/vapi_server_sdk/types/create_rime_ai_credential_dto.rb

@@ -9,6 +9,8 @@ module Vapi
     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.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -19,13 +21,17 @@ module Vapi
 
     # @param provider [String]
     # @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::CreateRimeAiCredentialDto]
-    def initialize(provider:, api_key:, additional_properties: nil)
+    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
       @provider = provider
       @api_key = api_key
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key }
+      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CreateRimeAiCredentialDto
@@ -37,9 +43,11 @@ module Vapi
       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
       )
     end
@@ -60,6 +68,7 @@ module Vapi
     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
   end
 end

data/lib/vapi_server_sdk/types/create_runpod_credential_dto.rb

@@ -9,6 +9,8 @@ module Vapi
     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.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -19,13 +21,17 @@ module Vapi
 
     # @param provider [String]
     # @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::CreateRunpodCredentialDto]
-    def initialize(provider:, api_key:, additional_properties: nil)
+    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
       @provider = provider
       @api_key = api_key
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "apiKey": api_key }
+      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CreateRunpodCredentialDto
@@ -37,9 +43,11 @@ module Vapi
       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
       )
     end
@@ -60,6 +68,7 @@ module Vapi
     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
   end
 end

data/lib/vapi_server_sdk/types/create_s_3_credential_dto.rb

@@ -17,6 +17,8 @@ module Vapi
     attr_reader :s_3_bucket_name
     # @return [String] The path prefix for the uploaded recording. Ex. "recordings/"
     attr_reader :s_3_path_prefix
+    # @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]
@@ -31,16 +33,18 @@ module Vapi
     # @param region [String] AWS region in which the S3 bucket is located.
     # @param s_3_bucket_name [String] AWS S3 bucket name.
     # @param s_3_path_prefix [String] The path prefix for the uploaded recording. Ex. "recordings/"
+    # @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::CreateS3CredentialDto]
     def initialize(provider:, aws_access_key_id:, aws_secret_access_key:, region:, s_3_bucket_name:, s_3_path_prefix:,
-                   additional_properties: nil)
+                   name: OMIT, additional_properties: nil)
       @provider = provider
       @aws_access_key_id = aws_access_key_id
       @aws_secret_access_key = aws_secret_access_key
       @region = region
       @s_3_bucket_name = s_3_bucket_name
       @s_3_path_prefix = s_3_path_prefix
+      @name = name if name != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "provider": provider,
@@ -48,8 +52,11 @@ module Vapi
         "awsSecretAccessKey": aws_secret_access_key,
         "region": region,
         "s3BucketName": s_3_bucket_name,
-        "s3PathPrefix": s_3_path_prefix
-      }
+        "s3PathPrefix": s_3_path_prefix,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of CreateS3CredentialDto
@@ -65,6 +72,7 @@ module Vapi
       region = parsed_json["region"]
       s_3_bucket_name = parsed_json["s3BucketName"]
       s_3_path_prefix = parsed_json["s3PathPrefix"]
+      name = parsed_json["name"]
       new(
         provider: provider,
         aws_access_key_id: aws_access_key_id,
@@ -72,6 +80,7 @@ module Vapi
         region: region,
         s_3_bucket_name: s_3_bucket_name,
         s_3_path_prefix: s_3_path_prefix,
+        name: name,
         additional_properties: struct
       )
     end
@@ -96,6 +105,7 @@ module Vapi
       obj.region.is_a?(String) != false || raise("Passed value for field obj.region is not the expected type, validation failed.")
       obj.s_3_bucket_name.is_a?(String) != false || raise("Passed value for field obj.s_3_bucket_name is not the expected type, validation failed.")
       obj.s_3_path_prefix.is_a?(String) != false || raise("Passed value for field obj.s_3_path_prefix 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

data/lib/vapi_server_sdk/types/{knowledge_base.rb → create_tavus_credential_dto.rb}

@@ -4,13 +4,13 @@ require "ostruct"
 require "json"
 
 module Vapi
-  class KnowledgeBase
+  class CreateTavusCredentialDto
     # @return [String]
     attr_reader :provider
-    # @return [Float]
-    attr_reader :top_k
-    # @return [Array<String>]
-    attr_reader :file_ids
+    # @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.
+    attr_reader :name
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -20,39 +20,39 @@ module Vapi
     OMIT = Object.new
 
     # @param provider [String]
-    # @param top_k [Float]
-    # @param file_ids [Array<String>]
+    # @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::KnowledgeBase]
-    def initialize(provider:, file_ids:, top_k: OMIT, additional_properties: nil)
+    # @return [Vapi::CreateTavusCredentialDto]
+    def initialize(provider:, api_key:, name: OMIT, additional_properties: nil)
       @provider = provider
-      @top_k = top_k if top_k != OMIT
-      @file_ids = file_ids
+      @api_key = api_key
+      @name = name if name != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "provider": provider, "topK": top_k, "fileIds": file_ids }.reject do |_k, v|
+      @_field_set = { "provider": provider, "apiKey": api_key, "name": name }.reject do |_k, v|
         v == OMIT
       end
     end
 
-    # Deserialize a JSON object to an instance of KnowledgeBase
+    # Deserialize a JSON object to an instance of CreateTavusCredentialDto
     #
     # @param json_object [String]
-    # @return [Vapi::KnowledgeBase]
+    # @return [Vapi::CreateTavusCredentialDto]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
       provider = parsed_json["provider"]
-      top_k = parsed_json["topK"]
-      file_ids = parsed_json["fileIds"]
+      api_key = parsed_json["apiKey"]
+      name = parsed_json["name"]
       new(
         provider: provider,
-        top_k: top_k,
-        file_ids: file_ids,
+        api_key: api_key,
+        name: name,
         additional_properties: struct
       )
     end
 
-    # Serialize an instance of KnowledgeBase to a JSON object
+    # Serialize an instance of CreateTavusCredentialDto to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -67,8 +67,8 @@ module Vapi
     # @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.top_k&.is_a?(Float) != false || raise("Passed value for field obj.top_k is not the expected type, validation failed.")
-      obj.file_ids.is_a?(Array) != false || raise("Passed value for field obj.file_ids 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
 end

data/lib/vapi_server_sdk/types/create_text_editor_tool_dto.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative "create_text_editor_tool_dto_messages_item"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateTextEditorToolDto
+    # @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::CreateTextEditorToolDtoMessagesItem>] 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 [String] The sub type of tool.
+    attr_reader :sub_type
+    # @return [String] The name of the tool, fixed to 'str_replace_editor'
+    attr_reader :name
+    # @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::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]
+    attr_reader :_field_set
+    protected :_field_set
+
+    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::CreateTextEditorToolDtoMessagesItem>] 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 sub_type [String] The sub type of tool.
+    # @param name [String] The name of the tool, fixed to 'str_replace_editor'
+    # @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 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::CreateTextEditorToolDto]
+    def initialize(sub_type:, name:, async: OMIT, messages: OMIT, function: OMIT, server: OMIT,
+                   additional_properties: nil)
+      @async = async if async != OMIT
+      @messages = messages if messages != OMIT
+      @sub_type = sub_type
+      @name = name
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "subType": sub_type,
+        "name": name,
+        "function": function,
+        "server": server
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateTextEditorToolDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateTextEditorToolDto]
+    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::CreateTextEditorToolDtoMessagesItem.from_json(json_object: item)
+      end
+      sub_type = parsed_json["subType"]
+      name = parsed_json["name"]
+      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["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,
+        sub_type: sub_type,
+        name: name,
+        function: function,
+        server: server,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateTextEditorToolDto 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.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.")
+      obj.sub_type.is_a?(String) != false || raise("Passed value for field obj.sub_type 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.function.nil? || Vapi::OpenAiFunction.validate_raw(obj: obj.function)
+      obj.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
+    end
+  end
+end