Build SDK

Stainless-Generated-From: 4416676

Author: stlc-bot

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

@@ -46,7 +46,7 @@ private constructor(
     ) : this(id, createdAt, enabled, name, transformation, mutableMapOf())
 
     /**
-     * Unique identifier generated by ImageKit when the named transformation was created.
+     * Unique identifier for a named transformation.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -62,24 +62,30 @@ private constructor(
     fun createdAt(): Optional<OffsetDateTime> = createdAt.getOptional("createdAt")
 
     /**
-     * Whether the named transformation is currently enabled.
+     * Whether the named transformation is currently enabled. When this is set to `false`, requests
+     * using such disabled named transformations fail at delivery time.
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
      */
     fun enabled(): Optional<Boolean> = enabled.getOptional("enabled")
 
     /**
-     * Name of the named transformation, used as `tr:n-<name>` in image and video URLs.
+     * 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 (e.g. if the
      *   server responded with an unexpected value).
      */
     fun name(): Optional<String> = name.getOptional("name")
 
     /**
-     * Transformation string this name refers to. Always includes the `tr:` prefix, even if you
-     * omitted it in the request.
+     * The transformation string this name refers to, for example `w-150,h-150,fo-center,cm-resize`.
+     * The `tr:` prefix is optional; if present, it is validated. The string must be a valid
+     * ImageKit transformation and cannot itself reference another named transformation (no
+     * nesting). Learn more about the
+     * [transformation syntax](https://imagekit.io/docs/transformations).
      *
      * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
      *   server responded with an unexpected value).
@@ -163,7 +169,7 @@ private constructor(
             additionalProperties = namedTransformation.additionalProperties.toMutableMap()
         }
 
-        /** Unique identifier generated by ImageKit when the named transformation was created. */
+        /** Unique identifier for a named transformation. */
         fun id(id: String) = id(JsonField.of(id))
 
         /**
@@ -186,7 +192,10 @@ private constructor(
          */
         fun createdAt(createdAt: JsonField<OffsetDateTime>) = apply { this.createdAt = createdAt }
 
-        /** Whether the named transformation is currently enabled. */
+        /**
+         * Whether the named transformation is currently enabled. When this is set to `false`,
+         * requests using such disabled named transformations fail at delivery time.
+         */
         fun enabled(enabled: Boolean) = enabled(JsonField.of(enabled))
 
         /**
@@ -197,7 +206,11 @@ private constructor(
          */
         fun enabled(enabled: JsonField<Boolean>) = apply { this.enabled = enabled }
 
-        /** Name of the named transformation, used as `tr:n-<name>` in image and video URLs. */
+        /**
+         * 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))
 
         /**
@@ -209,8 +222,11 @@ private constructor(
         fun name(name: JsonField<String>) = apply { this.name = name }
 
         /**
-         * Transformation string this name refers to. Always includes the `tr:` prefix, even if you
-         * omitted it in the request.
+         * The transformation string this name refers to, for example
+         * `w-150,h-150,fo-center,cm-resize`. The `tr:` prefix is optional; if present, it is
+         * validated. The string must be a valid ImageKit transformation and cannot itself reference
+         * another named transformation (no nesting). Learn more about the
+         * [transformation syntax](https://imagekit.io/docs/transformations).
          */
         fun transformation(transformation: String) = transformation(JsonField.of(transformation))
 

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

@@ -39,6 +39,7 @@ private constructor(
     private val label: JsonField<String>,
     private val name: JsonField<String>,
     private val schema: JsonField<Schema>,
+    private val description: JsonField<String>,
     private val additionalProperties: MutableMap<String, JsonValue>,
 ) {
 
@@ -48,7 +49,10 @@ private constructor(
         @JsonProperty("label") @ExcludeMissing label: JsonField<String> = JsonMissing.of(),
         @JsonProperty("name") @ExcludeMissing name: JsonField<String> = JsonMissing.of(),
         @JsonProperty("schema") @ExcludeMissing schema: JsonField<Schema> = JsonMissing.of(),
-    ) : this(id, label, name, schema, mutableMapOf())
+        @JsonProperty("description")
+        @ExcludeMissing
+        description: JsonField<String> = JsonMissing.of(),
+    ) : this(id, label, name, schema, description, mutableMapOf())
 
     /**
      * Unique identifier for the custom metadata field. Use this to update the field.
@@ -84,6 +88,16 @@ private constructor(
      */
     fun schema(): Schema = schema.getRequired("schema")
 
