vapi_server_sdk 0.5.0 → 0.9.1

data/lib/vapi_server_sdk/types/create_web_chat_dto.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative "chat_assistant_overrides"
+require_relative "create_web_customer_dto"
+require_relative "create_web_chat_dto_input"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateWebChatDto
+    # @return [String] The assistant ID to use for this chat
+    attr_reader :assistant_id
+    # @return [String] This is the ID of the session that will be used for the chat.
+    #  If provided, the conversation will continue from the previous state.
+    #  If not provided or expired, a new session will be created.
+    attr_reader :session_id
+    # @return [Vapi::ChatAssistantOverrides] These are the variable values that will be used to replace template variables in
+    #  the assistant messages.
+    #  Only variable substitution is supported in web chat - other assistant properties
+    #  cannot be overridden.
+    attr_reader :assistant_overrides
+    # @return [Vapi::CreateWebCustomerDto] This is the customer information for the chat.
+    #  Used to automatically manage sessions for repeat customers.
+    attr_reader :customer
+    # @return [Vapi::CreateWebChatDtoInput] This is the input text for the chat.
+    #  Can be a string or an array of chat messages.
+    attr_reader :input
+    # @return [Boolean] This is a flag that determines whether the response should be streamed.
+    #  When true, the response will be sent as chunks of text.
+    attr_reader :stream
+    # @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 assistant_id [String] The assistant ID to use for this chat
+    # @param session_id [String] This is the ID of the session that will be used for the chat.
+    #  If provided, the conversation will continue from the previous state.
+    #  If not provided or expired, a new session will be created.
+    # @param assistant_overrides [Vapi::ChatAssistantOverrides] These are the variable values that will be used to replace template variables in
+    #  the assistant messages.
+    #  Only variable substitution is supported in web chat - other assistant properties
+    #  cannot be overridden.
+    # @param customer [Vapi::CreateWebCustomerDto] This is the customer information for the chat.
+    #  Used to automatically manage sessions for repeat customers.
+    # @param input [Vapi::CreateWebChatDtoInput] This is the input text for the chat.
+    #  Can be a string or an array of chat messages.
+    # @param stream [Boolean] This is a flag that determines whether the response should be streamed.
+    #  When true, the response will be sent as chunks of text.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateWebChatDto]
+    def initialize(assistant_id:, input:, session_id: OMIT, assistant_overrides: OMIT, customer: OMIT, stream: OMIT,
+                   additional_properties: nil)
+      @assistant_id = assistant_id
+      @session_id = session_id if session_id != OMIT
+      @assistant_overrides = assistant_overrides if assistant_overrides != OMIT
+      @customer = customer if customer != OMIT
+      @input = input
+      @stream = stream if stream != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "assistantId": assistant_id,
+        "sessionId": session_id,
+        "assistantOverrides": assistant_overrides,
+        "customer": customer,
+        "input": input,
+        "stream": stream
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateWebChatDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWebChatDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      assistant_id = parsed_json["assistantId"]
+      session_id = parsed_json["sessionId"]
+      if parsed_json["assistantOverrides"].nil?
+        assistant_overrides = nil
+      else
+        assistant_overrides = parsed_json["assistantOverrides"].to_json
+        assistant_overrides = Vapi::ChatAssistantOverrides.from_json(json_object: assistant_overrides)
+      end
+      if parsed_json["customer"].nil?
+        customer = nil
+      else
+        customer = parsed_json["customer"].to_json
+        customer = Vapi::CreateWebCustomerDto.from_json(json_object: customer)
+      end
+      if parsed_json["input"].nil?
+        input = nil
+      else
+        input = parsed_json["input"].to_json
+        input = Vapi::CreateWebChatDtoInput.from_json(json_object: input)
+      end
+      stream = parsed_json["stream"]
+      new(
+        assistant_id: assistant_id,
+        session_id: session_id,
+        assistant_overrides: assistant_overrides,
+        customer: customer,
+        input: input,
+        stream: stream,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateWebChatDto 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.assistant_id.is_a?(String) != false || raise("Passed value for field obj.assistant_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.assistant_overrides.nil? || Vapi::ChatAssistantOverrides.validate_raw(obj: obj.assistant_overrides)
+      obj.customer.nil? || Vapi::CreateWebCustomerDto.validate_raw(obj: obj.customer)
+      Vapi::CreateWebChatDtoInput.validate_raw(obj: obj.input)
+      obj.stream&.is_a?(Boolean) != false || raise("Passed value for field obj.stream is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_web_chat_dto_input.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Vapi
+  # This is the input text for the chat.
+  #  Can be a string or an array of chat messages.
+  class CreateWebChatDtoInput
+    # Deserialize a JSON object to an instance of CreateWebChatDtoInput
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWebChatDtoInput]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      begin
+        struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return struct unless struct.nil?
+
+        return nil
+      rescue StandardError
+        # noop
+      end
+      begin
+        struct.is_a?(Array) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+        return nil if struct.nil?
+
+        return struct&.map do |item|
+          item = item.to_json
+          Vapi::CreateWebChatDtoInputItem.from_json(json_object: item)
+        end
+      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 obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return obj.is_a?(Array) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      raise("Passed value matched no type within the union, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_web_chat_dto_input_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 CreateWebChatDtoInputItem
+    # Deserialize a JSON object to an instance of CreateWebChatDtoInputItem
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWebChatDtoInputItem]
+    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/create_web_customer_dto.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require_relative "chat_assistant_overrides"
+require "ostruct"
+require "json"
+
+module Vapi
+  class CreateWebCustomerDto
+    # @return [Boolean] This is the flag to toggle the E164 check for the `number` field. This is an
+    #  advanced property which should be used if you know your use case requires it.
+    #  Use cases:
+    #  - `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`.
+    #  This is useful for dialing out to non-E164 numbers on your SIP trunks.
+    #  - `true` (default): To allow only E164 numbers like `+14155551234`. This is
+    #  standard for PSTN calls.
+    #  If `false`, the `number` is still required to only contain alphanumeric
+    #  characters (regex: `/^\+?[a-zA-Z0-9]+$/`).
+    #  @default true (E164 check is enabled)
+    attr_reader :number_e_164_check_enabled
+    # @return [String] This is the extension that will be dialed after the call is answered.
+    attr_reader :extension
+    # @return [Vapi::ChatAssistantOverrides] These are the variable values that will be used to replace template variables in
+    #  the assistant messages.
+    #  Only variable substitution is supported in web chat - other assistant properties
+    #  cannot be overridden.
+    attr_reader :assistant_overrides
+    # @return [String] This is the number of the customer.
+    attr_reader :number
+    # @return [String] This is the SIP URI of the customer.
+    attr_reader :sip_uri
+    # @return [String] This is the name of the customer. This is just for your own reference.
+    #  For SIP inbound calls, this is extracted from the `From` SIP header with format
+    #  `"Display Name" <sip:username@domain>`.
+    attr_reader :name
+    # @return [String] This is the email of the customer.
+    attr_reader :email
+    # @return [String] This is the external ID of the customer.
+    attr_reader :external_id
+    # @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 number_e_164_check_enabled [Boolean] This is the flag to toggle the E164 check for the `number` field. This is an
+    #  advanced property which should be used if you know your use case requires it.
+    #  Use cases:
+    #  - `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`.
+    #  This is useful for dialing out to non-E164 numbers on your SIP trunks.
+    #  - `true` (default): To allow only E164 numbers like `+14155551234`. This is
+    #  standard for PSTN calls.
+    #  If `false`, the `number` is still required to only contain alphanumeric
+    #  characters (regex: `/^\+?[a-zA-Z0-9]+$/`).
+    #  @default true (E164 check is enabled)
+    # @param extension [String] This is the extension that will be dialed after the call is answered.
+    # @param assistant_overrides [Vapi::ChatAssistantOverrides] These are the variable values that will be used to replace template variables in
+    #  the assistant messages.
+    #  Only variable substitution is supported in web chat - other assistant properties
+    #  cannot be overridden.
+    # @param number [String] This is the number of the customer.
+    # @param sip_uri [String] This is the SIP URI of the customer.
+    # @param name [String] This is the name of the customer. This is just for your own reference.
+    #  For SIP inbound calls, this is extracted from the `From` SIP header with format
+    #  `"Display Name" <sip:username@domain>`.
+    # @param email [String] This is the email of the customer.
+    # @param external_id [String] This is the external ID of the customer.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::CreateWebCustomerDto]
+    def initialize(number_e_164_check_enabled: OMIT, extension: OMIT, assistant_overrides: OMIT, number: OMIT,
+                   sip_uri: OMIT, name: OMIT, email: OMIT, external_id: OMIT, additional_properties: nil)
+      @number_e_164_check_enabled = number_e_164_check_enabled if number_e_164_check_enabled != OMIT
+      @extension = extension if extension != OMIT
+      @assistant_overrides = assistant_overrides if assistant_overrides != OMIT
+      @number = number if number != OMIT
+      @sip_uri = sip_uri if sip_uri != OMIT
+      @name = name if name != OMIT
+      @email = email if email != OMIT
+      @external_id = external_id if external_id != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "numberE164CheckEnabled": number_e_164_check_enabled,
+        "extension": extension,
+        "assistantOverrides": assistant_overrides,
+        "number": number,
+        "sipUri": sip_uri,
+        "name": name,
+        "email": email,
+        "externalId": external_id
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreateWebCustomerDto
+    #
+    # @param json_object [String]
+    # @return [Vapi::CreateWebCustomerDto]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      number_e_164_check_enabled = parsed_json["numberE164CheckEnabled"]
+      extension = parsed_json["extension"]
+      if parsed_json["assistantOverrides"].nil?
+        assistant_overrides = nil
+      else
+        assistant_overrides = parsed_json["assistantOverrides"].to_json
+        assistant_overrides = Vapi::ChatAssistantOverrides.from_json(json_object: assistant_overrides)
+      end
+      number = parsed_json["number"]
+      sip_uri = parsed_json["sipUri"]
+      name = parsed_json["name"]
+      email = parsed_json["email"]
+      external_id = parsed_json["externalId"]
+      new(
+        number_e_164_check_enabled: number_e_164_check_enabled,
+        extension: extension,
+        assistant_overrides: assistant_overrides,
+        number: number,
+        sip_uri: sip_uri,
+        name: name,
+        email: email,
+        external_id: external_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateWebCustomerDto 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.number_e_164_check_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.number_e_164_check_enabled is not the expected type, validation failed.")
+      obj.extension&.is_a?(String) != false || raise("Passed value for field obj.extension is not the expected type, validation failed.")
+      obj.assistant_overrides.nil? || Vapi::ChatAssistantOverrides.validate_raw(obj: obj.assistant_overrides)
+      obj.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
+      obj.sip_uri&.is_a?(String) != false || raise("Passed value for field obj.sip_uri 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.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+      obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/create_webhook_credential_dto.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "o_auth_2_authentication_plan"
+require_relative "create_webhook_credential_dto_authentication_plan"
 require "ostruct"
 require "json"
 
 module Vapi
   class CreateWebhookCredentialDto
-    # @return [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749.
+    # @return [Vapi::CreateWebhookCredentialDtoAuthenticationPlan] This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.
     attr_reader :authentication_plan
     # @return [String] This is the name of credential. This is just for your reference.
     attr_reader :name
@@ -18,7 +18,7 @@ module Vapi
 
     OMIT = Object.new
 
-    # @param authentication_plan [Vapi::OAuth2AuthenticationPlan] This is the authentication plan. Currently supports OAuth2 RFC 6749.
+    # @param authentication_plan [Vapi::CreateWebhookCredentialDtoAuthenticationPlan] This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.
     # @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::CreateWebhookCredentialDto]
@@ -42,7 +42,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::CreateWebhookCredentialDtoAuthenticationPlan.from_json(json_object: authentication_plan)
       end
       name = parsed_json["name"]
       new(
@@ -66,7 +66,7 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      Vapi::OAuth2AuthenticationPlan.validate_raw(obj: obj.authentication_plan)
+      Vapi::CreateWebhookCredentialDtoAuthenticationPlan.validate_raw(obj: obj.authentication_plan)
       obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
     end
   end

data/lib/vapi_server_sdk/types/{update_conversation_block_dto_messages_item.rb → create_webhook_credential_dto_authentication_plan.rb}

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "block_start_message"
-require_relative "block_complete_message"
+require_relative "o_auth_2_authentication_plan"
+require_relative "hmac_authentication_plan"
 
 module Vapi
-  class UpdateConversationBlockDtoMessagesItem
+  # This is the authentication plan. Supports OAuth2 RFC 6749 and HMAC signing.
+  class CreateWebhookCredentialDtoAuthenticationPlan
     # @return [Object]
     attr_reader :member
     # @return [String]
@@ -16,26 +17,26 @@ module Vapi
 
     # @param member [Object]
     # @param discriminant [String]
-    # @return [Vapi::UpdateConversationBlockDtoMessagesItem]
+    # @return [Vapi::CreateWebhookCredentialDtoAuthenticationPlan]
     def initialize(member:, discriminant:)
       @member = member
       @discriminant = discriminant
     end
 
     # Deserialize a JSON object to an instance of
-    #  UpdateConversationBlockDtoMessagesItem
+    #  CreateWebhookCredentialDtoAuthenticationPlan
     #
     # @param json_object [String]
-    # @return [Vapi::UpdateConversationBlockDtoMessagesItem]
+    # @return [Vapi::CreateWebhookCredentialDtoAuthenticationPlan]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       member = case struct.type
-               when "block-start"
-                 Vapi::BlockStartMessage.from_json(json_object: json_object)
-               when "block-complete"
-                 Vapi::BlockCompleteMessage.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::BlockStartMessage.from_json(json_object: json_object)
+                 Vapi::OAuth2AuthenticationPlan.from_json(json_object: json_object)
                end
       new(member: member, discriminant: struct.type)
     end
@@ -45,9 +46,9 @@ module Vapi
     # @return [String]
     def to_json(*_args)
       case @discriminant
-      when "block-start"
+      when "oauth2"
         { **@member.to_json, type: @discriminant }.to_json
-      when "block-complete"
+      when "hmac"
         { **@member.to_json, type: @discriminant }.to_json
       else
         { "type": @discriminant, value: @member }.to_json
@@ -63,10 +64,10 @@ module Vapi
     # @return [Void]
     def self.validate_raw(obj:)
       case obj.type
-      when "block-start"
-        Vapi::BlockStartMessage.validate_raw(obj: obj)
-      when "block-complete"
-        Vapi::BlockCompleteMessage.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
@@ -80,16 +81,16 @@ module Vapi
       @member.is_a?(obj)
     end
 
-    # @param member [Vapi::BlockStartMessage]
-    # @return [Vapi::UpdateConversationBlockDtoMessagesItem]
-    def self.block_start(member:)
-      new(member: member, discriminant: "block-start")
+    # @param member [Vapi::OAuth2AuthenticationPlan]
+    # @return [Vapi::CreateWebhookCredentialDtoAuthenticationPlan]
+    def self.oauth_2(member:)
+      new(member: member, discriminant: "oauth2")
     end
 
-    # @param member [Vapi::BlockCompleteMessage]
-    # @return [Vapi::UpdateConversationBlockDtoMessagesItem]
-    def self.block_complete(member:)
-      new(member: member, discriminant: "block-complete")
+    # @param member [Vapi::HmacAuthenticationPlan]
+    # @return [Vapi::CreateWebhookCredentialDtoAuthenticationPlan]
+    def self.hmac(member:)
+      new(member: member, discriminant: "hmac")
     end
   end
 end