Build SDK

Stainless-Generated-From: a63c852

Author: stlc-bot

src/imagekitio/resources/custom_metadata_fields.py

@@ -53,6 +53,7 @@ def create(
         label: str,
         name: str,
         schema: custom_metadata_field_create_params.Schema,
+        description: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -76,6 +77,10 @@ def create(
           name: API name of the custom metadata field. This should be unique across all
               (including deleted) custom metadata fields.
 
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              This is shown as a hint to the users while setting the field's value on an asset
+              in the media library UI.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -91,6 +96,7 @@ def create(
                     "label": label,
                     "name": name,
                     "schema": schema,
+                    "description": description,
                 },
                 custom_metadata_field_create_params.CustomMetadataFieldCreateParams,
             ),
@@ -104,6 +110,7 @@ def update(
         self,
         id: str,
         *,
+        description: str | Omit = omit,
         label: str | Omit = omit,
         schema: custom_metadata_field_update_params.Schema | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -114,9 +121,15 @@ def update(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CustomMetadataField:
         """
-        This API updates the label or schema of an existing custom metadata field.
+        This API updates the label, description, or schema of an existing custom
+        metadata field.
 
         Args:
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              Send an empty string to clear an existing description. This is shown as a hint
+              to the users while setting the field's value on an asset in the media library
+              UI.
+
           label: Human readable name of the custom metadata field. This should be unique across
               all non deleted custom metadata fields. This name is displayed as form field
               label to the users while setting field value on an asset in the media library
@@ -141,6 +154,7 @@ def update(
             path_template("/v1/customMetadataFields/{id}", id=id),
             body=maybe_transform(
                 {
+                    "description": description,
                     "label": label,
                     "schema": schema,
                 },
@@ -271,6 +285,7 @@ async def create(
         label: str,
         name: str,
         schema: custom_metadata_field_create_params.Schema,
+        description: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -294,6 +309,10 @@ async def create(
           name: API name of the custom metadata field. This should be unique across all
               (including deleted) custom metadata fields.
 
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              This is shown as a hint to the users while setting the field's value on an asset
+              in the media library UI.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -309,6 +328,7 @@ async def create(
                     "label": label,
                     "name": name,
                     "schema": schema,
+                    "description": description,
                 },
                 custom_metadata_field_create_params.CustomMetadataFieldCreateParams,
             ),
@@ -322,6 +342,7 @@ async def update(
         self,
         id: str,
         *,
+        description: str | Omit = omit,
         label: str | Omit = omit,
         schema: custom_metadata_field_update_params.Schema | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -332,9 +353,15 @@ async def update(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> CustomMetadataField:
         """
-        This API updates the label or schema of an existing custom metadata field.
+        This API updates the label, description, or schema of an existing custom
+        metadata field.
 
         Args:
+          description: Optional description for the custom metadata field. Can be up to 500 characters.
+              Send an empty string to clear an existing description. This is shown as a hint
+              to the users while setting the field's value on an asset in the media library
+              UI.
+
           label: Human readable name of the custom metadata field. This should be unique across
               all non deleted custom metadata fields. This name is displayed as form field
               label to the users while setting field value on an asset in the media library
@@ -359,6 +386,7 @@ async def update(
             path_template("/v1/customMetadataFields/{id}", id=id),
             body=await async_maybe_transform(
                 {
+                    "description": description,
                     "label": label,
                     "schema": schema,
                 },

src/imagekitio/types/custom_metadata_field.py

@@ -75,3 +75,10 @@ class CustomMetadataField(BaseModel):
 
     schema_: Schema = FieldInfo(alias="schema")
     """An object that describes the rules for the custom metadata field value."""
+
+    description: Optional[str] = None
+    """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.
+    """

src/imagekitio/types/custom_metadata_field_create_params.py

@@ -28,6 +28,13 @@ class CustomMetadataFieldCreateParams(TypedDict, total=False):
 
     schema: Required[Schema]
 
+    description: str
+    """Optional description for the custom metadata field.
+
+    Can be up to 500 characters. This is shown as a hint to the users while setting
+    the field's value on an asset in the media library UI.
+    """
+
 
 class Schema(TypedDict, total=False):
     type: Required[Literal["Text", "Textarea", "Number", "Date", "Boolean", "SingleSelect", "MultiSelect"]]

src/imagekitio/types/custom_metadata_field_update_params.py

@@ -12,6 +12,14 @@
 
 
 class CustomMetadataFieldUpdateParams(TypedDict, total=False):
+    description: str
+    """Optional description for the custom metadata field.
+
+    Can be up to 500 characters. Send an empty string to clear an existing
+    description. This is shown as a hint to the users while setting the field's
+    value on an asset in the media library UI.
+    """
+
     label: str
     """Human readable name of the custom metadata field.
 

tests/api_resources/test_custom_metadata_fields.py

@@ -47,6 +47,7 @@ def test_method_create_with_all_params(self, client: ImageKit) -> None:
                 "min_value": 1000,
                 "select_options": ["small", "medium", "large", 30, 40, True],
             },
+            description="description",
         )
         assert_matches_type(CustomMetadataField, custom_metadata_field, path=["response"])
 
@@ -93,6 +94,7 @@ def test_method_update(self, client: ImageKit) -> None:
     def test_method_update_with_all_params(self, client: ImageKit) -> None:
         custom_metadata_field = client.custom_metadata_fields.update(
             id="id",
+            description="description",
             label="price",
             schema={
                 "default_value": [True, 10, "Hello"],
@@ -251,6 +253,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncImageKit)
                 "min_value": 1000,
                 "select_options": ["small", "medium", "large", 30, 40, True],
             },
+            description="description",
         )
         assert_matches_type(CustomMetadataField, custom_metadata_field, path=["response"])
 
@@ -297,6 +300,7 @@ async def test_method_update(self, async_client: AsyncImageKit) -> None:
     async def test_method_update_with_all_params(self, async_client: AsyncImageKit) -> None:
         custom_metadata_field = await async_client.custom_metadata_fields.update(
             id="id",
+            description="description",
             label="price",
             schema={
                 "default_value": [True, 10, "Hello"],