Merge pull request #17 from imagekit-developer/release-please--branches--master--changes--next

release: 2.4.0

Author: imagekitio

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.3.0"
+  ".": "2.4.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 48
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-63aff1629530786015da3c86131afa8a9b60545d488884b77641f1d4b89c6e9d.yml
-openapi_spec_hash: 586d357bd7e5217d240a99e0d83c6d1f
-config_hash: 47cb702ee2cb52c58d803ae39ade9b44
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-70c42eda2bee929830b2537f758400a58dded1f1ef5686a286e2469c35a041a0.yml
+openapi_spec_hash: cdaeed824e91657b45092765cf55eb42
+config_hash: e3c2679d25f6235381dfb11962fbf3d9

CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 2.4.0 (2026-04-13)
+
+Full Changelog: [v2.3.0...v2.4.0](https://github.com/imagekit-developer/imagekit-go/compare/v2.3.0...v2.4.0)
+
+### Features
+
+* **api:** dam related webhook events ([b364b42](https://github.com/imagekit-developer/imagekit-go/commit/b364b4250885a0c3d172d26e0121979970c55990))
+* **api:** fix spec indentation ([f254242](https://github.com/imagekit-developer/imagekit-go/commit/f2542428409b7963a25d629c667291292d5b0126))
+* **api:** indentation fix ([d9bbacf](https://github.com/imagekit-developer/imagekit-go/commit/d9bbacf78dd49e892ea97ead76000115c863495f))
+* **api:** merge with main to bring back missing parameters ([4ab1555](https://github.com/imagekit-developer/imagekit-go/commit/4ab1555f5ecf9f5aeca0de356f67b7e7ce831a7c))
+* **api:** update webhook event names and remove DAM prefix ([5054493](https://github.com/imagekit-developer/imagekit-go/commit/5054493498d777340e64c267da0621cc1fa3f804))
+
+
+### Bug Fixes
+
+* **api:** extract shared schemas to prevent Go webhook union breaking changes ([57ff5e2](https://github.com/imagekit-developer/imagekit-go/commit/57ff5e25ba5dfb11ebed03cdfb145001bf717d40))
+* **api:** fix references of schema ([991d381](https://github.com/imagekit-developer/imagekit-go/commit/991d3815942efcb68655192ad7b81ab3fb37b791))
+* **api:** remove optional password parameter from client initialization ([e322edc](https://github.com/imagekit-developer/imagekit-go/commit/e322edc056ae3145fcc1e10af75b6a1208692cd0))
+* **api:** rename DamFile events to File for consistency ([6d142f5](https://github.com/imagekit-developer/imagekit-go/commit/6d142f5d4d48d2368a7b59d6508062dd63a46c72))
+
+
+### Documentation
+
+* improve examples ([3953c51](https://github.com/imagekit-developer/imagekit-go/commit/3953c51e4f8582b9ac3e317f846e8fcc17725c05))
+
+
+### Refactors
+
+* add backwards-compatible type aliases and import removed json package ([e12a0f6](https://github.com/imagekit-developer/imagekit-go/commit/e12a0f663b5fb2f89306aa02f2da40217a18a2b3))
+* AITags to singular AITag schema with array items pattern ([1fe0465](https://github.com/imagekit-developer/imagekit-go/commit/1fe04652d68fccf6ce2465a8148b4aa892f9e3e0))
+
 ## 2.3.0 (2026-04-06)
 
 Full Changelog: [v2.2.0...v2.3.0](https://github.com/imagekit-developer/imagekit-go/compare/v2.2.0...v2.3.0)

README.md

@@ -59,7 +59,7 @@ Or to pin the version:
 <!-- x-release-please-start-version -->
 
 ```sh
-go get -u 'github.com/imagekit-developer/imagekit-go/v2@v2.3.0'
+go get -u 'github.com/imagekit-developer/imagekit-go/v2@v2.4.0'
 ```
 
 <!-- x-release-please-end -->

aliases.go

@@ -16,6 +16,12 @@ type paramObj = param.APIObject
 
 type Error = apierror.Error
 
+// AI-generated tag associated with an image. These tags can be added using the
+// `google-auto-tagging` or `aws-auto-tagging` extensions.
+//
+// This is an alias to an internal type.
+type AITag = shared.AITag
+
 // This is an alias to an internal type.
 type BaseOverlayParam = shared.BaseOverlayParam
 
@@ -55,6 +61,17 @@ const BaseOverlayLayerModeCutout = shared.BaseOverlayLayerModeCutout
 // Equals "displace"
 const BaseOverlayLayerModeDisplace = shared.BaseOverlayLayerModeDisplace
 
+// A key-value data associated with the asset.
+//
+// This is an alias to an internal type.
+type CustomMetadata = shared.CustomMetadata
+
+// Consolidated embedded metadata associated with the file. It includes exif, iptc,
+// and xmp data.
+//
+// This is an alias to an internal type.
+type EmbeddedMetadata = shared.EmbeddedMetadata
+
 // Configuration object for an extension (base extensions only, not saved extension
 // references).
 //
@@ -518,6 +535,46 @@ type SavedExtension = shared.SavedExtension
 // This is an alias to an internal type.
 type SavedExtensionParam = shared.SavedExtensionParam
 
+// This field is included in the response only if the Path policy feature is
+// available in the plan. It contains schema definitions for the custom metadata
+// fields selected for the specified file path. Field selection can only be done
+// when the Path policy feature is enabled.
+//
+// Keys are the names of the custom metadata fields; the value object has details
+// about the custom metadata schema.
+//
+// This is an alias to an internal type.
+type SelectedFieldsSchema = shared.SelectedFieldsSchema
+
+// This is an alias to an internal type.
+type SelectedFieldsSchemaItem = shared.SelectedFieldsSchemaItem
+
+// The default value for this custom metadata field. The value should match the
+// `type` of custom metadata field.
+//
+// This is an alias to an internal type.
+type SelectedFieldsSchemaItemDefaultValueUnion = shared.SelectedFieldsSchemaItemDefaultValueUnion
+
+// This is an alias to an internal type.
+type SelectedFieldsSchemaItemDefaultValueMixedItemUnion = shared.SelectedFieldsSchemaItemDefaultValueMixedItemUnion
+
+// Maximum value of the field. Only set if field type is `Date` or `Number`. For
+// `Date` type field, the value will be in ISO8601 string format. For `Number` type
+// field, it will be a numeric value.
+//
+// This is an alias to an internal type.
+type SelectedFieldsSchemaItemMaxValueUnion = shared.SelectedFieldsSchemaItemMaxValueUnion
+
+// Minimum value of the field. Only set if field type is `Date` or `Number`. For
+// `Date` type field, the value will be in ISO8601 string format. For `Number` type
+// field, it will be a numeric value.
+//
+// This is an alias to an internal type.
+type SelectedFieldsSchemaItemMinValueUnion = shared.SelectedFieldsSchemaItemMinValueUnion
+
+// This is an alias to an internal type.
+type SelectedFieldsSchemaItemSelectOptionUnion = shared.SelectedFieldsSchemaItemSelectOptionUnion
+
 // This is an alias to an internal type.
 type SolidColorOverlayParam = shared.SolidColorOverlayParam
 
@@ -1031,5 +1088,10 @@ const TransformationPositionPath = shared.TransformationPositionPath
 // Equals "query"
 const TransformationPositionQuery = shared.TransformationPositionQuery
 
+// An object containing the file or file version's `id` (versionId) and `name`.
+//
+// This is an alias to an internal type.
+type VersionInfo = shared.VersionInfo
+
 // This is an alias to an internal type.
 type VideoOverlayParam = shared.VideoOverlayParam

api.md

@@ -24,10 +24,15 @@
 
 # Shared Response Types
 
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#AITag">AITag</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#CustomMetadata">CustomMetadata</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#EmbeddedMetadata">EmbeddedMetadata</a>
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#ExtensionConfigUnion">ExtensionConfigUnion</a>
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#SavedExtension">SavedExtension</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#SelectedFieldsSchema">SelectedFieldsSchema</a>
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#StreamingResolution">StreamingResolution</a>
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#TransformationPosition">TransformationPosition</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared">shared</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2/shared#VersionInfo">VersionInfo</a>
 
 
 # CustomMetadataFields
@@ -236,6 +241,11 @@ Methods:
 Response Types:
 
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#BaseWebhookEvent">BaseWebhookEvent</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#FileCreateEvent">FileCreateEvent</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#FileDeleteEvent">FileDeleteEvent</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#FileUpdateEvent">FileUpdateEvent</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#FileVersionCreateEvent">FileVersionCreateEvent</a>
+- <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#FileVersionDeleteEvent">FileVersionDeleteEvent</a>
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#UploadPostTransformErrorEvent">UploadPostTransformErrorEvent</a>
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#UploadPostTransformSuccessEvent">UploadPostTransformSuccessEvent</a>
 - <a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2">imagekit</a>.<a href="https://pkg.go.dev/github.com/imagekit-developer/imagekit-go/v2#UploadPreTransformErrorEvent">UploadPreTransformErrorEvent</a>

asset.go

@@ -16,6 +16,7 @@ import (
 	"github.com/imagekit-developer/imagekit-go/v2/option"
 	"github.com/imagekit-developer/imagekit-go/v2/packages/param"
 	"github.com/imagekit-developer/imagekit-go/v2/packages/respjson"
+	"github.com/imagekit-developer/imagekit-go/v2/shared"
 )
 
 // AssetService contains methods and other services that help with interacting with
@@ -56,7 +57,7 @@ func (r *AssetService) List(ctx context.Context, query AssetListParams, opts ...
 // Use the methods beginning with 'As' to cast the union to one of its variants.
 type AssetListResponseUnion struct {
 	// This field is from variant [File].
-	AITags []FileAITag `json:"AITags"`
+	AITags []shared.AITag `json:"AITags"`
 	// This field is from variant [File].
 	AudioCodec string `json:"audioCodec"`
 	// This field is from variant [File].
@@ -70,7 +71,7 @@ type AssetListResponseUnion struct {
 	// This field is from variant [File].
 	Duration int64 `json:"duration"`
 	// This field is from variant [File].
-	EmbeddedMetadata map[string]any `json:"embeddedMetadata"`
+	EmbeddedMetadata shared.EmbeddedMetadata `json:"embeddedMetadata"`
 	// This field is from variant [File].
 	FileID string `json:"fileId"`
 	// This field is from variant [File].
@@ -89,7 +90,7 @@ type AssetListResponseUnion struct {
 	Mime string `json:"mime"`
 	Name string `json:"name"`
 	// This field is from variant [File].
-	SelectedFieldsSchema map[string]FileSelectedFieldsSchema `json:"selectedFieldsSchema"`
+	SelectedFieldsSchema shared.SelectedFieldsSchema `json:"selectedFieldsSchema"`
 	// This field is from variant [File].
 	Size float64 `json:"size"`
 	// This field is from variant [File].
@@ -102,7 +103,7 @@ type AssetListResponseUnion struct {
 	// This field is from variant [File].
 	URL string `json:"url"`
 	// This field is from variant [File].
-	VersionInfo FileVersionInfo `json:"versionInfo"`
+	VersionInfo shared.VersionInfo `json:"versionInfo"`
 	// This field is from variant [File].
 	VideoCodec string `json:"videoCodec"`
 	// This field is from variant [File].

backcompat.go

@@ -0,0 +1,41 @@
+package imagekit
+
+import "github.com/imagekit-developer/imagekit-go/v2/shared"
+
+// Backwards-compatible type aliases for types consolidated into the shared package.
+
+type FileAITag = shared.AITag
+type FileSelectedFieldsSchema = shared.SelectedFieldsSchemaItem
+type FileSelectedFieldsSchemaDefaultValueUnion = shared.SelectedFieldsSchemaItemDefaultValueUnion
+type FileSelectedFieldsSchemaDefaultValueMixedItemUnion = shared.SelectedFieldsSchemaItemDefaultValueMixedItemUnion
+type FileSelectedFieldsSchemaMaxValueUnion = shared.SelectedFieldsSchemaItemMaxValueUnion
+type FileSelectedFieldsSchemaMinValueUnion = shared.SelectedFieldsSchemaItemMinValueUnion
+type FileSelectedFieldsSchemaSelectOptionUnion = shared.SelectedFieldsSchemaItemSelectOptionUnion
+type FileVersionInfo = shared.VersionInfo
+
+type FileUploadResponseAITag = shared.AITag
+type FileUploadResponseSelectedFieldsSchema = shared.SelectedFieldsSchemaItem
+type FileUploadResponseSelectedFieldsSchemaDefaultValueUnion = shared.SelectedFieldsSchemaItemDefaultValueUnion
+type FileUploadResponseSelectedFieldsSchemaDefaultValueMixedItemUnion = shared.SelectedFieldsSchemaItemDefaultValueMixedItemUnion
+type FileUploadResponseSelectedFieldsSchemaMaxValueUnion = shared.SelectedFieldsSchemaItemMaxValueUnion
+type FileUploadResponseSelectedFieldsSchemaMinValueUnion = shared.SelectedFieldsSchemaItemMinValueUnion
+type FileUploadResponseSelectedFieldsSchemaSelectOptionUnion = shared.SelectedFieldsSchemaItemSelectOptionUnion
+type FileUploadResponseVersionInfo = shared.VersionInfo
+
+type BetaV2FileUploadResponseAITag = shared.AITag
+type BetaV2FileUploadResponseSelectedFieldsSchema = shared.SelectedFieldsSchemaItem
+type BetaV2FileUploadResponseSelectedFieldsSchemaDefaultValueUnion = shared.SelectedFieldsSchemaItemDefaultValueUnion
+type BetaV2FileUploadResponseSelectedFieldsSchemaDefaultValueMixedItemUnion = shared.SelectedFieldsSchemaItemDefaultValueMixedItemUnion
+type BetaV2FileUploadResponseSelectedFieldsSchemaMaxValueUnion = shared.SelectedFieldsSchemaItemMaxValueUnion
+type BetaV2FileUploadResponseSelectedFieldsSchemaMinValueUnion = shared.SelectedFieldsSchemaItemMinValueUnion
+type BetaV2FileUploadResponseSelectedFieldsSchemaSelectOptionUnion = shared.SelectedFieldsSchemaItemSelectOptionUnion
+type BetaV2FileUploadResponseVersionInfo = shared.VersionInfo
+
+type UploadPreTransformSuccessEventDataAITag = shared.AITag
+type UploadPreTransformSuccessEventDataSelectedFieldsSchema = shared.SelectedFieldsSchemaItem
+type UploadPreTransformSuccessEventDataSelectedFieldsSchemaDefaultValueUnion = shared.SelectedFieldsSchemaItemDefaultValueUnion
+type UploadPreTransformSuccessEventDataSelectedFieldsSchemaDefaultValueMixedItemUnion = shared.SelectedFieldsSchemaItemDefaultValueMixedItemUnion
+type UploadPreTransformSuccessEventDataSelectedFieldsSchemaMaxValueUnion = shared.SelectedFieldsSchemaItemMaxValueUnion
+type UploadPreTransformSuccessEventDataSelectedFieldsSchemaMinValueUnion = shared.SelectedFieldsSchemaItemMinValueUnion
+type UploadPreTransformSuccessEventDataSelectedFieldsSchemaSelectOptionUnion = shared.SelectedFieldsSchemaItemSelectOptionUnion
+type UploadPreTransformSuccessEventDataVersionInfo = shared.VersionInfo