@storyblok/management-api-client 0.3.0 → 1.0.0-alpha.2

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

@@ -1,855 +0,0 @@
-//#region src/generated/components/types.gen.d.ts
-type Component = Component2;
-/**
- * A component schema field object
- */
-type ComponentSchemaField = {
-  /**
-   * Field type (text, textarea, number, boolean, etc.)
-   */
-  type?: string;
-  /**
-   * Position of the field
-   */
-  pos?: number;
-  /**
-   * Human-readable display name
-   */
-  display_name?: string;
-  /**
-   * Whether the field is required
-   */
-  required?: boolean;
-  /**
-   * Regular expression for validation
-   */
-  regex?: string;
-  /**
-   * Whether the field is translatable
-   */
-  translatable?: boolean;
-  /**
-   * Field description
-   */
-  description?: string;
-  /**
-   * Default value for the field
-   */
-  default_value?: string;
-  /**
-   * Array of datasource entries [{name:"", value:""}]; Effects editor only if source=undefined. For field type option.
-   */
-  options?: Array<{
-    _uid?: string;
-    name?: string;
-    value?: string;
-  }>;
-  /**
-   * The source of Single-Option and Multi-Options fields
-   */
-  source?: 'internal_stories' | 'internal_languages' | 'external' | 'internal';
-  /**
-   * When the source is set to internal_stories, set the path of the allowed stories folder
-   */
-  folder_slug?: string;
-  /**
-   * Allowed file types for Asset and Multi-Assets fields (e.g. images, videos, audios, texts)
-   */
-  filetypes?: Array<string>;
-  /**
-   * The maximal number of components allowed inside a Blocks field
-   */
-  maximum?: number;
-  /**
-   * The minimal number of components allowed inside a Blocks field
-   */
-  minimum?: number;
-  /**
-   * Maximum length for text fields
-   */
-  maxlength?: number;
-  /**
-   * Minimum length for text fields
-   */
-  minlength?: number;
-  /**
-   * Whether rich markdown is enabled
-   */
-  rich_markdown?: boolean;
-  /**
-   * Whether rich text is enabled
-   */
-  rich_text?: boolean;
-  /**
-   * Whether markdown is enabled
-   */
-  markdown?: boolean;
-  /**
-   * Field size (small, medium, large)
-   */
-  size?: string;
-  /**
-   * Field height in pixels
-   */
-  height?: number;
-  /**
-   * Field width in pixels
-   */
-  width?: number;
-  /**
-   * When the source is set to internal_stories, displays the UUID of the selected story. Defaults to true.
-   */
-  use_uuid?: boolean;
-  /**
-   * Whether to restrict content types
-   */
-  restrict_content_types?: boolean;
-  /**
-   * Allow or deny access to nestable blocks inside Blocks and Richtext fields. Defaults to false (allowed).
-   */
-  restrict_components?: boolean;
-  /**
-   * Specify which blocks are allowed or not inside Blocks and Richtext fields. Supported types are groups (blocks in specific folders), tags (blocks assigned to specific tags), or "" for specific blocks (components).
-   */
-  restrict_type?: 'groups' | 'tags' | '';
-  /**
-   * An array of nestable or universal type block names allowed inside Blocks, Link, and Richtext fields
-   */
-  component_whitelist?: Array<string>;
-  /**
-   * An array of block names not allowed inside Blocks, Link, and Richtext fields
-   */
-  component_denylist?: Array<string>;
-  /**
-   * An array of group (folder) UUIDs that contain blocks allowed inside Blocks and Richtext fields
-   */
-  component_group_whitelist?: Array<string>;
-  /**
-   * An array of group (folder) UUIDs that contain blocks not allowed inside Blocks and Richtext fields
-   */
-  component_group_denylist?: Array<string>;
-  /**
-   * An array of tag IDs assigned to blocks allowed inside Blocks and Richtext fields
-   */
-  component_tag_whitelist?: Array<number>;
-  /**
-   * An array of tag IDs assigned to blocks not allowed inside Blocks and Richtext fields
-   */
-  component_tag_denylist?: Array<number>;
-  /**
-   * Maximum number of entries
-   */
-  maximum_entries?: number;
-  /**
-   * Minimum number of entries
-   */
-  minimum_entries?: number;
-  /**
-   * Whether to restrict assets
-   */
-  restrict_assets?: boolean;
-  /**
-   * List of allowed asset types
-   */
-  asset_whitelist?: Array<string>;
-  /**
-   * Numeric ID of the asset folder allowed in Asset and Multi-Assets fields
-   */
-  asset_folder_id?: number;
-  /**
-   * Allow loading assets from an external URL in Asset and Multi-Assets fields. Defaults to false.
-   */
-  allow_external_url?: boolean;
-  /**
-   * Whether to exclude empty option
-   */
-  exclude_empty_option?: boolean;
-  /**
-   * Whether to include empty option
-   */
-  include_empty_option?: boolean;
-  /**
-   * When the source is set to internal (Datasource), the selectable datasource slug
-   */
-  datasource_slug?: string;
-  /**
-   * When the source is set to external, the datasource JSON URL
-   */
-  external_datasource?: string;
-  /**
-   * When the source is set to internal_stories, allow users to select stories from an array of permitted content type blocks
-   */
-  filter_content_type?: Array<string>;
-  /**
-   * When the source is set to internal_stories, specify if the option appears as a link (default) or a card
-   */
-  entry_appearance?: string;
-  /**
-   * When the source is set to internal_stories, allow users to search stories in a modal window. Defaults to false.
-   */
-  allow_advanced_search?: boolean;
-  /**
-   * Set to true if the Multi-Options field is a References field
-   */
-  is_reference_type?: boolean;
-  /**
-   * The maximal number of selectable options in Single-Option, Multi-Options, and References fields
-   */
-  max_options?: string;
-  /**
-   * The minimal number of selectable options in Single-Option, Multi-Options, and References fields
-   */
-  min_options?: string;
-  /**
-   * Whether multiple values are allowed
-   */
-  multiple?: boolean;
-  /**
-   * Allow specifying an email address in a Link field. Defaults to false.
-   */
-  email_link_type?: boolean;
-  /**
-   * Allow specifying an asset's URL in a Link field. Defaults to false.
-   */
-  asset_link_type?: boolean;
-  /**
-   * When the URL in a Link field is an Internal link, allow users to define an anchor ID. Defaults to false.
-   */
-  show_anchor?: boolean;
-  /**
-   * Allow links to open in a new tab. Defaults to false.
-   */
-  allow_target_blank?: boolean;
-  /**
-   * Allow setting custom attributes in a Link field. Defaults to false.
-   */
-  allow_custom_attributes?: boolean;
-  /**
-   * When the URL in a Link field is an Internal link, allow users to only select stories from a specific folder. Defaults to false.
-   */
-  force_link_scope?: boolean;
-  /**
-   * When force_link_scope is set to true, specify the allowed path
-   */
-  link_scope?: string;
-  /**
-   * Exclude Text and number fields from translation exports
-   */
-  no_translate?: boolean;
-  /**
-   * Enable global right-to-left (RTL) support in Markdown, Text, and Textarea fields
-   */
-  rtl?: boolean;
-  /**
-   * Set to true to display the description as a tooltip. Defaults to false.
-   */
-  tooltip?: boolean;
-  /**
-   * The ID of the field
-   */
-  id?: string;
-  /**
-   * Set the maximum length of the input string in Markdown, Text, and Textarea fields
-   */
-  max_length?: number;
-  /**
-   * Objects containing data about custom CSS set inside the Richtext field
-   */
-  style_options?: Array<{
-    /**
-     * The unique ID of the style within the story
-     */
-    _uid?: string;
-    /**
-     * The style's name
-     */
-    name?: string;
-    /**
-     * The style's value
-     */
-    value?: string;
-  }>;
-  /**
-   * Set to true to enable a customized toolbar in Markdown and Richtext fields. Defaults to false.
-   */
-  customize_toolbar?: boolean;
-  /**
-   * An array of enabled toolbar elements
-   */
-  toolbar?: Array<string>;
-  /**
-   * Allow empty paragraphs in Markdown fields. Defaults to false.
-   */
-  allow_multiline?: boolean;
-  /**
-   * The minimal value allowed in a Number field
-   */
-  min_value?: number;
-  /**
-   * The maximal value allowed in a Number field
-   */
-  max_value?: number;
-  /**
-   * The number of decimal places that appear after the point in a Number field
-   */
-  decimals?: number;
-  /**
-   * The interval between numbers in a Number field
-   */
-  steps?: number;
-  /**
-   * Disable time selection in the date picker of a Date/Time field. Defaults to false.
-   */
-  disable_time?: boolean;
-  /**
-   * Display a Boolean field's label next to the toggle
-   */
-  inline_label?: boolean;
-  /**
-   * An array of field keys displayed in a Group field
-   */
-  keys?: Array<string>;
-  /**
-   * The name of the field type plugin used in a Plugin field
-   */
-  field_type?: string;
-  /**
-   * A comma-separated list of names of fields the user is required to fill in in a Plugin field
-   */
-  required_fields?: string;
-  /**
-   * Exclude the field from AI translations
-   */
-  exclude_from_ai_translation?: boolean;
-  /**
-   * Exclude the field when merging
-   */
-  exclude_from_merge?: boolean;
-  /**
-   * Exclude the field when overwriting
-   */
-  exclude_from_overwrite?: boolean;
-  /**
-   * Overwrite the field when merging
-   */
-  force_merge?: boolean;
-  /**
-   * An array that contains an object with information about conditions set on the field
-   */
-  conditional_settings?: Array<{
-    [key: string]: unknown;
-  }>;
-  /**
-   * Custom CSS for the field
-   */
-  custom_css?: string;
-  /**
-   * Custom JavaScript for the field
-   */
-  custom_js?: string;
-  /**
-   * API connection configuration
-   */
-  api_connection?: {
-    /**
-     * API URL
-     */
-    url?: string;
-    /**
-     * API headers
-     */
-    headers?: {
-      [key: string]: unknown;
-    };
-    /**
-     * API parameters
-     */
-    params?: {
-      [key: string]: unknown;
-    };
-  };
-  /**
-   * Fieldset configuration
-   */
-  fieldset?: {
-    /**
-     * Fieldset title
-     */
-    title?: string;
-    /**
-     * Fieldset description
-     */
-    description?: string;
-    /**
-     * Whether the fieldset is collapsible
-     */
-    collapsible?: boolean;
-    /**
-     * Whether the fieldset is collapsed by default
-     */
-    collapsed?: boolean;
-  };
-};
-type ComponentCreate = ComponentCreate2;
-type ComponentUpdate = ComponentUpdate2;
-/**
- * A Storyblok component object representing a content type
- */
-type Component2 = {
-  /**
-   * The numeric ID
-   */
-  readonly id: number;
-  /**
-   * Technical name used for component property in entries
-   */
-  name: string;
-  /**
-   * Name that will be used in the editor interface
-   */
-  display_name?: string | null;
-  /**
-   * Creation date
-   */
-  readonly created_at: string;
-  /**
-   * Latest update date
-   */
-  readonly updated_at: string;
-  /**
-   * Component schema definition containing fields and their configurations
-   */
-  schema: {
-    [key: string]: unknown;
-  };
-  /**
-   * URL to the preview image
-   */
-  image?: string | null;
-  /**
-   * The field that is for preview in the interface (Preview Field)
-   */
-  preview_field?: string;
-  /**
-   * Whether the component can be used as a root component
-   */
-  is_root?: boolean;
-  /**
-   * Preview template for the component
-   */
-  preview_tmpl?: string | null;
-  /**
-   * True if the component is nestable (insertable) in block field types
-   */
-  is_nestable?: boolean;
-  /**
-   * An array of presets for this component
-   */
-  all_presets?: Array<{
-    /**
-     * The numeric ID of the preset
-     */
-    id?: number;
-    /**
-     * Name of the preset
-     */
-    name?: string;
-    /**
-     * The ID of the component the preset is for
-     */
-    component_id?: number;
-    /**
-     * Link to the preview image of the preset
-     */
-    image?: string | null;
-    /**
-     * Icon selected for the preset
-     */
-    icon?: string;
-    /**
-     * Color of the icon selected for the preset
-     */
-    color?: string;
-    /**
-     * The description of the preset
-     */
-    description?: string;
-  }>;
-  /**
-   * ID of the preset currently selected for this component
-   */
-  preset_id?: number | null;
-  /**
-   * Duplicated technical name or display name, used for internal tasks
-   */
-  real_name?: string;
-  /**
-   * The component folder ID of the component
-   */
-  component_group_uuid?: string;
-  /**
-   * The color of the icon selected for the component
-   */
-  color?: string;
-  /**
-   * Icon selected for the component
-   */
-  icon?: string;
-  /**
-   * List of internal tags assigned to the component
-   */
-  internal_tags_list?: Array<{
-    /**
-     * Tag ID
-     */
-    id?: number;
-    /**
-     * Tag name
-     */
-    name?: string;
-  }>;
-  /**
-   * List of IDs of the tags assigned to the component
-   */
-  internal_tag_ids?: Array<string>;
-  /**
-   * Asset preview field (Preview Card) for a content type component
-   */
-  content_type_asset_preview?: string;
-};
-/**
- * Input for creating a component.
- */
-type ComponentCreate2 = {
-  /**
-   * Technical name used for component property in entries
-   */
-  name: string;
-  /**
-   * Name that will be used in the editor interface
-   */
-  display_name?: string | null;
-  /**
-   * Component schema definition containing fields and their configurations
-   */
-  schema?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Whether the component can be used as a root component
-   */
-  is_root?: boolean;
-  /**
-   * Whether the component is nestable in block field types
-   */
-  is_nestable?: boolean;
-  /**
-   * The component folder UUID
-   */
-  component_group_uuid?: string;
-  /**
-   * Icon color
-   */
-  color?: string;
-  /**
-   * Icon name
-   */
-  icon?: string;
-  /**
-   * The field used for preview in the interface
-   */
-  preview_field?: string;
-  /**
-   * IDs of internal tags to assign
-   */
-  internal_tag_ids?: Array<string>;
-};
-/**
- * Input for updating a component.
- */
-type ComponentUpdate2 = {
-  /**
-   * Technical name used for component property in entries
-   */
-  name?: string;
-  /**
-   * Name that will be used in the editor interface
-   */
-  display_name?: string | null;
-  /**
-   * Component schema definition containing fields and their configurations
-   */
-  schema?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Whether the component can be used as a root component
-   */
-  is_root?: boolean;
-  /**
-   * Whether the component is nestable in block field types
-   */
-  is_nestable?: boolean;
-  /**
-   * The component folder UUID
-   */
-  component_group_uuid?: string;
-  /**
-   * Icon color
-   */
-  color?: string;
-  /**
-   * Icon name
-   */
-  icon?: string;
-  /**
-   * The field used for preview in the interface
-   */
-  preview_field?: string;
-  /**
-   * IDs of internal tags to assign
-   */
-  internal_tag_ids?: Array<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;
-    /**
-     * Filter by ids (comma separated)
-     */
-    by_ids?: string;
-    /**
-     * Components can be sorted in an ascending or descending order by a specific property
-     */
-    sort_by?: string;
-    /**
-     * Retrieve all the components based on is_root property of a component
-     */
-    is_root?: boolean;
-    /**
-     * Search by name or display_name
-     */
-    search?: string;
-    /**
-     * Find components that are present in a specific group with the UUID of the group
-     */
-    in_group?: string;
-    /**
-     * Filter components by tags
-     */
-    with_tags?: string;
-    /**
-     * Filter components by metadata app slug
-     */
-    by_metadata_app_slug?: string;
-    /**
-     * Filter components by metadata frame ID
-     */
-    by_metadata_frame_id?: string;
-  };
-  url: '/v1/spaces/{space_id}/components';
-};
-type ListResponses = {
-  /**
-   * List of components
-   */
-  200: {
-    components?: Array<Component2>;
-  };
-};
-type CreateData = {
-  body: {
-    component?: ComponentCreate2;
-  };
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components';
-};
-type CreateResponses = {
-  /**
-   * Component created
-   */
-  201: {
-    component?: Component2;
-  };
-};
-type DeleteResponses = {
-  /**
-   * Component deleted
-   */
-  200: {
-    component?: Component2;
-  };
-};
-type GetResponses = {
-  /**
-   * Component details
-   */
-  200: {
-    component?: Component2;
-  };
-};
-type UpdateData = {
-  body: {
-    component?: ComponentUpdate2;
-    /**
-     * Update component name in stories when component name changes
-     */
-    update_content?: boolean;
-  };
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-    /**
-     * The ID of the component (can be integer or string)
-     */
-    component_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components/{component_id}';
-};
-type UpdateResponses = {
-  /**
-   * Component updated
-   */
-  200: {
-    component?: Component2;
-  };
-};
-type RestoreResponses = {
-  /**
-   * Component restored
-   */
-  200: {
-    component?: Component2;
-  };
-};
-type VersionsData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: {
-    /**
-     * Page number
-     */
-    page?: number;
-    /**
-     * Number of items per page. Default is 25.
-     */
-    per_page?: number;
-    /**
-     * Model type. Must be 'components' for component versions.
-     */
-    model?: 'components' | 'stories';
-    /**
-     * Component ID when model is 'components'
-     */
-    model_id?: string;
-    /**
-     * Use version 2 system for retrieving versions
-     */
-    versions_v2?: boolean;
-  };
-  url: '/v1/spaces/{space_id}/versions';
-};
-type VersionsResponses = {
-  /**
-   * Component versions
-   */
-  200: {
-    versions?: Array<{
-      id?: number;
-      event?: string;
-      created_at?: string;
-      author_id?: number;
-      item_id?: number;
-      author?: string;
-      is_draft?: boolean;
-    }>;
-  };
-};
-type VersionData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-    /**
-     * The ID of the component (can be integer or string)
-     */
-    component_id: number | string;
-    /**
-     * Version ID of the component
-     */
-    version_id: number;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components/{component_id}/component_versions/{version_id}';
-};
-type VersionResponses = {
-  /**
-   * Component version details
-   */
-  200: {
-    component_version?: {
-      schema?: {
-        [key: string]: unknown;
-      };
-    };
-  };
-};
-type RestoreVersionData = {
-  body: {
-    model?: string;
-    model_id?: string;
-  };
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-    /**
-     * ID of the component version
-     */
-    version_id: number;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/versions/{version_id}';
-};
-type RestoreVersionResponses = {
-  /**
-   * Component version restored
-   */
-  200: {
-    component?: Component2;
-  };
-};
-//#endregion
-export { Component, ComponentCreate, ComponentSchemaField, ComponentUpdate, CreateData, CreateResponses, DeleteResponses, GetResponses, ListData, ListResponses, RestoreResponses, RestoreVersionData, RestoreVersionResponses, UpdateData, UpdateResponses, VersionData, VersionResponses, VersionsData, VersionsResponses };
-//# sourceMappingURL=types.gen.d.mts.map