vapi_server_sdk 0.4.0 → 0.9.1

data/lib/vapi_server_sdk/types/hume_credential.rb

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

data/lib/vapi_server_sdk/types/hume_voice.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative "chunk_plan"
+require_relative "fallback_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class HumeVoice
+    # @return [Boolean] This is the flag to toggle voice caching for the assistant.
+    attr_reader :caching_enabled
+    # @return [String] This is the model that will be used.
+    attr_reader :model
+    # @return [String] The ID of the particular voice you want to use.
+    attr_reader :voice_id
+    # @return [Boolean] Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.
+    attr_reader :is_custom_hume_voice
+    # @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 [String] Natural language instructions describing how the synthesized speech should
+    #  sound, including but not limited to tone, intonation, pacing, and accent (e.g.,
+    #  'a soft, gentle voice with a strong British accent').
+    #  If a Voice is specified in the request, this description serves as acting
+    #  instructions.
+    #  If no Voice is specified, a new voice is generated based on this description.
+    attr_reader :description
+    # @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]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param caching_enabled [Boolean] This is the flag to toggle voice caching for the assistant.
+    # @param model [String] This is the model that will be used.
+    # @param voice_id [String] The ID of the particular voice you want to use.
+    # @param is_custom_hume_voice [Boolean] Indicates whether the chosen voice is a preset Hume AI voice or a custom voice.
+    # @param chunk_plan [Vapi::ChunkPlan] This is the plan for chunking the model output before it is sent to the voice
+    #  provider.
+    # @param description [String] Natural language instructions describing how the synthesized speech should
+    #  sound, including but not limited to tone, intonation, pacing, and accent (e.g.,
+    #  'a soft, gentle voice with a strong British accent').
+    #  If a Voice is specified in the request, this description serves as acting
+    #  instructions.
+    #  If no Voice is specified, a new voice is generated based on this description.
+    # @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::HumeVoice]
+    def initialize(voice_id:, caching_enabled: OMIT, model: OMIT, is_custom_hume_voice: OMIT, chunk_plan: OMIT,
+                   description: OMIT, fallback_plan: OMIT, additional_properties: nil)
+      @caching_enabled = caching_enabled if caching_enabled != OMIT
+      @model = model if model != OMIT
+      @voice_id = voice_id
+      @is_custom_hume_voice = is_custom_hume_voice if is_custom_hume_voice != OMIT
+      @chunk_plan = chunk_plan if chunk_plan != OMIT
+      @description = description if description != OMIT
+      @fallback_plan = fallback_plan if fallback_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "cachingEnabled": caching_enabled,
+        "model": model,
+        "voiceId": voice_id,
+        "isCustomHumeVoice": is_custom_hume_voice,
+        "chunkPlan": chunk_plan,
+        "description": description,
+        "fallbackPlan": fallback_plan
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of HumeVoice
+    #
+    # @param json_object [String]
+    # @return [Vapi::HumeVoice]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      caching_enabled = parsed_json["cachingEnabled"]
+      model = parsed_json["model"]
+      voice_id = parsed_json["voiceId"]
+      is_custom_hume_voice = parsed_json["isCustomHumeVoice"]
+      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
+      description = parsed_json["description"]
+      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(
+        caching_enabled: caching_enabled,
+        model: model,
+        voice_id: voice_id,
+        is_custom_hume_voice: is_custom_hume_voice,
+        chunk_plan: chunk_plan,
+        description: description,
+        fallback_plan: fallback_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of HumeVoice 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.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled is not the expected type, validation failed.")
+      obj.model&.is_a?(String) != false || raise("Passed value for field obj.model is not the expected type, validation failed.")
+      obj.voice_id.is_a?(String) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
+      obj.is_custom_hume_voice&.is_a?(Boolean) != false || raise("Passed value for field obj.is_custom_hume_voice is not the expected type, validation failed.")
+      obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description 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/import_twilio_phone_number_dto.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "import_twilio_phone_number_dto_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
 require_relative "server"
 require "ostruct"
 require "json"
@@ -14,23 +15,47 @@ module Vapi
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
     attr_reader :fallback_destination
+    # @return [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
+    attr_reader :hooks
+    # @return [Boolean] Controls whether Vapi sets the messaging webhook URL on the Twilio number during
+    #  import.
+    #  If set to `false`, Vapi will not update the Twilio messaging URL, leaving it as
+    #  is.
+    #  If `true` or omitted (default), Vapi will configure both the voice and messaging
+    #  URLs.
+    #  @default true
+    attr_reader :sms_enabled
     # @return [String] These are the digits of the phone number you own on your Twilio.
     attr_reader :twilio_phone_number
     # @return [String] This is your Twilio Account SID that will be used to handle this phone number.
     attr_reader :twilio_account_sid
     # @return [String] This is the Twilio Auth Token that will be used to handle this phone number.
     attr_reader :twilio_auth_token
+    # @return [String] This is the Twilio API Key that will be used to handle this phone number. If
+    #  AuthToken is provided, this will be ignored.
+    attr_reader :twilio_api_key
+    # @return [String] This is the Twilio API Secret that will be used to handle this phone number. If
+    #  AuthToken is provided, this will be ignored.
+    attr_reader :twilio_api_secret
     # @return [String] This is the name of the phone number. This is just for your own reference.
     attr_reader :name
     # @return [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId` nor `workflowId` 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.
     attr_reader :assistant_id
+    # @return [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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.
+    attr_reader :workflow_id
     # @return [String] This is the squad that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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.
     attr_reader :squad_id
     # @return [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
     #  with their shape in ServerMessage schema.
@@ -53,18 +78,37 @@ module Vapi
     #  3. and, `assistant-request` message to the `serverUrl` fails
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
+    # @param hooks [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
+    # @param sms_enabled [Boolean] Controls whether Vapi sets the messaging webhook URL on the Twilio number during
+    #  import.
+    #  If set to `false`, Vapi will not update the Twilio messaging URL, leaving it as
+    #  is.
+    #  If `true` or omitted (default), Vapi will configure both the voice and messaging
+    #  URLs.
+    #  @default true
     # @param twilio_phone_number [String] These are the digits of the phone number you own on your Twilio.
     # @param twilio_account_sid [String] This is your Twilio Account SID that will be used to handle this phone number.
     # @param twilio_auth_token [String] This is the Twilio Auth Token that will be used to handle this phone number.
+    # @param twilio_api_key [String] This is the Twilio API Key that will be used to handle this phone number. If
+    #  AuthToken is provided, this will be ignored.
+    # @param twilio_api_secret [String] This is the Twilio API Secret that will be used to handle this phone number. If
+    #  AuthToken is provided, this will be ignored.
     # @param name [String] This is the name of the phone number. This is just for your own reference.
     # @param assistant_id [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId` nor `workflowId` 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 workflow_id [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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 squad_id [String] This is the squad that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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 [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:
@@ -73,24 +117,34 @@ module Vapi
     #  3. org.server
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ImportTwilioPhoneNumberDto]
-    def initialize(twilio_phone_number:, twilio_account_sid:, twilio_auth_token:, fallback_destination: OMIT,
-                   name: OMIT, assistant_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
+    def initialize(twilio_phone_number:, twilio_account_sid:, fallback_destination: OMIT, hooks: OMIT,
+                   sms_enabled: OMIT, twilio_auth_token: OMIT, twilio_api_key: OMIT, twilio_api_secret: OMIT, name: OMIT, assistant_id: OMIT, workflow_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
+      @hooks = hooks if hooks != OMIT
+      @sms_enabled = sms_enabled if sms_enabled != OMIT
       @twilio_phone_number = twilio_phone_number
       @twilio_account_sid = twilio_account_sid
-      @twilio_auth_token = twilio_auth_token
+      @twilio_auth_token = twilio_auth_token if twilio_auth_token != OMIT
+      @twilio_api_key = twilio_api_key if twilio_api_key != OMIT
+      @twilio_api_secret = twilio_api_secret if twilio_api_secret != OMIT
       @name = name if name != OMIT
       @assistant_id = assistant_id if assistant_id != OMIT
+      @workflow_id = workflow_id if workflow_id != OMIT
       @squad_id = squad_id if squad_id != OMIT
       @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
+        "hooks": hooks,
+        "smsEnabled": sms_enabled,
         "twilioPhoneNumber": twilio_phone_number,
         "twilioAccountSid": twilio_account_sid,
         "twilioAuthToken": twilio_auth_token,
+        "twilioApiKey": twilio_api_key,
+        "twilioApiSecret": twilio_api_secret,
         "name": name,
         "assistantId": assistant_id,
+        "workflowId": workflow_id,
         "squadId": squad_id,
         "server": server
       }.reject do |_k, v|
@@ -111,11 +165,19 @@ module Vapi
         fallback_destination = parsed_json["fallbackDestination"].to_json
         fallback_destination = Vapi::ImportTwilioPhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
       end
+      hooks = parsed_json["hooks"]&.map do |item|
+        item = item.to_json
+        Vapi::PhoneNumberHookCallRinging.from_json(json_object: item)
+      end
+      sms_enabled = parsed_json["smsEnabled"]
       twilio_phone_number = parsed_json["twilioPhoneNumber"]
       twilio_account_sid = parsed_json["twilioAccountSid"]
       twilio_auth_token = parsed_json["twilioAuthToken"]
+      twilio_api_key = parsed_json["twilioApiKey"]
+      twilio_api_secret = parsed_json["twilioApiSecret"]
       name = parsed_json["name"]
       assistant_id = parsed_json["assistantId"]
+      workflow_id = parsed_json["workflowId"]
       squad_id = parsed_json["squadId"]
       if parsed_json["server"].nil?
         server = nil
@@ -125,11 +187,16 @@ module Vapi
       end
       new(
         fallback_destination: fallback_destination,
+        hooks: hooks,
+        sms_enabled: sms_enabled,
         twilio_phone_number: twilio_phone_number,
         twilio_account_sid: twilio_account_sid,
         twilio_auth_token: twilio_auth_token,
+        twilio_api_key: twilio_api_key,
+        twilio_api_secret: twilio_api_secret,
         name: name,
         assistant_id: assistant_id,
+        workflow_id: workflow_id,
         squad_id: squad_id,
         server: server,
         additional_properties: struct
@@ -151,11 +218,16 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.fallback_destination.nil? || Vapi::ImportTwilioPhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
+      obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
+      obj.sms_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.sms_enabled is not the expected type, validation failed.")
       obj.twilio_phone_number.is_a?(String) != false || raise("Passed value for field obj.twilio_phone_number is not the expected type, validation failed.")
       obj.twilio_account_sid.is_a?(String) != false || raise("Passed value for field obj.twilio_account_sid is not the expected type, validation failed.")
-      obj.twilio_auth_token.is_a?(String) != false || raise("Passed value for field obj.twilio_auth_token is not the expected type, validation failed.")
+      obj.twilio_auth_token&.is_a?(String) != false || raise("Passed value for field obj.twilio_auth_token is not the expected type, validation failed.")
+      obj.twilio_api_key&.is_a?(String) != false || raise("Passed value for field obj.twilio_api_key is not the expected type, validation failed.")
+      obj.twilio_api_secret&.is_a?(String) != false || raise("Passed value for field obj.twilio_api_secret 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.assistant_id&.is_a?(String) != false || raise("Passed value for field obj.assistant_id is not the expected type, validation failed.")
+      obj.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_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.nil? || Vapi::Server.validate_raw(obj: obj.server)
     end

data/lib/vapi_server_sdk/types/import_vonage_phone_number_dto.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "import_vonage_phone_number_dto_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
 require_relative "server"
 require "ostruct"
 require "json"
@@ -14,24 +15,33 @@ module Vapi
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
     attr_reader :fallback_destination
+    # @return [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
+    attr_reader :hooks
     # @return [String] These are the digits of the phone number you own on your Vonage.
     attr_reader :vonage_phone_number
-    # @return [String] This is the credential that is used to make outgoing calls, and do operations
-    #  like call transfer and hang up.
-    #  You can add the Vonage Credential in the Provider Credentials page on the
-    #  dashboard to get the credentialId.
+    # @return [String] This is the credential you added in dashboard.vapi.ai/keys. This is used to
+    #  configure the number to send inbound calls to Vapi, make outbound calls and do
+    #  live call updates like transfers and hangups.
     attr_reader :credential_id
     # @return [String] This is the name of the phone number. This is just for your own reference.
     attr_reader :name
     # @return [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId` nor `workflowId` 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.
     attr_reader :assistant_id
+    # @return [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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.
+    attr_reader :workflow_id
     # @return [String] This is the squad that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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.
     attr_reader :squad_id
     # @return [Vapi::Server] This is where Vapi will send webhooks. You can find all webhooks available along
     #  with their shape in ServerMessage schema.
@@ -54,20 +64,27 @@ module Vapi
     #  3. and, `assistant-request` message to the `serverUrl` fails
     #  If this is not set and above conditions are met, the inbound call is hung up
     #  with an error message.
+    # @param hooks [Array<Vapi::PhoneNumberHookCallRinging>] This is the hooks that will be used for incoming calls to this phone number.
     # @param vonage_phone_number [String] These are the digits of the phone number you own on your Vonage.
-    # @param credential_id [String] This is the credential that is used to make outgoing calls, and do operations
-    #  like call transfer and hang up.
-    #  You can add the Vonage Credential in the Provider Credentials page on the
-    #  dashboard to get the credentialId.
+    # @param credential_id [String] This is the credential you added in dashboard.vapi.ai/keys. This is used to
+    #  configure the number to send inbound calls to Vapi, make outbound calls and do
+    #  live call updates like transfers and hangups.
     # @param name [String] This is the name of the phone number. This is just for your own reference.
     # @param assistant_id [String] This is the assistant that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId` nor `workflowId` 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 workflow_id [String] This is the workflow that will be used for incoming calls to this phone number.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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 squad_id [String] This is the squad that will be used for incoming calls to this phone number.
-    #  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.
+    #  If neither `assistantId`, `squadId`, nor `workflowId` 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 [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:
@@ -76,22 +93,26 @@ module Vapi
     #  3. org.server
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::ImportVonagePhoneNumberDto]
-    def initialize(vonage_phone_number:, credential_id:, fallback_destination: OMIT, name: OMIT, assistant_id: OMIT,
-                   squad_id: OMIT, server: OMIT, additional_properties: nil)
+    def initialize(vonage_phone_number:, credential_id:, fallback_destination: OMIT, hooks: OMIT, name: OMIT,
+                   assistant_id: OMIT, workflow_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
       @fallback_destination = fallback_destination if fallback_destination != OMIT
+      @hooks = hooks if hooks != OMIT
       @vonage_phone_number = vonage_phone_number
       @credential_id = credential_id
       @name = name if name != OMIT
       @assistant_id = assistant_id if assistant_id != OMIT
+      @workflow_id = workflow_id if workflow_id != OMIT
       @squad_id = squad_id if squad_id != OMIT
       @server = server if server != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
+        "hooks": hooks,
         "vonagePhoneNumber": vonage_phone_number,
         "credentialId": credential_id,
         "name": name,
         "assistantId": assistant_id,
+        "workflowId": workflow_id,
         "squadId": squad_id,
         "server": server
       }.reject do |_k, v|
@@ -112,10 +133,15 @@ module Vapi
         fallback_destination = parsed_json["fallbackDestination"].to_json
         fallback_destination = Vapi::ImportVonagePhoneNumberDtoFallbackDestination.from_json(json_object: fallback_destination)
       end
+      hooks = parsed_json["hooks"]&.map do |item|
+        item = item.to_json
+        Vapi::PhoneNumberHookCallRinging.from_json(json_object: item)
+      end
       vonage_phone_number = parsed_json["vonagePhoneNumber"]
       credential_id = parsed_json["credentialId"]
       name = parsed_json["name"]
       assistant_id = parsed_json["assistantId"]
+      workflow_id = parsed_json["workflowId"]
       squad_id = parsed_json["squadId"]
       if parsed_json["server"].nil?
         server = nil
@@ -125,10 +151,12 @@ module Vapi
       end
       new(
         fallback_destination: fallback_destination,
+        hooks: hooks,
         vonage_phone_number: vonage_phone_number,
         credential_id: credential_id,
         name: name,
         assistant_id: assistant_id,
+        workflow_id: workflow_id,
         squad_id: squad_id,
         server: server,
         additional_properties: struct
@@ -150,10 +178,12 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.fallback_destination.nil? || Vapi::ImportVonagePhoneNumberDtoFallbackDestination.validate_raw(obj: obj.fallback_destination)
+      obj.hooks&.is_a?(Array) != false || raise("Passed value for field obj.hooks is not the expected type, validation failed.")
       obj.vonage_phone_number.is_a?(String) != false || raise("Passed value for field obj.vonage_phone_number is not the expected type, validation failed.")
       obj.credential_id.is_a?(String) != false || raise("Passed value for field obj.credential_id is not the expected type, validation failed.")
       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.workflow_id&.is_a?(String) != false || raise("Passed value for field obj.workflow_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.nil? || Vapi::Server.validate_raw(obj: obj.server)
     end