Skip to content

Commit a0781ed

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): Add saved extensions API and enhance transformation options
Added complete CRUD API endpoints for saved extensions, allowing users to save complex extension configurations and reuse them across multiple assets Fixed metadata endpoint path: /v1/files/metadata → /v1/metadata Added and improved transformation options e.g. color replace, layer modes, distort effect, gradient background etc.
1 parent f8580d6 commit a0781ed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2979
-62
lines changed

‎.stats.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
configured_endpoints: 43
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-9d184cb502ab32a85db2889c796cdfebe812f2a55a604df79c85dd4b5e7e2add.yml
3-
openapi_spec_hash: a9aa620376fce66532c84f9364209b0b
4-
config_hash: 71cab8223bb5610c6c7ca6e9c4cc1f89
1+
configured_endpoints: 48
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-7a3257eb171467b637c8d72877f201c2e6038c71ed447a9453230b7309ce7416.yml
3+
openapi_spec_hash: 87b000a9989ad5c9526f28d91b8a1749
4+
config_hash: aeb6eb949d73382270bbd8bbf2e4cf2a

‎api.md‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
```python
44
from imagekitio.types import (
55
BaseOverlay,
6+
ExtensionConfig,
67
Extensions,
78
GetImageAttributesOptions,
89
ImageOverlay,
910
Overlay,
1011
OverlayPosition,
1112
OverlayTiming,
1213
ResponsiveImageAttributes,
14+
SavedExtension,
1315
SolidColorOverlay,
1416
SolidColorOverlayTransformation,
1517
SrcOptions,
@@ -111,7 +113,23 @@ Methods:
111113
Methods:
112114

113115
- <code title="get /v1/files/{fileId}/metadata">client.files.metadata.<a href="./src/imagekitio/resources/files/metadata.py">get</a>(file_id) -> <a href="./src/imagekitio/types/metadata.py">Metadata</a></code>
114-
- <code title="get /v1/files/metadata">client.files.metadata.<a href="./src/imagekitio/resources/files/metadata.py">get_from_url</a>(\*\*<a href="src/imagekitio/types/files/metadata_get_from_url_params.py">params</a>) -> <a href="./src/imagekitio/types/metadata.py">Metadata</a></code>
116+
- <code title="get /v1/metadata">client.files.metadata.<a href="./src/imagekitio/resources/files/metadata.py">get_from_url</a>(\*\*<a href="src/imagekitio/types/files/metadata_get_from_url_params.py">params</a>) -> <a href="./src/imagekitio/types/metadata.py">Metadata</a></code>
117+
118+
# SavedExtensions
119+
120+
Types:
121+
122+
```python
123+
from imagekitio.types import SavedExtensionListResponse
124+
```
125+
126+
Methods:
127+
128+
- <code title="post /v1/saved-extensions">client.saved_extensions.<a href="./src/imagekitio/resources/saved_extensions.py">create</a>(\*\*<a href="src/imagekitio/types/saved_extension_create_params.py">params</a>) -> <a href="./src/imagekitio/types/shared/saved_extension.py">SavedExtension</a></code>
129+
- <code title="patch /v1/saved-extensions/{id}">client.saved_extensions.<a href="./src/imagekitio/resources/saved_extensions.py">update</a>(id, \*\*<a href="src/imagekitio/types/saved_extension_update_params.py">params</a>) -> <a href="./src/imagekitio/types/shared/saved_extension.py">SavedExtension</a></code>
130+
- <code title="get /v1/saved-extensions">client.saved_extensions.<a href="./src/imagekitio/resources/saved_extensions.py">list</a>() -> <a href="./src/imagekitio/types/saved_extension_list_response.py">SavedExtensionListResponse</a></code>
131+
- <code title="delete /v1/saved-extensions/{id}">client.saved_extensions.<a href="./src/imagekitio/resources/saved_extensions.py">delete</a>(id) -> None</code>
132+
- <code title="get /v1/saved-extensions/{id}">client.saved_extensions.<a href="./src/imagekitio/resources/saved_extensions.py">get</a>(id) -> <a href="./src/imagekitio/types/shared/saved_extension.py">SavedExtension</a></code>
115133

116134
# Assets
117135

‎src/imagekitio/_client.py‎

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,25 @@
3333
)
3434

3535
if TYPE_CHECKING:
36-
from .resources import beta, cache, dummy, files, assets, folders, accounts, custom_metadata_fields
36+
from .resources import (
37+
beta,
38+
cache,
39+
dummy,
40+
files,
41+
assets,
42+
folders,
43+
accounts,
44+
saved_extensions,
45+
custom_metadata_fields,
46+
)
3747
from .resources.dummy import DummyResource, AsyncDummyResource
3848
from .resources.assets import AssetsResource, AsyncAssetsResource
3949
from .resources.webhooks import WebhooksResource, AsyncWebhooksResource
4050
from .resources.beta.beta import BetaResource, AsyncBetaResource
4151
from .resources.cache.cache import CacheResource, AsyncCacheResource
4252
from .resources.files.files import FilesResource, AsyncFilesResource
4353
from .resources.folders.folders import FoldersResource, AsyncFoldersResource
54+
from .resources.saved_extensions import SavedExtensionsResource, AsyncSavedExtensionsResource
4455
from .resources.accounts.accounts import AccountsResource, AsyncAccountsResource
4556
from .resources.custom_metadata_fields import CustomMetadataFieldsResource, AsyncCustomMetadataFieldsResource
4657
from .lib.helper import HelperResource, AsyncHelperResource
@@ -146,6 +157,12 @@ def files(self) -> FilesResource:
146157

147158
return FilesResource(self)
148159

160+
@cached_property
161+
def saved_extensions(self) -> SavedExtensionsResource:
162+
from .resources.saved_extensions import SavedExtensionsResource
163+
164+
return SavedExtensionsResource(self)
165+
149166
@cached_property
150167
def assets(self) -> AssetsResource:
151168
from .resources.assets import AssetsResource
@@ -408,6 +425,12 @@ def files(self) -> AsyncFilesResource:
408425

409426
return AsyncFilesResource(self)
410427

428+
@cached_property
429+
def saved_extensions(self) -> AsyncSavedExtensionsResource:
430+
from .resources.saved_extensions import AsyncSavedExtensionsResource
431+
432+
return AsyncSavedExtensionsResource(self)
433+
411434
@cached_property
412435
def assets(self) -> AsyncAssetsResource:
413436
from .resources.assets import AsyncAssetsResource
@@ -605,6 +628,12 @@ def files(self) -> files.FilesResourceWithRawResponse:
605628

606629
return FilesResourceWithRawResponse(self._client.files)
607630

631+
@cached_property
632+
def saved_extensions(self) -> saved_extensions.SavedExtensionsResourceWithRawResponse:
633+
from .resources.saved_extensions import SavedExtensionsResourceWithRawResponse
634+
635+
return SavedExtensionsResourceWithRawResponse(self._client.saved_extensions)
636+
608637
@cached_property
609638
def assets(self) -> assets.AssetsResourceWithRawResponse:
610639
from .resources.assets import AssetsResourceWithRawResponse
@@ -660,6 +689,12 @@ def files(self) -> files.AsyncFilesResourceWithRawResponse:
660689

661690
return AsyncFilesResourceWithRawResponse(self._client.files)
662691

692+
@cached_property
693+
def saved_extensions(self) -> saved_extensions.AsyncSavedExtensionsResourceWithRawResponse:
694+
from .resources.saved_extensions import AsyncSavedExtensionsResourceWithRawResponse
695+
696+
return AsyncSavedExtensionsResourceWithRawResponse(self._client.saved_extensions)
697+
663698
@cached_property
664699
def assets(self) -> assets.AsyncAssetsResourceWithRawResponse:
665700
from .resources.assets import AsyncAssetsResourceWithRawResponse
@@ -715,6 +750,12 @@ def files(self) -> files.FilesResourceWithStreamingResponse:
715750

716751
return FilesResourceWithStreamingResponse(self._client.files)
717752

753+
@cached_property
754+
def saved_extensions(self) -> saved_extensions.SavedExtensionsResourceWithStreamingResponse:
755+
from .resources.saved_extensions import SavedExtensionsResourceWithStreamingResponse
756+
757+
return SavedExtensionsResourceWithStreamingResponse(self._client.saved_extensions)
758+
718759
@cached_property
719760
def assets(self) -> assets.AssetsResourceWithStreamingResponse:
720761
from .resources.assets import AssetsResourceWithStreamingResponse
@@ -770,6 +811,12 @@ def files(self) -> files.AsyncFilesResourceWithStreamingResponse:
770811

771812
return AsyncFilesResourceWithStreamingResponse(self._client.files)
772813

814+
@cached_property
815+
def saved_extensions(self) -> saved_extensions.AsyncSavedExtensionsResourceWithStreamingResponse:
816+
from .resources.saved_extensions import AsyncSavedExtensionsResourceWithStreamingResponse
817+
818+
return AsyncSavedExtensionsResourceWithStreamingResponse(self._client.saved_extensions)
819+
773820
@cached_property
774821
def assets(self) -> assets.AsyncAssetsResourceWithStreamingResponse:
775822
from .resources.assets import AsyncAssetsResourceWithStreamingResponse

‎src/imagekitio/resources/__init__.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,14 @@
6161
HelperResource,
6262
AsyncHelperResource,
6363
)
64+
from .saved_extensions import (
65+
SavedExtensionsResource,
66+
AsyncSavedExtensionsResource,
67+
SavedExtensionsResourceWithRawResponse,
68+
AsyncSavedExtensionsResourceWithRawResponse,
69+
SavedExtensionsResourceWithStreamingResponse,
70+
AsyncSavedExtensionsResourceWithStreamingResponse,
71+
)
6472
from .custom_metadata_fields import (
6573
CustomMetadataFieldsResource,
6674
AsyncCustomMetadataFieldsResource,
@@ -89,6 +97,12 @@
8997
"AsyncFilesResourceWithRawResponse",
9098
"FilesResourceWithStreamingResponse",
9199
"AsyncFilesResourceWithStreamingResponse",
100+
"SavedExtensionsResource",
101+
"AsyncSavedExtensionsResource",
102+
"SavedExtensionsResourceWithRawResponse",
103+
"AsyncSavedExtensionsResourceWithRawResponse",
104+
"SavedExtensionsResourceWithStreamingResponse",
105+
"AsyncSavedExtensionsResourceWithStreamingResponse",
92106
"AssetsResource",
93107
"AsyncAssetsResource",
94108
"AssetsResourceWithRawResponse",

‎src/imagekitio/resources/dummy.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@
2626
from ..types.shared_params.video_overlay import VideoOverlay
2727
from ..types.shared_params.overlay_timing import OverlayTiming
2828
from ..types.shared_params.transformation import Transformation
29+
from ..types.shared_params.saved_extension import SavedExtension
2930
from ..types.shared.transformation_position import TransformationPosition
31+
from ..types.shared_params.extension_config import ExtensionConfig
3032
from ..types.shared_params.overlay_position import OverlayPosition
3133
from ..types.shared_params.subtitle_overlay import SubtitleOverlay
3234
from ..types.shared_params.solid_color_overlay import SolidColorOverlay
@@ -63,13 +65,15 @@ def create(
6365
self,
6466
*,
6567
base_overlay: BaseOverlay | Omit = omit,
68+
extension_config: ExtensionConfig | Omit = omit,
6669
extensions: Extensions | Omit = omit,
6770
get_image_attributes_options: GetImageAttributesOptions | Omit = omit,
6871
image_overlay: ImageOverlay | Omit = omit,
6972
overlay: Overlay | Omit = omit,
7073
overlay_position: OverlayPosition | Omit = omit,
7174
overlay_timing: OverlayTiming | Omit = omit,
7275
responsive_image_attributes: ResponsiveImageAttributes | Omit = omit,
76+
saved_extensions: SavedExtension | Omit = omit,
7377
solid_color_overlay: SolidColorOverlay | Omit = omit,
7478
solid_color_overlay_transformation: SolidColorOverlayTransformation | Omit = omit,
7579
src_options: SrcOptions | Omit = omit,
@@ -95,6 +99,9 @@ def create(
9599
and is not intended for public consumption.
96100
97101
Args:
102+
extension_config: Configuration object for an extension (base extensions only, not saved extension
103+
references).
104+
98105
extensions: Array of extensions to be applied to the asset. Each extension can be configured
99106
with specific parameters based on the extension type.
100107
@@ -110,6 +117,8 @@ def create(
110117
responsive_image_attributes: Resulting set of attributes suitable for an HTML `<img>` element. Useful for
111118
enabling responsive image loading with `srcSet` and `sizes`.
112119
120+
saved_extensions: Saved extension object containing extension configuration.
121+
113122
src_options: Options for generating ImageKit URLs with transformations. See the
114123
[Transformations guide](https://imagekit.io/docs/transformations).
115124
@@ -146,13 +155,15 @@ def create(
146155
body=maybe_transform(
147156
{
148157
"base_overlay": base_overlay,
158+
"extension_config": extension_config,
149159
"extensions": extensions,
150160
"get_image_attributes_options": get_image_attributes_options,
151161
"image_overlay": image_overlay,
152162
"overlay": overlay,
153163
"overlay_position": overlay_position,
154164
"overlay_timing": overlay_timing,
155165
"responsive_image_attributes": responsive_image_attributes,
166+
"saved_extensions": saved_extensions,
156167
"solid_color_overlay": solid_color_overlay,
157168
"solid_color_overlay_transformation": solid_color_overlay_transformation,
158169
"src_options": src_options,
@@ -198,13 +209,15 @@ async def create(
198209
self,
199210
*,
200211
base_overlay: BaseOverlay | Omit = omit,
212+
extension_config: ExtensionConfig | Omit = omit,
201213
extensions: Extensions | Omit = omit,
202214
get_image_attributes_options: GetImageAttributesOptions | Omit = omit,
203215
image_overlay: ImageOverlay | Omit = omit,
204216
overlay: Overlay | Omit = omit,
205217
overlay_position: OverlayPosition | Omit = omit,
206218
overlay_timing: OverlayTiming | Omit = omit,
207219
responsive_image_attributes: ResponsiveImageAttributes | Omit = omit,
220+
saved_extensions: SavedExtension | Omit = omit,
208221
solid_color_overlay: SolidColorOverlay | Omit = omit,
209222
solid_color_overlay_transformation: SolidColorOverlayTransformation | Omit = omit,
210223
src_options: SrcOptions | Omit = omit,
@@ -230,6 +243,9 @@ async def create(
230243
and is not intended for public consumption.
231244
232245
Args:
246+
extension_config: Configuration object for an extension (base extensions only, not saved extension
247+
references).
248+
233249
extensions: Array of extensions to be applied to the asset. Each extension can be configured
234250
with specific parameters based on the extension type.
235251
@@ -245,6 +261,8 @@ async def create(
245261
responsive_image_attributes: Resulting set of attributes suitable for an HTML `<img>` element. Useful for
246262
enabling responsive image loading with `srcSet` and `sizes`.
247263
264+
saved_extensions: Saved extension object containing extension configuration.
265+
248266
src_options: Options for generating ImageKit URLs with transformations. See the
249267
[Transformations guide](https://imagekit.io/docs/transformations).
250268
@@ -281,13 +299,15 @@ async def create(
281299
body=await async_maybe_transform(
282300
{
283301
"base_overlay": base_overlay,
302+
"extension_config": extension_config,
284303
"extensions": extensions,
285304
"get_image_attributes_options": get_image_attributes_options,
286305
"image_overlay": image_overlay,
287306
"overlay": overlay,
288307
"overlay_position": overlay_position,
289308
"overlay_timing": overlay_timing,
290309
"responsive_image_attributes": responsive_image_attributes,
310+
"saved_extensions": saved_extensions,
291311
"solid_color_overlay": solid_color_overlay,
292312
"solid_color_overlay_transformation": solid_color_overlay_transformation,
293313
"src_options": src_options,

‎src/imagekitio/resources/files/metadata.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def get_from_url(
106106
timeout: Override the client-level default timeout for this request, in seconds
107107
"""
108108
return self._get(
109-
"/v1/files/metadata",
109+
"/v1/metadata",
110110
options=make_request_options(
111111
extra_headers=extra_headers,
112112
extra_query=extra_query,
@@ -203,7 +203,7 @@ async def get_from_url(
203203
timeout: Override the client-level default timeout for this request, in seconds
204204
"""
205205
return await self._get(
206-
"/v1/files/metadata",
206+
"/v1/metadata",
207207
options=make_request_options(
208208
extra_headers=extra_headers,
209209
extra_query=extra_query,

0 commit comments

Comments
 (0)