@storyblok/api-client 1.0.0-alpha.1 → 1.0.0-alpha.3

package/dist/generated/mapi/_internal.gen.d.cts

@@ -0,0 +1,146 @@
+//#region src/generated/mapi/_internal.gen.d.ts
+type Component = {
+  /**
+   * Unique identifier for the component
+   */
+  readonly id: number;
+  /**
+   * Technical name of the component.
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string | null;
+  /**
+   * Component description
+   */
+  description?: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  readonly created_at: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at: string;
+  /**
+   * Component field schema definition
+   */
+  schema: {
+    [key: string]: {
+      type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
+      /**
+       * Field ID
+       */
+      id?: string;
+      [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | undefined;
+    };
+  };
+  /**
+   * Component image URL
+   */
+  image?: string | null;
+  /**
+   * Field used for preview.
+   */
+  preview_field?: string | null;
+  /**
+   * Whether this component can be used as a root component.
+   */
+  is_root: boolean;
+  /**
+   * Preview template HTML.
+   */
+  preview_tmpl?: string | null;
+  /**
+   * Whether this component can be nested inside other components.
+   */
+  is_nestable: boolean;
+  /**
+   * All presets associated with this component.
+   */
+  all_presets?: Array<{
+    /**
+     * Preset ID
+     */
+    id?: number;
+    /**
+     * Preset name
+     */
+    name?: string;
+    /**
+     * Preset schema
+     */
+    preset?: {
+      [key: string]: unknown;
+    };
+    /**
+     * ID of the component this preset belongs to
+     */
+    component_id?: number;
+    /**
+     * Image URL for the preset preview
+     */
+    image?: string | null;
+    /**
+     * Icon name for the preset
+     */
+    icon?: string | null;
+    /**
+     * Color for the preset display
+     */
+    color?: string | null;
+    /**
+     * Description of the preset
+     */
+    description?: string | null;
+  }>;
+  /**
+   * Default preset ID.
+   */
+  preset_id?: number | null;
+  /**
+   * Display name if available, otherwise technical name.
+   */
+  real_name?: string;
+  /**
+   * UUID of the component group this component belongs to.
+   */
+  component_group_uuid?: string | null;
+  /**
+   * Component color for UI display
+   */
+  color?: string | null;
+  /**
+   * Component icon name
+   */
+  icon?: string | null;
+  internal_tags_list?: Array<{
+    /**
+     * ID
+     */
+    id?: number;
+    /**
+     * Name
+     */
+    name?: string;
+  }>;
+  /**
+   * List of internal tag IDs
+   */
+  internal_tag_ids?: Array<string>;
+  /**
+   * Content Type Asset preview.
+   */
+  content_type_asset_preview?: string | null;
+  /**
+   * Component metadata.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
+};
+//#endregion
+export { Component };
+//# sourceMappingURL=_internal.gen.d.cts.map

package/dist/generated/mapi/_internal.gen.d.mts

@@ -0,0 +1,146 @@
+//#region src/generated/mapi/_internal.gen.d.ts
+type Component = {
+  /**
+   * Unique identifier for the component
+   */
+  readonly id: number;
+  /**
+   * Technical name of the component.
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name?: string | null;
+  /**
+   * Component description
+   */
+  description?: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  readonly created_at: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at: string;
+  /**
+   * Component field schema definition
+   */
+  schema: {
+    [key: string]: {
+      type?: 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group';
+      /**
+       * Field ID
+       */
+      id?: string;
+      [key: string]: unknown | 'bloks' | 'text' | 'textarea' | 'richtext' | 'markdown' | 'number' | 'datetime' | 'boolean' | 'options' | 'option' | 'asset' | 'multiasset' | 'multilink' | 'table' | 'section' | 'commerce' | 'custom' | 'image' | 'file' | 'tab' | 'link' | 'group' | string | undefined;
+    };
+  };
+  /**
+   * Component image URL
+   */
+  image?: string | null;
+  /**
+   * Field used for preview.
+   */
+  preview_field?: string | null;
+  /**
+   * Whether this component can be used as a root component.
+   */
+  is_root: boolean;
+  /**
+   * Preview template HTML.
+   */
+  preview_tmpl?: string | null;
+  /**
+   * Whether this component can be nested inside other components.
+   */
+  is_nestable: boolean;
+  /**
+   * All presets associated with this component.
+   */
+  all_presets?: Array<{
+    /**
+     * Preset ID
+     */
+    id?: number;
+    /**
+     * Preset name
+     */
+    name?: string;
+    /**
+     * Preset schema
+     */
+    preset?: {
+      [key: string]: unknown;
+    };
+    /**
+     * ID of the component this preset belongs to
+     */
+    component_id?: number;
+    /**
+     * Image URL for the preset preview
+     */
+    image?: string | null;
+    /**
+     * Icon name for the preset
+     */
+    icon?: string | null;
+    /**
+     * Color for the preset display
+     */
+    color?: string | null;
+    /**
+     * Description of the preset
+     */
+    description?: string | null;
+  }>;
+  /**
+   * Default preset ID.
+   */
+  preset_id?: number | null;
+  /**
+   * Display name if available, otherwise technical name.
+   */
+  real_name?: string;
+  /**
+   * UUID of the component group this component belongs to.
+   */
+  component_group_uuid?: string | null;
+  /**
+   * Component color for UI display
+   */
+  color?: string | null;
+  /**
+   * Component icon name
+   */
+  icon?: string | null;
+  internal_tags_list?: Array<{
+    /**
+     * ID
+     */
+    id?: number;
+    /**
+     * Name
+     */
+    name?: string;
+  }>;
+  /**
+   * List of internal tag IDs
+   */
+  internal_tag_ids?: Array<string>;
+  /**
+   * Content Type Asset preview.
+   */
+  content_type_asset_preview?: string | null;
+  /**
+   * Component metadata.
+   */
+  metadata?: {
+    [key: string]: unknown;
+  } | null;
+};
+//#endregion
+export { Component };
+//# sourceMappingURL=_internal.gen.d.mts.map

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

@@ -0,0 +1,293 @@
+//#region src/generated/mapi/types.gen.d.ts
+type StoryTranslatedSlug = {
+  /**
+   * id
+   */
+  id: number;
+  /**
+   * The name for this translated slug
+   */
+  name: string | null;
+  /**
+   * URL-friendly identifier for the app category.
+   */
+  slug: string;
+  /**
+   * The language code for this translation.
+   */
+  lang: string;
+  published: boolean | null;
+};
+type StoryLocalizedPath = {
+  /**
+   * The localized path
+   */
+  path: string;
+  /**
+   * The translated name
+   */
+  name: string | null;
+  /**
+   * The language code for this translation.
+   */
+  lang: string;
+  /**
+   * Published status or date
+   */
+  published: boolean | string | null;
+  /**
+   * The translated slug (only present when folders are used).
+   */
+  translated_slug?: string;
+};
+type Space = {
+  /**
+   * The unique identifier of the space
+   */
+  readonly id: number;
+  /**
+   * The name of the space.
+   */
+  name: string;
+  /**
+   * External unique identifier
+   */
+  euid?: string | null;
+  /**
+   * The region where the space is hosted
+   */
+  region: string;
+  /**
+   * The ID of the space owner
+   */
+  owner_id: number;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at: string;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  readonly created_at: string;
+  /**
+   * The subscription plan name
+   */
+  plan: string;
+  /**
+   * The plan level identifier
+   */
+  plan_level: number;
+  /**
+   * Number of pending traffic boosts
+   */
+  pending_traffic_boosts?: number | null;
+  /**
+   * Number of pending limit boosts
+   */
+  pending_limit_boosts?: number | null;
+  /**
+   * Whether the space is on a trial plan
+   */
+  trial: boolean;
+  /**
+   * Whether two-factor authentication is required
+   */
+  requires_2fa: boolean;
+  /**
+   * The organization ID if space belongs to an organization
+   */
+  org_id?: number | null;
+  /**
+   * The partner ID if space is associated with a partner
+   */
+  partner_id?: number | null;
+  /**
+   * The subscription status
+   */
+  subscription_status?: string | null;
+  /**
+   * Stripe trial status
+   */
+  stripe_trial_status?: string | null;
+  /**
+   * Stripe trial end date
+   */
+  stripe_trial_end?: string | null;
+  /**
+   * The type of space (e.g., personal, team)
+   */
+  space_type?: string | null;
+  /**
+   * The timestamp when the space was canceled
+   */
+  canceled_at?: string | null;
+  /**
+   * Whether the organization requires 2FA.
+   */
+  org_requires_2fa: boolean;
+  /**
+   * The timestamp when the space became unpaid
+   */
+  unpaid_at?: string | null;
+  /**
+   * The timestamp when the space was blocked
+   */
+  blocked_at?: string | null;
+  /**
+   * Whether the space is in development mode
+   */
+  development_mode: boolean;
+  /**
+   * Flags indicating which feature limits have been exceeded
+   */
+  feature_limit_exceeded_flags: {
+    [key: string]: boolean | null;
+  };
+  /**
+   * The status of the organization.
+   */
+  org_status?: string | null;
+  /**
+   * Available roles in the space
+   */
+  space_roles?: Array<SpaceRole>;
+  /**
+   * Whether the space is on a Joyride trial
+   */
+  joyride_trial?: boolean;
+  /**
+   * When the Joyride trial expires
+   */
+  joyride_trial_expires_at?: string | null;
+  /**
+   * When the Joyride trial started
+   */
+  joyride_trial_started_at?: string | null;
+  /**
+   * Whether the Joyride trial traffic limit has been exceeded.
+   */
+  joyride_traffic_limit_exceeded?: boolean;
+  [key: string]: unknown | number | string | string | null | number | null | number | null | boolean | number | null | number | null | string | null | string | null | string | null | string | null | string | null | string | null | string | null | {
+    [key: string]: boolean | null;
+  } | string | null | Array<SpaceRole> | string | null | string | null | undefined;
+};
+/**
+ * Custom role definition controlling permissions within a space
+ */
+type SpaceRole = {
+  /**
+   * The unique identifier of the space role.
+   */
+  id: number;
+  /**
+   * The role name
+   */
+  role: string;
+  /**
+   * Optional subtitle for the role.
+   */
+  subtitle?: string | null;
+  /**
+   * External ID for integrations
+   */
+  ext_id?: string | null;
+  /**
+   * List of permissions
+   */
+  permissions: Array<string>;
+  /**
+   * Allowed content paths.
+   */
+  allowed_paths: Array<string>;
+  /**
+   * Resolved allowed paths with slugs.
+   */
+  resolved_allowed_paths: Array<string>;
+  /**
+   * Blocked content paths.
+   */
+  blocked_paths: Array<string>;
+  /**
+   * Resolved blocked paths with slugs.
+   */
+  resolved_blocked_paths: Array<string> | null;
+  /**
+   * Field-level permissions
+   */
+  field_permissions: Array<string>;
+  /**
+   * Allowed field permissions.
+   */
+  allowed_field_permissions: Array<string>;
+  /**
+   * Read-only field permissions.
+   */
+  readonly_field_permissions: Array<string>;
+  /**
+   * Allowed datasource IDs.
+   */
+  datasource_ids: Array<number>;
+  /**
+   * Blocked datasource IDs.
+   */
+  blocked_datasource_ids: Array<number>;
+  /**
+   * Blocked component IDs for usage.
+   */
+  component_ids: Array<number>;
+  /**
+   * Allowed component IDs for usage.
+   */
+  allowed_component_ids: Array<number>;
+  /**
+   * Managed component IDs.
+   */
+  managed_component_ids: Array<number>;
+  /**
+   * Blocked manage component IDs.
+   */
+  blocked_manage_component_ids: Array<number>;
+  /**
+   * Managed component group UUIDs.
+   */
+  managed_component_group_uuids: Array<string>;
+  /**
+   * Blocked manage component group UUIDs.
+   */
+  blocked_manage_component_group_uuids: Array<string>;
+  /**
+   * Allowed component group UUIDs for usage.
+   */
+  component_group_uuids: Array<string>;
+  /**
+   * Blocked component group UUIDs for usage.
+   */
+  blocked_component_group_uuids: Array<string>;
+  /**
+   * Allowed branch IDs.
+   */
+  branch_ids: Array<number>;
+  /**
+   * Blocked branch IDs.
+   */
+  blocked_branch_ids: Array<number>;
+  /**
+   * Allowed language codes.
+   */
+  allowed_languages: Array<string>;
+  /**
+   * Blocked language codes.
+   */
+  blocked_languages: Array<string>;
+  /**
+   * Allowed asset folder IDs.
+   */
+  asset_folder_ids: Array<number>;
+  /**
+   * Blocked asset folder IDs.
+   */
+  blocked_asset_folder_ids: Array<number>;
+};
+//#endregion
+export { Space, StoryLocalizedPath, StoryTranslatedSlug };
+//# sourceMappingURL=types.gen.d.cts.map