@usehercules/sdk 1.14.1 → 1.14.3

package/src/resources/content/{models/models.ts → collections/collections.ts}

@@ -8,61 +8,116 @@ import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../../cor
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
-export class Models extends APIResource {
+export class Collections extends APIResource {
   fields: FieldsAPI.Fields = new FieldsAPI.Fields(this._client);
 
   /**
-   * Creates a new content model with optional initial fields. Content models define
-   * the schema for entries. Example models: 'Blog Post', 'Product', 'Author'.
+   * Creates a new content collection with optional initial fields. Content
+   * collections define the schema for entries. Example collections: 'Blog Post',
+   * 'Product', 'Author'.
    */
-  create(body: ModelCreateParams, options?: RequestOptions): APIPromise<Model> {
-    return this._client.post('/v1/content/models', { body, ...options });
+  create(body: CollectionCreateParams, options?: RequestOptions): APIPromise<Collection> {
+    return this._client.post('/v1/content/collections', { body, ...options });
   }
 
   /**
-   * Updates an existing content model. Use this to modify the name, description, or
-   * lock status. The api_id cannot be changed after creation.
+   * Updates an existing content collection. 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 = {},
+    collectionID: string,
+    body: CollectionUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Model> {
-    return this._client.patch(path`/v1/content/models/${modelID}`, { body, ...options });
+  ): APIPromise<Collection> {
+    return this._client.patch(path`/v1/content/collections/${collectionID}`, { body, ...options });
   }
 
   /**
-   * Retrieves a paginated list of content models. Content models define the
-   * schema/structure for content entries.
+   * Retrieves a paginated list of content collections. Content collections define
+   * the schema/structure for content entries.
    */
   list(
-    query: ModelListParams | null | undefined = {},
+    query: CollectionListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ModelsCursorIDPage, Model> {
-    return this._client.getAPIList('/v1/content/models', CursorIDPage<Model>, { query, ...options });
+  ): PagePromise<CollectionsCursorIDPage, Collection> {
+    return this._client.getAPIList('/v1/content/collections', CursorIDPage<Collection>, {
+      query,
+      ...options,
+    });
   }
 
   /**
-   * Archives a content model, hiding it from the API. Existing entries are
+   * Archives a content collection, 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> {
-    return this._client.delete(path`/v1/content/models/${modelID}`, options);
+  archive(collectionID: string, options?: RequestOptions): APIPromise<Collection> {
+    return this._client.delete(path`/v1/content/collections/${collectionID}`, options);
   }
 
   /**
-   * Retrieves a content model by ID. Returns the model object including all field
-   * definitions.
+   * Retrieves a content collection by ID. Returns the collection object including
+   * all field definitions.
    */
-  get(modelID: string, options?: RequestOptions): APIPromise<Model> {
-    return this._client.get(path`/v1/content/models/${modelID}`, options);
+  get(collectionID: string, options?: RequestOptions): APIPromise<Collection> {
+    return this._client.get(path`/v1/content/collections/${collectionID}`, options);
   }
 }
 
-export type ModelsCursorIDPage = CursorIDPage<Model>;
+export type CollectionsCursorIDPage = CursorIDPage<Collection>;
 
 /**
- * A field definition within a content model
+ * A content collection defines the schema/structure for content entries. Each
+ * collection has fields that define what data entries can contain.
+ */
+export interface Collection {
+  /**
+   * Unique identifier for the content collection
+   */
+  id: string;
+
+  /**
+   * API identifier for the collection (camelCase, e.g., 'blogPost', 'product')
+   */
+  api_id: string;
+
+  /**
+   * Timestamp when the collection was created
+   */
+  created: string;
+
+  /**
+   * Whether field modifications are locked (for production safety)
+   */
+  locked: boolean;
+
+  /**
+   * Display name for the collection
+   */
+  name: string;
+
+  /**
+   * Timestamp when the collection was last updated
+   */
+  updated: string;
+
+  /**
+   * Schema version number
+   */
+  version: number;
+
+  /**
+   * Description of the collection
+   */
+  description?: string | null;
+
+  /**
+   * Fields defined in this collection
+   */
+  fields?: Array<Field>;
+}
+
+/**
+ * A field definition within a content collection
  */
 export interface Field {
   /**
@@ -107,7 +162,7 @@ export interface Field {
   description?: string | null;
 
   /**
-   * Display order within the model
+   * Display order within the collection
    */
   display_order?: number;
 
@@ -128,14 +183,14 @@ export namespace Field {
    */
   export interface Validation {
     /**
-     * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+     * Allowed collection apiIds for reference fields
      */
-    allowed_mime_types?: Array<string>;
+    allowed_collections?: Array<string>;
 
     /**
-     * Allowed model apiIds for reference fields
+     * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
      */
-    allowed_models?: Array<string>;
+    allowed_mime_types?: Array<string>;
 
     /**
      * Allowed values for enum fields
@@ -190,88 +245,37 @@ export namespace Field {
   }
 }
 
-/**
- * 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 content model
-   */
-  id: string;
-
+export interface CollectionCreateParams {
   /**
-   * API identifier for the model (camelCase, e.g., 'blogPost', 'product')
+   * API identifier for the collection (camelCase, e.g., 'blogPost')
    */
   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
+   * Display name for the collection
    */
   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.
+   * Optional custom ID for the collection. Must start with 'cm\_'. If not provided,
+   * one will be generated.
    */
   id?: string;
 
   /**
-   * Description of the model
+   * Description of the collection
    */
   description?: string;
 
   /**
-   * Initial fields to create with the model
+   * Initial fields to create with the collection
    */
-  fields?: Array<ModelCreateParams.Field>;
+  fields?: Array<CollectionCreateParams.Field>;
 }
 
-export namespace ModelCreateParams {
+export namespace CollectionCreateParams {
   /**
-   * Request to add a new field to a content model
+   * Request to add a new field to a content collection
    */
   export interface Field {
     /**
@@ -312,7 +316,7 @@ export namespace ModelCreateParams {
     description?: string;
 
     /**
-     * Display order within the model
+     * Display order within the collection
      */
     display_order?: number;
 
@@ -333,14 +337,14 @@ export namespace ModelCreateParams {
      */
     export interface Validation {
       /**
-       * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+       * Allowed collection apiIds for reference fields
        */
-      allowed_mime_types?: Array<string>;
+      allowed_collections?: Array<string>;
 
       /**
-       * Allowed model apiIds for reference fields
+       * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
        */
-      allowed_models?: Array<string>;
+      allowed_mime_types?: Array<string>;
 
       /**
        * Allowed values for enum fields
@@ -396,35 +400,35 @@ export namespace ModelCreateParams {
   }
 }
 
-export interface ModelUpdateParams {
+export interface CollectionUpdateParams {
   /**
-   * Description of the model
+   * Description of the collection
    */
   description?: string;
 
   /**
-   * Lock the model to prevent field modifications
+   * Lock the collection to prevent field modifications
    */
   locked?: boolean;
 
   /**
-   * Display name for the model
+   * Display name for the collection
    */
   name?: string;
 }
 
-export interface ModelListParams extends CursorIDPageParams {}
+export interface CollectionListParams extends CursorIDPageParams {}
 
-Models.Fields = Fields;
+Collections.Fields = Fields;
 
-export declare namespace Models {
+export declare namespace Collections {
   export {
+    type Collection as Collection,
     type Field as Field,
-    type Model as Model,
-    type ModelsCursorIDPage as ModelsCursorIDPage,
-    type ModelCreateParams as ModelCreateParams,
-    type ModelUpdateParams as ModelUpdateParams,
-    type ModelListParams as ModelListParams,
+    type CollectionsCursorIDPage as CollectionsCursorIDPage,
+    type CollectionCreateParams as CollectionCreateParams,
+    type CollectionUpdateParams as CollectionUpdateParams,
+    type CollectionListParams as CollectionListParams,
   };
 
   export {

package/src/resources/content/{models → collections}/fields.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as ModelsAPI from './models';
+import * as CollectionsAPI from './collections';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
@@ -9,29 +9,41 @@ import { path } from '../../../internal/utils/path';
 
 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.
+   * Adds a new field to a content collection. Fields define the structure of
+   * entries. The collection must not be locked. Adding a field increments the
+   * collection version.
    */
-  create(modelID: string, body: FieldCreateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field> {
-    return this._client.post(path`/v1/content/models/${modelID}/fields`, { body, ...options });
+  create(
+    collectionID: string,
+    body: FieldCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CollectionsAPI.Field> {
+    return this._client.post(path`/v1/content/collections/${collectionID}/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.
+   * Updates an existing field in a content collection. The field type cannot be
+   * changed after creation. The collection must not be locked.
    */
-  update(fieldID: string, params: FieldUpdateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field> {
-    const { model_id, ...body } = params;
-    return this._client.patch(path`/v1/content/models/${model_id}/fields/${fieldID}`, { body, ...options });
+  update(
+    fieldID: string,
+    params: FieldUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CollectionsAPI.Field> {
+    const { collection_id, ...body } = params;
+    return this._client.patch(path`/v1/content/collections/${collection_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.
+   * Removes a field from a content collection. Existing entry data for this field is
+   * preserved but will no longer be validated. The collection must not be locked.
    */
   delete(fieldID: string, params: FieldDeleteParams, options?: RequestOptions): APIPromise<void> {
-    const { model_id } = params;
-    return this._client.delete(path`/v1/content/models/${model_id}/fields/${fieldID}`, {
+    const { collection_id } = params;
+    return this._client.delete(path`/v1/content/collections/${collection_id}/fields/${fieldID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -77,7 +89,7 @@ export interface FieldCreateParams {
   description?: string;
 
   /**
-   * Display order within the model
+   * Display order within the collection
    */
   display_order?: number;
 
@@ -98,14 +110,14 @@ export namespace FieldCreateParams {
    */
   export interface Validation {
     /**
-     * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+     * Allowed collection apiIds for reference fields
      */
-    allowed_mime_types?: Array<string>;
+    allowed_collections?: Array<string>;
 
     /**
-     * Allowed model apiIds for reference fields
+     * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
      */
-    allowed_models?: Array<string>;
+    allowed_mime_types?: Array<string>;
 
     /**
      * Allowed values for enum fields
@@ -162,9 +174,9 @@ export namespace FieldCreateParams {
 
 export interface FieldUpdateParams {
   /**
-   * Path param: The unique identifier of the content model
+   * Path param: The unique identifier of the content collection
    */
-  model_id: string;
+  collection_id: string;
 
   /**
    * Body param: Description of the field
@@ -198,14 +210,14 @@ export namespace FieldUpdateParams {
    */
   export interface Validation {
     /**
-     * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
+     * Allowed collection apiIds for reference fields
      */
-    allowed_mime_types?: Array<string>;
+    allowed_collections?: Array<string>;
 
     /**
-     * Allowed model apiIds for reference fields
+     * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
      */
-    allowed_models?: Array<string>;
+    allowed_mime_types?: Array<string>;
 
     /**
      * Allowed values for enum fields
@@ -262,9 +274,9 @@ export namespace FieldUpdateParams {
 
 export interface FieldDeleteParams {
   /**
-   * The unique identifier of the content model
+   * The unique identifier of the content collection
    */
-  model_id: string;
+  collection_id: string;
 }
 
 export declare namespace Fields {

package/src/resources/content/{models → collections}/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Fields, type FieldCreateParams, type FieldUpdateParams, type FieldDeleteParams } from './fields';
 export {
-  Models,
+  Collections,
+  type Collection,
   type Field,
-  type Model,
-  type ModelCreateParams,
-  type ModelUpdateParams,
-  type ModelListParams,
-  type ModelsCursorIDPage,
-} from './models';
+  type CollectionCreateParams,
+  type CollectionUpdateParams,
+  type CollectionListParams,
+  type CollectionsCursorIDPage,
+} from './collections';
+export { Fields, type FieldCreateParams, type FieldUpdateParams, type FieldDeleteParams } from './fields';

package/src/resources/content/collections.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './collections/index';

package/src/resources/content/content.ts

@@ -29,16 +29,16 @@ import {
   Locales,
   LocalesCursorIDPage,
 } from './locales';
-import * as ModelsAPI from './models/models';
+import * as CollectionsAPI from './collections/collections';
 import {
+  Collection,
+  CollectionCreateParams,
+  CollectionListParams,
+  CollectionUpdateParams,
+  Collections,
+  CollectionsCursorIDPage,
   Field,
-  Model,
-  ModelCreateParams,
-  ModelListParams,
-  ModelUpdateParams,
-  Models,
-  ModelsCursorIDPage,
-} from './models/models';
+} from './collections/collections';
 import * as ReleasesAPI from './releases/releases';
 import {
   Release,
@@ -55,14 +55,14 @@ import {
  * Content APIs are currently in beta.
  */
 export class Content extends APIResource {
-  models: ModelsAPI.Models = new ModelsAPI.Models(this._client);
+  collections: CollectionsAPI.Collections = new CollectionsAPI.Collections(this._client);
   entries: EntriesAPI.Entries = new EntriesAPI.Entries(this._client);
   assets: AssetsAPI.Assets = new AssetsAPI.Assets(this._client);
   locales: LocalesAPI.Locales = new LocalesAPI.Locales(this._client);
   releases: ReleasesAPI.Releases = new ReleasesAPI.Releases(this._client);
 }
 
-Content.Models = Models;
+Content.Collections = Collections;
 Content.Entries = Entries;
 Content.Assets = Assets;
 Content.Locales = Locales;
@@ -70,13 +70,13 @@ Content.Releases = Releases;
 
 export declare namespace Content {
   export {
-    Models as Models,
+    Collections as Collections,
+    type Collection as Collection,
     type Field as Field,
-    type Model as Model,
-    type ModelsCursorIDPage as ModelsCursorIDPage,
-    type ModelCreateParams as ModelCreateParams,
-    type ModelUpdateParams as ModelUpdateParams,
-    type ModelListParams as ModelListParams,
+    type CollectionsCursorIDPage as CollectionsCursorIDPage,
+    type CollectionCreateParams as CollectionCreateParams,
+    type CollectionUpdateParams as CollectionUpdateParams,
+    type CollectionListParams as CollectionListParams,
   };
 
   export {

package/src/resources/content/entries.ts

@@ -8,7 +8,7 @@ import { path } from '../../internal/utils/path';
 
 export class Entries extends APIResource {
   /**
-   * Creates a new content entry for a given model. Entries start as drafts by
+   * Creates a new content entry for a given collection. Entries start as drafts by
    * default. Use the publish endpoint to make entries publicly accessible.
    */
   create(body: EntryCreateParams, options?: RequestOptions): APIPromise<Entry> {
@@ -29,7 +29,7 @@ export class Entries extends APIResource {
   }
 
   /**
-   * Retrieves a paginated list of content entries. Supports filtering by model,
+   * Retrieves a paginated list of content entries. Supports filtering by collection,
    * status, locale, and custom field queries. Use the 'where' parameter for
    * field-based filtering with operators like $eq, $contains, $gt, etc.
    */
@@ -81,8 +81,8 @@ export class Entries extends APIResource {
 export type EntriesCursorIDPage = CursorIDPage<Entry>;
 
 /**
- * A content entry containing field values based on its model schema. Entries can
- * be drafts, published, or archived.
+ * A content entry containing field values based on its collection schema. Entries
+ * can be drafts, published, or archived.
  */
 export interface Entry {
   /**
@@ -90,6 +90,11 @@ export interface Entry {
    */
   id: string;
 
+  /**
+   * ID of the content collection this entry belongs to
+   */
+  collection_id: string;
+
   /**
    * Timestamp when the entry was created
    */
@@ -106,11 +111,6 @@ export interface Entry {
    */
   locale: string;
 
-  /**
-   * ID of the content model this entry belongs to
-   */
-  model_id: string;
-
   /**
    * Publishing status: draft, published, or archived
    */
@@ -127,14 +127,14 @@ export interface Entry {
   version: number;
 
   /**
-   * Timestamp when first published
+   * API ID of the content collection (included when populated)
    */
-  first_published_at?: string | null;
+  collection_api_id?: string;
 
   /**
-   * API ID of the content model (included when populated)
+   * Timestamp when first published
    */
-  model_api_id?: string;
+  first_published_at?: string | null;
 
   /**
    * Timestamp when last published
@@ -154,9 +154,9 @@ export interface Entry {
 
 export interface EntryCreateParams {
   /**
-   * API ID of the content model (e.g., 'blogPost')
+   * API ID of the content collection (e.g., 'blogPost')
    */
-  model: string;
+  collection: string;
 
   /**
    * Optional custom ID for the entry. Must start with 'ce\_'. If not provided, one
@@ -200,6 +200,11 @@ export interface EntryUpdateParams {
 }
 
 export interface EntryListParams extends CursorIDPageParams {
+  /**
+   * Filter by content collection API ID (e.g., 'blogPost')
+   */
+  collection?: string;
+
   /**
    * Filter by creation date
    */
@@ -215,11 +220,6 @@ export interface EntryListParams extends CursorIDPageParams {
    */
   locale?: string;
 
-  /**
-   * Filter by content model API ID (e.g., 'blogPost')
-   */
-  model?: string;
-
   /**
    * JSON-encoded sort order. Example: {"field":"publishedAt","direction":"desc"}
    */