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
-config_hash: 4e73c7e12a531edcd1366dab7eccc360
+config_hash: 08e12746cdca1c59c897cf2e50893c3c

src/Webhooks/BaseWebhookEvent.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ImageKit\Webhooks;
+
+use ImageKit\Core\Attributes\Api;
+use ImageKit\Core\Concerns\SdkModel;
+use ImageKit\Core\Contracts\BaseModel;
+
+/**
+ * @phpstan-type base_webhook_event = array{id: string, type: string}
+ */
+final class BaseWebhookEvent implements BaseModel
+{
+    /** @use SdkModel<base_webhook_event> */
+    use SdkModel;
+
+    /**
+     * Unique identifier for the event.
+     */
+    #[Api]
+    public string $id;
+
+    /**
+     * The type of webhook event.
+     */
+    #[Api]
+    public string $type;
+
+    /**
+     * `new BaseWebhookEvent()` is missing required properties by the API.
+     *
+     * To enforce required parameters use
+     * ```
+     * BaseWebhookEvent::with(id: ..., type: ...)
+     * ```
+     *
+     * Otherwise ensure the following setters are called
+     *
+     * ```
+     * (new BaseWebhookEvent)->withID(...)->withType(...)
+     * ```
+     */
+    public function __construct()
+    {
+        $this->initialize();
+    }
+
+    /**
+     * Construct an instance from the required parameters.
+     *
+     * You must use named parameters to construct any parameters with a default value.
+     */
+    public static function with(string $id, string $type): self
+    {
+        $obj = new self;
+
+        $obj->id = $id;
+        $obj->type = $type;
+
+        return $obj;
+    }
+
+    /**
+     * Unique identifier for the event.
+     */
+    public function withID(string $id): self
+    {
+        $obj = clone $this;
+        $obj->id = $id;
+
+        return $obj;
+    }
+
+    /**
+     * The type of webhook event.
+     */
+    public function withType(string $type): self
+    {
+        $obj = clone $this;
+        $obj->type = $type;
+
+        return $obj;
+    }
+}

src/Webhooks/UnsafeUnwrapWebhookEvent.php

@@ -8,6 +8,9 @@
 use ImageKit\Core\Conversion\Contracts\Converter;
 use ImageKit\Core\Conversion\Contracts\ConverterSource;
 
