vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/vonage_phone_number.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "vonage_phone_number_fallback_destination"
+require_relative "phone_number_hook_call_ringing"
 require "date"
 require_relative "vonage_phone_number_status"
 require_relative "server"
@@ -16,6 +17,8 @@ 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] This is the unique identifier for the phone number.
     attr_reader :id
     # @return [String] This is the unique identifier for the org that this phone number belongs to.
@@ -29,14 +32,22 @@ module Vapi
     # @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.
@@ -47,8 +58,9 @@ module Vapi
     attr_reader :server
     # @return [String] These are the digits of the phone number you own on your Vonage.
     attr_reader :number
-    # @return [String] This is the credential that is used to make outgoing calls, and do operations
-    #  like call transfer and hang up.
+    # @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 [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -64,6 +76,7 @@ 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 id [String] This is the unique identifier for the phone number.
     # @param org_id [String] This is the unique identifier for the org that this phone number belongs to.
     # @param created_at [DateTime] This is the ISO 8601 date-time string of when the phone number was created.
@@ -71,13 +84,20 @@ module Vapi
     # @param status [Vapi::VonagePhoneNumberStatus] This is the status of the phone number.
     # @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:
@@ -85,13 +105,15 @@ module Vapi
     #  2. phoneNumber.server
     #  3. org.server
     # @param 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.
