vapi_server_sdk 0.1.0 → 0.3.0

data/lib/vapi_server_sdk/types/azure_credential_region.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the region of the Azure resource.
+  class AzureCredentialRegion
+    AUSTRALIA = "australia"
+    CANADA = "canada"
+    EASTUS_2 = "eastus2"
+    EASTUS = "eastus"
+    FRANCE = "france"
+    INDIA = "india"
+    JAPAN = "japan"
+    UAENORTH = "uaenorth"
+    NORTHCENTRALUS = "northcentralus"
+    NORWAY = "norway"
+    SOUTHCENTRALUS = "southcentralus"
+    SWEDENCENTRAL = "swedencentral"
+    SWITZERLAND = "switzerland"
+    UK = "uk"
+    WESTUS = "westus"
+    WESTUS_3 = "westus3"
+  end
+end

data/lib/vapi_server_sdk/types/azure_credential_service.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the service being used in Azure.
+  class AzureCredentialService
+    SPEECH = "speech"
+    BLOB_STORAGE = "blob_storage"
+  end
+end

data/lib/vapi_server_sdk/types/azure_open_ai_credential.rb

@@ -16,6 +16,8 @@ module Vapi
     attr_reader :models
     # @return [String] This is not returned in the API.
     attr_reader :open_ai_key
+    # @return [String] This is not returned in the API.
+    attr_reader :ocp_apim_subscription_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.
@@ -24,6 +26,8 @@ module Vapi
     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 [String]
     attr_reader :open_ai_endpoint
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -38,23 +42,27 @@ module Vapi
     # @param region [Vapi::AzureOpenAiCredentialRegion]
     # @param models [Array<Vapi::AzureOpenAiCredentialModelsItem>]
     # @param open_ai_key [String] This is not returned in the API.
+    # @param ocp_apim_subscription_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 open_ai_endpoint [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::AzureOpenAiCredential]
     def initialize(provider:, region:, models:, open_ai_key:, id:, org_id:, created_at:, updated_at:,
-                   open_ai_endpoint:, additional_properties: nil)
+                   open_ai_endpoint:, ocp_apim_subscription_key: OMIT, name: OMIT, additional_properties: nil)
       @provider = provider
       @region = region
       @models = models
       @open_ai_key = open_ai_key
+      @ocp_apim_subscription_key = ocp_apim_subscription_key if ocp_apim_subscription_key != OMIT
       @id = id
       @org_id = org_id
       @created_at = created_at
       @updated_at = updated_at
+      @name = name if name != OMIT
       @open_ai_endpoint = open_ai_endpoint
       @additional_properties = additional_properties
       @_field_set = {
@@ -62,12 +70,16 @@ module Vapi
         "region": region,
         "models": models,
         "openAIKey": open_ai_key,
+        "ocpApimSubscriptionKey": ocp_apim_subscription_key,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
         "updatedAt": updated_at,
+        "name": name,
         "openAIEndpoint": open_ai_endpoint
-      }
+      }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of AzureOpenAiCredential
@@ -81,20 +93,24 @@ module Vapi
       region = parsed_json["region"]
       models = parsed_json["models"]
       open_ai_key = parsed_json["openAIKey"]
+      ocp_apim_subscription_key = parsed_json["ocpApimSubscriptionKey"]
       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"]
       open_ai_endpoint = parsed_json["openAIEndpoint"]
       new(
         provider: provider,
         region: region,
         models: models,
         open_ai_key: open_ai_key,
+        ocp_apim_subscription_key: ocp_apim_subscription_key,
         id: id,
         org_id: org_id,
         created_at: created_at,
         updated_at: updated_at,
+        name: name,
         open_ai_endpoint: open_ai_endpoint,
         additional_properties: struct
       )
@@ -118,10 +134,12 @@ module Vapi
       obj.region.is_a?(Vapi::AzureOpenAiCredentialRegion) != false || raise("Passed value for field obj.region is not the expected type, validation failed.")
       obj.models.is_a?(Array) != false || raise("Passed value for field obj.models is not the expected type, validation failed.")
       obj.open_ai_key.is_a?(String) != false || raise("Passed value for field obj.open_ai_key is not the expected type, validation failed.")
