vapi_server_sdk 0.0.0.pre.alpha7 → 0.2.0

data/lib/vapi_server_sdk/types/transfer_plan.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require_relative "transfer_plan_mode"
+require_relative "transfer_plan_message"
+require_relative "summary_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TransferPlan
+    # @return [Vapi::TransferPlanMode] This configures how transfer is executed and the experience of the destination
+    #  party receiving the call.
+    #  Usage:
+    #  - `blind-transfer`: The assistant forwards the call to the destination without
+    #  any message or summary.
+    #  - `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to
+    #  the destination and adds a SIP header X-Transfer-Summary to the call to include
+    #  the summary.
+    #  - `warm-transfer-say-message`: The assistant dials the destination, delivers the
+    #  `message` to the destination party, connects the customer, and leaves the call.
+    #  - `warm-transfer-say-summary`: The assistant dials the destination, provides a
+    #  summary of the call to the destination party, connects the customer, and leaves
+    #  the call.
+    #  - `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The
+    #  assistant dials the destination, waits for the operator to speak, delivers the
+    #  `message` to the destination party, and then connects the customer.
+    #  - `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The
+    #  assistant dials the destination, waits for the operator to speak, provides a
+    #  summary of the call to the destination party, and then connects the customer.
+    #  @default 'blind-transfer'
+    attr_reader :mode
+    # @return [Vapi::TransferPlanMessage] This is the message the assistant will deliver to the destination party before
+    #  connecting the customer.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-say-message` or
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`.
+    attr_reader :message
+    # @return [Vapi::SummaryPlan] This is the plan for generating a summary of the call to present to the
+    #  destination party.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-say-summary` or
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`.
+    attr_reader :summary_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 mode [Vapi::TransferPlanMode] This configures how transfer is executed and the experience of the destination
+    #  party receiving the call.
+    #  Usage:
+    #  - `blind-transfer`: The assistant forwards the call to the destination without
+    #  any message or summary.
+    #  - `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to
+    #  the destination and adds a SIP header X-Transfer-Summary to the call to include
+    #  the summary.
+    #  - `warm-transfer-say-message`: The assistant dials the destination, delivers the
+    #  `message` to the destination party, connects the customer, and leaves the call.
+    #  - `warm-transfer-say-summary`: The assistant dials the destination, provides a
+    #  summary of the call to the destination party, connects the customer, and leaves
+    #  the call.
+    #  - `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The
+    #  assistant dials the destination, waits for the operator to speak, delivers the
+    #  `message` to the destination party, and then connects the customer.
+    #  - `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The
+    #  assistant dials the destination, waits for the operator to speak, provides a
+    #  summary of the call to the destination party, and then connects the customer.
+    #  @default 'blind-transfer'
+    # @param message [Vapi::TransferPlanMessage] This is the message the assistant will deliver to the destination party before
+    #  connecting the customer.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-say-message` or
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`.
+    # @param summary_plan [Vapi::SummaryPlan] This is the plan for generating a summary of the call to present to the
+    #  destination party.
+    #  Usage:
+    #  - Used only when `mode` is `warm-transfer-say-summary` or
+    #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TransferPlan]
+    def initialize(mode:, message: OMIT, summary_plan: OMIT, additional_properties: nil)
+      @mode = mode
+      @message = message if message != OMIT
+      @summary_plan = summary_plan if summary_plan != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "mode": mode, "message": message, "summaryPlan": summary_plan }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TransferPlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::TransferPlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      mode = parsed_json["mode"]
+      if parsed_json["message"].nil?
+        message = nil
+      else
+        message = parsed_json["message"].to_json
+        message = Vapi::TransferPlanMessage.from_json(json_object: message)
+      end
+      if parsed_json["summaryPlan"].nil?
+        summary_plan = nil
+      else
+        summary_plan = parsed_json["summaryPlan"].to_json
+        summary_plan = Vapi::SummaryPlan.from_json(json_object: summary_plan)
+      end
+      new(
+        mode: mode,
+        message: message,
+        summary_plan: summary_plan,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TransferPlan 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.mode.is_a?(Vapi::TransferPlanMode) != false || raise("Passed value for field obj.mode is not the expected type, validation failed.")
+      obj.message.nil? || Vapi::TransferPlanMessage.validate_raw(obj: obj.message)
+      obj.summary_plan.nil? || Vapi::SummaryPlan.validate_raw(obj: obj.summary_plan)
+    end
+  end
+end

data/lib/vapi_server_sdk/types/transfer_plan_message.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "custom_message"
+
+module Vapi
+  # This is the message the assistant will deliver to the destination party before
+  #  connecting the customer.
+  #  Usage:
+  #  - Used only when `mode` is `warm-transfer-say-message` or
+  #  `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`.
+  class TransferPlanMessage
+    # Deserialize a JSON object to an instance of TransferPlanMessage
+    #
+    # @param json_object [String]
+    # @return [Vapi::TransferPlanMessage]
+    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
+        Vapi::CustomMessage.validate_raw(obj: struct)
+        return Vapi::CustomMessage.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 obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+      rescue StandardError
+        # noop
+      end
+      begin
+        return Vapi::CustomMessage.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/transfer_plan_mode.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This configures how transfer is executed and the experience of the destination
+  #  party receiving the call.
+  #  Usage:
+  #  - `blind-transfer`: The assistant forwards the call to the destination without
+  #  any message or summary.
+  #  - `blind-transfer-add-summary-to-sip-header`: The assistant forwards the call to
+  #  the destination and adds a SIP header X-Transfer-Summary to the call to include
+  #  the summary.
+  #  - `warm-transfer-say-message`: The assistant dials the destination, delivers the
+  #  `message` to the destination party, connects the customer, and leaves the call.
+  #  - `warm-transfer-say-summary`: The assistant dials the destination, provides a
+  #  summary of the call to the destination party, connects the customer, and leaves
+  #  the call.
+  #  - `warm-transfer-wait-for-operator-to-speak-first-and-then-say-message`: The
+  #  assistant dials the destination, waits for the operator to speak, delivers the
+  #  `message` to the destination party, and then connects the customer.
+  #  - `warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary`: The
+  #  assistant dials the destination, waits for the operator to speak, provides a
+  #  summary of the call to the destination party, and then connects the customer.
+  #  @default 'blind-transfer'
+  class TransferPlanMode
+    BLIND_TRANSFER = "blind-transfer"
+    BLIND_TRANSFER_ADD_SUMMARY_TO_SIP_HEADER = "blind-transfer-add-summary-to-sip-header"
+    WARM_TRANSFER_SAY_MESSAGE = "warm-transfer-say-message"
+    WARM_TRANSFER_SAY_SUMMARY = "warm-transfer-say-summary"
+    WARM_TRANSFER_WAIT_FOR_OPERATOR_TO_SPEAK_FIRST_AND_THEN_SAY_MESSAGE = "warm-transfer-wait-for-operator-to-speak-first-and-then-say-message"
+    WARM_TRANSFER_WAIT_FOR_OPERATOR_TO_SPEAK_FIRST_AND_THEN_SAY_SUMMARY = "warm-transfer-wait-for-operator-to-speak-first-and-then-say-summary"
+  end
+end

data/lib/vapi_server_sdk/types/transport.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "transport_provider"
+require "ostruct"
+require "json"
+
+module Vapi
+  class Transport
+    # @return [Vapi::TransportProvider] This is the provider used for the call.
+    attr_reader :provider
+    # @return [Boolean] This is determines whether the assistant will have video enabled.
+    #  Only relevant for `webCall` type.
+    attr_reader :assistant_video_enabled
+    # @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 [Vapi::TransportProvider] This is the provider used for the call.
+    # @param assistant_video_enabled [Boolean] This is determines whether the assistant will have video enabled.
+    #  Only relevant for `webCall` type.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::Transport]
+    def initialize(provider: OMIT, assistant_video_enabled: OMIT, additional_properties: nil)
+      @provider = provider if provider != OMIT
+      @assistant_video_enabled = assistant_video_enabled if assistant_video_enabled != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "provider": provider, "assistantVideoEnabled": assistant_video_enabled }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of Transport
+    #
+    # @param json_object [String]
+    # @return [Vapi::Transport]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
+      assistant_video_enabled = parsed_json["assistantVideoEnabled"]
+      new(
+        provider: provider,
+        assistant_video_enabled: assistant_video_enabled,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of Transport 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?(Vapi::TransportProvider) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
+      obj.assistant_video_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.assistant_video_enabled is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/transport_cost.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "transport_cost_provider"
 require "ostruct"
 require "json"
 
 module Vapi
   class TransportCost
+    # @return [Vapi::TransportCostProvider]
+    attr_reader :provider
     # @return [Float] This is the minutes of `transport` usage. This should match `call.endedAt` -
     #  `call.startedAt`.
     attr_reader :minutes
@@ -18,16 +21,20 @@ module Vapi
 
     OMIT = Object.new
 
+    # @param provider [Vapi::TransportCostProvider]
     # @param minutes [Float] This is the minutes of `transport` usage. This should match `call.endedAt` -
     #  `call.startedAt`.
     # @param cost [Float] This is the cost of the component in USD.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Vapi::TransportCost]
-    def initialize(minutes:, cost:, additional_properties: nil)
+    def initialize(minutes:, cost:, provider: OMIT, additional_properties: nil)
+      @provider = provider if provider != OMIT
       @minutes = minutes
       @cost = cost
       @additional_properties = additional_properties
-      @_field_set = { "minutes": minutes, "cost": cost }
+      @_field_set = { "provider": provider, "minutes": minutes, "cost": cost }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
     # Deserialize a JSON object to an instance of TransportCost
@@ -37,9 +44,11 @@ module Vapi
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      provider = parsed_json["provider"]
       minutes = parsed_json["minutes"]
       cost = parsed_json["cost"]
       new(
+        provider: provider,
         minutes: minutes,
         cost: cost,
         additional_properties: struct
@@ -60,6 +69,7 @@ module Vapi
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.provider&.is_a?(Vapi::TransportCostProvider) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
       obj.minutes.is_a?(Float) != false || raise("Passed value for field obj.minutes is not the expected type, validation failed.")
       obj.cost.is_a?(Float) != false || raise("Passed value for field obj.cost is not the expected type, validation failed.")
     end

data/lib/vapi_server_sdk/types/transport_cost_provider.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Vapi
+  class TransportCostProvider
+    TWILIO = "twilio"
+    VONAGE = "vonage"
+    VAPI = "vapi"
+  end
+end

data/lib/vapi_server_sdk/types/transport_provider.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Vapi
+  # This is the provider used for the call.
+  class TransportProvider
+    TWILIO = "twilio"
+    VONAGE = "vonage"
+    VAPI = "vapi"
+    DAILY = "daily"
+  end
+end

data/lib/vapi_server_sdk/types/trieve_knowledge_base.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "trieve_knowledge_base_vector_store_search_plan"
+require_relative "trieve_knowledge_base_vector_store_create_plan"
+require "ostruct"
+require "json"
+
+module Vapi
+  class TrieveKnowledgeBase
+    # @return [String] This is the name of the knowledge base.
+    attr_reader :name
+    # @return [Vapi::TrieveKnowledgeBaseVectorStoreSearchPlan] This is the plan on how to search the vector store while a call is going on.
+    attr_reader :vector_store_search_plan
+    # @return [Vapi::TrieveKnowledgeBaseVectorStoreCreatePlan] This is the plan if you want us to create a new vector store on your behalf. To
+    #  use an existing vector store from your account, use `vectoreStoreProviderId`
+    attr_reader :vector_store_create_plan
+    # @return [String] This is an vector store that you already have on your account with the provider.
+    #  To create a new vector store, use vectorStoreCreatePlan.
+    #  Usage:
+    #  - To bring your own vector store from Trieve, go to https://trieve.ai
+    #  - Create a dataset, and use the datasetId here.
+    attr_reader :vector_store_provider_id
+    # @return [String] This is the id of the knowledge base.
+    attr_reader :id
+    # @return [String] This is the org id of the knowledge base.
+    attr_reader :org_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 name [String] This is the name of the knowledge base.
+    # @param vector_store_search_plan [Vapi::TrieveKnowledgeBaseVectorStoreSearchPlan] This is the plan on how to search the vector store while a call is going on.
+    # @param vector_store_create_plan [Vapi::TrieveKnowledgeBaseVectorStoreCreatePlan] This is the plan if you want us to create a new vector store on your behalf. To
+    #  use an existing vector store from your account, use `vectoreStoreProviderId`
+    # @param vector_store_provider_id [String] This is an vector store that you already have on your account with the provider.
+    #  To create a new vector store, use vectorStoreCreatePlan.
+    #  Usage:
+    #  - To bring your own vector store from Trieve, go to https://trieve.ai
+    #  - Create a dataset, and use the datasetId here.
+    # @param id [String] This is the id of the knowledge base.
+    # @param org_id [String] This is the org id of the knowledge base.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TrieveKnowledgeBase]
+    def initialize(vector_store_search_plan:, id:, org_id:, name: OMIT, vector_store_create_plan: OMIT,
+                   vector_store_provider_id: OMIT, additional_properties: nil)
+      @name = name if name != OMIT
+      @vector_store_search_plan = vector_store_search_plan
+      @vector_store_create_plan = vector_store_create_plan if vector_store_create_plan != OMIT
+      @vector_store_provider_id = vector_store_provider_id if vector_store_provider_id != OMIT
+      @id = id
+      @org_id = org_id
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "vectorStoreSearchPlan": vector_store_search_plan,
+        "vectorStoreCreatePlan": vector_store_create_plan,
+        "vectorStoreProviderId": vector_store_provider_id,
+        "id": id,
+        "orgId": org_id
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of TrieveKnowledgeBase
+    #
+    # @param json_object [String]
+    # @return [Vapi::TrieveKnowledgeBase]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      if parsed_json["vectorStoreSearchPlan"].nil?
+        vector_store_search_plan = nil
+      else
+        vector_store_search_plan = parsed_json["vectorStoreSearchPlan"].to_json
+        vector_store_search_plan = Vapi::TrieveKnowledgeBaseVectorStoreSearchPlan.from_json(json_object: vector_store_search_plan)
+      end
+      if parsed_json["vectorStoreCreatePlan"].nil?
+        vector_store_create_plan = nil
+      else
+        vector_store_create_plan = parsed_json["vectorStoreCreatePlan"].to_json
+        vector_store_create_plan = Vapi::TrieveKnowledgeBaseVectorStoreCreatePlan.from_json(json_object: vector_store_create_plan)
+      end
+      vector_store_provider_id = parsed_json["vectorStoreProviderId"]
+      id = parsed_json["id"]
+      org_id = parsed_json["orgId"]
+      new(
+        name: name,
+        vector_store_search_plan: vector_store_search_plan,
+        vector_store_create_plan: vector_store_create_plan,
+        vector_store_provider_id: vector_store_provider_id,
+        id: id,
+        org_id: org_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TrieveKnowledgeBase 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.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      Vapi::TrieveKnowledgeBaseVectorStoreSearchPlan.validate_raw(obj: obj.vector_store_search_plan)
+      obj.vector_store_create_plan.nil? || Vapi::TrieveKnowledgeBaseVectorStoreCreatePlan.validate_raw(obj: obj.vector_store_create_plan)
+      obj.vector_store_provider_id&.is_a?(String) != false || raise("Passed value for field obj.vector_store_provider_id 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.")
+    end
+  end
+end

data/lib/vapi_server_sdk/types/trieve_knowledge_base_vector_store_create_plan.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Vapi
+  class TrieveKnowledgeBaseVectorStoreCreatePlan
+    # @return [Array<String>] These are the file ids that will be used to create the vector store. To upload
+    #  files, use the `POST /files` endpoint.
+    attr_reader :file_ids
+    # @return [Float] This is an optional field which allows you to specify the number of splits you
+    #  want per chunk. If not specified, the default 20 is used. However, you may want
+    #  to use a different number.
+    attr_reader :target_splits_per_chunk
+    # @return [Array<String>] This is an optional field which allows you to specify the delimiters to use when
+    #  splitting the file before chunking the text. If not specified, the default
+    #  [.!?\n] are used to split into sentences. However, you may want to use spaces or
+    #  other delimiters.
+    attr_reader :split_delimiters
+    # @return [Boolean] This is an optional field which allows you to specify whether or not to
+    #  rebalance the chunks created from the file. If not specified, the default true
+    #  is used. If true, Trieve will evenly distribute remainder splits across chunks
+    #  such that 66 splits with a target_splits_per_chunk of 20 will result in 3 chunks
+    #  with 22 splits each.
+    attr_reader :rebalance_chunks
+    # @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 file_ids [Array<String>] These are the file ids that will be used to create the vector store. To upload
+    #  files, use the `POST /files` endpoint.
+    # @param target_splits_per_chunk [Float] This is an optional field which allows you to specify the number of splits you
+    #  want per chunk. If not specified, the default 20 is used. However, you may want
+    #  to use a different number.
+    # @param split_delimiters [Array<String>] This is an optional field which allows you to specify the delimiters to use when
+    #  splitting the file before chunking the text. If not specified, the default
+    #  [.!?\n] are used to split into sentences. However, you may want to use spaces or
+    #  other delimiters.
+    # @param rebalance_chunks [Boolean] This is an optional field which allows you to specify whether or not to
+    #  rebalance the chunks created from the file. If not specified, the default true
+    #  is used. If true, Trieve will evenly distribute remainder splits across chunks
+    #  such that 66 splits with a target_splits_per_chunk of 20 will result in 3 chunks
+    #  with 22 splits each.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vapi::TrieveKnowledgeBaseVectorStoreCreatePlan]
+    def initialize(file_ids:, target_splits_per_chunk: OMIT, split_delimiters: OMIT, rebalance_chunks: OMIT,
+                   additional_properties: nil)
+      @file_ids = file_ids
+      @target_splits_per_chunk = target_splits_per_chunk if target_splits_per_chunk != OMIT
+      @split_delimiters = split_delimiters if split_delimiters != OMIT
+      @rebalance_chunks = rebalance_chunks if rebalance_chunks != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "fileIds": file_ids,
+        "targetSplitsPerChunk": target_splits_per_chunk,
+        "splitDelimiters": split_delimiters,
+        "rebalanceChunks": rebalance_chunks
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of
+    #  TrieveKnowledgeBaseVectorStoreCreatePlan
+    #
+    # @param json_object [String]
+    # @return [Vapi::TrieveKnowledgeBaseVectorStoreCreatePlan]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      file_ids = parsed_json["fileIds"]
+      target_splits_per_chunk = parsed_json["targetSplitsPerChunk"]
+      split_delimiters = parsed_json["splitDelimiters"]
+      rebalance_chunks = parsed_json["rebalanceChunks"]
+      new(
+        file_ids: file_ids,
+        target_splits_per_chunk: target_splits_per_chunk,
+        split_delimiters: split_delimiters,
+        rebalance_chunks: rebalance_chunks,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of TrieveKnowledgeBaseVectorStoreCreatePlan 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.file_ids.is_a?(Array) != false || raise("Passed value for field obj.file_ids is not the expected type, validation failed.")
+      obj.target_splits_per_chunk&.is_a?(Float) != false || raise("Passed value for field obj.target_splits_per_chunk is not the expected type, validation failed.")
+      obj.split_delimiters&.is_a?(Array) != false || raise("Passed value for field obj.split_delimiters is not the expected type, validation failed.")
+      obj.rebalance_chunks&.is_a?(Boolean) != false || raise("Passed value for field obj.rebalance_chunks is not the expected type, validation failed.")
+    end
+  end
+end