Build SDK

Stainless-Generated-From: 2ed2977

Author: stlc-bot

image-kit-java-core/src/main/kotlin/io/imagekit/models/NamedTransformation.kt

@@ -17,8 +17,8 @@ import java.util.Objects
 import java.util.Optional
 
 /**
- * A named transformation is an alias for an actual transformation string, allowing you to apply and
- * later update complex transformations without changing your image or video URLs. Learn more about
+ * A named transformation is an alias for a transformation string, letting you apply and later
+ * update complex transformations without changing your image or video URLs. Learn more about
  * [named transformations](https://imagekit.io/docs/transformations#named-transformations).
  */
 class NamedTransformation
@@ -46,24 +46,23 @@ private constructor(
     ) : this(id, createdAt, enabled, name, transformation, mutableMapOf())
 
     /**
-     * Unique identifier of the named transformation. This is generated by ImageKit when you create
-     * a new named transformation.
+     * Unique identifier generated by ImageKit when the named transformation was created.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
     fun id(): Optional<String> = id.getOptional("id")
 
     /**
-     * Timestamp (ISO string) when the named transformation was created.
+     * ISO 8601 timestamp of when the named transformation was created.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
     fun createdAt(): Optional<OffsetDateTime> = createdAt.getOptional("createdAt")
 
     /**
-     * Whether this named transformation is currently enabled.
+     * Whether the named transformation is currently enabled.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -79,8 +78,8 @@ private constructor(
     fun name(): Optional<String> = name.getOptional("name")
 
     /**
-     * The transformation this name refers to. Always returned with the `tr:` prefix included,
-     * regardless of whether you supplied it when creating or updating the named transformation.
+     * Transformation string this name refers to. Always includes the `tr:` prefix, even if you
+     * omitted it in the request.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -164,10 +163,7 @@ private constructor(
             additionalProperties = namedTransformation.additionalProperties.toMutableMap()
         }
 
-        /**
-         * Unique identifier of the named transformation. This is generated by ImageKit when you
-         * create a new named transformation.
-         */
+        /** Unique identifier generated by ImageKit when the named transformation was created. */
         fun id(id: String) = id(JsonField.of(id))
 
         /**
@@ -178,7 +174,7 @@ private constructor(
          */
         fun id(id: JsonField<String>) = apply { this.id = id }
 
-        /** Timestamp (ISO string) when the named transformation was created. */
+        /** ISO 8601 timestamp of when the named transformation was created. */
         fun createdAt(createdAt: OffsetDateTime) = createdAt(JsonField.of(createdAt))
 
         /**
@@ -190,7 +186,7 @@ private constructor(
          */
         fun createdAt(createdAt: JsonField<OffsetDateTime>) = apply { this.createdAt = createdAt }
 
-        /** Whether this named transformation is currently enabled. */
+        /** Whether the named transformation is currently enabled. */
         fun enabled(enabled: Boolean) = enabled(JsonField.of(enabled))
 
         /**
@@ -213,8 +209,8 @@ private constructor(
         fun name(name: JsonField<String>) = apply { this.name = name }
 
         /**
-         * The transformation this name refers to. Always returned with the `tr:` prefix included,
-         * regardless of whether you supplied it when creating or updating the named transformation.
+         * Transformation string this name refers to. Always includes the `tr:` prefix, even if you
+         * omitted it in the request.
          */
         fun transformation(transformation: String) = transformation(JsonField.of(transformation))
 

image-kit-java-core/src/main/kotlin/io/imagekit/models/namedtransformations/NamedTransformationCreateParams.kt

