@storyblok/management-api-client 0.2.3 → 1.0.0-alpha.1

package/dist/generated/stories/types.gen.d.cts

@@ -1,6 +1,178 @@
 //#region src/generated/stories/types.gen.d.ts
-type StoryCreate = StoryCreate2;
-type StoryUpdate = StoryUpdate2;
+/**
+ * Input for creating a story.
+ */
+type StoryCreate = {
+  /**
+   * The numeric ID of the story. Can be passed in the body per the MAPI docs.
+   */
+  id?: number;
+  /**
+   * The complete name provided for the story.
+   */
+  name: string;
+  /**
+   * The slug specific for the story. Auto-generated as a UUID when omitted.
+   */
+  slug?: string;
+  content?: BlokContentInput;
+  /**
+   * ID of the parent folder.
+   */
+  parent_id?: number;
+  /**
+   * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor).
+   */
+  path?: string | null;
+  /**
+   * true if the story is defined as root for the folder.
+   */
+  is_startpage?: boolean;
+  /**
+   * Array of tag names.
+   */
+  tag_list?: Array<string>;
+  /**
+   * Date defined in the story's entry configuration YYYY-mm-dd.
+   */
+  sort_by_date?: string | null;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position?: number;
+  /**
+   * Object to store non-editable data that is exclusively maintained with the Management API.
+   */
+  meta_data?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Whether the entry is a folder.
+   */
+  is_folder?: boolean;
+  /**
+   * Default content type for stories in this folder.
+   */
+  default_root?: string | null;
+  /**
+   * Whether the Visual Editor is disabled.
+   */
+  disable_fe_editor?: boolean;
+  /**
+   * Translated slug entries to create, update, or delete.
+   */
+  translated_slugs_attributes?: Array<{
+    id?: number;
+    lang?: string;
+    slug?: string;
+    name?: string;
+    published?: boolean;
+  }>;
+};
+/**
+ * Input for updating a story.
+ */
+type StoryUpdate = {
+  /**
+   * The numeric ID of the story. Can be passed in the update body per the MAPI docs.
+   */
+  id?: number;
+  /**
+   * The complete name provided for the story.
+   */
+  name?: string;
+  /**
+   * The slug specific for the story.
+   */
+  slug?: string;
+  content?: BlokContentInput;
+  /**
+   * ID of the parent folder.
+   */
+  parent_id?: number;
+  /**
+   * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor).
+   */
+  path?: string | null;
+  /**
+   * true if the story is defined as root for the folder.
+   */
+  is_startpage?: boolean;
+  /**
+   * Array of tag names.
+   */
+  tag_list?: Array<string>;
+  /**
+   * Date defined in the story's entry configuration YYYY-mm-dd.
+   */
+  sort_by_date?: string | null;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position?: number;
+  /**
+   * Object to store non-editable data that is exclusively maintained with the Management API.
+   */
+  meta_data?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Whether the entry is a folder.
+   */
+  is_folder?: boolean;
+  /**
+   * Default content type for stories in this folder.
+   */
+  default_root?: string | null;
+  /**
+   * Whether the Visual Editor is disabled.
+   */
+  disable_fe_editor?: boolean;
+  /**
+   * Translated slug entries to create, update, or delete.
+   */
+  translated_slugs_attributes?: Array<{
+    id?: number;
+    lang?: string;
+    slug?: string;
+    name?: string;
+    published?: boolean;
+  }>;
+};
+type StoryCreateRequest = {
+  story: StoryCreate;
+  /**
+   * Should the story be published immediately (set 1 to publish)
+   */
+  publish?: number;
+  /**
+   * ID of the current release (can be requested with the from_release API parameter)
+   */
+  release_id?: number;
+};
+type StoryUpdateRequest = {
+  story: StoryUpdate;
+  /**
+   * Group ID (UUID string), shared between stories defined as alternates
+   */
+  group_id?: string;
+  /**
+   * If this is 1, the request can overwrite a locked story. Note that a user currently editing the story (which is why it was locked) will encounter a content conflict model. Importantly, note that force_update does not work when editing is locked for the workflow stage that the story currently is in
+   */
+  force_update?: '0' | '1';
+  /**
+   * Numeric ID of release (optional)
+   */
+  release_id?: number;
+  /**
+   * Should the story be published immediately (set 1 to publish)
+   */
+  publish?: number;
+  /**
+   * Language code to publish the story individually (must be enabled in the space settings)
+   */
+  lang?: string;
+};
 /**
  * Minimal story object for alternates
  */