+      obj.ocp_apim_subscription_key&.is_a?(String) != false || raise("Passed value for field obj.ocp_apim_subscription_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.")
       obj.open_ai_endpoint.is_a?(String) != false || raise("Passed value for field obj.open_ai_endpoint is not the expected type, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/azure_open_ai_credential_models_item.rb

@@ -2,6 +2,7 @@
 
 module Vapi
   class AzureOpenAiCredentialModelsItem
+    GPT_4_O_20240806 = "gpt-4o-2024-08-06"
     GPT_4_O_MINI_20240718 = "gpt-4o-mini-2024-07-18"
     GPT_4_O_20240513 = "gpt-4o-2024-05-13"
     GPT_4_TURBO_20240409 = "gpt-4-turbo-2024-04-09"

data/lib/vapi_server_sdk/types/azure_open_ai_credential_region.rb

@@ -9,10 +9,11 @@ module Vapi
     FRANCE = "france"
     INDIA = "india"
     JAPAN = "japan"
+    UAENORTH = "uaenorth"
     NORTHCENTRALUS = "northcentralus"
     NORWAY = "norway"
     SOUTHCENTRALUS = "southcentralus"
-    SWEDEN = "sweden"
+    SWEDENCENTRAL = "swedencentral"
     SWITZERLAND = "switzerland"
     UK = "uk"
     WESTUS = "westus"

data/lib/vapi_server_sdk/types/azure_speech_transcriber.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "azure_speech_transcriber_language"
+require "ostruct"
+require "json"
+
+module Vapi
+  class AzureSpeechTranscriber
+    # @return [Vapi::AzureSpeechTranscriberLanguage] This is the language that will be set for the transcription. The list of
+    #  languages Azure supports can be found here:
+    #  n.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt
+    attr_reader :language
+    # @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 language [Vapi::AzureSpeechTranscriberLanguage] This is the language that will be set for the transcription. The list of
+    #  languages Azure supports can be found here:
+    #  n.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::AzureSpeechTranscriber]
+    def initialize(language: OMIT, additional_properties: nil)
+      @language = language if language != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "language": language }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of AzureSpeechTranscriber
+    #
+    # @param json_object [String]
+    # @return [Vapi::AzureSpeechTranscriber]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      language = parsed_json["language"]
+      new(language: language, additional_properties: struct)
+    end
+
+    # Serialize an instance of AzureSpeechTranscriber 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.language&.is_a?(Vapi::AzureSpeechTranscriberLanguage) != false || raise("Passed value for field obj.language is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/azure_speech_transcriber_language.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the language that will be set for the transcription. The list of
+  #  languages Azure supports can be found here:
+  #  n.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt
+  class AzureSpeechTranscriberLanguage
+    AF_ZA = "af-ZA"
+    AM_ET = "am-ET"
+    AR_AE = "ar-AE"
+    AR_BH = "ar-BH"
+    AR_DZ = "ar-DZ"
+    AR_EG = "ar-EG"
+    AR_IL = "ar-IL"
+    AR_IQ = "ar-IQ"
+    AR_JO = "ar-JO"
+    AR_KW = "ar-KW"
+    AR_LB = "ar-LB"
+    AR_LY = "ar-LY"
+    AR_MA = "ar-MA"
+    AR_OM = "ar-OM"
+    AR_PS = "ar-PS"
+    AR_QA = "ar-QA"
+    AR_SA = "ar-SA"
+    AR_SY = "ar-SY"
+    AR_TN = "ar-TN"
+    AR_YE = "ar-YE"
+    AZ_AZ = "az-AZ"
+    BG_BG = "bg-BG"
+    BN_IN = "bn-IN"
+    BS_BA = "bs-BA"
+    CA_ES = "ca-ES"
+    CS_CZ = "cs-CZ"
+    CY_GB = "cy-GB"
+    DA_DK = "da-DK"
+    DE_AT = "de-AT"
+    DE_CH = "de-CH"
+    DE_DE = "de-DE"
+    EL_GR = "el-GR"
+    EN_AU = "en-AU"
+    EN_CA = "en-CA"
+    EN_GB = "en-GB"
+    EN_GH = "en-GH"
+    EN_HK = "en-HK"
+    EN_IE = "en-IE"
+    EN_IN = "en-IN"
+    EN_KE = "en-KE"
+    EN_NG = "en-NG"
+    EN_NZ = "en-NZ"
+    EN_PH = "en-PH"
+    EN_SG = "en-SG"
+    EN_TZ = "en-TZ"
+    EN_US = "en-US"
+    EN_ZA = "en-ZA"
+    ES_AR = "es-AR"
+    ES_BO = "es-BO"
+    ES_CL = "es-CL"
+    ES_CO = "es-CO"
+    ES_CR = "es-CR"
+    ES_CU = "es-CU"
+    ES_DO = "es-DO"
+    ES_EC = "es-EC"
+    ES_ES = "es-ES"
+    ES_GQ = "es-GQ"
+    ES_GT = "es-GT"
+    ES_HN = "es-HN"
+    ES_MX = "es-MX"
+    ES_NI = "es-NI"
+    ES_PA = "es-PA"
+    ES_PE = "es-PE"
+    ES_PR = "es-PR"
+    ES_PY = "es-PY"
+    ES_SV = "es-SV"
+    ES_US = "es-US"
+    ES_UY = "es-UY"
+    ES_VE = "es-VE"
+    ET_EE = "et-EE"
+    EU_ES = "eu-ES"
+    FA_IR = "fa-IR"
+    FI_FI = "fi-FI"
+    FIL_PH = "fil-PH"
+    FR_BE = "fr-BE"
+    FR_CA = "fr-CA"
+    FR_CH = "fr-CH"
+    FR_FR = "fr-FR"
+    GA_IE = "ga-IE"
+    GL_ES = "gl-ES"
+    GU_IN = "gu-IN"
+    HE_IL = "he-IL"
+    HI_IN = "hi-IN"
+    HR_HR = "hr-HR"
+    HU_HU = "hu-HU"
+    HY_AM = "hy-AM"
+    ID_ID = "id-ID"
+    IS_IS = "is-IS"
+    IT_CH = "it-CH"
+    IT_IT = "it-IT"
+    JA_JP = "ja-JP"
+    JV_ID = "jv-ID"
+    KA_GE = "ka-GE"
+    KK_KZ = "kk-KZ"
+    KM_KH = "km-KH"
+    KN_IN = "kn-IN"
+    KO_KR = "ko-KR"
+    LO_LA = "lo-LA"
+    LT_LT = "lt-LT"
+    LV_LV = "lv-LV"
+    MK_MK = "mk-MK"
+    ML_IN = "ml-IN"
+    MN_MN = "mn-MN"
+    MR_IN = "mr-IN"
+    MS_MY = "ms-MY"
+    MT_MT = "mt-MT"
+    MY_MM = "my-MM"
+    NB_NO = "nb-NO"
+    NE_NP = "ne-NP"
+    NL_BE = "nl-BE"
+    NL_NL = "nl-NL"
+    PA_IN = "pa-IN"
+    PL_PL = "pl-PL"
+    PS_AF = "ps-AF"
+    PT_BR = "pt-BR"
+    PT_PT = "pt-PT"
+    RO_RO = "ro-RO"
+    RU_RU = "ru-RU"
+    SI_LK = "si-LK"
+    SK_SK = "sk-SK"
+    SL_SI = "sl-SI"
+    SO_SO = "so-SO"
+    SQ_AL = "sq-AL"
+    SR_RS = "sr-RS"
+    SV_SE = "sv-SE"
+    SW_KE = "sw-KE"
+    SW_TZ = "sw-TZ"
+    TA_IN = "ta-IN"
+    TE_IN = "te-IN"
+    TH_TH = "th-TH"
+    TR_TR = "tr-TR"
+    UK_UA = "uk-UA"
+    UR_IN = "ur-IN"
+    UZ_UZ = "uz-UZ"
+    VI_VN = "vi-VN"
+    WUU_CN = "wuu-CN"
+    YUE_CN = "yue-CN"
+    ZH_CN = "zh-CN"
+    ZH_CN_SHANDONG = "zh-CN-shandong"
+    ZH_CN_SICHUAN = "zh-CN-sichuan"
+    ZH_HK = "zh-HK"
+    ZH_TW = "zh-TW"
+    ZU_ZA = "zu-ZA"
+  end
+end

