feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 42
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml
-openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-eab9713fd85da68b41e881dfd9cd71f654e8620132da2023bab7dd01e5f7852e.yml
+openapi_spec_hash: b5037b26fbe7360c6bfaf9947a65bb85
 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c

README.md

@@ -33,10 +33,7 @@ image_kit = Imagekit::Client.new(
   password: ENV["OPTIONAL_IMAGEKIT_IGNORES_THIS"] # This is the default and can be omitted
 )
 
-response = image_kit.files.upload(
-  file: StringIO.new("https://www.example.com/public-url.jpg"),
-  file_name: "file-name.jpg"
-)
+response = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg")
 
 puts(response.videoCodec)
 ```
@@ -49,14 +46,14 @@ Request parameters that correspond to file uploads can be passed as raw contents
 require "pathname"
 
 # Use `Pathname` to send the filename and/or avoid paging a large file into memory:
-response = image_kit.files.upload(file: Pathname("/path/to/file"))
+response = image_kit.beta.v2.files.upload(file: Pathname("/path/to/file"))
 
 # Alternatively, pass file contents or a `StringIO` directly:
-response = image_kit.files.upload(file: File.read("/path/to/file"))
+response = image_kit.beta.v2.files.upload(file: File.read("/path/to/file"))
 
 # Or, to control the filename and/or content type:
 file = Imagekit::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")
-response = image_kit.files.upload(file: file)
+response = image_kit.beta.v2.files.upload(file: file)
 
 puts(response.videoCodec)
 ```
