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-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml
 openapi_spec_hash: 1d382866fce3284f26d341f112988d9d
-config_hash: 54c05a157f2cc730fac9e1df5dc3ca29
+config_hash: 29a2351fe2be89392b15719be8bc964f

README.md

@@ -32,7 +32,7 @@ import os
 from imagekit import ImageKit
 
 client = ImageKit(
-    private_api_key=os.environ.get(
+    private_key=os.environ.get(
         "IMAGEKIT_PRIVATE_API_KEY"
     ),  # This is the default and can be omitted
     password=os.environ.get(
@@ -47,10 +47,10 @@ response = client.files.upload(
 print(response.video_codec)
 ```
 
-While you can provide a `private_api_key` keyword argument,
+While you can provide a `private_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `IMAGEKIT_PRIVATE_API_KEY="My Private API Key"` to your `.env` file
-so that your Private API Key is not stored in source control.
+to add `IMAGEKIT_PRIVATE_API_KEY="My Private Key"` to your `.env` file
+so that your Private Key is not stored in source control.
 
 ## Async usage
 
@@ -62,7 +62,7 @@ import asyncio
 from imagekit import AsyncImageKit
 
 client = AsyncImageKit(
-    private_api_key=os.environ.get(
+    private_key=os.environ.get(
         "IMAGEKIT_PRIVATE_API_KEY"
     ),  # This is the default and can be omitted
     password=os.environ.get(
@@ -105,7 +105,7 @@ from imagekit import AsyncImageKit
 
 async def main() -> None:
     async with AsyncImageKit(
-        private_api_key="My Private API Key",
+        private_key="My Private Key",
         password="My Password",
         http_client=DefaultAioHttpClient(),
     ) as client:

src/imagekit/_client.py

@@ -62,14 +62,14 @@ class ImageKit(SyncAPIClient):
     with_streaming_response: ImageKitWithStreamedResponse
 
     # client options
-    private_api_key: str
+    private_key: str
     password: str | None
     webhook_secret: str | None
 
     def __init__(
         self,
         *,
-        private_api_key: str | None = None,
+        private_key: str | None = None,
         password: str | None = None,
         webhook_secret: str | None = None,
         base_url: str | httpx.URL | None = None,
@@ -94,17 +94,17 @@ def __init__(
         """Construct a new synchronous ImageKit client instance.
 
         This automatically infers the following arguments from their corresponding environment variables if they are not provided:
-        - `private_api_key` from `IMAGEKIT_PRIVATE_API_KEY`
+        - `private_key` from `IMAGEKIT_PRIVATE_API_KEY`
         - `password` from `OPTIONAL_IMAGEKIT_IGNORES_THIS`
         - `webhook_secret` from `IMAGEKIT_WEBHOOK_SECRET`
         """
-        if private_api_key is None:
-            private_api_key = os.environ.get("IMAGEKIT_PRIVATE_API_KEY")
-        if private_api_key is None:
+        if private_key is None:
+            private_key = os.environ.get("IMAGEKIT_PRIVATE_API_KEY")
+        if private_key is None:
             raise ImageKitError(
-                "The private_api_key client option must be set either by passing private_api_key to the client or by setting the IMAGEKIT_PRIVATE_API_KEY environment variable"
+                "The private_key client option must be set either by passing private_key to the client or by setting the IMAGEKIT_PRIVATE_API_KEY environment variable"
             )
-        self.private_api_key = private_api_key
+        self.private_key = private_key
 
         if password is None:
             password = os.environ.get("OPTIONAL_IMAGEKIT_IGNORES_THIS") or "do_not_set"
@@ -152,7 +152,7 @@ def qs(self) -> Querystring:
     def auth_headers(self) -> dict[str, str]:
         if self.password is None:
             return {}
-        credentials = f"{self.private_api_key}:{self.password}".encode("ascii")
+        credentials = f"{self.private_key}:{self.password}".encode("ascii")
         header = f"Basic {base64.b64encode(credentials).decode('ascii')}"
         return {"Authorization": header}
 
@@ -167,19 +167,19 @@ def default_headers(self) -> dict[str, str | Omit]:
 
     @override
     def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
-        if self.private_api_key and self.password and headers.get("Authorization"):
+        if self.private_key and self.password and headers.get("Authorization"):
             return
         if isinstance(custom_headers.get("Authorization"), Omit):
             return
 
         raise TypeError(
-            '"Could not resolve authentication method. Expected the private_api_key or password to be set. Or for the `Authorization` headers to be explicitly omitted"'
+            '"Could not resolve authentication method. Expected the private_key or password to be set. Or for the `Authorization` headers to be explicitly omitted"'
         )
 
     def copy(
         self,
         *,
-        private_api_key: str | None = None,
+        private_key: str | None = None,
         password: str | None = None,
         webhook_secret: str | None = None,
         base_url: str | httpx.URL | None = None,
@@ -215,7 +215,7 @@ def copy(
 
         http_client = http_client or self._client
         client = self.__class__(
-            private_api_key=private_api_key or self.private_api_key,
+            private_key=private_key or self.private_key,
             password=password or self.password,
             webhook_secret=webhook_secret or self.webhook_secret,
             base_url=base_url or self.base_url,
@@ -280,14 +280,14 @@ class AsyncImageKit(AsyncAPIClient):
     with_streaming_response: AsyncImageKitWithStreamedResponse
 
     # client options
-    private_api_key: str
+    private_key: str
     password: str | None
     webhook_secret: str | None
 
     def __init__(
         self,
         *,
-        private_api_key: str | None = None,
+        private_key: str | None = None,
         password: str | None = None,
         webhook_secret: str | None = None,
         base_url: str | httpx.URL | None = None,
@@ -312,17 +312,17 @@ def __init__(
         """Construct a new async AsyncImageKit client instance.
 
         This automatically infers the following arguments from their corresponding environment variables if they are not provided:
-        - `private_api_key` from `IMAGEKIT_PRIVATE_API_KEY`
+        - `private_key` from `IMAGEKIT_PRIVATE_API_KEY`
         - `password` from `OPTIONAL_IMAGEKIT_IGNORES_THIS`
         - `webhook_secret` from `IMAGEKIT_WEBHOOK_SECRET`
         """
-        if private_api_key is None:
-            private_api_key = os.environ.get("IMAGEKIT_PRIVATE_API_KEY")
-        if private_api_key is None:
+        if private_key is None:
+            private_key = os.environ.get("IMAGEKIT_PRIVATE_API_KEY")
+        if private_key is None:
             raise ImageKitError(
-                "The private_api_key client option must be set either by passing private_api_key to the client or by setting the IMAGEKIT_PRIVATE_API_KEY environment variable"
+                "The private_key client option must be set either by passing private_key to the client or by setting the IMAGEKIT_PRIVATE_API_KEY environment variable"
             )
-        self.private_api_key = private_api_key
+        self.private_key = private_key
 
         if password is None:
             password = os.environ.get("OPTIONAL_IMAGEKIT_IGNORES_THIS") or "do_not_set"
@@ -370,7 +370,7 @@ def qs(self) -> Querystring:
     def auth_headers(self) -> dict[str, str]:
         if self.password is None:
             return {}
-        credentials = f"{self.private_api_key}:{self.password}".encode("ascii")
+        credentials = f"{self.private_key}:{self.password}".encode("ascii")
         header = f"Basic {base64.b64encode(credentials).decode('ascii')}"
         return {"Authorization": header}
 
@@ -385,19 +385,19 @@ def default_headers(self) -> dict[str, str | Omit]:
 
     @override
     def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
-        if self.private_api_key and self.password and headers.get("Authorization"):
+        if self.private_key and self.password and headers.get("Authorization"):
             return
         if isinstance(custom_headers.get("Authorization"), Omit):
             return
 
         raise TypeError(
-            '"Could not resolve authentication method. Expected the private_api_key or password to be set. Or for the `Authorization` headers to be explicitly omitted"'
+            '"Could not resolve authentication method. Expected the private_key or password to be set. Or for the `Authorization` headers to be explicitly omitted"'
         )
 
     def copy(
         self,
         *,
-        private_api_key: str | None = None,
+        private_key: str | None = None,
         password: str | None = None,
         webhook_secret: str | None = None,
         base_url: str | httpx.URL | None = None,
@@ -433,7 +433,7 @@ def copy(
 
         http_client = http_client or self._client
         client = self.__class__(
-            private_api_key=private_api_key or self.private_api_key,
+            private_key=private_key or self.private_key,
             password=password or self.password,
             webhook_secret=webhook_secret or self.webhook_secret,
             base_url=base_url or self.base_url,

tests/conftest.py

@@ -45,7 +45,7 @@ def pytest_collection_modifyitems(items: list[pytest.Function]) -> None:
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
-private_api_key = "My Private API Key"
+private_key = "My Private Key"
 password = "My Password"
 
 
@@ -56,7 +56,7 @@ def client(request: FixtureRequest) -> Iterator[ImageKit]:
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
     with ImageKit(
-        base_url=base_url, private_api_key=private_api_key, password=password, _strict_response_validation=strict
+        base_url=base_url, private_key=private_key, password=password, _strict_response_validation=strict
     ) as client:
         yield client
 
@@ -83,7 +83,7 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncImageKit]:
 
     async with AsyncImageKit(
         base_url=base_url,
-        private_api_key=private_api_key,
+        private_key=private_key,
         password=password,
         _strict_response_validation=strict,
         http_client=http_client,