@storyblok/management-api-client 0.2.2 → 0.2.4

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

@@ -1,13 +1,5 @@
-declare namespace types_gen_d_exports {
-  export { BulkMoveData, BulkMoveErrors, BulkMoveResponse, BulkMoveResponses, ClientOptions, Component, Component2, ComponentId, ComponentSchemaField, ComponentVersion, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteComponentData, DeleteComponentErrors, DeleteComponentResponse, DeleteComponentResponses, GetData, GetErrors, GetResponse, GetResponses, ListData, ListErrors, ListResponse, ListResponses, Page, PerPage, RenameAttributeData, RenameAttributeErrors, RenameAttributeResponse, RenameAttributeResponses, RestoreData, RestoreErrors, RestoreResponse, RestoreResponses, RestoreVersionData, RestoreVersionErrors, RestoreVersionResponse, RestoreVersionResponses, SpaceId, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses, VersionData, VersionErrors, VersionResponse, VersionResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses };
-}
+//#region src/generated/components/types.gen.d.ts
 type Component = Component2;
-/**
- * A component version object
- */
-type ComponentVersion = {
-  schema?: unknown;
-};
 /**
  * A component schema field object
  */
@@ -52,21 +44,24 @@ type ComponentSchemaField = {
     name?: string;
     value?: string;
   }>;
-  source?: 'option' | 'options' | 'custom';
   /**
-   * Folder slug for asset fields
+   * 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 fields
+   * Allowed file types for Asset and Multi-Assets fields (e.g. images, videos, audios, texts)
    */
   filetypes?: Array<string>;
   /**
-   * Maximum value for number fields
+   * The maximal number of components allowed inside a Blocks field
    */
   maximum?: number;
   /**
-   * Minimum value for number fields
+   * The minimal number of components allowed inside a Blocks field
    */
   minimum?: number;
   /**
@@ -102,7 +97,7 @@ type ComponentSchemaField = {
    */
   width?: number;
   /**
-   * Whether to use UUID for the field
+   * When the source is set to internal_stories, displays the UUID of the selected story. Defaults to true.
    */
   use_uuid?: boolean;
   /**
@@ -110,17 +105,37 @@ type ComponentSchemaField = {
    */
   restrict_content_types?: boolean;
   /**
-   * Whether to restrict components
+   * Allow or deny access to nestable blocks inside Blocks and Richtext fields. Defaults to false (allowed).
    */
   restrict_components?: boolean;
   /**
-   * List of allowed components
+   * 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>;
   /**
-   * List of allowed component groups
+   * 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
    */
