feat(api): fix spec indentation

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 48
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-1422f7513f230162270b197061e5768c2e0c803b94b8cd03a5e72544ac75a27f.yml
-openapi_spec_hash: 41175e752e6f6ce900b36aecba687fa7
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-f4cd00365ba96133e0675eae3d5d3c6ac13874789e2ce69a84310ab64a4f87dd.yml
+openapi_spec_hash: dce632cfbb5464a98c0f5d8eb9573d68
 config_hash: 17e408231b0b01676298010c7405f483

README.md

@@ -50,6 +50,7 @@ pip install imagekitio
 The full API of this library can be found in [api.md](api.md).
 
 ```python
+import os
 from imagekitio import ImageKit
 
 client = ImageKit(
@@ -121,6 +122,7 @@ print(response.file_id)
 Simply import `AsyncImageKit` instead of `ImageKit` and use `await` with each API call:
 
 ```python
+import os
 import asyncio
 from imagekitio import AsyncImageKit
 
@@ -161,6 +163,7 @@ pip install imagekitio[aiohttp]
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
+import os
 import asyncio
 from imagekitio import DefaultAioHttpClient
 from imagekitio import AsyncImageKit
@@ -503,9 +506,7 @@ from pathlib import Path
 from imagekitio import ImageKit
 import io
 
-client = ImageKit(
-    private_key="My Private Key",
-)
+client = ImageKit()
 
 # Method 1: Upload from bytes
 # Read file into memory first, then upload
@@ -579,9 +580,7 @@ All errors inherit from `imagekitio.APIError`.
 import imagekitio
 from imagekitio import ImageKit
 
-client = ImageKit(
-    private_key="My Private Key",
-)
+client = ImageKit()
 
 try:
     # Read file into memory and upload
@@ -629,7 +628,6 @@ from imagekitio import ImageKit
 
 # Configure the default for all requests:
 client = ImageKit(
-    private_key="My Private Key",
     # default is 2
     max_retries=0,
 )
@@ -654,14 +652,12 @@ from imagekitio import ImageKit
 
 # Configure the default for all requests:
 client = ImageKit(
-    private_key="My Private Key",
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
 client = ImageKit(
-    private_key="My Private Key",
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
@@ -800,7 +796,6 @@ import httpx
 from imagekitio import ImageKit, DefaultHttpxClient
 
 client = ImageKit(
-    private_key="My Private Key",
     # Or use the `IMAGE_KIT_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
@@ -823,9 +818,7 @@ By default the library closes underlying HTTP connections whenever the client is
 ```py
 from imagekitio import ImageKit
 
-with ImageKit(
-    private_key="My Private Key",
-) as client:
+with ImageKit() as client:
   # make requests here
   ...
 

src/imagekitio/_client.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import os
+import base64
 from typing import TYPE_CHECKING, Any, Mapping
 from typing_extensions import Self, override
 
@@ -12,6 +13,7 @@
 from ._qs import Querystring
 from ._types import (
     Omit,
+    Headers,
     Timeout,
     NotGiven,
     Transport,
@@ -216,6 +218,15 @@ def with_streaming_response(self) -> ImageKitWithStreamedResponse:
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
+    @property
+    @override
+    def auth_headers(self) -> dict[str, str]:
+        if self.password is None:
+            return {}
+        credentials = f"{self.private_key}:{self.password}".encode("ascii")
+        header = f"Basic {base64.b64encode(credentials).decode('ascii')}"
+        return {"Authorization": header}
+
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]:
@@ -225,6 +236,15 @@ def default_headers(self) -> dict[str, str | Omit]:
             **self._custom_headers,
         }
 
+    @override
+    def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
+        if headers.get("Authorization") or isinstance(custom_headers.get("Authorization"), Omit):
+            return
+
+        raise TypeError(
+            '"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,
         *,
@@ -466,6 +486,15 @@ def with_streaming_response(self) -> AsyncImageKitWithStreamedResponse:
     def qs(self) -> Querystring:
         return Querystring(array_format="comma")
 
+    @property
+    @override
+    def auth_headers(self) -> dict[str, str]:
+        if self.password is None:
+            return {}
+        credentials = f"{self.private_key}:{self.password}".encode("ascii")
+        header = f"Basic {base64.b64encode(credentials).decode('ascii')}"
+        return {"Authorization": header}
+
     @property
     @override
     def default_headers(self) -> dict[str, str | Omit]:
@@ -475,6 +504,15 @@ def default_headers(self) -> dict[str, str | Omit]:
             **self._custom_headers,
         }
 
+    @override
+    def _validate_headers(self, headers: Headers, custom_headers: Headers) -> None:
+        if headers.get("Authorization") or isinstance(custom_headers.get("Authorization"), Omit):
+            return
+
+        raise TypeError(
+            '"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,
         *,

tests/conftest.py

@@ -46,6 +46,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_key = "My Private Key"
+password = "My Password"
 
 
 @pytest.fixture(scope="session")
@@ -54,7 +55,9 @@ def client(request: FixtureRequest) -> Iterator[ImageKit]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    with ImageKit(base_url=base_url, private_key=private_key, _strict_response_validation=strict) as client:
+    with ImageKit(
+        base_url=base_url, private_key=private_key, password=password, _strict_response_validation=strict
+    ) as client:
         yield client
 
 
@@ -79,6 +82,10 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncImageKit]:
         raise TypeError(f"Unexpected fixture parameter type {type(param)}, expected bool or dict")
 
     async with AsyncImageKit(
-        base_url=base_url, private_key=private_key, _strict_response_validation=strict, http_client=http_client
+        base_url=base_url,
+        private_key=private_key,
+        password=password,
+        _strict_response_validation=strict,
+        http_client=http_client,
     ) as client:
         yield client