turbopuffer 1.18.0 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392026af67d721a1c1e41655fa994e4b091513a09098debb10dfe3d7f5b28b10
-  data.tar.gz: b2594569c7c125a0ac5adf38e0a2837143672f8c5e2fac0d2c6e44c1a9e74f27
+  metadata.gz: 6fde3b29deac3a828174a6a5f6255d81bde5182f8c4b4cb83f702e16c69a2c6c
+  data.tar.gz: 90aabb5c4ce6118046e6a93063f0ead79498511fc1a61f0d61f1da0b961ac51d
 SHA512:
-  metadata.gz: 5479a222309efe4bcf5c8405c3801e1b69701ae752e97629503da8fb575267f6a5ae1c9ad25761c76c4cc0e390e8ba5b236fdbd950fbcd4a6901ab7f9d4170e9
-  data.tar.gz: c8ae2cdf9de61b0766fb85f8de6e647d8eeda1d5d59fa5de98dbe69d22d02ae7a7106e4ac9403cba15a5449f21bff58cea6b0cf015dbbd89072f94c5bae02a6b
+  metadata.gz: a3c9579b604aee56e05f0617558f582c41591c7570d577a739404916c07dc4aaf5c77988823c3d630720157aaa262ac50d6ae20e4c4a906b2582293688196b81
+  data.tar.gz: a7da8ab2ba206e0282f8db9b7d55a096d3248db24456ec3674c87b64f8db8222a869a42b346a329eaab390ecfdfcdb90f45648f7ef076af6409b7779b42a9735

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## 2.0.0-alpha.1 (2026-04-29)
+
+Full Changelog: [v1.19.0...v2.0.0-alpha.1](https://github.com/turbopuffer/turbopuffer-ruby/compare/v1.19.0...v2.0.0-alpha.1)
+
+### Features
+
+* Add sparse vectors to the spec. ([060434a](https://github.com/turbopuffer/turbopuffer-ruby/commit/060434a1516b678fdf8090b9c7d37c9b9102c3f3))
+* Enable Stainless normalizer v2 while keeping Query inlined ([20d751b](https://github.com/turbopuffer/turbopuffer-ruby/commit/20d751b10ff3a74dfc27f5f5baf4ac41ee50f71d))
+* Require `fuzzy: true` in the schema to use the `Fuzzy` filter ([7408995](https://github.com/turbopuffer/turbopuffer-ruby/commit/7408995fefd4c32638309feefe39e1c4d474213b))
+* set up branchFrom and copyFrom sugar in the OpenAPI spec ([3b0df07](https://github.com/turbopuffer/turbopuffer-ruby/commit/3b0df076ee081ed3ddf129be8762d683a949845c))
+* spec: flatten branchFrom/copyFrom sugar endpoint params ([06214bc](https://github.com/turbopuffer/turbopuffer-ruby/commit/06214bcbded87f2c214b3fc7b2cf2309540b197b))
+* spec: update OpenAPI spec for v2 encryption API ([0c2654f](https://github.com/turbopuffer/turbopuffer-ruby/commit/0c2654fdb779231b867c4c40f9ff9e904601ca3c))
+* support setting headers via env ([a0c4d53](https://github.com/turbopuffer/turbopuffer-ruby/commit/a0c4d53342da77dfbf07f60350246ab418926cff))
+
+
+### Bug Fixes
+
+* multipart encoding for file arrays ([bca18a3](https://github.com/turbopuffer/turbopuffer-ruby/commit/bca18a3d40304187b478ec130b274316fb95125a))
+
+
+### Chores
+
+* **internal:** more robust bootstrap script ([0b727d5](https://github.com/turbopuffer/turbopuffer-ruby/commit/0b727d5f42db0363d4143b8a912621c2c892c93f))
+
+## 1.19.0 (2026-04-06)
+
+Full Changelog: [v1.18.0...v1.19.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v1.18.0...v1.19.0)
+
+### Features
+
+* add update_metadata method to configure pinning ([f59a80b](https://github.com/turbopuffer/turbopuffer-ruby/commit/f59a80b8ff95b181a07d7bf2feb9715bf6ed2080))
+* docs for glob/regex acceleration ([bafcf09](https://github.com/turbopuffer/turbopuffer-ruby/commit/bafcf09b3b25db23394a76cf6acb688f471a35ea))
+* Multiple Vector Columns Docs ([76392ee](https://github.com/turbopuffer/turbopuffer-ruby/commit/76392ee17ea6ea2d177b7002ca791c27bff394d6))
+* spec: include pinning status in /metadata response ([0ff4fa4](https://github.com/turbopuffer/turbopuffer-ruby/commit/0ff4fa4877dea26f3c5786891632b060e97ad7a2))
+
+
+### Bug Fixes
+
+* align path encoding with RFC 3986 section 3.3 ([77633f8](https://github.com/turbopuffer/turbopuffer-ruby/commit/77633f885d255631ce1d4b48075c87f5120973ab))
+* **internal:** correct multipart form field name encoding ([7f54d40](https://github.com/turbopuffer/turbopuffer-ruby/commit/7f54d4035b422d568d640ad74d0a311135743927))
+* variable name typo ([7b17a7a](https://github.com/turbopuffer/turbopuffer-ruby/commit/7b17a7a9830198e0ffa46c406bdf87ea865f5863))
+
+
+### Chores
+
+* **ci:** skip lint on metadata-only changes ([016dab3](https://github.com/turbopuffer/turbopuffer-ruby/commit/016dab37b9e2e92fb14dfea9e814590f329a7cc5))
+* **ci:** support opting out of skipping builds on metadata-only commits ([afc1d7d](https://github.com/turbopuffer/turbopuffer-ruby/commit/afc1d7d3f532ac4d79b73a171308d627e14afd68))
+* **internal:** update gitignore ([cb07b77](https://github.com/turbopuffer/turbopuffer-ruby/commit/cb07b772afcb6337e032217f724cc9d121004adc))
+
 ## 1.18.0 (2026-03-20)
 
 Full Changelog: [v1.17.0...v1.18.0](https://github.com/turbopuffer/turbopuffer-ruby/compare/v1.17.0...v1.18.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "turbopuffer", "~> 1.18.0"
+gem "turbopuffer", "~> 2.0.0.pre.alpha.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/turbopuffer/client.rb

@@ -109,6 +109,19 @@ module Turbopuffer
         raise ArgumentError.new("api_key is required, and can be set via environ: \"TURBOPUFFER_API_KEY\"")
       end
 
+      headers = compression ? {} : {"accept-encoding" => "identity"}
+      custom_headers_env = ENV["TURBOPUFFER_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       if base_url.include?("{region}")
         if region.nil?
           raise ArgumentError.new("region is required when base_url contains {region} placeholder: #{base_url}")
@@ -128,7 +141,7 @@ module Turbopuffer
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
         max_retry_delay: max_retry_delay,
-        headers: compression ? {} : {"accept-encoding" => "identity"}
+        headers: headers
       )
     end
   end

data/lib/turbopuffer/internal/util.rb

@@ -157,7 +157,7 @@ module Turbopuffer
           in Hash | nil => coerced
             coerced
           else
-            message = "Expected a #{Hash} or #{Turbopuffer::Internal::Type::BaseModel}, got #{data.inspect}"
+            message = "Expected a #{Hash} or #{Turbopuffer::Internal::Type::BaseModel}, got #{input.inspect}"
             raise ArgumentError.new(message)
           end
         end
@@ -237,6 +237,11 @@ module Turbopuffer
         end
       end
 
+      # @type [Regexp]
+      #
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = /[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/
+
       class << self
         # @api private
         #
@@ -247,6 +252,15 @@ module Turbopuffer
           "#{uri.scheme}://#{uri.host}#{":#{uri.port}" unless uri.port == uri.default_port}"
         end
 
+        # @api private
+        #
+        # @param path [String, Integer]
+        #
+        # @return [String]
+        def encode_path(path)
+          path.to_s.gsub(Turbopuffer::Internal::Util::RFC_3986_NOT_PCHARS) { ERB::Util.url_encode(_1) }
+        end
+
         # @api private
         #
         # @param path [String, Array<String>]
@@ -259,7 +273,7 @@ module Turbopuffer
           in []
             ""
           in [String => p, *interpolations]
-            encoded = interpolations.map { ERB::Util.url_encode(_1) }
+            encoded = interpolations.map { encode_path(_1) }
             format(p, *encoded)
           end
         end
@@ -571,16 +585,15 @@ module Turbopuffer
           y << "Content-Disposition: form-data"
 
           unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
+            y << "; name=\"#{key}\""
           end
 
           case val
           in Turbopuffer::FilePart unless val.filename.nil?
-            filename = ERB::Util.url_encode(val.filename)
+            filename = encode_path(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(::File.basename(val.to_path))
+            filename = encode_path(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -597,6 +610,7 @@ module Turbopuffer
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
+          # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
@@ -606,7 +620,7 @@ module Turbopuffer
             in Hash
               body.each do |key, val|
                 case val
-                in Array if val.all? { primitive?(_1) }
+                in Array if val.all? { primitive?(_1) || Turbopuffer::Internal::Type::FileInput === _1 }
                   val.each do |v|
                     write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
                   end
@@ -622,6 +636,7 @@ module Turbopuffer
 
           fused_io = fused_enum(strio) { closing.each(&:call) }
           [boundary, fused_io]
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private

data/lib/turbopuffer/models/attribute_schema.rb

@@ -6,7 +6,7 @@ module Turbopuffer
     module AttributeSchema
       extend Turbopuffer::Internal::Type::Union
 
-      # The data type of the attribute. Valid values: string, int, uint, float, uuid, datetime, bool, []string, []int, []uint, []float, []uuid, []datetime, []bool, [DIMS]f16, [DIMS]f32.
+      # The data type of the attribute. Valid values: string, int, uint, float, uuid, datetime, bool, []string, []int, []uint, []float, []uuid, []datetime, []bool, [DIMS]f16, [DIMS]f32, {}f16.
       variant -> { Turbopuffer::AttributeType }
 
       # Detailed configuration for an attribute attached to a document.

data/lib/turbopuffer/models/attribute_schema_config.rb

@@ -6,7 +6,7 @@ module Turbopuffer
       # @!attribute type
       #   The data type of the attribute. Valid values: string, int, uint, float, uuid,
       #   datetime, bool, []string, []int, []uint, []float, []uuid, []datetime, []bool,
-      #   [DIMS]f16, [DIMS]f32.
+      #   [DIMS]f16, [DIMS]f32, {}f16.
       #
       #   @return [String]
       required :type, String
@@ -32,13 +32,32 @@ module Turbopuffer
       #   @return [Boolean, Turbopuffer::Models::FullTextSearchConfig, nil]
       optional :full_text_search, union: -> { Turbopuffer::FullTextSearch }
 
+      # @!attribute fuzzy
+      #   Whether to enable Fuzzy filters on this attribute.
+      #
+      #   @return [Boolean, nil]
+      optional :fuzzy, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute glob
+      #   Whether to enable Glob filters on this attribute.
+      #
+      #   @return [Boolean, nil]
+      optional :glob, Turbopuffer::Internal::Type::Boolean
+
       # @!attribute regex
       #   Whether to enable Regex filters on this attribute.
       #
       #   @return [Boolean, nil]
       optional :regex, Turbopuffer::Internal::Type::Boolean
 
-      # @!method initialize(type:, ann: nil, filterable: nil, full_text_search: nil, regex: nil)
+      # @!attribute sparse_knn
+      #   Whether to create a sparse kNN index for the attribute. Requires the `{}f16`
+      #   type.
+      #
+      #   @return [Turbopuffer::Models::AttributeSchemaConfig::SparseKnn, nil]
+      optional :sparse_knn, -> { Turbopuffer::AttributeSchemaConfig::SparseKnn }
+
+      # @!method initialize(type:, ann: nil, filterable: nil, full_text_search: nil, fuzzy: nil, glob: nil, regex: nil, sparse_knn: nil)
       #   Some parameter documentations has been truncated, see
       #   {Turbopuffer::Models::AttributeSchemaConfig} for more details.
       #
@@ -52,7 +71,13 @@ module Turbopuffer
       #
       #   @param full_text_search [Boolean, Turbopuffer::Models::FullTextSearchConfig] Whether this attribute can be used as part of a BM25 full-text search. Requires
       #
+      #   @param fuzzy [Boolean] Whether to enable Fuzzy filters on this attribute.
+      #
+      #   @param glob [Boolean] Whether to enable Glob filters on this attribute.
+      #
       #   @param regex [Boolean] Whether to enable Regex filters on this attribute.
+      #
+      #   @param sparse_knn [Turbopuffer::Models::AttributeSchemaConfig::SparseKnn] Whether to create a sparse kNN index for the attribute. Requires the `{}f16` typ
 
       # Whether to create an approximate nearest neighbor index for the attribute. Can
       # be a boolean or a detailed configuration object.
@@ -82,6 +107,21 @@ module Turbopuffer
         # @!method self.variants
         #   @return [Array(Boolean, Turbopuffer::Models::AttributeSchemaConfig::Ann::AnnConfig)]
       end
+
+      # @see Turbopuffer::Models::AttributeSchemaConfig#sparse_knn
+      class SparseKnn < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute distance_metric
+        #   A function used to calculate sparse vector similarity.
+        #
+        #   @return [Symbol, :dot_product]
+        required :distance_metric, const: :dot_product
+
+        # @!method initialize(distance_metric: :dot_product)
+        #   Whether to create a sparse kNN index for the attribute. Requires the `{}f16`
+        #   type.
+        #
+        #   @param distance_metric [Symbol, :dot_product] A function used to calculate sparse vector similarity.
+      end
     end
   end
 end

data/lib/turbopuffer/models/columns.rb

@@ -32,20 +32,14 @@ module Turbopuffer
         # The vector embeddings of the documents.
         variant -> { Turbopuffer::Models::Columns::Vector::VectorArray }
 
-        # A dense vector encoded as an array of floats.
-        variant -> { Turbopuffer::Models::Columns::Vector::FloatArray }
-
-        # A dense vector encoded as a base64 string.
-        variant String
+        # A vector embedding associated with a document.
+        variant union: -> { Turbopuffer::Vector }
 
         # @!method self.variants
         #   @return [Array(Array<Array<Float>, String>, Array<Float>, String)]
 
         # @type [Turbopuffer::Internal::Type::Converter]
         VectorArray = Turbopuffer::Internal::Type::ArrayOf[union: -> { Turbopuffer::Vector }]
-
-        # @type [Turbopuffer::Internal::Type::Converter]
-        FloatArray = Turbopuffer::Internal::Type::ArrayOf[Float]
       end
 
       def method_missing(name, *args, &block)

data/lib/turbopuffer/models/encryption.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # The encryption configuration for a namespace.
+    module Encryption
+      extend Turbopuffer::Internal::Type::Union
+
+      # Encrypt the namespace with a customer-managed encryption key (CMEK).
+      variant -> { Turbopuffer::Encryption::CustomerManaged }
+
+      # Use the default server-side encryption (SSE).
+      variant -> { Turbopuffer::Encryption::Default }
+
+      class CustomerManaged < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute key_name
+        #   The identifier of the CMEK key to use for encryption. For GCP, the
+        #   fully-qualified resource name of the key. For AWS, the ARN of the key.
+        #
+        #   @return [String]
+        required :key_name, String
+
+        # @!attribute mode
+        #
+        #   @return [Symbol, :"customer-managed"]
+        required :mode, const: :"customer-managed"
+
+        # @!method initialize(key_name:, mode: :"customer-managed")
+        #   Some parameter documentations has been truncated, see
+        #   {Turbopuffer::Models::Encryption::CustomerManaged} for more details.
+        #
+        #   Encrypt the namespace with a customer-managed encryption key (CMEK).
+        #
+        #   @param key_name [String] The identifier of the CMEK key to use for encryption. For GCP, the fully-qualifi
+        #
+        #   @param mode [Symbol, :"customer-managed"]
+      end
+
+      class Default < Turbopuffer::Internal::Type::BaseModel
+        # @!attribute mode
+        #
+        #   @return [Symbol, :default]
+        required :mode, const: :default
+
+        # @!method initialize(mode: :default)
+        #   Use the default server-side encryption (SSE).
+        #
+        #   @param mode [Symbol, :default]
+      end
+
+      # @!method self.variants
+      #   @return [Array(Turbopuffer::Models::Encryption::CustomerManaged, Turbopuffer::Models::Encryption::Default)]
+    end
+  end
+end

data/lib/turbopuffer/models/id.rb

@@ -6,7 +6,7 @@ module Turbopuffer
     module ID
       extend Turbopuffer::Internal::Type::Union
 
-      # A UUID.
+      # A string ID.
       variant String
 
       # An integer ID.

data/lib/turbopuffer/models/limit.rb

@@ -41,9 +41,6 @@ module Turbopuffer
         required :limit, Integer
 
         # @!method initialize(attributes:, limit:)
-        #   Some parameter documentations has been truncated, see
-        #   {Turbopuffer::Models::Limit::Per} for more details.
-        #
         #   Limits the number of documents with the same value for a set of attributes (the
         #   "limit key") that can appear in the results.
         #

data/lib/turbopuffer/models/namespace_branch_from_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#branch_from
+    class NamespaceBranchFromParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!attribute source_namespace
+      #   The namespace to create an instant, copy-on-write clone of.
+      #
+      #   @return [String]
+      required :source_namespace, String
+
+      # @!method initialize(source_namespace:, namespace: nil, request_options: {})
+      #   @param source_namespace [String] The namespace to create an instant, copy-on-write clone of.
+      #
+      #   @param namespace [String]
+      #
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_branch_from_response.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#branch_from
+    class NamespaceBranchFromResponse < Turbopuffer::Internal::Type::BaseModel
+      # @!attribute billing
+      #   The billing information for a write request.
+      #
+      #   @return [Turbopuffer::Models::WriteBilling]
+      required :billing, -> { Turbopuffer::WriteBilling }
+
+      # @!attribute message
+      #   A message describing the result of the write request.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute rows_affected
+      #   The number of rows affected by the write request.
+      #
+      #   @return [Integer]
+      required :rows_affected, Integer
+
+      # @!attribute status
+      #   The status of the request.
+      #
+      #   @return [Symbol, :OK]
+      required :status, const: :OK
+
+      # @!attribute deleted_ids
+      #   The IDs of documents that were deleted. Only included when `return_affected_ids`
+      #   is true and at least one document was deleted.
+      #
+      #   @return [Array<String, Integer>, nil]
+      optional :deleted_ids, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!attribute patched_ids
+      #   The IDs of documents that were patched. Only included when `return_affected_ids`
+      #   is true and at least one document was patched.
+      #
+      #   @return [Array<String, Integer>, nil]
+      optional :patched_ids, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!attribute performance
+      #   The performance information for a write request.
+      #
+      #   @return [Turbopuffer::Models::WritePerformance, nil]
+      optional :performance, -> { Turbopuffer::WritePerformance }
+
+      # @!attribute rows_deleted
+      #   The number of rows deleted by the write request.
+      #
+      #   @return [Integer, nil]
+      optional :rows_deleted, Integer
+
+      # @!attribute rows_patched
+      #   The number of rows patched by the write request.
+      #
+      #   @return [Integer, nil]
+      optional :rows_patched, Integer
+
+      # @!attribute rows_remaining
+      #   Whether more documents match the filter for partial operations.
+      #
+      #   @return [Boolean, nil]
+      optional :rows_remaining, Turbopuffer::Internal::Type::Boolean
+
+      # @!attribute rows_upserted
+      #   The number of rows upserted by the write request.
+      #
+      #   @return [Integer, nil]
+      optional :rows_upserted, Integer
+
+      # @!attribute upserted_ids
+      #   The IDs of documents that were upserted. Only included when
+      #   `return_affected_ids` is true and at least one document was upserted.
+      #
+      #   @return [Array<String, Integer>, nil]
+      optional :upserted_ids, -> { Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::ID] }
+
+      # @!method initialize(billing:, message:, rows_affected:, deleted_ids: nil, patched_ids: nil, performance: nil, rows_deleted: nil, rows_patched: nil, rows_remaining: nil, rows_upserted: nil, upserted_ids: nil, status: :OK)
+      #   Some parameter documentations has been truncated, see
+      #   {Turbopuffer::Models::NamespaceBranchFromResponse} for more details.
+      #
+      #   The response to a successful write request.
+      #
+      #   @param billing [Turbopuffer::Models::WriteBilling] The billing information for a write request.
+      #
+      #   @param message [String] A message describing the result of the write request.
+      #
+      #   @param rows_affected [Integer] The number of rows affected by the write request.
+      #
+      #   @param deleted_ids [Array<String, Integer>] The IDs of documents that were deleted. Only included when `return_affected_ids`
+      #
+      #   @param patched_ids [Array<String, Integer>] The IDs of documents that were patched. Only included when `return_affected_ids`
+      #
+      #   @param performance [Turbopuffer::Models::WritePerformance] The performance information for a write request.
+      #
+      #   @param rows_deleted [Integer] The number of rows deleted by the write request.
+      #
+      #   @param rows_patched [Integer] The number of rows patched by the write request.
+      #
+      #   @param rows_remaining [Boolean] Whether more documents match the filter for partial operations.
+      #
+      #   @param rows_upserted [Integer] The number of rows upserted by the write request.
+      #
+      #   @param upserted_ids [Array<String, Integer>] The IDs of documents that were upserted. Only included when `return_affected_ids
+      #
+      #   @param status [Symbol, :OK] The status of the request.
+    end
+  end
+end

data/lib/turbopuffer/models/namespace_copy_from_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Turbopuffer
+  module Models
+    # @see Turbopuffer::Resources::Namespaces#copy_from
+    class NamespaceCopyFromParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String, nil]
+      optional :namespace, String
+
+      # @!attribute source_namespace
+      #   The namespace to copy documents from.
+      #
+      #   @return [String]
+      required :source_namespace, String
+
+      # @!attribute source_api_key
+      #   (Optional) An API key for the organization containing the source namespace
+      #
+      #   @return [String, nil]
+      optional :source_api_key, String
+
+      # @!attribute source_region
+      #   (Optional) The region of the source namespace.
+      #
+      #   @return [String, nil]
+      optional :source_region, String
+
+      # @!method initialize(source_namespace:, namespace: nil, source_api_key: nil, source_region: nil, request_options: {})
+      #   @param source_namespace [String] The namespace to copy documents from.
+      #
+      #   @param namespace [String]
+      #
+      #   @param source_api_key [String] (Optional) An API key for the organization containing the source namespace
+      #
+      #   @param source_region [String] (Optional) The region of the source namespace.
+      #
+      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end