@storyblok/management-api-client 0.1.9 → 0.2.0

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

@@ -1,885 +0,0 @@
-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 };
-}
-type Component = Component2;
-/**
- * A component version object
- */
-type ComponentVersion = {
-  schema?: unknown;
-};
-/**
- * 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;
-  }>;
-  source?: 'option' | 'options' | 'custom';
-  /**
-   * Folder slug for asset fields
-   */
-  folder_slug?: string;
-  /**
-   * Allowed file types for asset fields
-   */
-  filetypes?: Array<string>;
-  /**
-   * Maximum value for number fields
-   */
-  maximum?: number;
-  /**
-   * Minimum value for number fields
-   */
-  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;
-  /**
-   * Whether to use UUID for the field
-   */
-  use_uuid?: boolean;
-  /**
-   * Whether to restrict content types
-   */
-  restrict_content_types?: boolean;
-  /**
-   * Whether to restrict components
-   */
-  restrict_components?: boolean;
-  /**
-   * List of allowed components
-   */
-  component_whitelist?: Array<string>;
-  /**
-   * List of allowed component groups
-   */
-  component_group_whitelist?: Array<string>;
-  /**
-   * 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>;
-  /**
-   * Whether to exclude empty option
-   */
-  exclude_empty_option?: boolean;
-  /**
-   * Whether to include empty option
-   */
-  include_empty_option?: boolean;
-  /**
-   * Datasource slug for datasource fields
-   */
-  datasource_slug?: string;
-  /**
-   * Whether multiple values are allowed
-   */
-  multiple?: boolean;
-  /**
-   * 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;
-  };
-};
-/**
- * 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;
-  /**
-   * Creation date
-   */
-  readonly created_at: string;
-  /**
-   * Latest update date
-   */
-  readonly updated_at: string;
-  /**
-   * 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;
-  };
-  /**
-   * URL to the preview image
-   */
-  image?: string;
-  /**
-   * 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;
-  /**
-   * 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;
-    /**
-     * 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;
-  /**
-   * 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;
-};
-/**
- * The ID of the Storyblok space (can be integer or string)
- */
-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;
-/**
- * The ID of the component (can be integer or string)
- */
-type ComponentId = number | 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 ListErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-};
-type ListResponses = {
-  /**
-   * List of components
-   */
-  200: {
-    components?: Array<Component2>;
-  };
-};
-type ListResponse = ListResponses[keyof ListResponses];
-type CreateData = {
-  body: {
-    component?: Component2;
-  };
-  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 CreateErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-};
-type CreateResponses = {
-  /**
-   * Component created
-   */
-  201: {
-    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 = {
-  /**
-   * Component deleted
-   */
-  200: {
-    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
-   */
-  200: {
-    component?: Component2;
-  };
-};
-type GetResponse = GetResponses[keyof GetResponses];
-type UpdateData = {
-  body: {
-    component?: Component2;
-    /**
-     * 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 UpdateErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
-type UpdateResponses = {
-  /**
-   * Component updated
-   */
-  200: {
-    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
-   */
-  200: {
-    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: {
-    /**
-     * 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 VersionsErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component not found
-   */
-  404: unknown;
-};
-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 VersionsResponse = VersionsResponses[keyof VersionsResponses];
-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 VersionErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component or version not found
-   */
-  404: unknown;
-};
-type VersionResponses = {
-  /**
-   * Component version details
-   */
-  200: {
-    component_version?: {
-      schema?: {
-        [key: string]: unknown;
-      };
-    };
-  };
-};
-type VersionResponse = VersionResponses[keyof VersionResponses];
-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 RestoreVersionErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Component or version not found
-   */
-  404: unknown;
-};
-type RestoreVersionResponses = {
-  /**
-   * Component version restored
-   */
-  200: {
-    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.storyblok.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 };
-//# sourceMappingURL=types.gen.d.mts.map