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-dd864816d7f4316ae89f57394da2fd1926166d4704db5a0bb5d23461d2d75e49.yml
-openapi_spec_hash: 7f7c416563a15bbaea98804ecdc1a8f9
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml
+openapi_spec_hash: 1d382866fce3284f26d341f112988d9d
 config_hash: 54c05a157f2cc730fac9e1df5dc3ca29

src/imagekit/resources/files/files.py

@@ -172,7 +172,7 @@ def update(
         self,
         file_id: str,
         *,
-        body: object,
+        publish: file_update_params.ChangePublicationStatusPublish | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -186,6 +186,8 @@ def update(
         status, remove existing `AITags` and apply extensions using this API.
 
         Args:
+          publish: Configure the publication status of a file and its versions.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -207,7 +209,7 @@ def update(
         remove_ai_tags: Union[SequenceNotStr[str], Literal["all"]] | Omit = omit,
         tags: Optional[SequenceNotStr[str]] | Omit = omit,
         webhook_url: str | Omit = omit,
-        body: object | Omit = omit,
+        publish: file_update_params.ChangePublicationStatusPublish | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -228,7 +230,7 @@ def update(
                     "remove_ai_tags": remove_ai_tags,
                     "tags": tags,
                     "webhook_url": webhook_url,
-                    "body": body,
+                    "publish": publish,
                 },
                 file_update_params.FileUpdateParams,
             ),
@@ -841,7 +843,7 @@ async def update(
         self,
         file_id: str,
         *,
-        body: object,
+        publish: file_update_params.ChangePublicationStatusPublish | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -855,6 +857,8 @@ async def update(
         status, remove existing `AITags` and apply extensions using this API.
 
         Args:
+          publish: Configure the publication status of a file and its versions.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -876,7 +880,7 @@ async def update(
         remove_ai_tags: Union[SequenceNotStr[str], Literal["all"]] | Omit = omit,
         tags: Optional[SequenceNotStr[str]] | Omit = omit,
         webhook_url: str | Omit = omit,
-        body: object | Omit = omit,
+        publish: file_update_params.ChangePublicationStatusPublish | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -897,7 +901,7 @@ async def update(
                     "remove_ai_tags": remove_ai_tags,
                     "tags": tags,
                     "webhook_url": webhook_url,
-                    "body": body,
+                    "publish": publish,
                 },
                 file_update_params.FileUpdateParams,
             ),

src/imagekit/types/file_update_params.py

@@ -9,7 +9,7 @@
 from .._utils import PropertyInfo
 from .shared_params.extensions import Extensions
 
-__all__ = ["FileUpdateParams", "UpdateFileDetails", "ChangePublicationStatus"]
+__all__ = ["FileUpdateParams", "UpdateFileDetails", "ChangePublicationStatus", "ChangePublicationStatusPublish"]
 
 
 class UpdateFileDetails(TypedDict, total=False):
@@ -65,7 +65,19 @@ class UpdateFileDetails(TypedDict, total=False):
 
 
 class ChangePublicationStatus(TypedDict, total=False):
-    body: Required[object]
+    publish: ChangePublicationStatusPublish
+    """Configure the publication status of a file and its versions."""
+
+
+class ChangePublicationStatusPublish(TypedDict, total=False):
+    is_published: Required[Annotated[bool, PropertyInfo(alias="isPublished")]]
+    """Set to `true` to publish the file. Set to `false` to unpublish the file."""
+
+    include_file_versions: Annotated[bool, PropertyInfo(alias="includeFileVersions")]
+    """Set to `true` to publish/unpublish all versions of the file.
+
+    Set to `false` to publish/unpublish only the current version of the file.
+    """
 
 
 FileUpdateParams: TypeAlias = Union[UpdateFileDetails, ChangePublicationStatus]

src/imagekit/types/update_file_request_param.py

@@ -3,13 +3,13 @@
 from __future__ import annotations
 
 from typing import Dict, Union, Optional
-from typing_extensions import Literal, Annotated, TypeAlias, TypedDict
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
 from .shared_params.extensions import Extensions
 
-__all__ = ["UpdateFileRequestParam", "UpdateFileDetails"]
+__all__ = ["UpdateFileRequestParam", "UpdateFileDetails", "ChangePublicationStatus", "ChangePublicationStatusPublish"]
 
 
 class UpdateFileDetails(TypedDict, total=False):
@@ -64,4 +64,20 @@ class UpdateFileDetails(TypedDict, total=False):
     """
 
 
-UpdateFileRequestParam: TypeAlias = Union[UpdateFileDetails, object]
+class ChangePublicationStatusPublish(TypedDict, total=False):
+    is_published: Required[Annotated[bool, PropertyInfo(alias="isPublished")]]
+    """Set to `true` to publish the file. Set to `false` to unpublish the file."""
+
+    include_file_versions: Annotated[bool, PropertyInfo(alias="includeFileVersions")]
+    """Set to `true` to publish/unpublish all versions of the file.
+
+    Set to `false` to publish/unpublish only the current version of the file.
+    """
+
+
+class ChangePublicationStatus(TypedDict, total=False):
+    publish: ChangePublicationStatusPublish
+    """Configure the publication status of a file and its versions."""
+
+
+UpdateFileRequestParam: TypeAlias = Union[UpdateFileDetails, ChangePublicationStatus]

tests/api_resources/test_files.py

@@ -102,7 +102,18 @@ def test_path_params_update_overload_1(self, client: ImageKit) -> None:
     def test_method_update_overload_2(self, client: ImageKit) -> None:
         file = client.files.update(
             file_id="fileId",
-            body={},
+        )
+        assert_matches_type(FileUpdateResponse, file, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_update_with_all_params_overload_2(self, client: ImageKit) -> None:
+        file = client.files.update(
+            file_id="fileId",
+            publish={
+                "is_published": True,
+                "include_file_versions": True,
+            },
         )
         assert_matches_type(FileUpdateResponse, file, path=["response"])
 
@@ -111,7 +122,6 @@ def test_method_update_overload_2(self, client: ImageKit) -> None:
     def test_raw_response_update_overload_2(self, client: ImageKit) -> None:
         response = client.files.with_raw_response.update(
             file_id="fileId",
-            body={},
         )
 
         assert response.is_closed is True
@@ -124,7 +134,6 @@ def test_raw_response_update_overload_2(self, client: ImageKit) -> None:
     def test_streaming_response_update_overload_2(self, client: ImageKit) -> None:
         with client.files.with_streaming_response.update(
             file_id="fileId",
-            body={},
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -140,7 +149,6 @@ def test_path_params_update_overload_2(self, client: ImageKit) -> None:
         with pytest.raises(ValueError, match=r"Expected a non-empty value for `file_id` but received ''"):
             client.files.with_raw_response.update(
                 file_id="",
-                body={},
             )
 
     @pytest.mark.skip(reason="Prism tests are disabled")
@@ -541,7 +549,18 @@ async def test_path_params_update_overload_1(self, async_client: AsyncImageKit)
     async def test_method_update_overload_2(self, async_client: AsyncImageKit) -> None:
         file = await async_client.files.update(
             file_id="fileId",
-            body={},
+        )
+        assert_matches_type(FileUpdateResponse, file, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_update_with_all_params_overload_2(self, async_client: AsyncImageKit) -> None:
+        file = await async_client.files.update(
+            file_id="fileId",
+            publish={
+                "is_published": True,
+                "include_file_versions": True,
+            },
         )
         assert_matches_type(FileUpdateResponse, file, path=["response"])
 
@@ -550,7 +569,6 @@ async def test_method_update_overload_2(self, async_client: AsyncImageKit) -> No
     async def test_raw_response_update_overload_2(self, async_client: AsyncImageKit) -> None:
         response = await async_client.files.with_raw_response.update(
             file_id="fileId",
-            body={},
         )
 
         assert response.is_closed is True
@@ -563,7 +581,6 @@ async def test_raw_response_update_overload_2(self, async_client: AsyncImageKit)
     async def test_streaming_response_update_overload_2(self, async_client: AsyncImageKit) -> None:
         async with async_client.files.with_streaming_response.update(
             file_id="fileId",
-            body={},
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -579,7 +596,6 @@ async def test_path_params_update_overload_2(self, async_client: AsyncImageKit)
         with pytest.raises(ValueError, match=r"Expected a non-empty value for `file_id` but received ''"):
             await async_client.files.with_raw_response.update(
                 file_id="",
-                body={},
             )
 
     @pytest.mark.skip(reason="Prism tests are disabled")