@@ -137,6 +152,14 @@ type ComponentSchemaField = {
    * 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
    */
@@ -146,13 +169,176 @@ type ComponentSchemaField = {
    */
   include_empty_option?: boolean;
   /**
-   * Datasource slug for datasource fields
+   * 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
    */
@@ -204,6 +390,8 @@ type ComponentSchemaField = {
     collapsed?: boolean;
   };
 };
+type ComponentCreate = ComponentCreate2;
+type ComponentUpdate = ComponentUpdate2;
 /**
  * A Storyblok component object representing a content type
  */
@@ -219,7 +407,7 @@ type Component2 = {
   /**
    * Name that will be used in the editor interface
    */
-  display_name?: string;
+  display_name?: string | null;
   /**
    * Creation date
    */
@@ -232,28 +420,12 @@ type Component2 = {
    * Component schema definition containing fields and their configurations
    */
   schema: {
-    /**
-     * Unique identifier field configuration
-     */
-    _uid?: {
-      [key: string]: unknown;
-    };
-    /**
-     * Component type field configuration
-     */
-    component?: {
-      [key: string]: unknown;
-    };
-    [key: string]: unknown | {
-      [key: string]: unknown;
-    } | {
-      [key: string]: unknown;
-    } | undefined;
+    [key: string]: unknown;
   };
   /**
    * URL to the preview image
    */
-  image?: string;
+  image?: string | null;
   /**
    * The field that is for preview in the interface (Preview Field)
    */
@@ -265,7 +437,7 @@ type Component2 = {
   /**
    * Preview template for the component
    */
-  preview_tmpl?: string;
+  preview_tmpl?: string | null;
   /**
    * True if the component is nestable (insertable) in block field types
    */
@@ -289,7 +461,7 @@ type Component2 = {
     /**
      * Link to the preview image of the preset
      */
-    image?: string;
+    image?: string | null;
     /**
      * Icon selected for the preset
      */
@@ -306,7 +478,7 @@ type Component2 = {
   /**
    * ID of the preset currently selected for this component
    */
-  preset_id?: number;
+  preset_id?: number | null;
   /**
    * Duplicated technical name or display name, used for internal tasks
    */
@@ -346,21 +518,99 @@ type Component2 = {
   content_type_asset_preview?: string;
 };
 /**
- * The ID of the Storyblok space (can be integer or string)
+ * Input for creating a component.
  */
-type SpaceId = number | string;
-/**
- * Page number for pagination. Default is 1.
- */
-type Page = number;
-/**
- * Number of items per page. Default is 25.
- */
-type PerPage = number;
+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>;
+};
 /**
- * The ID of the component (can be integer or string)
+ * Input for updating a component.
  */
-type ComponentId = number | string;
+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: {
@@ -413,20 +663,6 @@ type ListData = {
   };
   url: '/v1/spaces/{space_id}/components';
 };
-type ListErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-};
 type ListResponses = {
   /**
    * List of components
@@ -435,10 +671,9 @@ type ListResponses = {
     components?: Array<Component2>;
   };
 };
-type ListResponse = ListResponses[keyof ListResponses];
 type CreateData = {
   body: {
-    component?: Component2;
+    component?: ComponentCreate2;
   };
   path: {
     /**
@@ -449,20 +684,6 @@ type CreateData = {
   query?: never;
   url: '/v1/spaces/{space_id}/components';
 };
-type CreateErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-};
 type CreateResponses = {
   /**
    * Component created
@@ -471,37 +692,7 @@ type CreateResponses = {
     component?: Component2;
   };
 };
-type CreateResponse = CreateResponses[keyof CreateResponses];
-type DeleteComponentData = {
-  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;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components/{component_id}';
-};
-type DeleteComponentErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
-type DeleteComponentResponses = {
+type DeleteResponses = {
   /**
    * Component deleted
    */
@@ -509,36 +700,6 @@ type DeleteComponentResponses = {
     component?: Component2;
   };
 };
-type DeleteComponentResponse = DeleteComponentResponses[keyof DeleteComponentResponses];
-type GetData = {
-  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;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components/{component_id}';
-};
-type GetErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
 type GetResponses = {
   /**
    * Component details
@@ -547,10 +708,9 @@ type GetResponses = {
     component?: Component2;
   };
 };
-type GetResponse = GetResponses[keyof GetResponses];
 type UpdateData = {
   body: {
-    component?: Component2;
+    component?: ComponentUpdate2;
     /**
      * Update component name in stories when component name changes
      */
@@ -569,20 +729,6 @@ type UpdateData = {
   query?: never;
   url: '/v1/spaces/{space_id}/components/{component_id}';
 };
-type UpdateErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
 type UpdateResponses = {
   /**
    * Component updated
@@ -591,85 +737,6 @@ type UpdateResponses = {
     component?: Component2;
   };
 };
-type UpdateResponse = UpdateResponses[keyof UpdateResponses];
-type RenameAttributeData = {
-  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;
-  };
-  query: {
-    /**
-     * Current name of the attribute
-     */
-    old_name: string;
-    /**
-     * New name for the attribute
-     */
-    new_name: string;
-    /**
-     * Optional story ID to update the attribute in a specific story
-     */
-    story_id?: number;
-  };
-  url: '/v1/spaces/{space_id}/components/{component_id}/rename_attribute';
-};
-type RenameAttributeErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
-type RenameAttributeResponses = {
-  /**
-   * Attribute renamed successfully
-   */
-  204: void;
-};
-type RenameAttributeResponse = RenameAttributeResponses[keyof RenameAttributeResponses];
-type RestoreData = {
-  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;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components/{component_id}/restore';
-};
-type RestoreErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
 type RestoreResponses = {
   /**
    * Component restored
@@ -678,55 +745,6 @@ type RestoreResponses = {
     component?: Component2;
   };
 };
-type RestoreResponse = RestoreResponses[keyof RestoreResponses];
-type BulkMoveData = {
-  body: {
-    /**
-     * Array of component IDs to update
-     */
-    ids: Array<number>;
-    component: {
-      /**
-       * ID of the component group to assign components to
-       */
-      component_group_id: number;
-    };
-  };
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/components/bulk_update';
-};
-type BulkMoveErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component group not found
-   */
-  404: unknown;
-};
-type BulkMoveResponses = {
-  /**
-   * Components updated successfully
-   */
-  200: {
-    /**
-     * Success message
-     */
-    message?: string;
-  };
-};
-type BulkMoveResponse = BulkMoveResponses[keyof BulkMoveResponses];
 type VersionsData = {
   body?: never;
   path: {
@@ -759,20 +777,6 @@ type VersionsData = {
   };
   url: '/v1/spaces/{space_id}/versions';
 };
-type VersionsErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
 type VersionsResponses = {
   /**
    * Component versions
@@ -789,7 +793,6 @@ type VersionsResponses = {
     }>;
   };
 };
-type VersionsResponse = VersionsResponses[keyof VersionsResponses];
 type VersionData = {
   body?: never;
   path: {
@@ -809,20 +812,6 @@ type VersionData = {
   query?: never;
   url: '/v1/spaces/{space_id}/components/{component_id}/component_versions/{version_id}';
 };
-type VersionErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component or version not found
-   */
-  404: unknown;
-};
 type VersionResponses = {
   /**
    * Component version details
@@ -835,7 +824,6 @@ type VersionResponses = {
     };
   };
 };
-type VersionResponse = VersionResponses[keyof VersionResponses];
 type RestoreVersionData = {
   body: {
     model?: string;
@@ -854,20 +842,6 @@ type RestoreVersionData = {
   query?: never;
   url: '/v1/spaces/{space_id}/versions/{version_id}';
 };
-type RestoreVersionErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component or version not found
-   */
-  404: unknown;
-};
 type RestoreVersionResponses = {
   /**
    * Component version restored
@@ -876,10 +850,6 @@ type RestoreVersionResponses = {
     component?: Component2;
   };
 };
-type RestoreVersionResponse = RestoreVersionResponses[keyof RestoreVersionResponses];
-type ClientOptions = {
-  baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblokchina.cn' | (string & {});
-};
 //#endregion
-export { BulkMoveData, BulkMoveErrors, BulkMoveResponse, BulkMoveResponses, ClientOptions, Component, Component2, ComponentId, ComponentSchemaField, ComponentVersion, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteComponentData, DeleteComponentErrors, DeleteComponentResponse, DeleteComponentResponses, GetData, GetErrors, GetResponse, GetResponses, ListData, ListErrors, ListResponse, ListResponses, Page, PerPage, RenameAttributeData, RenameAttributeErrors, RenameAttributeResponse, RenameAttributeResponses, RestoreData, RestoreErrors, RestoreResponse, RestoreResponses, RestoreVersionData, RestoreVersionErrors, RestoreVersionResponse, RestoreVersionResponses, SpaceId, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses, VersionData, VersionErrors, VersionResponse, VersionResponses, VersionsData, VersionsErrors, VersionsResponse, VersionsResponses, types_gen_d_exports };
+export { Component, ComponentCreate, ComponentSchemaField, ComponentUpdate, CreateData, CreateResponses, DeleteResponses, GetResponses, ListData, ListResponses, RestoreResponses, RestoreVersionData, RestoreVersionResponses, UpdateData, UpdateResponses, VersionData, VersionResponses, VersionsData, VersionsResponses };
 //# sourceMappingURL=types.gen.d.cts.map