+    /**
+     * Optional description of the custom metadata field. Only present when a description has been
+     * set. Shown as a hint to the users while setting the field's value on an asset in the media
+     * library UI.
+     *
+     * @throws ImageKitInvalidDataException if the JSON field has an unexpected type (e.g. if the
+     *   server responded with an unexpected value).
+     */
+    fun description(): Optional<String> = description.getOptional("description")
+
     /**
      * Returns the raw JSON value of [id].
      *
@@ -112,6 +126,13 @@ private constructor(
      */
     @JsonProperty("schema") @ExcludeMissing fun _schema(): JsonField<Schema> = schema
 
+    /**
+     * Returns the raw JSON value of [description].
+     *
+     * Unlike [description], this method doesn't throw if the JSON field has an unexpected type.
+     */
+    @JsonProperty("description") @ExcludeMissing fun _description(): JsonField<String> = description
+
     @JsonAnySetter
     private fun putAdditionalProperty(key: String, value: JsonValue) {
         additionalProperties.put(key, value)
@@ -147,6 +168,7 @@ private constructor(
         private var label: JsonField<String>? = null
         private var name: JsonField<String>? = null
         private var schema: JsonField<Schema>? = null
+        private var description: JsonField<String> = JsonMissing.of()
         private var additionalProperties: MutableMap<String, JsonValue> = mutableMapOf()
 
         @JvmSynthetic
@@ -155,6 +177,7 @@ private constructor(
             label = customMetadataField.label
             name = customMetadataField.name
             schema = customMetadataField.schema
+            description = customMetadataField.description
             additionalProperties = customMetadataField.additionalProperties.toMutableMap()
         }
 
@@ -208,6 +231,22 @@ private constructor(
          */
         fun schema(schema: JsonField<Schema>) = apply { this.schema = schema }
 
+        /**
+         * Optional description of the custom metadata field. Only present when a description has
+         * been set. Shown as a hint to the users while setting the field's value on an asset in the
+         * media library UI.
+         */
+        fun description(description: String) = description(JsonField.of(description))
+
+        /**
+         * Sets [Builder.description] to an arbitrary JSON value.
+         *
+         * You should usually call [Builder.description] with a well-typed [String] value instead.
+         * This method is primarily for setting the field to an undocumented or not yet supported
+         * value.
+         */
+        fun description(description: JsonField<String>) = apply { this.description = description }
+
         fun additionalProperties(additionalProperties: Map<String, JsonValue>) = apply {
             this.additionalProperties.clear()
             putAllAdditionalProperties(additionalProperties)
@@ -248,6 +287,7 @@ private constructor(
                 checkRequired("label", label),
                 checkRequired("name", name),
                 checkRequired("schema", schema),
+                description,
                 additionalProperties.toMutableMap(),
             )
     }
@@ -271,6 +311,7 @@ private constructor(
         label()
         name()
         schema().validate()
+        description()
         validated = true
     }
 
@@ -292,7 +333,8 @@ private constructor(
         (if (id.asKnown().isPresent) 1 else 0) +
             (if (label.asKnown().isPresent) 1 else 0) +
             (if (name.asKnown().isPresent) 1 else 0) +
-            (schema.asKnown().getOrNull()?.validity() ?: 0)
+            (schema.asKnown().getOrNull()?.validity() ?: 0) +
+            (if (description.asKnown().isPresent) 1 else 0)
 
     /** An object that describes the rules for the custom metadata field value. */
     class Schema
@@ -2185,15 +2227,16 @@ private constructor(
             label == other.label &&
             name == other.name &&
             schema == other.schema &&
+            description == other.description &&
             additionalProperties == other.additionalProperties
     }
 
     private val hashCode: Int by lazy {
-        Objects.hash(id, label, name, schema, additionalProperties)
+        Objects.hash(id, label, name, schema, description, additionalProperties)
     }
 
     override fun hashCode(): Int = hashCode
 
     override fun toString() =
-        "CustomMetadataField{id=$id, label=$label, name=$name, schema=$schema, additionalProperties=$additionalProperties}"
+        "CustomMetadataField{id=$id, label=$label, name=$name, schema=$schema, description=$description, additionalProperties=$additionalProperties}"
 }