data/lib/vapi_server_sdk/types/azure_voice.rb

@@ -2,22 +2,22 @@
 
 require_relative "azure_voice_id"
 require_relative "chunk_plan"
+require_relative "fallback_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class AzureVoice
-    # @return [Boolean] This determines whether fillers are injected into the model output before
-    #  inputting it into the voice provider.
-    #  Default `false` because you can achieve better results with prompting the model.
-    attr_reader :filler_injection_enabled
     # @return [Vapi::AzureVoiceId] This is the provider-specific ID that will be used.
     attr_reader :voice_id
-    # @return [Float] This is the speed multiplier that will be used.
-    attr_reader :speed
     # @return [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
     attr_reader :chunk_plan
+    # @return [Float] This is the speed multiplier that will be used.
+    attr_reader :speed
+    # @return [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
+    #  voice provider fails.
+    attr_reader :fallback_plan
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -26,26 +26,25 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param filler_injection_enabled [Boolean] This determines whether fillers are injected into the model output before
-    #  inputting it into the voice provider.
-    #  Default `false` because you can achieve better results with prompting the model.
     # @param voice_id [Vapi::AzureVoiceId] This is the provider-specific ID that will be used.
-    # @param speed [Float] This is the speed multiplier that will be used.
     # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
     #  provider.
