@storyblok/management-api-client 0.2.1 → 0.2.3

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

@@ -0,0 +1,1306 @@
+//#region src/generated/stories/types.gen.d.ts
+type StoryCreate = StoryCreate2;
+type StoryUpdate = StoryUpdate2;
+/**
+ * Minimal story object for alternates
+ */
+type StoryAlternate = {
+  /**
+   * The numeric ID
+   */
+  id: number;
+  /**
+   * The complete name provided for the story
+   */
+  name: string;
+  /**
+   * The slug specific for the story
+   */
+  slug: string;
+  /**
+   * true if a story is currently published, even if it has unpublished changes
+   */
+  published: boolean;
+  /**
+   * The full slug of the story, combining the parent folder(s) and the designated story slug
+   */
+  full_slug: string;
+  /**
+   * true if the instance constitutes a folder
+   */
+  is_folder: boolean;
+  /**
+   * ID of the parent folder. 0 for root-level stories.
+   */
+  parent_id: number;
+};
+/**
+ * Asset field type - single asset (image, video, audio, or document)
+ */
+type AssetField = {
+  /**
+   * Identifies this as an asset field
+   */
+  fieldtype: 'asset';
+  /**
+   * Numeric ID of the asset
+   */
+  id: number | null;
+  /**
+   * Alternative text for the asset
+   */
+  alt: string | null;
+  /**
+   * Name of the asset
+   */
+  name?: string;
+  /**
+   * Focal point coordinates for cropping (format "123x456:789x1011")
+   */
+  focus?: string | null;
+  /**
+   * Title of the asset
+   */
+  title?: string | null;
+  /**
+   * Source attribution for the asset
+   */
+  source?: string | null;
+  /**
+   * URL to the asset file
+   */
+  filename: string;
+  /**
+   * Copyright information
+   */
+  copyright?: string | null;
+  /**
+   * Additional metadata for the asset
+   */
+  meta_data?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Whether the asset is hosted externally
+   */
+  is_external_url?: boolean;
+};
+/**
+ * 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 = {
+  /**
+   * Unique identifier for this component instance
+   */
+  _uid: string;
+  /**
+   * Technical name of the component (content type or nestable block)
+   */
+  component: string;
+  /**
+   * 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;
+};
+/**
+ * Multilink field type - link to internal stories, external URLs, emails, etc.
+ */
+type MultilinkField = {
+  /**
+   * Identifies this as a multilink field
+   */
+  fieldtype: 'multilink';
+  /**
+   * UUID of the linked story (for internal links)
+   */
+  id: string;
+  /**
+   * URL for external links or email addresses
+   */
+  url: string;
+  /**
+   * Type of link
+   */
+  linktype: 'story' | 'url' | 'email' | 'asset';
+  /**
+   * Cached URL path for the linked story
+   */
+  cached_url: string;
+  /**
+   * Anchor/fragment identifier for the link
+   */
+  anchor?: string | null;
+  /**
+   * Link target attribute
+   */
+  target?: '_self' | '_blank' | null;
+};
+/**
+ * Table field type - structured table data
+ */
+type TableField = {
+  /**
+   * Table header cells
+   */
+  thead: Array<{
+    _uid: string;
+    component: '_table_head';
+    /**
+     * Header cell content
+     */
+    value?: string;
+  }>;
+  /**
+   * Table body rows
+   */
+  tbody: Array<{
+    _uid: string;
+    component: '_table_row';
+    /**
+     * Cells in this row
+     */
+    body?: Array<{
+      _uid: string;
+      component: '_table_col';
+      /**
+       * Cell content
+       */
+      value?: string;
+    }>;
+  }>;
+};
+/**
+ * Richtext field type - structured rich text document (ProseMirror format)
+ */
+type RichtextField = {
+  /**
+   * Root node type for richtext documents
+   */
+  type: 'doc';
+  /**
+   * Array of richtext nodes (paragraphs, headings, lists, bloks, etc.)
+   */
+  content?: Array<{
+    [key: string]: unknown;
+  }>;
+};
+/**
+ * Plugin/Custom field type - field plugin with custom structure
+ */
+type PluginField = {
+  /**
+   * Technical name of the field plugin
+   */
+  plugin: string;
+  /**
+   * Unique identifier for this plugin field instance
+   */
+  _uid?: string;
+  [key: string]: unknown | string | undefined;
+};
+/**
+ * Translated slug object (from Translatable Slugs app)
+ */
+type StoryTranslatedSlug = {
+  /**
+   * Translated slug path
+   */
+  path: string | null;
+  /**
+   * Language code of the current language
+   */
+  lang: string;
+  /**
+   * The complete name provided for the story
+   */
+  name?: string | null;
+  /**
+   * true if a story is currently published, even if it has unpublished changes
+   */
+  published?: boolean | null;
+};
+/**
+ * Localized path object (from Translatable Slugs app)
+ */
+type StoryLocalizedPath = {
+  /**
+   * Value of the real path defined in the story's entry configuration
+   */
+  path: string;
+  /**
+   * The complete name provided for the story
+   */
+  name?: string | null;
+  /**
+   * Language code of the current language
+   */
+  lang: string;
+  /**
+   * true if a story is currently published, even if it has unpublished changes
+   */
+  published?: boolean | null;
+};
+/**
+ * Common Storyblok story fields shared by Content Delivery and Management APIs
+ */
+type StoryBase = {
+  /**
+   * Numeric id of the story
+   */
+  readonly id: number;
+  /**
+   * The complete name provided for the story
+   */
+  name: string;
+  /**
+   * ID of the parent folder. 0 for root-level stories.
+   */
+  parent_id: number;
+  /**
+   * Group ID (UUID string), shared between stories defined as alternates
+   */
+  group_id: string;
+  /**
+   * An array containing objects that provide basic data of the stories defined as alternates of the current story
+   */
+  alternates: Array<StoryAlternate>;
+  /**
+   * Creation date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  created_at: string;
+  /**
+   * Date defined in the story's entry configuration YYYY-mm-dd
+   */
+  sort_by_date: string | null;
+  /**
+   * Array of tag names
+   */
+  tag_list: Array<string>;
+  /**
+   * Latest update date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  updated_at: string;
+  /**
+   * Latest publishing date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  published_at: string | null;
+  /**
+   * Generated UUID string
+   */
+  readonly uuid: string;
+  content: StoryContent;
+  /**
+   * The slug specific for the story
+   */
+  slug: string;
+  /**
+   * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor)
+   */
+  path: string | null;
+  /**
+   * The full slug of the story, combining the parent folder(s) and the designated story slug
+   */
+  full_slug: string;
+  /**
+   * true if the story is defined as root for the folder
+   */
+  is_startpage: boolean;
+  /**
+   * Object to store non-editable data that is exclusively maintained with the Management API
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * First publishing date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  first_published_at: string | null;
+  /**
+   * Array of translated slug objects (if the app Translatable Slugs is installed)
+   */
+  translated_slugs: Array<StoryTranslatedSlug> | null;
+  /**
+   * An array of translated path objects
+   */
+  localized_paths?: Array<StoryLocalizedPath>;
+  /**
+   * Numeric representation of the story's position in the folder
+   */
+  position: number;
+};
+/**
+ * Storyblok story object from the Management API.
+ */
+type StoryMapi = StoryBase & {
+  /**
+   * Deletion date and time.
+   */
+  deleted_at?: string | null;
+  /**
+   * Whether the entry is a folder.
+   */
+  is_folder?: boolean;
+  /**
+   * Whether the story is currently published.
+   */
+  published?: boolean;
+  /**
+   * Default content type for stories in this folder.
+   */
+  default_root?: string | null;
+  /**
+   * Whether the Visual Editor is disabled.
+   */
+  disable_fe_editor?: boolean;
+  /**
+   * Subset of parent folder info (resolved from parent_id).
+   */
+  parent?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Whether the story has unpublished changes.
+   */
+  unpublished_changes?: boolean;
+  /**
+   * Latest import date.
+   */
+  imported_at?: string | null;
+  preview_token?: {
+    token?: string;
+    timestamp?: string;
+  };
+  /**
+   * Legacy UI feature replaced by favourite_for_user_ids.
+   */
+  pinned?: boolean;
+  breadcrumbs?: Array<{
+    id?: number;
+    name?: string;
+    parent_id?: number;
+    disable_fe_editor?: boolean;
+    path?: string;
+    slug?: string;
+    translated_slugs?: Array<StoryTranslatedSlug>;
+  }>;
+  last_author?: {
+    id?: number;
+    userid?: string;
+    friendly_name?: string;
+  };
+  /**
+   * ID of the last user who interacted with the story.
+   */
+  last_author_id?: number;
+  translated_slugs_attributes?: Array<{
+    id?: number;
+    lang?: string;
+    slug?: string;
+    name?: string;
+    published?: boolean;
+  }>;
+  /**
+   * ID of the current release.
+   */
+  release_id?: number;
+  /**
+   * Scheduled publishing date.
+   */
+  scheduled_dates?: string;
+  /**
+   * User IDs who saved the story as Favorite.
+   */
+  favourite_for_user_ids?: Array<number>;
+  /**
+   * User IDs assigned to a workflow stage.
+   */
+  user_ids?: Array<number>;
+  /**
+   * Space role IDs assigned to a workflow stage.
+   */
+  space_role_ids?: Array<number>;
+  /**
+   * Release IDs associated with the story.
+   */
+  release_ids?: Array<number>;
+  /**
+   * Version ID of the story's latest content within the release.
+   */
+  current_version_id?: number;
+  /**
+   * Version ID of the story's content when first added to a release.
+   */
+  base_version_id?: number;
+  /**
+   * Version ID of the story's current content outside the release.
+   */
+  main_version_id?: number;
+  /**
+   * Current workflow stage details.
+   */
+  stage?: {
+    workflow_id?: number;
+    workflow_stage_id?: number;
+    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.
+ */
+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;
+  /**
+   * 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 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;
+  /**
+   * 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;
+};
+/**
+ * Request body for duplicating a story
+ */
+type StoryDuplicateRequestWritable = {
+  story?: StoryMapiWritable;
+  /**
+   * The id of the target folder
+   */
+  target_dimension?: number;
+  /**
+   * If set to true, the current story's path attribute will used for the duplicated story
+   */
+  same_path?: boolean;
+};
+/**
+ * Common Storyblok story fields shared by Content Delivery and Management APIs
+ */
+type StoryBaseWritable = {
+  /**
+   * The complete name provided for the story
+   */
+  name: string;
+  /**
+   * ID of the parent folder. 0 for root-level stories.
+   */
+  parent_id: number;
+  /**
+   * Group ID (UUID string), shared between stories defined as alternates
+   */
+  group_id: string;
+  /**
+   * An array containing objects that provide basic data of the stories defined as alternates of the current story
+   */
+  alternates: Array<StoryAlternate>;
+  /**
+   * Creation date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  created_at: string;
+  /**
+   * Date defined in the story's entry configuration YYYY-mm-dd
+   */
+  sort_by_date: string | null;
+  /**
+   * Array of tag names
+   */
+  tag_list: Array<string>;
+  /**
+   * Latest update date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  updated_at: string;
+  /**
+   * Latest publishing date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  published_at: string | null;
+  content: StoryContent;
+  /**
+   * The slug specific for the story
+   */
+  slug: string;
+  /**
+   * Value of the real path defined in the story's entry configuration (usually required for the Visual Editor)
+   */
+  path: string | null;
+  /**
+   * The full slug of the story, combining the parent folder(s) and the designated story slug
+   */
+  full_slug: string;
+  /**
+   * true if the story is defined as root for the folder
+   */
+  is_startpage: boolean;
+  /**
+   * Object to store non-editable data that is exclusively maintained with the Management API
+   */
+  meta_data: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * First publishing date yyyy-MM-dd'T'HH:mm:ssZ
+   */
+  first_published_at: string | null;
+  /**
+   * Array of translated slug objects (if the app Translatable Slugs is installed)
+   */
+  translated_slugs: Array<StoryTranslatedSlug> | null;
+  /**
+   * An array of translated path objects
+   */
+  localized_paths?: Array<StoryLocalizedPath>;
+  /**
+   * Numeric representation of the story's position in the folder
+   */
+  position: number;
+};
+/**
+ * Storyblok story object from the Management API.
+ */
+type StoryMapiWritable = StoryBaseWritable & {
+  /**
+   * Deletion date and time.
+   */
+  deleted_at?: string | null;
+  /**
+   * Whether the entry is a folder.
+   */
+  is_folder?: boolean;
+  /**
+   * Whether the story is currently published.
+   */
+  published?: boolean;
+  /**
+   * Default content type for stories in this folder.
+   */
+  default_root?: string | null;
+  /**
+   * Whether the Visual Editor is disabled.
+   */
+  disable_fe_editor?: boolean;
+  /**
+   * Subset of parent folder info (resolved from parent_id).
+   */
+  parent?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Whether the story has unpublished changes.
+   */
+  unpublished_changes?: boolean;
+  /**
+   * Latest import date.
+   */
+  imported_at?: string | null;
+  preview_token?: {
+    token?: string;
+    timestamp?: string;
+  };
+  /**
+   * Legacy UI feature replaced by favourite_for_user_ids.
+   */
+  pinned?: boolean;
+  breadcrumbs?: Array<{
+    id?: number;
+    name?: string;
+    parent_id?: number;
+    disable_fe_editor?: boolean;
+    path?: string;
+    slug?: string;
+    translated_slugs?: Array<StoryTranslatedSlug>;
+  }>;
+  last_author?: {
+    id?: number;
+    userid?: string;
+    friendly_name?: string;
+  };
+  /**
+   * ID of the last user who interacted with the story.
+   */
+  last_author_id?: number;
+  translated_slugs_attributes?: Array<{
+    id?: number;
+    lang?: string;
+    slug?: string;
+    name?: string;
+    published?: boolean;
+  }>;
+  /**
+   * ID of the current release.
+   */
+  release_id?: number;
+  /**
+   * Scheduled publishing date.
+   */
+  scheduled_dates?: string;
+  /**
+   * User IDs who saved the story as Favorite.
+   */
+  favourite_for_user_ids?: Array<number>;
+  /**
+   * User IDs assigned to a workflow stage.
+   */
+  user_ids?: Array<number>;
+  /**
+   * Space role IDs assigned to a workflow stage.
+   */
+  space_role_ids?: Array<number>;
+  /**
+   * Release IDs associated with the story.
+   */
+  release_ids?: Array<number>;
+  /**
+   * Version ID of the story's latest content within the release.
+   */
+  current_version_id?: number;
+  /**
+   * Version ID of the story's content when first added to a release.
+   */
+  base_version_id?: number;
+  /**
+   * Version ID of the story's current content outside the release.
+   */
+  main_version_id?: number;
+  /**
+   * Current workflow stage details.
+   */
+  stage?: {
+    workflow_id?: number;
+    workflow_stage_id?: number;
+    story_id?: number;
+    due_date?: string;
+    created_at?: string;
+  };
+};
+type ListData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: {
+    /**
+     * Page number for pagination. Default is 1.
+     */
+    page?: number;
+    /**
+     * Number of items per page. Default is 25.
+     */
+    per_page?: number;
+    /**
+     * Filters by component in all levels of the content. Allows comma separated value for multiple components
+     */
+    contain_component?: string;
+    /**
+     * Filter by a term using full text search
+     */
+    text_search?: string;
+    /**
+     * Sort entries by specific attribute and order with content.YOUR_FIELD:asc and content.YOUR_FIELD:desc. To sort integers append :int. To sort floats append :float. Possible values are all root attributes of the entry (_position_ and _parent_position_ are special invisible attributes) and all fields of your content type inside content with a dot as separator.
+     */
+    sort_by?: string;
+    /**
+     * Filter by pinned stories if '1'
+     */
+    pinned?: boolean;
+    /**
+     * Exclude specific stories by providing their IDs as a comma-separated string.
+     */
+    excluding_ids?: string;
+    /**
+     * Filter by ids (comma separated)
+     */
+    by_ids?: string;
+    /**
+     * Retrieve specific stories by providing their UUIDs as a comma-separated string.
+     */
+    by_uuids?: string;
+    /**
+     * Filter by specific tag(s). Multiple tags can be provided as a comma-separated string (treated like an OR operator).
+     */
+    with_tag?: string;
+    /**
+     * Filter by folders only
+     */
+    folder_only?: boolean;
+    /**
+     * Filter by stories only
+     */
+    story_only?: boolean;
+    /**
+     * Filter by parent id
+     */
+    with_parent?: number;
+    /**
+     * Filter stories starting with a specific slug
+     */
+    starts_with?: string;
+    /**
+     * Filter by items in the trash folder
+     */
+    in_trash?: boolean;
+    /**
+     * Filter by search term
+     */
+    search?: string;
+    /**
+     * Filter by specific attribute(s) of your content type. See Content Delivery API Documentation.
+     */
+    filter_query?: string;
+    /**
+     * Filter items by the release id
+     */
+    in_release?: number;
+    /**
+     * true for entries that are currently published; false for those that are currently not published or unpublished
+     */
+    is_published?: boolean;
+    /**
+     * Retrieve stories by comma-separated full_slug. It is possible to specify wildcards by using *.
+     */
+    by_slugs?: string;
+    /**
+     * Filters all the stories assigned to the current user whose token is being used
+     */
+    mine?: boolean;
+    /**
+     * Exclude stories by specifying comma-separated values of full_slug. It is possible to specify wildcards by using *.
+     */
+    excluding_slugs?: string;
+    /**
+     * Retrieve stories that are in a particular workflow stage by providing a comma-separated list of workflow stage IDs. Workflow stage IDs can be retrieved via the Management API.
+     */
+    in_workflow_stages?: string;
+    /**
+     * Retrieve specific stories by providing their UUIDs as a comma-separated string. The order of the stories in the response matches the order in which the UUIDs are listed.
+     */
+    by_uuids_ordered?: string;
+    /**
+     * Filter by exact slug. Make sure to use the full slug.
+     */
+    with_slug?: string;
+    /**
+     * If added, returns content_summary object with relevant information.
+     */
+    with_summary?: number;
+    /**
+     * Filter stories that are scheduled after the provided date
+     */
+    scheduled_at_gt?: string;
+    /**
+     * Filter stories that are scheduled before the provided date
+     */
+    scheduled_at_lt?: string;
+    /**
+     * Filter by your favourites.
+     */
+    favourite?: boolean;
+    /**
+     * Filter by references. Can be used for texts (partial search supported) and other references like assets. Example - stories with specific asset. For stories with a specific asset, complete URL of an asset is recommended for specific results. Names are also valid but will include the results found with content search as well.
+     */
+    reference_search?: string;
+    /**
+     * Filter by branch ID
+     */
+    branch_id?: number;
+    /**
+     * Release ID for filtering stories
+     */
+    release_id?: number;
+    /**
+     * Release scope ID for filtering stories
+     */
+    release_scope_id?: number;
+    /**
+     * Filter stories in specific release
+     */
+    in_release_filter?: number;
+    /**
+     * Include alternate stories
+     */
+    with_alts?: boolean;
+    /**
+     * Include translated stories
+     */
+    with_translated_stories?: boolean;
+  };
+  url: '/v1/spaces/{space_id}/stories';
+};
+type ListResponses = {
+  /**
+   * List of stories
+   */
+  200: {
+    stories?: Array<StoryMapi>;
+  };
+};
+type CreateData = {
+  body: StoryCreateRequest2;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: {
+    /**
+     * Release ID for scheduled content
+     */
+    release_id?: number;
+    /**
+     * Language code for translated stories
+     */
+    lang?: string;
+    /**
+     * Publish the story after creation
+     */
+    publish?: boolean;
+    /**
+     * Preset ID to use for story content
+     */
+    preset_id?: number;
+    /**
+     * Use default preset for story content
+     */
+    use_default_preset?: boolean;
+    /**
+     * Disable frontend editor for this story
+     */
+    disable_fe_editor?: boolean;
+  };
+  url: '/v1/spaces/{space_id}/stories';
+};
+type CreateResponses = {
+  /**
+   * Story created
+   */
+  201: {
+    story?: StoryMapi;
+  };
+};
+type DeleteResponses = {
+  /**
+   * Story deleted
+   */
+  200: {
+    story?: StoryMapi;
+  };
+};
+type GetData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The ID of the story (can be integer or string)
+     */
+    story_id: number | string;
+  };
+  query?: {
+    /**
+     * Retrieve story by UUID instead of ID
+     */
+    uuid?: string;
+    /**
+     * Retrieve specific version of the story
+     */
+    version?: number;
+  };
+  url: '/v1/spaces/{space_id}/stories/{story_id}';
+};
+type GetResponses = {
+  /**
+   * Story details
+   */
+  200: {
+    story?: StoryMapi;
+  };
+};
+type UpdateData = {
+  body: StoryUpdateRequest2;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The ID of the story (can be integer or string)
+     */
+    story_id: number | string;
+  };
+  query?: {
+    /**
+     * Release ID for scheduled content
+     */
+    release_id?: number;
+    /**
+     * Language code for translated stories
+     */
+    lang?: string;
+    /**
+     * Force update even if story has been modified
+     */
+    force_update?: boolean;
+    /**
+     * Publish the story after update
+     */
+    publish?: boolean;
+  };
+  url: '/v1/spaces/{space_id}/stories/{story_id}';
+};
+type UpdateResponses = {
+  /**
+   * Story updated
+   */
+  200: {
+    story?: StoryMapi;
+  };
+};
+type DuplicateData = {
+  body: StoryDuplicateRequestWritable;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The ID of the story (can be integer or string)
+     */
+    story_id: number | string;
+  };
+  query?: {
+    /**
+     * Release ID for scheduled content
+     */
+    release_id?: number;
+    /**
+     * Automatically create folders during duplication
+     */
+    auto_create_folders?: boolean;
+    /**
+     * Target dimension for duplication
+     */
+    target_dimension?: number;
+  };
+  url: '/v1/spaces/{space_id}/stories/{story_id}/duplicate';
+};
+type DuplicateResponses = {
+  /**
+   * Story duplicated
+   */
+  200: {
+    story?: StoryMapi;
+  };
+};
+type PublishData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The ID of the story (can be integer or string)
+     */
+    story_id: number | string;
+  };
+  query?: {
+    /**
+     * Accept a list of languages codes separated by a comma
+     */
+    lang?: string;
+    /**
+     * Release ID for scheduled publishing
+     */
+    release_id?: number;
+  };
+  url: '/v1/spaces/{space_id}/stories/{story_id}/publish';
+};
+type PublishResponses = {
+  /**
+   * Story published
+   */
+  200: {
+    story?: StoryMapi;
+  };
+};
+type VersionsData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: {
+    /**
+     * ID of the story. When this is passed, the endpoint returns versions of this particular story
+     */
+    by_story_id?: number;
+    /**
+     * ID of a Story's version. Use it to retrieve only a specific version of a story
+     */
+    version_id?: number;
+    /**
+     * ID of the release. When this is passed, the endpoint returns versions of all stories within the release and stories not associated with a particular release
+     */
+    by_release_id?: number;
+    page?: number;
+    /**
+     * Number of items per page. Default is 25.
+     */
+    per_page?: number;
+    /**
+     * Use it to retrieve all the content of a version
+     */
+    show_content?: string;
+  };
+  url: '/v1/spaces/{space_id}/story_versions';
+};
+type VersionsResponses = {
+  /**
+   * Story versions
+   */
+  200: {
+    /**
+     * An array of objects with each object representing a version and details about the version
+     */
+    story_versions?: Array<{
+      /**
+       * Numeric id of the story version
+       */
+      id?: number;
+      /**
+       * Creation date
+       */
+      created_at?: string;
+      /**
+       * User/numeric id of collaborator
+       */
+      user_id?: number;
+      /**
+       * Name of the author
+       */
+      user?: {
+        /**
+         * The user ID
+         */
+        id?: number;
+        /**
+         * First name of collaborator
+         */
+        firstname?: string;
+        /**
+         * Last name of collaborator
+         */
+        lastname?: string;
+        /**
+         * Email of collaborator
+         */
+        alt_email?: string;
+        /**
+         * Avatar of collaborator usually an image
+         */
+        avatar?: string;
+        /**
+         * User ID of collaborator
+         */
+        userid?: string;
+        /**
+         * Friendly name of collaborator
+         */
+        friendly_name?: string;
+      };
+      /**
+       * ID of the story
+       */
+      story_id?: number;
+      /**
+       * Publication status of the version
+       */
+      status?: string;
+      /**
+       * ID of the release
+       */
+      release_id?: number;
+      /**
+       * ID of the parent folder. 0 for root-level stories.
+       */
+      parent_id?: number;
+      /**
+       * This object contains the Story's content when the show_content parameter is used
+       */
+      content?: {
+        [key: string]: unknown;
+      };
+    }>;
+  };
+};
+//#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 };
+//# sourceMappingURL=types.gen.d.mts.map