+/**
+ * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle.
+ */
 final class UnsafeUnwrapWebhookEvent implements ConverterSource
 {
     use SdkUnion;

src/Webhooks/UnwrapWebhookEvent.php

@@ -8,6 +8,9 @@
 use ImageKit\Core\Conversion\Contracts\Converter;
 use ImageKit\Core\Conversion\Contracts\ConverterSource;
 
+/**
+ * Triggered when a new video transformation request is accepted for processing. This event confirms that ImageKit has received and queued your transformation request. Use this for debugging and tracking transformation lifecycle.
+ */
 final class UnwrapWebhookEvent implements ConverterSource
 {
     use SdkUnion;

src/Webhooks/UploadPostTransformErrorEvent.php

@@ -11,12 +11,10 @@
 use ImageKit\Webhooks\UploadPostTransformErrorEvent\Request;
 
 /**
+ * Triggered when a post-transformation fails. The original file remains available, but the requested transformation could not be generated.
+ *
  * @phpstan-type upload_post_transform_error_event = array{
- *   id: string,
- *   createdAt: \DateTimeInterface,
- *   data: Data,
- *   request: Request,
- *   type: string,
+ *   createdAt: \DateTimeInterface, data: Data, request: Request, type: string
  * }
  */
 final class UploadPostTransformErrorEvent implements BaseModel
@@ -27,12 +25,6 @@ final class UploadPostTransformErrorEvent implements BaseModel
     #[Api]
     public string $type = 'upload.post-transform.error';
 
-    /**
-     * Unique identifier for the event.
-     */
-    #[Api]
-    public string $id;
-
     /**
      * Timestamp of when the event occurred in ISO8601 format.
      */
@@ -50,16 +42,13 @@ final class UploadPostTransformErrorEvent implements BaseModel
      *
      * To enforce required parameters use
      * ```
-     * UploadPostTransformErrorEvent::with(
-     *   id: ..., createdAt: ..., data: ..., request: ...
-     * )
+     * UploadPostTransformErrorEvent::with(createdAt: ..., data: ..., request: ...)
      * ```
      *
      * Otherwise ensure the following setters are called
      *
      * ```
      * (new UploadPostTransformErrorEvent)
-     *   ->withID(...)
      *   ->withCreatedAt(...)
      *   ->withData(...)
      *   ->withRequest(...)
@@ -76,32 +65,19 @@ public function __construct()
      * You must use named parameters to construct any parameters with a default value.
      */
     public static function with(
-        string $id,
         \DateTimeInterface $createdAt,
         Data $data,
         Request $request
     ): self {
         $obj = new self;
 
-        $obj->id = $id;
         $obj->createdAt = $createdAt;
         $obj->data = $data;
         $obj->request = $request;
 
         return $obj;
     }
 
-    /**
-     * Unique identifier for the event.
-     */
-    public function withID(string $id): self
-    {
-        $obj = clone $this;
-        $obj->id = $id;
-
-        return $obj;
-    }
-
     /**
      * Timestamp of when the event occurred in ISO8601 format.
      */

src/Webhooks/UploadPostTransformSuccessEvent.php

@@ -11,12 +11,10 @@
 use ImageKit\Webhooks\UploadPostTransformSuccessEvent\Request;
 
 /**
+ * Triggered when a post-transformation completes successfully. The transformed version of the file is now ready and can be accessed via the provided URL. Note that each post-transformation generates a separate webhook event.
+ *
  * @phpstan-type upload_post_transform_success_event = array{
- *   id: string,
- *   createdAt: \DateTimeInterface,
- *   data: Data,
- *   request: Request,
- *   type: string,
+ *   createdAt: \DateTimeInterface, data: Data, request: Request, type: string
  * }
  */
 final class UploadPostTransformSuccessEvent implements BaseModel
@@ -27,12 +25,6 @@ final class UploadPostTransformSuccessEvent implements BaseModel
     #[Api]
     public string $type = 'upload.post-transform.success';
 
-    /**
-     * Unique identifier for the event.
-     */
-    #[Api]
-    public string $id;
-
     /**
      * Timestamp of when the event occurred in ISO8601 format.
      */
@@ -50,16 +42,13 @@ final class UploadPostTransformSuccessEvent implements BaseModel
      *
      * To enforce required parameters use
      * ```
-     * UploadPostTransformSuccessEvent::with(
-     *   id: ..., createdAt: ..., data: ..., request: ...
-     * )
+     * UploadPostTransformSuccessEvent::with(createdAt: ..., data: ..., request: ...)
      * ```
      *
      * Otherwise ensure the following setters are called
      *
      * ```
      * (new UploadPostTransformSuccessEvent)
-     *   ->withID(...)
      *   ->withCreatedAt(...)
      *   ->withData(...)
      *   ->withRequest(...)
@@ -76,32 +65,19 @@ public function __construct()
      * You must use named parameters to construct any parameters with a default value.
      */
     public static function with(
-        string $id,
         \DateTimeInterface $createdAt,
         Data $data,
         Request $request
     ): self {
         $obj = new self;
 
-        $obj->id = $id;
         $obj->createdAt = $createdAt;
         $obj->data = $data;
         $obj->request = $request;
 
         return $obj;
     }
 
-    /**
-     * Unique identifier for the event.
-     */
-    public function withID(string $id): self
-    {
-        $obj = clone $this;
-        $obj->id = $id;
-
-        return $obj;
-    }
-
     /**
      * Timestamp of when the event occurred in ISO8601 format.
      */

src/Webhooks/UploadPreTransformErrorEvent.php

@@ -11,12 +11,10 @@
 use ImageKit\Webhooks\UploadPreTransformErrorEvent\Request;
 
 /**
+ * Triggered when a pre-transformation fails. The file upload may have been accepted, but the requested transformation could not be applied.
+ *
  * @phpstan-type upload_pre_transform_error_event = array{
- *   id: string,
- *   createdAt: \DateTimeInterface,
- *   data: Data,
- *   request: Request,
- *   type: string,
+ *   createdAt: \DateTimeInterface, data: Data, request: Request, type: string
  * }
  */
 final class UploadPreTransformErrorEvent implements BaseModel
@@ -27,12 +25,6 @@ final class UploadPreTransformErrorEvent implements BaseModel
     #[Api]
     public string $type = 'upload.pre-transform.error';
 
-    /**
-     * Unique identifier for the event.
-     */
-    #[Api]
-    public string $id;
-
     /**
      * Timestamp of when the event occurred in ISO8601 format.
      */
@@ -50,16 +42,13 @@ final class UploadPreTransformErrorEvent implements BaseModel
      *
      * To enforce required parameters use
      * ```
-     * UploadPreTransformErrorEvent::with(
-     *   id: ..., createdAt: ..., data: ..., request: ...
-     * )
+     * UploadPreTransformErrorEvent::with(createdAt: ..., data: ..., request: ...)
      * ```
      *
      * Otherwise ensure the following setters are called
      *
      * ```
      * (new UploadPreTransformErrorEvent)
-     *   ->withID(...)
      *   ->withCreatedAt(...)
      *   ->withData(...)
      *   ->withRequest(...)
@@ -76,32 +65,19 @@ public function __construct()
      * You must use named parameters to construct any parameters with a default value.
      */
     public static function with(
-        string $id,
         \DateTimeInterface $createdAt,
         Data $data,
         Request $request
     ): self {
         $obj = new self;
 
-        $obj->id = $id;
         $obj->createdAt = $createdAt;
         $obj->data = $data;
         $obj->request = $request;
 
         return $obj;
     }
 
-    /**
-     * Unique identifier for the event.
-     */
-    public function withID(string $id): self
-    {
-        $obj = clone $this;
-        $obj->id = $id;
-
-        return $obj;
-    }
-
     /**
      * Timestamp of when the event occurred in ISO8601 format.
      */