@@ -69,10 +66,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  file = image_kit.files.upload(
-    file: StringIO.new("https://www.example.com/public-url.jpg"),
-    file_name: "file-name.jpg"
-  )
+  file = image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg")
 rescue Imagekit::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -116,7 +110,7 @@ image_kit = Imagekit::Client.new(
 
 # Or, configure per-request:
 image_kit.files.upload(
-  file: StringIO.new("https://www.example.com/public-url.jpg"),
+  file: "https://www.example.com/public-url.jpg",
   file_name: "file-name.jpg",
   request_options: {max_retries: 5}
 )
@@ -134,7 +128,7 @@ image_kit = Imagekit::Client.new(
 
 # Or, configure per-request:
 image_kit.files.upload(
-  file: StringIO.new("https://www.example.com/public-url.jpg"),
+  file: "https://www.example.com/public-url.jpg",
   file_name: "file-name.jpg",
   request_options: {timeout: 5}
 )
@@ -169,7 +163,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 ```ruby
 response =
   image_kit.files.upload(
-    file: StringIO.new("https://www.example.com/public-url.jpg"),
+    file: "https://www.example.com/public-url.jpg",
     file_name: "file-name.jpg",
     request_options: {
       extra_query: {my_query_parameter: value},
@@ -216,26 +210,17 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-image_kit.files.upload(
-  file: StringIO.new("https://www.example.com/public-url.jpg"),
-  file_name: "file-name.jpg"
-)
+image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg")
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-image_kit.files.upload(
-  file: StringIO.new("https://www.example.com/public-url.jpg"),
-  file_name: "file-name.jpg"
-)
+image_kit.files.upload(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg")
 
 # You can also splat a full Params class:
-params = Imagekit::FileUploadParams.new(
-  file: StringIO.new("https://www.example.com/public-url.jpg"),
-  file_name: "file-name.jpg"
-)
+params = Imagekit::FileUploadParams.new(file: "https://www.example.com/public-url.jpg", file_name: "file-name.jpg")
 image_kit.files.upload(**params)
 ```
 

lib/imagekit/models/file_upload_params.rb

@@ -18,8 +18,8 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel
       #   When supplying a URL, the server must receive the response headers within 8
       #   seconds; otherwise the request fails with 400 Bad Request.
       #
-      #   @return [Pathname, StringIO, IO, String, Imagekit::FilePart]
-      required :file, Imagekit::Internal::Type::FileInput
+      #   @return [String]
+      required :file, String
 
       # @!attribute file_name
       #   The name with which the file has to be uploaded. The file name can contain:
@@ -240,7 +240,7 @@ class FileUploadParams < Imagekit::Internal::Type::BaseModel
       #   Some parameter documentations has been truncated, see
       #   {Imagekit::Models::FileUploadParams} for more details.
       #
-      #   @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following:
+      #   @param file [String] The API accepts any of the following:
       #
       #   @param file_name [String] The name with which the file has to be uploaded.
       #

lib/imagekit/resources/files.rb

@@ -221,7 +221,7 @@ def rename(params)
       #
       # @overload upload(file:, file_name:, token: nil, checks: nil, custom_coordinates: nil, custom_metadata: nil, description: nil, expire: nil, extensions: nil, folder: nil, is_private_file: nil, is_published: nil, overwrite_ai_tags: nil, overwrite_custom_metadata: nil, overwrite_file: nil, overwrite_tags: nil, public_key: nil, response_fields: nil, signature: nil, tags: nil, transformation: nil, use_unique_file_name: nil, webhook_url: nil, request_options: {})
       #
-      # @param file [Pathname, StringIO, IO, String, Imagekit::FilePart] The API accepts any of the following:
+      # @param file [String] The API accepts any of the following:
       #
       # @param file_name [String] The name with which the file has to be uploaded.
       #

rbi/imagekit/models/file_upload_params.rbi

@@ -20,7 +20,7 @@ module Imagekit
       #
       # When supplying a URL, the server must receive the response headers within 8
       # seconds; otherwise the request fails with 400 Bad Request.
-      sig { returns(Imagekit::Internal::FileInput) }
+      sig { returns(String) }
       attr_accessor :file
 
       # The name with which the file has to be uploaded. The file name can contain:
@@ -290,7 +290,7 @@ module Imagekit
 
       sig do
         params(
-          file: Imagekit::Internal::FileInput,
+          file: String,
           file_name: String,
           token: String,
           checks: String,
@@ -462,7 +462,7 @@ module Imagekit
       sig do
         override.returns(
           {
-            file: Imagekit::Internal::FileInput,
+            file: String,
             file_name: String,
             token: String,
             checks: String,

rbi/imagekit/resources/files.rbi

@@ -189,7 +189,7 @@ module Imagekit
       #   technologies.
       sig do
         params(
-          file: Imagekit::Internal::FileInput,
+          file: String,
           file_name: String,
           token: String,
           checks: String,

sig/imagekit/models/file_upload_params.rbs

@@ -2,7 +2,7 @@ module Imagekit
   module Models
     type file_upload_params =
       {
-        file: Imagekit::Internal::file_input,
+        file: String,
         file_name: String,
         token: String,
         checks: String,
@@ -32,7 +32,7 @@ module Imagekit
       extend Imagekit::Internal::Type::RequestParameters::Converter
       include Imagekit::Internal::Type::RequestParameters
 
-      attr_accessor file: Imagekit::Internal::file_input
+      attr_accessor file: String
 
       attr_accessor file_name: String
 
@@ -127,7 +127,7 @@ module Imagekit
       def webhook_url=: (String) -> String
 
       def initialize: (
-        file: Imagekit::Internal::file_input,
+        file: String,
         file_name: String,
         ?token: String,
         ?checks: String,
@@ -154,7 +154,7 @@ module Imagekit
       ) -> void
 
       def to_hash: -> {
-        file: Imagekit::Internal::file_input,
+        file: String,
         file_name: String,
         token: String,
         checks: String,

sig/imagekit/resources/files.rbs

@@ -44,7 +44,7 @@ module Imagekit
       ) -> Imagekit::Models::FileRenameResponse
 
       def upload: (
-        file: Imagekit::Internal::file_input,
+        file: String,
         file_name: String,
         ?token: String,
         ?checks: String,

test/imagekit/client_test.rb

@@ -45,7 +45,7 @@ def test_client_default_request_default_retry_attempts
       )
 
     assert_raises(Imagekit::Errors::InternalServerError) do
-      image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+      image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
     end
 
     assert_requested(:any, /./, times: 3)
@@ -63,7 +63,7 @@ def test_client_given_request_default_retry_attempts
       )
 
     assert_raises(Imagekit::Errors::InternalServerError) do
-      image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+      image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
     end
 
     assert_requested(:any, /./, times: 4)
@@ -81,7 +81,7 @@ def test_client_default_request_given_retry_attempts
 
     assert_raises(Imagekit::Errors::InternalServerError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {max_retries: 3}
       )
@@ -103,7 +103,7 @@ def test_client_given_request_given_retry_attempts
 
     assert_raises(Imagekit::Errors::InternalServerError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {max_retries: 4}
       )
@@ -128,7 +128,7 @@ def test_client_retry_after_seconds
       )
 
     assert_raises(Imagekit::Errors::InternalServerError) do
-      image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+      image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
     end
 
     assert_requested(:any, /./, times: 2)
@@ -152,7 +152,7 @@ def test_client_retry_after_date
 
     assert_raises(Imagekit::Errors::InternalServerError) do
       Thread.current.thread_variable_set(:time_now, Time.now)
-      image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+      image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
       Thread.current.thread_variable_set(:time_now, nil)
     end
 
@@ -176,7 +176,7 @@ def test_client_retry_after_ms
       )
 
     assert_raises(Imagekit::Errors::InternalServerError) do
-      image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+      image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
     end
 
     assert_requested(:any, /./, times: 2)
@@ -194,7 +194,7 @@ def test_retry_count_header
       )
 
     assert_raises(Imagekit::Errors::InternalServerError) do
-      image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+      image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
     end
 
     3.times do
@@ -214,7 +214,7 @@ def test_omit_retry_count_header
 
     assert_raises(Imagekit::Errors::InternalServerError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {extra_headers: {"x-stainless-retry-count" => nil}}
       )
@@ -237,7 +237,7 @@ def test_overwrite_retry_count_header
 
     assert_raises(Imagekit::Errors::InternalServerError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {extra_headers: {"x-stainless-retry-count" => "42"}}
       )
@@ -266,7 +266,7 @@ def test_client_redirect_307
 
     assert_raises(Imagekit::Errors::APIConnectionError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {extra_headers: {}}
       )
@@ -304,7 +304,7 @@ def test_client_redirect_303
 
     assert_raises(Imagekit::Errors::APIConnectionError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {extra_headers: {}}
       )
@@ -337,7 +337,7 @@ def test_client_redirect_auth_keep_same_origin
 
     assert_raises(Imagekit::Errors::APIConnectionError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {extra_headers: {"authorization" => "Bearer xyz"}}
       )
@@ -373,7 +373,7 @@ def test_client_redirect_auth_strip_cross_origin
 
     assert_raises(Imagekit::Errors::APIConnectionError) do
       image_kit.files.upload(
-        file: Pathname(__FILE__),
+        file: "https://www.example.com/path/to-image.jpg",
         file_name: "fileName",
         request_options: {extra_headers: {"authorization" => "Bearer xyz"}}
       )
@@ -395,7 +395,7 @@ def test_default_headers
         password: "My Password"
       )
 
-    image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+    image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
 
     assert_requested(:any, /./) do |req|
       headers = req.headers.transform_keys(&:downcase).fetch_values("accept", "content-type")

test/imagekit/resources/files_test.rb

@@ -113,7 +113,8 @@ def test_rename_required_params
   def test_upload_required_params
     skip("Prism tests are disabled")
 
-    response = @image_kit.files.upload(file: Pathname(__FILE__), file_name: "fileName")
+    response =
+      @image_kit.files.upload(file: "https://www.example.com/path/to-image.jpg", file_name: "fileName")
 
     assert_pattern do
       response => Imagekit::Models::FileUploadResponse