@usehercules/sdk 1.8.0 → 1.10.0

package/src/resources/beta/content/entries.ts

@@ -0,0 +1,347 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+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
+   * default. Use the publish endpoint to make entries publicly accessible.
+   */
+  create(body: EntryCreateParams, options?: RequestOptions): APIPromise<Entry> {
+    return this._client.post('/v1/content/entries', { body, ...options });
+  }
+
+  /**
+   * Updates an existing content entry. Supports partial updates - only specified
+   * fields are modified. Use the version parameter for optimistic locking to prevent
+   * concurrent update conflicts.
+   */
+  update(
+    entryID: string,
+    body: EntryUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Entry> {
+    return this._client.patch(path`/v1/content/entries/${entryID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a paginated list of content entries. Supports filtering by model,
+   * status, locale, and custom field queries. Use the 'where' parameter for
+   * field-based filtering with operators like $eq, $contains, $gt, etc.
+   */
+  list(
+    query: EntryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<EntriesCursorIDPage, Entry> {
+    return this._client.getAPIList('/v1/content/entries', CursorIDPage<Entry>, { query, ...options });
+  }
+
+  /**
+   * Archives a content entry, hiding it from the API and public access. The entry
+   * data is preserved and can be restored later.
+   */
+  archive(entryID: string, options?: RequestOptions): APIPromise<Entry> {
+    return this._client.delete(path`/v1/content/entries/${entryID}`, options);
+  }
+
+  /**
+   * Retrieves a content entry by ID. Optionally specify a locale to get localized
+   * field values with fallback resolution.
+   */
+  get(entryID: string, options?: RequestOptions): APIPromise<Entry> {
+    return this._client.get(path`/v1/content/entries/${entryID}`, options);
+  }
+
+  /**
+   * Publishes a content entry, making it publicly accessible. Optionally schedule
+   * publishing for a future time. Publishing validates that all required fields have
+   * values.
+   */
+  publish(
+    entryID: string,
+    body: EntryPublishParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Entry> {
+    return this._client.post(path`/v1/content/entries/${entryID}/publish`, { body, ...options });
+  }
+
+  /**
+   * Unpublishes a content entry, reverting it to draft status. The entry will no
+   * longer be publicly accessible but all data is preserved.
+   */
+  unpublish(entryID: string, options?: RequestOptions): APIPromise<Entry> {
+    return this._client.post(path`/v1/content/entries/${entryID}/unpublish`, options);
+  }
+}
+
+export type EntriesCursorIDPage = CursorIDPage<Entry>;
+
+/**
+ * A content entry containing field values based on its model schema. Entries can
+ * be drafts, published, or archived.
+ */
+export interface Entry {
+  /**
+   * Unique identifier for the topic subscription
+   */
+  id: string;
+
+  /**
+   * Timestamp when the entry was created
+   */
+  created: string;
+
+  /**
+   * Field values. For localized fields: { fieldApiId: { locale: value } }. For
+   * non-localized: { fieldApiId: value }
+   */
+  fields: { [key: string]: unknown };
+
+  /**
+   * Primary locale for this entry
+   */
+  locale: string;
+
+  /**
+   * ID of the content model this entry belongs to
+   */
+  model_id: string;
+
+  /**
+   * Publishing status: draft, published, or archived
+   */
+  status: 'draft' | 'published' | 'archived';
+
+  /**
+   * Timestamp when the entry was last updated
+   */
+  updated: string;
+
+  /**
+   * Version number for optimistic locking
+   */
+  version: number;
+
+  /**
+   * Timestamp when first published
+   */
+  first_published_at?: string | null;
+
+  /**
+   * API ID of the content model (included when populated)
+   */
+  model_api_id?: string;
+
+  /**
+   * Timestamp when last published
+   */
+  published_at?: string | null;
+
+  /**
+   * Scheduled publish time
+   */
+  scheduled_publish_at?: string | null;
+
+  /**
+   * Scheduled unpublish time
+   */
+  scheduled_unpublish_at?: string | null;
+}
+
+export interface EntryCreateParams {
+  /**
+   * API ID of the content model (e.g., 'blogPost')
+   */
+  model: string;
+
+  /**
+   * Optional custom ID for the entry. Must start with 'ce\_'. If not provided, one
+   * will be generated.
+   */
+  id?: string;
+
+  /**
+   * Field values. For localized fields: { fieldApiId: { locale: value } }. For
+   * non-localized: { fieldApiId: value }
+   */
+  fields?: { [key: string]: unknown };
+
+  /**
+   * Primary locale for this entry
+   */
+  locale?: string;
+
+  /**
+   * Initial status (default: draft)
+   */
+  status?: 'draft' | 'published' | 'archived';
+}
+
+export interface EntryUpdateParams {
+  /**
+   * Field values to update. Supports partial updates - only specified fields are
+   * changed.
+   */
+  fields?: { [key: string]: unknown };
+
+  /**
+   * Primary locale
+   */
+  locale?: string;
+
+  /**
+   * Expected version for optimistic locking. Update fails if version mismatch.
+   */
+  version?: number;
+}
+
+export interface EntryListParams extends CursorIDPageParams {
+  /**
+   * Filter by creation date
+   */
+  created?: EntryListParams.Created;
+
+  /**
+   * Depth for populating reference fields (0-3)
+   */
+  include_depth?: number;
+
+  /**
+   * Filter by primary locale
+   */
+  locale?: string;
+
+  /**
+   * Filter by content model API ID (e.g., 'blogPost')
+   */
+  model?: string;
+
+  /**
+   * JSON-encoded sort order. Example: {"field":"publishedAt","direction":"desc"}
+   */
+  order_by?: string;
+
+  /**
+   * Filter by publish date
+   */
+  published?: EntryListParams.Published;
+
+  /**
+   * Full-text search across text fields
+   */
+  query?: string;
+
+  /**
+   * Filter by status
+   */
+  status?: 'draft' | 'published' | 'archived';
+
+  /**
+   * Filter by update date
+   */
+  updated?: EntryListParams.Updated;
+
+  /**
+   * JSON-encoded field filters. Example: {"title":{"$contains":"hello"}}
+   */
+  where?: string;
+}
+
+export namespace EntryListParams {
+  /**
+   * Filter by creation date
+   */
+  export interface Created {
+    /**
+     * Greater than (Unix timestamp in seconds)
+     */
+    gt?: number;
+
+    /**
+     * Greater than or equal (Unix timestamp in seconds)
+     */
+    gte?: number;
+
+    /**
+     * Less than (Unix timestamp in seconds)
+     */
+    lt?: number;
+
+    /**
+     * Less than or equal (Unix timestamp in seconds)
+     */
+    lte?: number;
+  }
+
+  /**
+   * Filter by publish date
+   */
+  export interface Published {
+    /**
+     * Greater than (Unix timestamp in seconds)
+     */
+    gt?: number;
+
+    /**
+     * Greater than or equal (Unix timestamp in seconds)
+     */
+    gte?: number;
+
+    /**
+     * Less than (Unix timestamp in seconds)
+     */
+    lt?: number;
+
+    /**
+     * Less than or equal (Unix timestamp in seconds)
+     */
+    lte?: number;
+  }
+
+  /**
+   * Filter by update date
+   */
+  export interface Updated {
+    /**
+     * Greater than (Unix timestamp in seconds)
+     */
+    gt?: number;
+
+    /**
+     * Greater than or equal (Unix timestamp in seconds)
+     */
+    gte?: number;
+
+    /**
+     * Less than (Unix timestamp in seconds)
+     */
+    lt?: number;
+
+    /**
+     * Less than or equal (Unix timestamp in seconds)
+     */
+    lte?: number;
+  }
+}
+
+export interface EntryPublishParams {
+  /**
+   * Schedule publish for a future time instead of publishing immediately
+   */
+  scheduled_at?: string;
+}
+
+export declare namespace Entries {
+  export {
+    type Entry as Entry,
+    type EntriesCursorIDPage as EntriesCursorIDPage,
+    type EntryCreateParams as EntryCreateParams,
+    type EntryUpdateParams as EntryUpdateParams,
+    type EntryListParams as EntryListParams,
+    type EntryPublishParams as EntryPublishParams,
+  };
+}

package/src/resources/beta/content/index.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Assets,
+  type Asset,
+  type AssetCreateParams,
+  type AssetUpdateParams,
+  type AssetListParams,
+  type AssetsCursorIDPage,
+} from './assets';
+export { Content } from './content';
+export {
+  Entries,
+  type Entry,
+  type EntryCreateParams,
+  type EntryUpdateParams,
+  type EntryListParams,
+  type EntryPublishParams,
+  type EntriesCursorIDPage,
+} from './entries';
+export {
+  Locales,
+  type Locale,
+  type LocaleCreateParams,
+  type LocaleUpdateParams,
+  type LocaleListParams,
+  type LocalesCursorIDPage,
+} from './locales';
+export {
+  Models,
+  type Field,
+  type Model,
+  type ModelCreateParams,
+  type ModelUpdateParams,
+  type ModelListParams,
+  type ModelsCursorIDPage,
+} from './models/index';
+export {
+  Releases,
+  type Release,
+  type ReleaseItem,
+  type ReleaseCreateParams,
+  type ReleaseUpdateParams,
+  type ReleaseListParams,
+  type ReleaseScheduleParams,
+  type ReleasesCursorIDPage,
+} from './releases/index';

package/src/resources/beta/content/locales.ts

@@ -0,0 +1,169 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from '../../../core/pagination';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Locales extends APIResource {
+  /**
+   * Creates a new locale for content localization. Configure fallback chains by
+   * setting the fallback_locale to another locale code.
+   */
+  create(body: LocaleCreateParams, options?: RequestOptions): APIPromise<Locale> {
+    return this._client.post('/v1/content/locales', { body, ...options });
+  }
+
+  /**
+   * Updates a locale's configuration including name, fallback, default status, and
+   * active status.
+   */
+  update(
+    localeCode: string,
+    body: LocaleUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Locale> {
+    return this._client.patch(path`/v1/content/locales/${localeCode}`, { body, ...options });
+  }
+
+  /**
+   * Retrieves a list of configured locales. Locales define the languages available
+   * for content localization.
+   */
+  list(
+    query: LocaleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<LocalesCursorIDPage, Locale> {
+    return this._client.getAPIList('/v1/content/locales', CursorIDPage<Locale>, { query, ...options });
+  }
+
+  /**
+   * Deletes a locale. The default locale cannot be deleted - set another locale as
+   * default first. Existing localized content is preserved.
+   */
+  delete(localeCode: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/content/locales/${localeCode}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Retrieves a locale by its code.
+   */
+  get(localeCode: string, options?: RequestOptions): APIPromise<Locale> {
+    return this._client.get(path`/v1/content/locales/${localeCode}`, options);
+  }
+}
+
+export type LocalesCursorIDPage = CursorIDPage<Locale>;
+
+/**
+ * A locale configuration for content localization. Locales define supported
+ * languages and fallback chains.
+ */
+export interface Locale {
+  /**
+   * Unique identifier for the topic subscription
+   */
+  id: string;
+
+  /**
+   * Whether the locale is active
+   */
+  active: boolean;
+
+  /**
+   * Locale code (e.g., 'en', 'en-US', 'fr-CA')
+   */
+  code: string;
+
+  /**
+   * Timestamp when the locale was created
+   */
+  created: string;
+
+  /**
+   * Whether this is the default locale
+   */
+  is_default: boolean;
+
+  /**
+   * Display name (e.g., 'English', 'French (Canada)')
+   */
+  name: string;
+
+  /**
+   * Fallback locale code for missing translations
+   */
+  fallback_locale?: string | null;
+}
+
+export interface LocaleCreateParams {
+  /**
+   * Locale code (e.g., 'en', 'en-US', 'fr-CA')
+   */
+  code: string;
+
+  /**
+   * Display name (e.g., 'English', 'French (Canada)')
+   */
+  name: string;
+
+  /**
+   * Optional custom ID for the locale. Must start with 'cl\_'. If not provided, one
+   * will be generated.
+   */
+  id?: string;
+
+  /**
+   * Fallback locale code for missing translations
+   */
+  fallback_locale?: string;
+
+  /**
+   * Set as the default locale (only one per website)
+   */
+  is_default?: boolean;
+}
+
+export interface LocaleUpdateParams {
+  /**
+   * Whether the locale is active
+   */
+  active?: boolean;
+
+  /**
+   * Fallback locale code
+   */
+  fallback_locale?: string | null;
+
+  /**
+   * Set as the default locale
+   */
+  is_default?: boolean;
+
+  /**
+   * Display name
+   */
+  name?: string;
+}
+
+export interface LocaleListParams extends CursorIDPageParams {
+  /**
+   * Filter by active status
+   */
+  active?: 'true' | 'false';
+}
+
+export declare namespace Locales {
+  export {
+    type Locale as Locale,
+    type LocalesCursorIDPage as LocalesCursorIDPage,
+    type LocaleCreateParams as LocaleCreateParams,
+    type LocaleUpdateParams as LocaleUpdateParams,
+    type LocaleListParams as LocaleListParams,
+  };
+}