@@ -37,7 +209,7 @@ type StoryAlternate = {
 /**
  * Asset field type - single asset (image, video, audio, or document)
  */
-type AssetField = {
+type AssetFieldValue = {
   /**
    * Identifies this as an asset field
    */
@@ -88,7 +260,7 @@ type AssetField = {
 /**
  * Content object representing a component instance. Contains a _uid, a component technical name, and dynamic fields whose values depend on the component's schema field types (text, textarea, richtext, markdown, number, datetime, boolean, option, options, asset, multiasset, multilink, bloks, table, section, custom/plugin).
  */
-type StoryContent = {
+type BlokContent = {
   /**
    * Unique identifier for this component instance
    */
@@ -101,12 +273,12 @@ type StoryContent = {
    * Storyblok editor markup string for inline editing (present in draft/preview mode)
    */
   _editable?: string;
-  [key: string]: string | number | boolean | Array<string | AssetField | StoryContent> | AssetField | MultilinkField | TableField | RichtextField | PluginField | string | undefined;
+  [key: string]: string | number | boolean | Array<string | AssetFieldValue | BlokContent> | AssetFieldValue | MultilinkFieldValue | TableFieldValue | RichtextFieldValue | PluginFieldValue | string | undefined;
 };
 /**
  * Multilink field type - link to internal stories, external URLs, emails, etc.
  */
-type MultilinkField = {
+type MultilinkFieldValue = {
   /**
    * Identifies this as a multilink field
    */
@@ -139,7 +311,7 @@ type MultilinkField = {
 /**
  * Table field type - structured table data
  */
-type TableField = {
+type TableFieldValue = {
   /**
    * Table header cells
    */
@@ -173,7 +345,7 @@ type TableField = {
 /**
  * Richtext field type - structured rich text document (ProseMirror format)
  */
-type RichtextField = {
+type RichtextFieldValue = {
   /**
    * Root node type for richtext documents
    */
@@ -188,7 +360,7 @@ type RichtextField = {
 /**
  * Plugin/Custom field type - field plugin with custom structure
  */
-type PluginField = {
+type PluginFieldValue = {
   /**
    * Technical name of the field plugin
    */
@@ -289,7 +461,7 @@ type StoryBase = {
    * Generated UUID string
    */
   readonly uuid: string;
-  content: StoryContent;
+  content: BlokContent;
   /**
    * The slug specific for the story
    */
@@ -354,11 +526,11 @@ type StoryMapi = StoryBase & {
    */
   disable_fe_editor?: boolean;
   /**
-   * Subset of parent folder info (resolved from parent_id).
+   * Subset of parent folder info (resolved from parent_id). Null when the story has no parent folder.
    */
   parent?: {
     [key: string]: unknown;
-  };
+  } | null;
   /**
    * Whether the story has unpublished changes.
    */
@@ -401,13 +573,9 @@ type StoryMapi = StoryBase & {
     published?: boolean;
   }>;
   /**
-   * ID of the current release.
-   */
-  release_id?: number;
-  /**
-   * Scheduled publishing date.
+   * Scheduled publishing date. Null when no publishing date is scheduled.
    */
-  scheduled_dates?: string;
+  scheduled_dates?: string | null;
   /**
    * User IDs who saved the story as Favorite.
    */
@@ -437,7 +605,7 @@ type StoryMapi = StoryBase & {
    */
   main_version_id?: number;
   /**
-   * Current workflow stage details.
+   * Current workflow stage details. Null when the story is not assigned to a workflow stage.
    */
   stage?: {
     workflow_id?: number;
@@ -445,181 +613,25 @@ type StoryMapi = StoryBase & {
     story_id?: number;
     due_date?: string;
     created_at?: string;
-  };
-};
-/**
- * Input for creating a story.
- */
-type StoryCreate2 = {
-  /**
-   * The numeric ID of the story. Can be passed in the body per the MAPI docs.
-   */
-  id?: number;
-  /**
-   * The complete name provided for the story.
-   */
-  name: string;
-  /**
-   * The slug specific for the story. Auto-generated as a UUID when omitted.
-   */
-  slug?: string;
-  content?: StoryContent;
-  /**
-   * ID of the parent folder.
-   */
-  parent_id?: number;
-  /**
-   * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor).
-   */
-  path?: string | null;
-  /**
-   * true if the story is defined as root for the folder.
-   */
-  is_startpage?: boolean;
-  /**
-   * Array of tag names.
-   */
-  tag_list?: Array<string>;
-  /**
-   * Date defined in the story's entry configuration YYYY-mm-dd.
-   */
-  sort_by_date?: string | null;
-  /**
-   * Numeric representation of the story's position in the folder.
-   */
-  position?: number;
-  /**
-   * Object to store non-editable data that is exclusively maintained with the Management API.
-   */
-  meta_data?: {
-    [key: string]: unknown;
   } | null;
-  /**
-   * Whether the entry is a folder.
-   */
-  is_folder?: boolean;
-  /**
-   * Default content type for stories in this folder.
-   */
-  default_root?: string | null;
-  /**
-   * Whether the Visual Editor is disabled.
-   */
-  disable_fe_editor?: boolean;
-  /**
-   * Translated slug entries to create, update, or delete.
-   */
-  translated_slugs_attributes?: Array<{
-    id?: number;
-    lang?: string;
-    slug?: string;
-    name?: string;
-    published?: boolean;
-  }>;
-};
-type StoryCreateRequest2 = {
-  story: StoryCreate2;
-  /**
-   * Should the story be published immediately (set 1 to publish)
-   */
-  publish?: number;
-  /**
-   * ID of the current release (can be requested with the from_release API parameter)
-   */
-  release_id?: number;
 };
 /**
- * Input for updating a story.
+ * Content object for creating or updating a component instance. Contains a component technical name and dynamic fields whose values depend on the component's schema field types. The _uid is optional — Storyblok will auto-generate one if not provided.
  */
-type StoryUpdate2 = {
-  /**
-   * The numeric ID of the story. Can be passed in the update body per the MAPI docs.
-   */
-  id?: number;
-  /**
-   * The complete name provided for the story.
-   */
-  name?: string;
-  /**
-   * The slug specific for the story.
-   */
-  slug?: string;
-  content?: StoryContent;
-  /**
-   * ID of the parent folder.
-   */
-  parent_id?: number;
-  /**
-   * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor).
-   */
-  path?: string | null;
+type BlokContentInput = {
   /**
-   * true if the story is defined as root for the folder.
+   * Unique identifier for this component instance (auto-generated when omitted)
    */
-  is_startpage?: boolean;
-  /**
-   * Array of tag names.
-   */
-  tag_list?: Array<string>;
-  /**
-   * Date defined in the story's entry configuration YYYY-mm-dd.
-   */
-  sort_by_date?: string | null;
-  /**
-   * Numeric representation of the story's position in the folder.
-   */
-  position?: number;
-  /**
-   * Object to store non-editable data that is exclusively maintained with the Management API.
-   */
-  meta_data?: {
-    [key: string]: unknown;
-  } | null;
-  /**
-   * Whether the entry is a folder.
-   */
-  is_folder?: boolean;
-  /**
-   * Default content type for stories in this folder.
-   */
-  default_root?: string | null;
-  /**
-   * Whether the Visual Editor is disabled.
-   */
-  disable_fe_editor?: boolean;
-  /**
-   * Translated slug entries to create, update, or delete.
-   */
-  translated_slugs_attributes?: Array<{
-    id?: number;
-    lang?: string;
-    slug?: string;
-    name?: string;
-    published?: boolean;
-  }>;
-};
-type StoryUpdateRequest2 = {
-  story: StoryUpdate2;
-  /**
-   * Group ID (UUID string), shared between stories defined as alternates
-   */
-  group_id?: string;
-  /**
-   * If this is 1, the request can overwrite a locked story. Note that a user currently editing the story (which is why it was locked) will encounter a content conflict model. Importantly, note that force_update does not work when editing is locked for the workflow stage that the story currently is in
-   */
-  force_update?: '0' | '1';
-  /**
-   * Numeric ID of release (optional)
-   */
-  release_id?: number;
+  _uid?: string;
   /**
-   * Should the story be published immediately (set 1 to publish)
+   * Technical name of the component (content type or nestable block)
    */
-  publish?: number;
+  component: string;
   /**
-   * Language code to publish the story individually (must be enabled in the space settings)
+   * Storyblok editor markup string for inline editing (present in draft/preview mode)
    */
-  lang?: string;
+  _editable?: string;
+  [key: string]: null | string | number | boolean | Array<string | AssetFieldValue | BlokContentInput> | AssetFieldValue | MultilinkFieldValue | TableFieldValue | RichtextFieldValue | PluginFieldValue | string | undefined;
 };
 /**
  * Request body for duplicating a story
@@ -675,7 +687,7 @@ type StoryBaseWritable = {
    * Latest publishing date yyyy-MM-dd'T'HH:mm:ssZ
    */
   published_at: string | null;
-  content: StoryContent;
+  content: BlokContent;
   /**
    * The slug specific for the story
    */
@@ -740,11 +752,11 @@ type StoryMapiWritable = StoryBaseWritable & {
    */
   disable_fe_editor?: boolean;
   /**
-   * Subset of parent folder info (resolved from parent_id).
+   * Subset of parent folder info (resolved from parent_id). Null when the story has no parent folder.
    */
   parent?: {
     [key: string]: unknown;
-  };
+  } | null;
   /**
    * Whether the story has unpublished changes.
    */
@@ -787,13 +799,9 @@ type StoryMapiWritable = StoryBaseWritable & {
     published?: boolean;
   }>;
   /**
-   * ID of the current release.
+   * Scheduled publishing date. Null when no publishing date is scheduled.
    */
-  release_id?: number;
-  /**
-   * Scheduled publishing date.
-   */
-  scheduled_dates?: string;
+  scheduled_dates?: string | null;
   /**
    * User IDs who saved the story as Favorite.
    */
@@ -823,7 +831,7 @@ type StoryMapiWritable = StoryBaseWritable & {
    */
   main_version_id?: number;
   /**
-   * Current workflow stage details.
+   * Current workflow stage details. Null when the story is not assigned to a workflow stage.
    */
   stage?: {
     workflow_id?: number;
@@ -831,7 +839,7 @@ type StoryMapiWritable = StoryBaseWritable & {
     story_id?: number;
     due_date?: string;
     created_at?: string;
-  };
+  } | null;
 };
 type ListData = {
   body?: never;
@@ -998,7 +1006,7 @@ type ListResponses = {
   };
 };
 type CreateData = {
-  body: StoryCreateRequest2;
+  body: StoryCreateRequest;
   path: {
     /**
      * The ID of the Storyblok space (can be integer or string)
@@ -1082,7 +1090,7 @@ type GetResponses = {
   };
 };
 type UpdateData = {
-  body: StoryUpdateRequest2;
+  body: StoryUpdateRequest;
   path: {
     /**
      * The ID of the Storyblok space (can be integer or string)
@@ -1302,5 +1310,5 @@ type VersionsResponses = {
   };
 };
 //#endregion
-export { AssetField, CreateData, CreateResponses, DeleteResponses, DuplicateData, DuplicateResponses, GetData, GetResponses, ListData, ListResponses, MultilinkField, PluginField, PublishData, PublishResponses, RichtextField, StoryAlternate, StoryContent, StoryCreate, StoryLocalizedPath, StoryMapi, StoryTranslatedSlug, StoryUpdate, TableField, UpdateData, UpdateResponses, VersionsData, VersionsResponses };
+export { CreateData, CreateResponses, DeleteResponses, DuplicateData, DuplicateResponses, GetData, GetResponses, ListData, ListResponses, PublishData, PublishResponses, StoryCreateRequest, StoryMapi, StoryUpdateRequest, UpdateData, UpdateResponses, VersionsData, VersionsResponses };
 //# sourceMappingURL=types.gen.d.cts.map