@imagekit/nodejs 7.0.1

package/resources/custom-metadata-fields.d.mts

@@ -0,0 +1,274 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class CustomMetadataFields extends APIResource {
+    /**
+     * This API creates a new custom metadata field. Once a custom metadata field is
+     * created either through this API or using the dashboard UI, its value can be set
+     * on the assets. The value of a field for an asset can be set using the media
+     * library UI or programmatically through upload or update assets API.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.create({
+     *     label: 'price',
+     *     name: 'price',
+     *     schema: {
+     *       type: 'Number',
+     *       minValue: 1000,
+     *       maxValue: 3000,
+     *     },
+     *   });
+     * ```
+     */
+    create(body: CustomMetadataFieldCreateParams, options?: RequestOptions): APIPromise<CustomMetadataField>;
+    /**
+     * This API updates the label or schema of an existing custom metadata field.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.update('id', {
+     *     label: 'price',
+     *     schema: {
+     *       type: 'Number',
+     *       minValue: 1000,
+     *       maxValue: 3000,
+     *     },
+     *   });
+     * ```
+     */
+    update(id: string, body?: CustomMetadataFieldUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomMetadataField>;
+    /**
+     * This API returns the array of created custom metadata field objects. By default
+     * the API returns only non deleted field objects, but you can include deleted
+     * fields in the API response.
+     *
+     * @example
+     * ```ts
+     * const customMetadataFields =
+     *   await client.customMetadataFields.list();
+     * ```
+     */
+    list(query?: CustomMetadataFieldListParams | null | undefined, options?: RequestOptions): APIPromise<CustomMetadataFieldListResponse>;
+    /**
+     * This API deletes a custom metadata field. Even after deleting a custom metadata
+     * field, you cannot create any new custom metadata field with the same name.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.delete('id');
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<CustomMetadataFieldDeleteResponse>;
+}
+/**
+ * Object containing details of a custom metadata field.
+ */
+export interface CustomMetadataField {
+    /**
+     * Unique identifier for the custom metadata field. Use this to update the field.
+     */
+    id: string;
+    /**
+     * Human readable name of the custom metadata field. This name is displayed as form
+     * field label to the users while setting field value on the asset in the media
+     * library UI.
+     */
+    label: string;
+    /**
+     * API name of the custom metadata field. This becomes the key while setting
+     * `customMetadata` (key-value object) for an asset using upload or update API.
+     */
+    name: string;
+    /**
+     * An object that describes the rules for the custom metadata field value.
+     */
+    schema: CustomMetadataField.Schema;
+}
+export declare namespace CustomMetadataField {
+    /**
+     * An object that describes the rules for the custom metadata field value.
+     */
+    interface Schema {
+        /**
+         * Type of the custom metadata field.
+         */
+        type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
+        /**
+         * The default value for this custom metadata field. Date type of default value
+         * depends on the field type.
+         */
+        defaultValue?: string | number | boolean | Array<string | number | boolean>;
+        /**
+         * Specifies if the this custom metadata field is required or not.
+         */
+        isValueRequired?: boolean;
+        /**
+         * Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
+         */
+        maxLength?: number;
+        /**
+         * 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.
+         */
+        maxValue?: string | number;
+        /**
+         * Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
+         */
+        minLength?: number;
+        /**
+         * 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.
+         */
+        minValue?: string | number;
+        /**
+         * An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
+         */
+        selectOptions?: Array<string | number | boolean>;
+    }
+}
+export type CustomMetadataFieldListResponse = Array<CustomMetadataField>;
+export interface CustomMetadataFieldDeleteResponse {
+}
+export interface CustomMetadataFieldCreateParams {
+    /**
+     * 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
+     * UI.
+     */
+    label: string;
+    /**
+     * API name of the custom metadata field. This should be unique across all
+     * (including deleted) custom metadata fields.
+     */
+    name: string;
+    schema: CustomMetadataFieldCreateParams.Schema;
+}
+export declare namespace CustomMetadataFieldCreateParams {
+    interface Schema {
+        /**
+         * Type of the custom metadata field.
+         */
+        type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
+        /**
+         * The default value for this custom metadata field. This property is only required
+         * if `isValueRequired` property is set to `true`. The value should match the
+         * `type` of custom metadata field.
+         */
+        defaultValue?: string | number | boolean | Array<string | number | boolean>;
+        /**
+         * Sets this custom metadata field as required. Setting custom metadata fields on
+         * an asset will throw error if the value for all required fields are not present
+         * in upload or update asset API request body.
+         */
+        isValueRequired?: boolean;
+        /**
+         * Maximum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        maxLength?: number;
+        /**
+         * Maximum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        maxValue?: string | number;
+        /**
+         * Minimum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        minLength?: number;
+        /**
+         * Minimum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        minValue?: string | number;
+        /**
+         * An array of allowed values. This property is only required if `type` property is
+         * set to `SingleSelect` or `MultiSelect`.
+         */
+        selectOptions?: Array<string | number | boolean>;
+    }
+}
+export interface CustomMetadataFieldUpdateParams {
+    /**
+     * 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
+     * UI. This parameter is required if `schema` is not provided.
+     */
+    label?: string;
+    /**
+     * An object that describes the rules for the custom metadata key. This parameter
+     * is required if `label` is not provided. Note: `type` cannot be updated and will
+     * be ignored if sent with the `schema`. The schema will be validated as per the
+     * existing `type`.
+     */
+    schema?: CustomMetadataFieldUpdateParams.Schema;
+}
+export declare namespace CustomMetadataFieldUpdateParams {
+    /**
+     * An object that describes the rules for the custom metadata key. This parameter
+     * is required if `label` is not provided. Note: `type` cannot be updated and will
+     * be ignored if sent with the `schema`. The schema will be validated as per the
+     * existing `type`.
+     */
+    interface Schema {
+        /**
+         * The default value for this custom metadata field. This property is only required
+         * if `isValueRequired` property is set to `true`. The value should match the
+         * `type` of custom metadata field.
+         */
+        defaultValue?: string | number | boolean | Array<string | number | boolean>;
+        /**
+         * Sets this custom metadata field as required. Setting custom metadata fields on
+         * an asset will throw error if the value for all required fields are not present
+         * in upload or update asset API request body.
+         */
+        isValueRequired?: boolean;
+        /**
+         * Maximum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        maxLength?: number;
+        /**
+         * Maximum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        maxValue?: string | number;
+        /**
+         * Minimum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        minLength?: number;
+        /**
+         * Minimum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        minValue?: string | number;
+        /**
+         * An array of allowed values. This property is only required if `type` property is
+         * set to `SingleSelect` or `MultiSelect`.
+         */
+        selectOptions?: Array<string | number | boolean>;
+    }
+}
+export interface CustomMetadataFieldListParams {
+    /**
+     * Set it to `true` to include deleted field objects in the API response.
+     */
+    includeDeleted?: boolean;
+}
+export declare namespace CustomMetadataFields {
+    export { type CustomMetadataField as CustomMetadataField, type CustomMetadataFieldListResponse as CustomMetadataFieldListResponse, type CustomMetadataFieldDeleteResponse as CustomMetadataFieldDeleteResponse, type CustomMetadataFieldCreateParams as CustomMetadataFieldCreateParams, type CustomMetadataFieldUpdateParams as CustomMetadataFieldUpdateParams, type CustomMetadataFieldListParams as CustomMetadataFieldListParams, };
+}
+//# sourceMappingURL=custom-metadata-fields.d.mts.map

package/resources/custom-metadata-fields.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-metadata-fields.d.mts","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;CAG5F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;CACpC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,MAAM,+BAA+B,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEzE,MAAM,WAAW,iCAAiC;CAAG;AAErD,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,+BAA+B,CAAC,MAAM,CAAC;CAChD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,+BAA+B,CAAC,MAAM,CAAC;CACjD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/custom-metadata-fields.d.ts

@@ -0,0 +1,274 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class CustomMetadataFields extends APIResource {
+    /**
+     * This API creates a new custom metadata field. Once a custom metadata field is
+     * created either through this API or using the dashboard UI, its value can be set
+     * on the assets. The value of a field for an asset can be set using the media
+     * library UI or programmatically through upload or update assets API.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.create({
+     *     label: 'price',
+     *     name: 'price',
+     *     schema: {
+     *       type: 'Number',
+     *       minValue: 1000,
+     *       maxValue: 3000,
+     *     },
+     *   });
+     * ```
+     */
+    create(body: CustomMetadataFieldCreateParams, options?: RequestOptions): APIPromise<CustomMetadataField>;
+    /**
+     * This API updates the label or schema of an existing custom metadata field.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.update('id', {
+     *     label: 'price',
+     *     schema: {
+     *       type: 'Number',
+     *       minValue: 1000,
+     *       maxValue: 3000,
+     *     },
+     *   });
+     * ```
+     */
+    update(id: string, body?: CustomMetadataFieldUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomMetadataField>;
+    /**
+     * This API returns the array of created custom metadata field objects. By default
+     * the API returns only non deleted field objects, but you can include deleted
+     * fields in the API response.
+     *
+     * @example
+     * ```ts
+     * const customMetadataFields =
+     *   await client.customMetadataFields.list();
+     * ```
+     */
+    list(query?: CustomMetadataFieldListParams | null | undefined, options?: RequestOptions): APIPromise<CustomMetadataFieldListResponse>;
+    /**
+     * This API deletes a custom metadata field. Even after deleting a custom metadata
+     * field, you cannot create any new custom metadata field with the same name.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.delete('id');
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<CustomMetadataFieldDeleteResponse>;
+}
+/**
+ * Object containing details of a custom metadata field.
+ */
+export interface CustomMetadataField {
+    /**
+     * Unique identifier for the custom metadata field. Use this to update the field.
+     */
+    id: string;
+    /**
+     * Human readable name of the custom metadata field. This name is displayed as form
+     * field label to the users while setting field value on the asset in the media
+     * library UI.
+     */
+    label: string;
+    /**
+     * API name of the custom metadata field. This becomes the key while setting
+     * `customMetadata` (key-value object) for an asset using upload or update API.
+     */
+    name: string;
+    /**
+     * An object that describes the rules for the custom metadata field value.
+     */
+    schema: CustomMetadataField.Schema;
+}
+export declare namespace CustomMetadataField {
+    /**
+     * An object that describes the rules for the custom metadata field value.
+     */
+    interface Schema {
+        /**
+         * Type of the custom metadata field.
+         */
+        type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
+        /**
+         * The default value for this custom metadata field. Date type of default value
+         * depends on the field type.
+         */
+        defaultValue?: string | number | boolean | Array<string | number | boolean>;
+        /**
+         * Specifies if the this custom metadata field is required or not.
+         */
+        isValueRequired?: boolean;
+        /**
+         * Maximum length of string. Only set if `type` is set to `Text` or `Textarea`.
+         */
+        maxLength?: number;
+        /**
+         * 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.
+         */
+        maxValue?: string | number;
+        /**
+         * Minimum length of string. Only set if `type` is set to `Text` or `Textarea`.
+         */
+        minLength?: number;
+        /**
+         * 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.
+         */
+        minValue?: string | number;
+        /**
+         * An array of allowed values when field type is `SingleSelect` or `MultiSelect`.
+         */
+        selectOptions?: Array<string | number | boolean>;
+    }
+}
+export type CustomMetadataFieldListResponse = Array<CustomMetadataField>;
+export interface CustomMetadataFieldDeleteResponse {
+}
+export interface CustomMetadataFieldCreateParams {
+    /**
+     * 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
+     * UI.
+     */
+    label: string;
+    /**
+     * API name of the custom metadata field. This should be unique across all
+     * (including deleted) custom metadata fields.
+     */
+    name: string;
+    schema: CustomMetadataFieldCreateParams.Schema;
+}
+export declare namespace CustomMetadataFieldCreateParams {
+    interface Schema {
+        /**
+         * Type of the custom metadata field.
+         */
+        type: 'Text' | 'Textarea' | 'Number' | 'Date' | 'Boolean' | 'SingleSelect' | 'MultiSelect';
+        /**
+         * The default value for this custom metadata field. This property is only required
+         * if `isValueRequired` property is set to `true`. The value should match the
+         * `type` of custom metadata field.
+         */
+        defaultValue?: string | number | boolean | Array<string | number | boolean>;
+        /**
+         * Sets this custom metadata field as required. Setting custom metadata fields on
+         * an asset will throw error if the value for all required fields are not present
+         * in upload or update asset API request body.
+         */
+        isValueRequired?: boolean;
+        /**
+         * Maximum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        maxLength?: number;
+        /**
+         * Maximum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        maxValue?: string | number;
+        /**
+         * Minimum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        minLength?: number;
+        /**
+         * Minimum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        minValue?: string | number;
+        /**
+         * An array of allowed values. This property is only required if `type` property is
+         * set to `SingleSelect` or `MultiSelect`.
+         */
+        selectOptions?: Array<string | number | boolean>;
+    }
+}
+export interface CustomMetadataFieldUpdateParams {
+    /**
+     * 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
+     * UI. This parameter is required if `schema` is not provided.
+     */
+    label?: string;
+    /**
+     * An object that describes the rules for the custom metadata key. This parameter
+     * is required if `label` is not provided. Note: `type` cannot be updated and will
+     * be ignored if sent with the `schema`. The schema will be validated as per the
+     * existing `type`.
+     */
+    schema?: CustomMetadataFieldUpdateParams.Schema;
+}
+export declare namespace CustomMetadataFieldUpdateParams {
+    /**
+     * An object that describes the rules for the custom metadata key. This parameter
+     * is required if `label` is not provided. Note: `type` cannot be updated and will
+     * be ignored if sent with the `schema`. The schema will be validated as per the
+     * existing `type`.
+     */
+    interface Schema {
+        /**
+         * The default value for this custom metadata field. This property is only required
+         * if `isValueRequired` property is set to `true`. The value should match the
+         * `type` of custom metadata field.
+         */
+        defaultValue?: string | number | boolean | Array<string | number | boolean>;
+        /**
+         * Sets this custom metadata field as required. Setting custom metadata fields on
+         * an asset will throw error if the value for all required fields are not present
+         * in upload or update asset API request body.
+         */
+        isValueRequired?: boolean;
+        /**
+         * Maximum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        maxLength?: number;
+        /**
+         * Maximum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        maxValue?: string | number;
+        /**
+         * Minimum length of string. Only set this property if `type` is set to `Text` or
+         * `Textarea`.
+         */
+        minLength?: number;
+        /**
+         * Minimum value of the field. Only set this property if field type is `Date` or
+         * `Number`. For `Date` type field, set the minimum date in ISO8601 string format.
+         * For `Number` type field, set the minimum numeric value.
+         */
+        minValue?: string | number;
+        /**
+         * An array of allowed values. This property is only required if `type` property is
+         * set to `SingleSelect` or `MultiSelect`.
+         */
+        selectOptions?: Array<string | number | boolean>;
+    }
+}
+export interface CustomMetadataFieldListParams {
+    /**
+     * Set it to `true` to include deleted field objects in the API response.
+     */
+    includeDeleted?: boolean;
+}
+export declare namespace CustomMetadataFields {
+    export { type CustomMetadataField as CustomMetadataField, type CustomMetadataFieldListResponse as CustomMetadataFieldListResponse, type CustomMetadataFieldDeleteResponse as CustomMetadataFieldDeleteResponse, type CustomMetadataFieldCreateParams as CustomMetadataFieldCreateParams, type CustomMetadataFieldUpdateParams as CustomMetadataFieldUpdateParams, type CustomMetadataFieldListParams as CustomMetadataFieldListParams, };
+}
+//# sourceMappingURL=custom-metadata-fields.d.ts.map

package/resources/custom-metadata-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-metadata-fields.d.ts","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,oBAAqB,SAAQ,WAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;CAG5F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC;CACpC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,MAAM,+BAA+B,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAEzE,MAAM,WAAW,iCAAiC;CAAG;AAErD,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,+BAA+B,CAAC,MAAM,CAAC;CAChD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,MAAM;QACrB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,aAAa,CAAC;QAE3F;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,+BAA+B,CAAC,MAAM,CAAC;CACjD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;;;;OAKG;IACH,UAAiB,MAAM;QACrB;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;QAE5E;;;;WAIG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAE3B;;;WAGG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;KAClD;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/custom-metadata-fields.js

@@ -0,0 +1,79 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomMetadataFields = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class CustomMetadataFields extends resource_1.APIResource {
+    /**
+     * This API creates a new custom metadata field. Once a custom metadata field is
+     * created either through this API or using the dashboard UI, its value can be set
+     * on the assets. The value of a field for an asset can be set using the media
+     * library UI or programmatically through upload or update assets API.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.create({
+     *     label: 'price',
+     *     name: 'price',
+     *     schema: {
+     *       type: 'Number',
+     *       minValue: 1000,
+     *       maxValue: 3000,
+     *     },
+     *   });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/v1/customMetadataFields', { body, ...options });
+    }
+    /**
+     * This API updates the label or schema of an existing custom metadata field.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.update('id', {
+     *     label: 'price',
+     *     schema: {
+     *       type: 'Number',
+     *       minValue: 1000,
+     *       maxValue: 3000,
+     *     },
+     *   });
+     * ```
+     */
+    update(id, body = {}, options) {
+        return this._client.patch((0, path_1.path) `/v1/customMetadataFields/${id}`, { body, ...options });
+    }
+    /**
+     * This API returns the array of created custom metadata field objects. By default
+     * the API returns only non deleted field objects, but you can include deleted
+     * fields in the API response.
+     *
+     * @example
+     * ```ts
+     * const customMetadataFields =
+     *   await client.customMetadataFields.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/customMetadataFields', { query, ...options });
+    }
+    /**
+     * This API deletes a custom metadata field. Even after deleting a custom metadata
+     * field, you cannot create any new custom metadata field with the same name.
+     *
+     * @example
+     * ```ts
+     * const customMetadataField =
+     *   await client.customMetadataFields.delete('id');
+     * ```
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/v1/customMetadataFields/${id}`, options);
+    }
+}
+exports.CustomMetadataFields = CustomMetadataFields;
+//# sourceMappingURL=custom-metadata-fields.js.map

package/resources/custom-metadata-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-metadata-fields.js","sourceRoot":"","sources":["../src/resources/custom-metadata-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,oBAAqB,SAAQ,sBAAW;IACnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAqC,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,EAAU,EACV,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF;AAhFD,oDAgFC"}