@usehercules/sdk 1.8.0 → 1.10.0

package/resources/beta/content/models/fields.d.ts

@@ -0,0 +1,186 @@
+import { APIResource } from "../../../../core/resource.js";
+import * as ModelsAPI from "./models.js";
+import { APIPromise } from "../../../../core/api-promise.js";
+import { RequestOptions } from "../../../../internal/request-options.js";
+export declare class Fields extends APIResource {
+    /**
+     * Adds a new field to a content model. Fields define the structure of entries. The
+     * model must not be locked. Adding a field increments the model version.
+     */
+    create(modelID: string, body: FieldCreateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field>;
+    /**
+     * Updates an existing field in a content model. The field type cannot be changed
+     * after creation. The model must not be locked.
+     */
+    update(fieldID: string, params: FieldUpdateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field>;
+    /**
+     * Removes a field from a content model. Existing entry data for this field is
+     * preserved but will no longer be validated. The model must not be locked.
+     */
+    delete(fieldID: string, params: FieldDeleteParams, options?: RequestOptions): APIPromise<void>;
+}
+export interface FieldCreateParams {
+    /**
+     * API identifier for the field (camelCase, e.g., 'title')
+     */
+    api_id: string;
+    /**
+     * Display name for the field
+     */
+    name: string;
+    /**
+     * Field data type
+     */
+    type: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
+    /**
+     * Optional custom ID for the field. Must start with 'cf\_'. If not provided, one
+     * will be generated.
+     */
+    id?: string;
+    /**
+     * Description of the field
+     */
+    description?: string;
+    /**
+     * Display order within the model
+     */
+    display_order?: number;
+    /**
+     * Whether field values are stored per-locale
+     */
+    localized?: boolean;
+    /**
+     * Validation rules
+     */
+    validation?: FieldCreateParams.Validation;
+}
+export declare namespace FieldCreateParams {
+    /**
+     * Validation rules
+     */
+    interface Validation {
+        /**
+         * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+         */
+        allowed_mime_types?: Array<string>;
+        /**
+         * Allowed model apiIds for reference fields
+         */
+        allowed_models?: Array<string>;
+        /**
+         * Allowed values for enum fields
+         */
+        allowed_values?: Array<string>;
+        /**
+         * Type of items for array fields
+         */
+        array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
+        /**
+         * Default value for the field
+         */
+        default_value?: unknown;
+        /**
+         * Maximum value for numbers, maximum length for text/arrays
+         */
+        max?: number;
+        /**
+         * Minimum value for numbers, minimum length for text/arrays
+         */
+        min?: number;
+        /**
+         * Regex pattern for text field validation
+         */
+        pattern?: string;
+        /**
+         * Whether the field is required
+         */
+        required?: boolean;
+        /**
+         * Whether field values must be unique
+         */
+        unique?: boolean;
+    }
+}
+export interface FieldUpdateParams {
+    /**
+     * Path param: The unique identifier of the content model
+     */
+    model_id: string;
+    /**
+     * Body param: Description of the field
+     */
+    description?: string;
+    /**
+     * Body param: Display order
+     */
+    display_order?: number;
+    /**
+     * Body param: Whether field values are localized
+     */
+    localized?: boolean;
+    /**
+     * Body param: Display name for the field
+     */
+    name?: string;
+    /**
+     * Body param: Validation rules
+     */
+    validation?: FieldUpdateParams.Validation;
+}
+export declare namespace FieldUpdateParams {
+    /**
+     * Validation rules
+     */
+    interface Validation {
+        /**
+         * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+         */
+        allowed_mime_types?: Array<string>;
+        /**
+         * Allowed model apiIds for reference fields
+         */
+        allowed_models?: Array<string>;
+        /**
+         * Allowed values for enum fields
+         */
+        allowed_values?: Array<string>;
+        /**
+         * Type of items for array fields
+         */
+        array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
+        /**
+         * Default value for the field
+         */
+        default_value?: unknown;
+        /**
+         * Maximum value for numbers, maximum length for text/arrays
+         */
+        max?: number;
+        /**
+         * Minimum value for numbers, minimum length for text/arrays
+         */
+        min?: number;
+        /**
+         * Regex pattern for text field validation
+         */
+        pattern?: string;
+        /**
+         * Whether the field is required
+         */
+        required?: boolean;
+        /**
+         * Whether field values must be unique
+         */
+        unique?: boolean;
+    }
+}
+export interface FieldDeleteParams {
+    /**
+     * The unique identifier of the content model
+     */
+    model_id: string;
+}
+export declare namespace Fields {
+    export { type FieldCreateParams as FieldCreateParams, type FieldUpdateParams as FieldUpdateParams, type FieldDeleteParams as FieldDeleteParams, };
+}
+//# sourceMappingURL=fields.d.ts.map

package/resources/beta/content/models/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;IAIvG;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;IAKzG;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO/F;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;IAEZ;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/beta/content/models/fields.js

@@ -0,0 +1,37 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fields = void 0;
+const resource_1 = require("../../../../core/resource.js");
+const headers_1 = require("../../../../internal/headers.js");
+const path_1 = require("../../../../internal/utils/path.js");
+class Fields extends resource_1.APIResource {
+    /**
+     * Adds a new field to a content model. Fields define the structure of entries. The
+     * model must not be locked. Adding a field increments the model version.
+     */
+    create(modelID, body, options) {
+        return this._client.post((0, path_1.path) `/v1/content/models/${modelID}/fields`, { body, ...options });
+    }
+    /**
+     * Updates an existing field in a content model. The field type cannot be changed
+     * after creation. The model must not be locked.
+     */
+    update(fieldID, params, options) {
+        const { model_id, ...body } = params;
+        return this._client.patch((0, path_1.path) `/v1/content/models/${model_id}/fields/${fieldID}`, { body, ...options });
+    }
+    /**
+     * Removes a field from a content model. Existing entry data for this field is
+     * preserved but will no longer be validated. The model must not be locked.
+     */
+    delete(fieldID, params, options) {
+        const { model_id } = params;
+        return this._client.delete((0, path_1.path) `/v1/content/models/${model_id}/fields/${fieldID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+exports.Fields = Fields;
+//# sourceMappingURL=fields.js.map

package/resources/beta/content/models/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2DAAwD;AAGxD,6DAA4D;AAE5D,6DAAuD;AAEvD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,OAAO,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE;YACjF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA7BD,wBA6BC"}

package/resources/beta/content/models/fields.mjs

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../../core/resource.mjs";
+import { buildHeaders } from "../../../../internal/headers.mjs";
+import { path } from "../../../../internal/utils/path.mjs";
+export class Fields extends APIResource {
+    /**
+     * Adds a new field to a content model. Fields define the structure of entries. The
+     * model must not be locked. Adding a field increments the model version.
+     */
+    create(modelID, body, options) {
+        return this._client.post(path `/v1/content/models/${modelID}/fields`, { body, ...options });
+    }
+    /**
+     * Updates an existing field in a content model. The field type cannot be changed
+     * after creation. The model must not be locked.
+     */
+    update(fieldID, params, options) {
+        const { model_id, ...body } = params;
+        return this._client.patch(path `/v1/content/models/${model_id}/fields/${fieldID}`, { body, ...options });
+    }
+    /**
+     * Removes a field from a content model. Existing entry data for this field is
+     * preserved but will no longer be validated. The model must not be locked.
+     */
+    delete(fieldID, params, options) {
+        const { model_id } = params;
+        return this._client.delete(path `/v1/content/models/${model_id}/fields/${fieldID}`, {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+//# sourceMappingURL=fields.mjs.map

package/resources/beta/content/models/fields.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.mjs","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/fields.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,sBAAsB,OAAO,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE;YACjF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/beta/content/models/index.d.mts

@@ -0,0 +1,3 @@
+export { Fields, type FieldCreateParams, type FieldUpdateParams, type FieldDeleteParams } from "./fields.mjs";
+export { Models, type Field, type Model, type ModelCreateParams, type ModelUpdateParams, type ModelListParams, type ModelsCursorIDPage, } from "./models.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/beta/content/models/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE;OAClF,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB"}

package/resources/beta/content/models/index.d.ts

@@ -0,0 +1,3 @@
+export { Fields, type FieldCreateParams, type FieldUpdateParams, type FieldDeleteParams } from "./fields.js";
+export { Models, type Field, type Model, type ModelCreateParams, type ModelUpdateParams, type ModelListParams, type ModelsCursorIDPage, } from "./models.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/beta/content/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE;OAClF,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB"}

package/resources/beta/content/models/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Models = exports.Fields = void 0;
+var fields_1 = require("./fields.js");
+Object.defineProperty(exports, "Fields", { enumerable: true, get: function () { return fields_1.Fields; } });
+var models_1 = require("./models.js");
+Object.defineProperty(exports, "Models", { enumerable: true, get: function () { return models_1.Models; } });
+//# sourceMappingURL=index.js.map

package/resources/beta/content/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAA0G;AAAjG,gGAAA,MAAM,OAAA;AACf,sCAQkB;AAPhB,gGAAA,MAAM,OAAA"}

package/resources/beta/content/models/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Fields } from "./fields.mjs";
+export { Models, } from "./models.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/beta/content/models/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,MAAM,EAA0E;OAClF,EACL,MAAM,GAOP"}

package/resources/beta/content/models/models.d.mts

@@ -0,0 +1,296 @@
+import { APIResource } from "../../../../core/resource.mjs";
+import * as FieldsAPI from "./fields.mjs";
+import { FieldCreateParams, FieldDeleteParams, FieldUpdateParams, Fields } from "./fields.mjs";
+import { APIPromise } from "../../../../core/api-promise.mjs";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../../core/pagination.mjs";
+import { RequestOptions } from "../../../../internal/request-options.mjs";
+export declare class Models extends APIResource {
+    fields: FieldsAPI.Fields;
+    /**
+     * Creates a new content model with optional initial fields. Content models define
+     * the schema for entries. Example models: 'Blog Post', 'Product', 'Author'.
+     */
+    create(body: ModelCreateParams, options?: RequestOptions): APIPromise<Model>;
+    /**
+     * Updates an existing content model. Use this to modify the name, description, or
+     * lock status. The api_id cannot be changed after creation.
+     */
+    update(modelID: string, body?: ModelUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Model>;
+    /**
+     * Retrieves a paginated list of content models. Content models define the
+     * schema/structure for content entries.
+     */
+    list(query?: ModelListParams | null | undefined, options?: RequestOptions): PagePromise<ModelsCursorIDPage, Model>;
+    /**
+     * Archives a content model, hiding it from the API. Existing entries are
+     * preserved. Use this instead of deletion to maintain data integrity.
+     */
+    archive(modelID: string, options?: RequestOptions): APIPromise<Model>;
+    /**
+     * Retrieves a content model by ID. Returns the model object including all field
+     * definitions.
+     */
+    get(modelID: string, options?: RequestOptions): APIPromise<Model>;
+}
+export type ModelsCursorIDPage = CursorIDPage<Model>;
+/**
+ * A field definition within a content model
+ */
+export interface Field {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * API identifier for the field (camelCase, e.g., 'title', 'publishDate')
+     */
+    api_id: string;
+    /**
+     * Timestamp when the field was created
+     */
+    created: string;
+    /**
+     * Display name for the field
+     */
+    name: string;
+    /**
+     * Field data type
+     */
+    type: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
+    /**
+     * Description of the field
+     */
+    description?: string | null;
+    /**
+     * Display order within the model
+     */
+    display_order?: number;
+    /**
+     * Whether field values are stored per-locale
+     */
+    localized?: boolean;
+    /**
+     * Validation rules
+     */
+    validation?: Field.Validation;
+}
+export declare namespace Field {
+    /**
+     * Validation rules
+     */
+    interface Validation {
+        /**
+         * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+         */
+        allowed_mime_types?: Array<string>;
+        /**
+         * Allowed model apiIds for reference fields
+         */
+        allowed_models?: Array<string>;
+        /**
+         * Allowed values for enum fields
+         */
+        allowed_values?: Array<string>;
+        /**
+         * Type of items for array fields
+         */
+        array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
+        /**
+         * Default value for the field
+         */
+        default_value?: unknown;
+        /**
+         * Maximum value for numbers, maximum length for text/arrays
+         */
+        max?: number;
+        /**
+         * Minimum value for numbers, minimum length for text/arrays
+         */
+        min?: number;
+        /**
+         * Regex pattern for text field validation
+         */
+        pattern?: string;
+        /**
+         * Whether the field is required
+         */
+        required?: boolean;
+        /**
+         * Whether field values must be unique
+         */
+        unique?: boolean;
+    }
+}
+/**
+ * A content model defines the schema/structure for content entries. Each model has
+ * fields that define what data entries can contain.
+ */
+export interface Model {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    id: string;
+    /**
+     * API identifier for the model (camelCase, e.g., 'blogPost', 'product')
+     */
+    api_id: string;
+    /**
+     * Timestamp when the model was created
+     */
+    created: string;
+    /**
+     * Whether field modifications are locked (for production safety)
+     */
+    locked: boolean;
+    /**
+     * Display name for the model
+     */
+    name: string;
+    /**
+     * Timestamp when the model was last updated
+     */
+    updated: string;
+    /**
+     * Schema version number
+     */
+    version: number;
+    /**
+     * Description of the model
+     */
+    description?: string | null;
+    /**
+     * Fields defined in this model
+     */
+    fields?: Array<Field>;
+}
+export interface ModelCreateParams {
+    /**
+     * API identifier for the model (camelCase, e.g., 'blogPost')
+     */
+    api_id: string;
+    /**
+     * Display name for the model
+     */
+    name: string;
+    /**
+     * Optional custom ID for the model. Must start with 'cm\_'. If not provided, one
+     * will be generated.
+     */
+    id?: string;
+    /**
+     * Description of the model
+     */
+    description?: string;
+    /**
+     * Initial fields to create with the model
+     */
+    fields?: Array<ModelCreateParams.Field>;
+}
+export declare namespace ModelCreateParams {
+    /**
+     * Request to add a new field to a content model
+     */
+    interface Field {
+        /**
+         * API identifier for the field (camelCase, e.g., 'title')
+         */
+        api_id: string;
+        /**
+         * Display name for the field
+         */
+        name: string;
+        /**
+         * Field data type
+         */
+        type: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
+        /**
+         * Optional custom ID for the field. Must start with 'cf\_'. If not provided, one
+         * will be generated.
+         */
+        id?: string;
+        /**
+         * Description of the field
+         */
+        description?: string;
+        /**
+         * Display order within the model
+         */
+        display_order?: number;
+        /**
+         * Whether field values are stored per-locale
+         */
+        localized?: boolean;
+        /**
+         * Validation rules
+         */
+        validation?: Field.Validation;
+    }
+    namespace Field {
+        /**
+         * Validation rules
+         */
+        interface Validation {
+            /**
+             * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+             */
+            allowed_mime_types?: Array<string>;
+            /**
+             * Allowed model apiIds for reference fields
+             */
+            allowed_models?: Array<string>;
+            /**
+             * Allowed values for enum fields
+             */
+            allowed_values?: Array<string>;
+            /**
+             * Type of items for array fields
+             */
+            array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
+            /**
+             * Default value for the field
+             */
+            default_value?: unknown;
+            /**
+             * Maximum value for numbers, maximum length for text/arrays
+             */
+            max?: number;
+            /**
+             * Minimum value for numbers, minimum length for text/arrays
+             */
+            min?: number;
+            /**
+             * Regex pattern for text field validation
+             */
+            pattern?: string;
+            /**
+             * Whether the field is required
+             */
+            required?: boolean;
+            /**
+             * Whether field values must be unique
+             */
+            unique?: boolean;
+        }
+    }
+}
+export interface ModelUpdateParams {
+    /**
+     * Description of the model
+     */
+    description?: string;
+    /**
+     * Lock the model to prevent field modifications
+     */
+    locked?: boolean;
+    /**
+     * Display name for the model
+     */
+    name?: string;
+}
+export interface ModelListParams extends CursorIDPageParams {
+}
+export declare namespace Models {
+    export { type Field as Field, type Model as Model, type ModelsCursorIDPage as ModelsCursorIDPage, type ModelCreateParams as ModelCreateParams, type ModelUpdateParams as ModelUpdateParams, type ModelListParams as ModelListParams, };
+    export { Fields as Fields, type FieldCreateParams as FieldCreateParams, type FieldUpdateParams as FieldUpdateParams, type FieldDeleteParams as FieldDeleteParams, };
+}
+//# sourceMappingURL=models.d.mts.map

package/resources/beta/content/models/models.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.d.mts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/models.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,EAAE;OACnE,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;;OAGG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,KAAK,CAAC;IAIzC;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIrE;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGlE;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;CAC/B;AAED,yBAAiB,KAAK,CAAC;IACrB;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;CACzC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EACA,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;;WAGG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;KAC/B;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAEnC;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;eAEG;YACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;YAEZ;;eAEG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;YAExB;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAC;YAEnB;;eAEG;YACH,MAAM,CAAC,EAAE,OAAO,CAAC;SAClB;KACF;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;CAAG;AAI9D,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}