+    # @param speed [Float] This is the speed multiplier that will be used.
+    # @param fallback_plan [Vapi::FallbackPlan] This is the plan for voice provider fallbacks in the event that the primary
+    #  voice provider fails.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::AzureVoice]
-    def initialize(voice_id:, filler_injection_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, additional_properties: nil)
-      @filler_injection_enabled = filler_injection_enabled if filler_injection_enabled != OMIT
+    def initialize(voice_id:, chunk_plan: OMIT, speed: OMIT, fallback_plan: OMIT, additional_properties: nil)
       @voice_id = voice_id
-      @speed = speed if speed != OMIT
       @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @speed = speed if speed != OMIT
+      @fallback_plan = fallback_plan if fallback_plan != OMIT
       @additional_properties = additional_properties
       @_field_set = {
-        "fillerInjectionEnabled": filler_injection_enabled,
         "voiceId": voice_id,
+        "chunkPlan": chunk_plan,
         "speed": speed,
-        "chunkPlan": chunk_plan
+        "fallbackPlan": fallback_plan
       }.reject do |_k, v|
         v == OMIT
       end
@@ -58,25 +57,30 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      filler_injection_enabled = parsed_json["fillerInjectionEnabled"]
       if parsed_json["voiceId"].nil?
         voice_id = nil
       else
         voice_id = parsed_json["voiceId"].to_json
         voice_id = Vapi::AzureVoiceId.from_json(json_object: voice_id)
       end
-      speed = parsed_json["speed"]
       if parsed_json["chunkPlan"].nil?
         chunk_plan = nil
       else
         chunk_plan = parsed_json["chunkPlan"].to_json
         chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
       end
+      speed = parsed_json["speed"]
+      if parsed_json["fallbackPlan"].nil?
+        fallback_plan = nil
+      else
+        fallback_plan = parsed_json["fallbackPlan"].to_json
+        fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
+      end
       new(
-        filler_injection_enabled: filler_injection_enabled,
         voice_id: voice_id,
-        speed: speed,
         chunk_plan: chunk_plan,
+        speed: speed,
+        fallback_plan: fallback_plan,
         additional_properties: struct
       )
     end
@@ -95,10 +99,10 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.filler_injection_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.filler_injection_enabled is not the expected type, validation failed.")
       Vapi::AzureVoiceId.validate_raw(obj: obj.voice_id)
-      obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
       obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+      obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
+      obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
     end
   end
 end

data/lib/vapi_server_sdk/types/bash_tool.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require_relative "bash_tool_messages_item"
+require "date"
+require_relative "open_ai_function"
+require_relative "server"
+require "ostruct"
+require "json"
+
+module Vapi
+  class BashTool
+    # @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::BashToolMessagesItem>] 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] 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::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 [String] The name of the tool, fixed to 'bash'
+    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 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::BashToolMessagesItem>] 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 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 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 name [String] The name of the tool, fixed to 'bash'
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::BashTool]
+    def initialize(sub_type:, id:, org_id:, created_at:, updated_at:, 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
+      @id = id
+      @org_id = org_id
+      @created_at = created_at
+      @updated_at = updated_at
+      @function = function if function != OMIT
+      @server = server if server != OMIT
+      @name = name
+      @additional_properties = additional_properties
+      @_field_set = {
+        "async": async,
+        "messages": messages,
+        "subType": sub_type,
+        "id": id,
+        "orgId": org_id,
+        "createdAt": created_at,
+        "updatedAt": updated_at,
+        "function": function,
+        "server": server,
+        "name": name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of BashTool
+    #
+    # @param json_object [String]
+    # @return [Vapi::BashTool]
+    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::BashToolMessagesItem.from_json(json_object: item)
+      end
+      sub_type = parsed_json["subType"]
+      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["server"].nil?
+        server = nil
+      else
+        server = parsed_json["server"].to_json
+        server = Vapi::Server.from_json(json_object: server)
+      end
+      name = parsed_json["name"]
+      new(
+        async: async,
+        messages: messages,
+        sub_type: sub_type,
+        id: id,
+        org_id: org_id,
+        created_at: created_at,
+        updated_at: updated_at,
+        function: function,
+        server: server,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of BashTool 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.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.server.nil? || Vapi::Server.validate_raw(obj: obj.server)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+    end
+  end
+end