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-9ae7b43dcfd6208ca37c32c887630ae186ec338bcdd36902b6fe5d1cc66459dc.yml
+openapi_spec_hash: 25fb64c067e64bcff6eaaabda26de397
 config_hash: 70f9408b8d1dfbcf262a20d6eed50e1c

README.md

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

src/Core/ServiceContracts/FilesContract.php

@@ -104,13 +104,8 @@ public function rename(
     /**
      * @api
      *
-     * @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 $file The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch.
+     * 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,13 +257,8 @@ 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 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 $file The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch.
+     * 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,13 +66,8 @@ final class FileUploadParams implements BaseModel
     use SdkParams;
 
     /**
-     * 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.
+     * The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch.
+     * The server must receive the response headers within 8 seconds; otherwise the request fails with 400 Bad Request.
      */
     #[Api]
     public string $file;
@@ -344,13 +339,8 @@ public static function with(
     }
 
     /**
-     * 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.
+     * The URL of the file to upload. A publicly reachable URL that ImageKit servers can fetch.
+     * 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,7 +163,10 @@ public function testUpload(): void
             $this->markTestSkipped('Prism tests are disabled');
         }
 
-        $result = $this->client->files->upload(file: 'file', fileName: 'fileName');
+        $result = $this->client->files->upload(
+            file: 'https://example.com',
+            fileName: 'fileName'
+        );
 
         $this->assertTrue(true); // @phpstan-ignore-line
     }
@@ -175,7 +178,10 @@ public function testUploadWithOptionalParams(): void
             $this->markTestSkipped('Prism tests are disabled');
         }
 
-        $result = $this->client->files->upload(file: 'file', fileName: 'fileName');
+        $result = $this->client->files->upload(
+            file: 'https://example.com',
+            fileName: 'fileName'
+        );
 
         $this->assertTrue(true); // @phpstan-ignore-line
     }