@@ -22,15 +22,12 @@ import java.util.Optional
 /**
  * Creates a new named transformation and returns the created object.
  *
- * Named transformations let you assign a short, reusable name to a complex transformation string,
- * so it can be applied in image and video URLs as `tr:n-<name>` and later updated without changing
- * any existing URLs.
- *
- * Learn more about
+ * A named transformation is a short, reusable name for a transformation string. Use it in image and
+ * video URLs as `tr:n-<name>`, and update the underlying transformation later without changing
+ * existing URLs. Learn more about
  * [named transformations](https://imagekit.io/docs/transformations#named-transformations).
  *
- * **Note:** You can create up to 250 named transformations per account. Once this limit is reached,
- * the request fails with a `400` error.
+ * You can create up to 250 named transformations per account.
  */
 class NamedTransformationCreateParams
 private constructor(
@@ -40,32 +37,28 @@ private constructor(
 ) : Params {
 
     /**
-     * Name of the named transformation. This is the alias used to refer to the transformation
-     * string in image and video URLs, for example `tr:n-<name>`. Can only contain alphanumeric
-     * characters or `_` (hyphens are not allowed), and must be unique for your account. Name
-     * matching is case-sensitive, so `Small_Thumbnail` and `small_thumbnail` are treated as
-     * different names.
+     * Alias for the transformation string, used in URLs as `tr:n-<name>`. Must contain only
+     * alphanumeric characters or `_` (no hyphens), and be unique for your account. Name matching is
+     * case-sensitive.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
      */
     fun name(): String = body.name()
 
     /**
-     * The transformation this name refers to, expressed as one or more comma-separated
-     * transformation parameters, for example `w-150,h-150,fo-center,cm-resize`. You do not need to
-     * prefix this with `tr:` — it is added automatically. If you do include it, it must appear in
-     * lowercase at the start of the string, or the request is rejected. Learn more about the
-     * [transformation syntax](https://imagekit.io/docs/transformations).
+     * The transformation string this name refers to, for example `w-150,h-150,fo-center,cm-resize`.
+     * The `tr:` prefix is optional — it's added automatically if missing, and validated if present.
+     * Learn more about the [transformation syntax](https://imagekit.io/docs/transformations).
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
      */
     fun transformation(): String = body.transformation()
 
     /**
-     * Whether this named transformation is enabled. Set to `false` to temporarily disable it
-     * without deleting it — requests using a disabled named transformation fail at delivery time.
+     * Whether the named transformation is enabled. Set to `false` to disable it without deleting
+     * it; requests using a disabled named transformation fail at delivery time.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -146,11 +139,9 @@ private constructor(
         fun body(body: Body) = apply { this.body = body.toBuilder() }
 
         /**
-         * Name of the named transformation. This is the alias used to refer to the transformation
-         * string in image and video URLs, for example `tr:n-<name>`. Can only contain alphanumeric
-         * characters or `_` (hyphens are not allowed), and must be unique for your account. Name
-         * matching is case-sensitive, so `Small_Thumbnail` and `small_thumbnail` are treated as
-         * different names.
+         * Alias for the transformation string, used in URLs as `tr:n-<name>`. Must contain only
+         * alphanumeric characters or `_` (no hyphens), and be unique for your account. Name
+         * matching is case-sensitive.
          */
         fun name(name: String) = apply { body.name(name) }
 
@@ -163,11 +154,10 @@ private constructor(
         fun name(name: JsonField<String>) = apply { body.name(name) }
 
         /**
-         * The transformation this name refers to, expressed as one or more comma-separated
-         * transformation parameters, for example `w-150,h-150,fo-center,cm-resize`. You do not need
-         * to prefix this with `tr:` — it is added automatically. If you do include it, it must
-         * appear in lowercase at the start of the string, or the request is rejected. Learn more
-         * about the [transformation syntax](https://imagekit.io/docs/transformations).
+         * The transformation string this name refers to, for example
+         * `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
+         * automatically if missing, and validated if present. Learn more about the
+         * [transformation syntax](https://imagekit.io/docs/transformations).
          */
         fun transformation(transformation: String) = apply { body.transformation(transformation) }
 
@@ -183,9 +173,8 @@ private constructor(
         }
 
         /**
-         * Whether this named transformation is enabled. Set to `false` to temporarily disable it
-         * without deleting it — requests using a disabled named transformation fail at delivery
-         * time.
+         * Whether the named transformation is enabled. Set to `false` to disable it without
+         * deleting it; requests using a disabled named transformation fail at delivery time.
          */
         fun enabled(enabled: Boolean) = apply { body.enabled(enabled) }
 
@@ -360,33 +349,29 @@ private constructor(
         ) : this(name, transformation, enabled, mutableMapOf())
 
         /**
-         * Name of the named transformation. This is the alias used to refer to the transformation
-         * string in image and video URLs, for example `tr:n-<name>`. Can only contain alphanumeric
-         * characters or `_` (hyphens are not allowed), and must be unique for your account. Name
-         * matching is case-sensitive, so `Small_Thumbnail` and `small_thumbnail` are treated as
-         * different names.
+         * Alias for the transformation string, used in URLs as `tr:n-<name>`. Must contain only
+         * alphanumeric characters or `_` (no hyphens), and be unique for your account. Name
+         * matching is case-sensitive.
          *
          * @throws ImageKitInvalidDataException if the JSON field has an unexpected type or is
          *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
          */
         fun name(): String = name.getRequired("name")
 
         /**
-         * The transformation this name refers to, expressed as one or more comma-separated
-         * transformation parameters, for example `w-150,h-150,fo-center,cm-resize`. You do not need
-         * to prefix this with `tr:` — it is added automatically. If you do include it, it must
-         * appear in lowercase at the start of the string, or the request is rejected. Learn more
-         * about the [transformation syntax](https://imagekit.io/docs/transformations).
+         * The transformation string this name refers to, for example
+         * `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
+         * automatically if missing, and validated if present. Learn more about the
+         * [transformation syntax](https://imagekit.io/docs/transformations).
          *
          * @throws ImageKitInvalidDataException if the JSON field has an unexpected type or is
          *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
          */
         fun transformation(): String = transformation.getRequired("transformation")
 
         /**
-         * Whether this named transformation is enabled. Set to `false` to temporarily disable it
-         * without deleting it — requests using a disabled named transformation fail at delivery
-         * time.
+         * Whether the named transformation is enabled. Set to `false` to disable it without
+         * deleting it; requests using a disabled named transformation fail at delivery time.
          *
          * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if
          *   the server responded with an unexpected value).
@@ -460,11 +445,9 @@ private constructor(
             }
 
             /**
-             * Name of the named transformation. This is the alias used to refer to the
-             * transformation string in image and video URLs, for example `tr:n-<name>`. Can only
-             * contain alphanumeric characters or `_` (hyphens are not allowed), and must be unique
-             * for your account. Name matching is case-sensitive, so `Small_Thumbnail` and
-             * `small_thumbnail` are treated as different names.
+             * Alias for the transformation string, used in URLs as `tr:n-<name>`. Must contain only
+             * alphanumeric characters or `_` (no hyphens), and be unique for your account. Name
+             * matching is case-sensitive.
              */
             fun name(name: String) = name(JsonField.of(name))
 
@@ -478,11 +461,9 @@ private constructor(
             fun name(name: JsonField<String>) = apply { this.name = name }
 
             /**
-             * The transformation this name refers to, expressed as one or more comma-separated
-             * transformation parameters, for example `w-150,h-150,fo-center,cm-resize`. You do not
-             * need to prefix this with `tr:` — it is added automatically. If you do include it, it
-             * must appear in lowercase at the start of the string, or the request is rejected.
-             * Learn more about the
+             * The transformation string this name refers to, for example
+             * `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional — it's added
+             * automatically if missing, and validated if present. Learn more about the
              * [transformation syntax](https://imagekit.io/docs/transformations).
              */
             fun transformation(transformation: String) =
@@ -500,9 +481,8 @@ private constructor(
             }
 
             /**
-             * Whether this named transformation is enabled. Set to `false` to temporarily disable
-             * it without deleting it — requests using a disabled named transformation fail at
-             * delivery time.
+             * Whether the named transformation is enabled. Set to `false` to disable it without
+             * deleting it; requests using a disabled named transformation fail at delivery time.
              */
             fun enabled(enabled: Boolean) = enabled(JsonField.of(enabled))
 

image-kit-java-core/src/main/kotlin/io/imagekit/models/namedtransformations/NamedTransformationDeleteParams.kt

@@ -14,14 +14,11 @@ import kotlin.jvm.optionals.getOrNull
 /**
  * Permanently deletes the named transformation identified by `id` and returns the deleted object.
  *
- * **Note:**
- * - If another *enabled* named transformation, or your account's upload
- *   pre-transformation/post-transformation settings, reference this named transformation (via the
- *   `n-<name>` token), the request fails with a `409` error whose `message` describes what it is
- *   referenced by. A reference from a named transformation that is itself disabled does not block
- *   this request. Remove or disable those references first, then retry the deletion. This is a
- *   best-effort check and cannot detect references baked into your own application code or
- *   previously generated URLs.
+ * Deletion fails with a `409` error if the named transformation is still referenced (via the
+ * `n-<name>` token) by another enabled named transformation, or by an upload
+ * pre-transformation/post-transformation setting. References from disabled named transformations
+ * don't count. This check is best-effort and can't detect references in your own application code
+ * or in previously generated URLs.
  */
 class NamedTransformationDeleteParams
 private constructor(