+    # @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 additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::VonagePhoneNumber]
-    def initialize(id:, org_id:, created_at:, updated_at:, number:, credential_id:, fallback_destination: OMIT, status: OMIT, name: OMIT,
-                   assistant_id: OMIT, squad_id: OMIT, server: OMIT, additional_properties: nil)
+    def initialize(id:, org_id:, created_at:, updated_at:, number:, credential_id:, fallback_destination: OMIT, hooks: OMIT, status: 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
       @id = id
       @org_id = org_id
       @created_at = created_at
@@ -99,6 +121,7 @@ module Vapi
       @status = status if status != 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
       @number = number
@@ -106,6 +129,7 @@ module Vapi
       @additional_properties = additional_properties
       @_field_set = {
         "fallbackDestination": fallback_destination,
+        "hooks": hooks,
         "id": id,
         "orgId": org_id,
         "createdAt": created_at,
@@ -113,6 +137,7 @@ module Vapi
         "status": status,
         "name": name,
         "assistantId": assistant_id,
+        "workflowId": workflow_id,
         "squadId": squad_id,
         "server": server,
         "number": number,
@@ -135,6 +160,10 @@ module Vapi
         fallback_destination = parsed_json["fallbackDestination"].to_json
         fallback_destination = Vapi::VonagePhoneNumberFallbackDestination.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
       id = parsed_json["id"]
       org_id = parsed_json["orgId"]
       created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
@@ -142,6 +171,7 @@ module Vapi
       status = parsed_json["status"]
       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
@@ -153,6 +183,7 @@ module Vapi
       credential_id = parsed_json["credentialId"]
       new(
         fallback_destination: fallback_destination,
+        hooks: hooks,
         id: id,
         org_id: org_id,
         created_at: created_at,
@@ -160,6 +191,7 @@ module Vapi
         status: status,
         name: name,
         assistant_id: assistant_id,
+        workflow_id: workflow_id,
         squad_id: squad_id,
         server: server,
         number: number,
@@ -183,6 +215,7 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       obj.fallback_destination.nil? || Vapi::VonagePhoneNumberFallbackDestination.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.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.")
@@ -190,6 +223,7 @@ module Vapi
       obj.status&.is_a?(Vapi::VonagePhoneNumberStatus) != false || raise("Passed value for field obj.status 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)
       obj.number.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")

data/lib/vapi_server_sdk/types/web_chat.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "web_chat_output_item"
+require "ostruct"
+require "json"
+
+module Vapi
+  class WebChat
+    # @return [String] This is the unique identifier for the chat.
+    attr_reader :id
+    # @return [String] This is the ID of the session for the chat. Send it in the next chat request to
+    #  continue the conversation.
+    attr_reader :session_id
+    # @return [Array<Vapi::WebChatOutputItem>] This is the output messages generated by the system in response to the input.
+    attr_reader :output
+    # @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 id [String] This is the unique identifier for the chat.
+    # @param session_id [String] This is the ID of the session for the chat. Send it in the next chat request to
+    #  continue the conversation.
+    # @param output [Array<Vapi::WebChatOutputItem>] This is the output messages generated by the system in response to the input.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::WebChat]
+    def initialize(id:, output:, session_id: OMIT, additional_properties: nil)
+      @id = id
+      @session_id = session_id if session_id != OMIT
+      @output = output
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "sessionId": session_id, "output": output }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of WebChat
+    #
+    # @param json_object [String]
+    # @return [Vapi::WebChat]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      session_id = parsed_json["sessionId"]
+      output = parsed_json["output"]&.map do |item|
+        item = item.to_json
+        Vapi::WebChatOutputItem.from_json(json_object: item)
+      end
+      new(
+        id: id,
+        session_id: session_id,
+        output: output,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WebChat 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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.session_id&.is_a?(String) != false || raise("Passed value for field obj.session_id is not the expected type, validation failed.")
+      obj.output.is_a?(Array) != false || raise("Passed value for field obj.output is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/web_chat_output_item.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "system_message"
+require_relative "user_message"
+require_relative "assistant_message"
+require_relative "tool_message"
+require_relative "developer_message"
+
+module Vapi
+  class WebChatOutputItem
+    # Deserialize a JSON object to an instance of WebChatOutputItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::WebChatOutputItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        Vapi::SystemMessage.validate_raw(obj: struct)
+        return Vapi::SystemMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::UserMessage.validate_raw(obj: struct)
+        return Vapi::UserMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::AssistantMessage.validate_raw(obj: struct)
+        return Vapi::AssistantMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::ToolMessage.validate_raw(obj: struct)
+        return Vapi::ToolMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        Vapi::DeveloperMessage.validate_raw(obj: struct)
+        return Vapi::DeveloperMessage.from_json(json_object: struct) unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      struct
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      begin
+        return Vapi::SystemMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::UserMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::AssistantMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::ToolMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::DeveloperMessage.validate_raw(obj: obj)
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/webhook_credential.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "o_auth_2_authentication_plan"
+require_relative "webhook_credential_authentication_plan"
 require "date"
 require_relative "oauth_2_authentication_session"
 require "ostruct"
@@ -10,7 +10,7 @@ module Vapi
   class WebhookCredential
     # @return [String]
     attr_reader :provider
-    # @return [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749.
+    # @return [Vapi::WebhookCredentialAuthenticationPlan] This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.
     attr_reader :authentication_plan
     # @return [String] This is the unique identifier for the credential.
     attr_reader :id
@@ -34,7 +34,7 @@ module Vapi
     OMIT = Object.new
 
     # @param provider [String]
-    # @param authentication_plan [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749.
+    # @param authentication_plan [Vapi::WebhookCredentialAuthenticationPlan] This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.
     # @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.
@@ -81,7 +81,7 @@ module Vapi
         authentication_plan = nil
       else
         authentication_plan = parsed_json["authenticationPlan"].to_json
-        authentication_plan = Vapi::OAuth2AuthenticationPlan.from_json(json_object: authentication_plan)
+        authentication_plan = Vapi::WebhookCredentialAuthenticationPlan.from_json(json_object: authentication_plan)
       end
       id = parsed_json["id"]
       org_id = parsed_json["orgId"]
@@ -122,7 +122,7 @@ 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.")
-      Vapi::OAuth2AuthenticationPlan.validate_raw(obj: obj.authentication_plan)
+      Vapi::WebhookCredentialAuthenticationPlan.validate_raw(obj: obj.authentication_plan)
       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.")

data/lib/vapi_server_sdk/types/{block_start_message_conditions_item.rb → webhook_credential_authentication_plan.rb}

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "model_based_condition"
-require_relative "rule_based_condition"
+require_relative "o_auth_2_authentication_plan"
+require_relative "hmac_authentication_plan"
 
 module Vapi
-  class BlockStartMessageConditionsItem
+  # This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.
+  class WebhookCredentialAuthenticationPlan
     # @return [Object]
     attr_reader :member
     # @return [String]
@@ -16,25 +17,25 @@ module Vapi
 
     # @param member [Object]
     # @param discriminant [String]
-    # @return [Vapi::BlockStartMessageConditionsItem]
+    # @return [Vapi::WebhookCredentialAuthenticationPlan]
     def initialize(member:, discriminant:)
       @member = member
       @discriminant = discriminant
     end
 
-    # Deserialize a JSON object to an instance of BlockStartMessageConditionsItem
+    # Deserialize a JSON object to an instance of WebhookCredentialAuthenticationPlan
     #
     # @param json_object [String]
-    # @return [Vapi::BlockStartMessageConditionsItem]
+    # @return [Vapi::WebhookCredentialAuthenticationPlan]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       member = case struct.type
-               when "model-based"
-                 Vapi::ModelBasedCondition.from_json(json_object: json_object)
-               when "rule-based"
-                 Vapi::RuleBasedCondition.from_json(json_object: json_object)
+               when "oauth2"
+                 Vapi::OAuth2AuthenticationPlan.from_json(json_object: json_object)
+               when "hmac"
+                 Vapi::HmacAuthenticationPlan.from_json(json_object: json_object)
                else
-                 Vapi::ModelBasedCondition.from_json(json_object: json_object)
+                 Vapi::OAuth2AuthenticationPlan.from_json(json_object: json_object)
                end
       new(member: member, discriminant: struct.type)
     end
@@ -44,9 +45,9 @@ module Vapi
     # @return [String]
     def to_json(*_args)
       case @discriminant
-      when "model-based"
+      when "oauth2"
         { **@member.to_json, type: @discriminant }.to_json
-      when "rule-based"
+      when "hmac"
         { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
@@ -62,10 +63,10 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       case obj.type
-      when "model-based"
-        Vapi::ModelBasedCondition.validate_raw(obj: obj)
-      when "rule-based"
-        Vapi::RuleBasedCondition.validate_raw(obj: obj)
+      when "oauth2"
+        Vapi::OAuth2AuthenticationPlan.validate_raw(obj: obj)
+      when "hmac"
+        Vapi::HmacAuthenticationPlan.validate_raw(obj: obj)
       else
         raise("Passed value matched no type within the union, validation failed.")
       end
@@ -79,16 +80,16 @@ module Vapi
       @member.is_a?(obj)
     end
 
-    # @param member [Vapi::ModelBasedCondition]
-    # @return [Vapi::BlockStartMessageConditionsItem]
-    def self.model_based(member:)
-      new(member: member, discriminant: "model-based")
+    # @param member [Vapi::OAuth2AuthenticationPlan]
+    # @return [Vapi::WebhookCredentialAuthenticationPlan]
+    def self.oauth_2(member:)
+      new(member: member, discriminant: "oauth2")
     end
 
-    # @param member [Vapi::RuleBasedCondition]
-    # @return [Vapi::BlockStartMessageConditionsItem]
-    def self.rule_based(member:)
-      new(member: member, discriminant: "rule-based")
+    # @param member [Vapi::HmacAuthenticationPlan]
+    # @return [Vapi::WebhookCredentialAuthenticationPlan]
+    def self.hmac(member:)
+      new(member: member, discriminant: "hmac")
     end
   end
 end