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-e7bc47a9221d7da9c8c9653d3fd1d4cfdf2408588e32c4aa62bd02a50ec93c36.yml
-openapi_spec_hash: 8d061396a2fff9d1add4d5baf03ab939
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-667f7f4988b44bc587d6eb9960ff5c8326e9f7e9b072f3f724f9f54166eff8b1.yml
+openapi_spec_hash: f2081864a4abee0480e5ff991b4c936a
 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c

README.md

@@ -52,9 +52,7 @@ $client = new Client(
   password: getenv("OPTIONAL_IMAGEKIT_IGNORES_THIS") ?: "do_not_set",
 );
 
-$response = $client->files->upload(
-  file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg"
-);
+$response = $client->files->upload(file: 'file', fileName: "file-name.jpg");
 
 var_dump($response->videoCodec);
 ```
@@ -76,9 +74,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 use ImageKit\Core\Exceptions\APIConnectionException;
 
 try {
-  $response = $client->files->upload(
-    file: "https://www.example.com/public-url.jpg", fileName: "file-name.jpg"
-  );
+  $response = $client->files->upload(file: 'file', fileName: "file-name.jpg");
 } catch (APIConnectionException $e) {
   echo "The server could not be reached", PHP_EOL;
   var_dump($e->getPrevious());
@@ -126,7 +122,7 @@ $client = new Client(maxRetries: 0);
 // Or, configure per-request:
 
 $result = $client->files->upload(
-  file: "https://www.example.com/public-url.jpg",
+  file: 'file',
   fileName: "file-name.jpg",
   requestOptions: RequestOptions::with(maxRetries: 5),
 );
@@ -148,7 +144,7 @@ Note: the `extra*` parameters of the same name overrides the documented paramete
 use ImageKit\RequestOptions;
 
 $response = $client->files->upload(
-  file: "https://www.example.com/public-url.jpg",
+  file: 'file',
   fileName: "file-name.jpg",
   requestOptions: RequestOptions::with(
     extraQueryParams: ["my_query_parameter" => "value"],

src/Core/ServiceContracts/FilesContract.php

@@ -104,7 +104,13 @@ public function rename(
     /**
      * @api
      *
-     * @param string $file A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
+     * @param string $file The API accepts any of the following:
+     *
+     * - **Binary data** – send the raw bytes as `multipart/form-data`.
+     * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch.
+     * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64.
+     *
+     * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
      * @param string $fileName The name with which the file has to be uploaded.
      * The file name can contain:
      *

src/Core/Services/FilesService.php

@@ -257,7 +257,13 @@ public function rename(
      * - A full-fledged [upload widget using Uppy](https://github.com/imagekit-samples/uppy-uploader), supporting file selections from local storage, URL, Dropbox, Google Drive, Instagram, and more.
      * - [Quick start guides](/docs/quick-start-guides) for various frameworks and technologies.
      *
-     * @param string $file A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
+     * @param string $file The API accepts any of the following:
+     *
+     * - **Binary data** – send the raw bytes as `multipart/form-data`.
+     * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch.
+     * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64.
+     *
+     * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
      * @param string $fileName The name with which the file has to be uploaded.
      * The file name can contain:
      *

src/Files/FileUploadParams.php

@@ -66,7 +66,13 @@ final class FileUploadParams implements BaseModel
     use SdkParams;
 
     /**
-     * A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
+     * The API accepts any of the following:
+     *
+     * - **Binary data** – send the raw bytes as `multipart/form-data`.
+     * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch.
+     * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64.
+     *
+     * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
      */
     #[Api]
     public string $file;
@@ -338,7 +344,13 @@ public static function with(
     }
 
     /**
-     * A publicly reachable URL that ImageKit’s servers can fetch. The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
+     * The API accepts any of the following:
+     *
+     * - **Binary data** – send the raw bytes as `multipart/form-data`.
+     * - **HTTP / HTTPS URL** – a publicly reachable URL that ImageKit’s servers can fetch.
+     * - **Base64 string** – the file encoded as a Base64 data URI or plain Base64.
+     *
+     * When supplying a URL, the server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
      */
     public function withFile(string $file): self
     {

tests/Services/FilesTest.php

@@ -163,10 +163,7 @@ public function testUpload(): void
             $this->markTestSkipped('Prism tests are disabled');
         }
 
-        $result = $this->client->files->upload(
-            file: 'https://www.example.com/path/to-image.jpg',
-            fileName: 'fileName'
-        );
+        $result = $this->client->files->upload(file: 'file', fileName: 'fileName');
 
         $this->assertTrue(true); // @phpstan-ignore-line
     }
@@ -178,10 +175,7 @@ public function testUploadWithOptionalParams(): void
             $this->markTestSkipped('Prism tests are disabled');
         }
 
-        $result = $this->client->files->upload(
-            file: 'https://www.example.com/path/to-image.jpg',
-            fileName: 'fileName'
-        );
+        $result = $this->client->files->upload(file: 'file', fileName: 'fileName');
 
         $this->assertTrue(true); // @phpstan-ignore-line
     }