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

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

@@ -1,415 +0,0 @@
-//#region src/generated/assets/types.gen.d.ts
-/**
- * A single asset object
- */
-type Asset = {
-  /**
-   * The numeric ID
-   */
-  readonly id: number;
-  /**
-   * Full path of the asset, including the file name
-   */
-  readonly filename: string;
-  /**
-   * Space ID in which the asset is connected
-   */
-  readonly space_id: number;
-  /**
-   * Creation date (Format yyyy-MM-dd'T'HH:mm:ssZ)
-   */
-  readonly created_at: string;
-  /**
-   * Latest update date (Format yyyy-MM-dd'T'HH:mm:ssZ)
-   */
-  readonly updated_at: string;
-  /**
-   * Id of the folder containing this asset
-   */
-  asset_folder_id?: number;
-  /**
-   * Deleted date (Format YYYY-mm-dd HH:MM)
-   */
-  deleted_at?: string;
-  /**
-   * The file name of the asset
-   */
-  readonly short_filename: string;
-  /**
-   * The MIME type of the asset
-   */
-  readonly content_type: string;
-  /**
-   * The content length in bytes
-   */
-  readonly content_length: number;
-  /**
-   * Alt text for the asset (default language)
-   */
-  alt?: string;
-  /**
-   * Copyright text for the asset (default language)
-   */
-  copyright?: string;
-  /**
-   * Title of the asset (default language)
-   */
-  title?: string;
-  /**
-   * Source text for the asset (default language)
-   */
-  source?: string;
-  /**
-   * Date when the asset should expire (Format yyyy-MM-dd'T'HH:mm:ssZ)
-   */
-  expire_at?: string;
-  /**
-   * The focus point of the image (Only for image assets)
-   */
-  focus?: string;
-  /**
-   * List of ids of the tags assigned to the asset
-   */
-  internal_tag_ids?: Array<string>;
-  /**
-   * List of objects containing the details of tags used for the asset
-   */
-  internal_tags_list?: Array<{
-    /**
-     * Id of the tag
-     */
-    id?: number;
-    /**
-     * Name of the tag
-     */
-    name?: string;
-  }>;
-  /**
-   * Defines if the asset is locked for any changes
-   */
-  locked?: boolean;
-  /**
-   * Date when the asset should be made public (Format yyyy-MM-dd'T'HH:mm:ssZ)
-   */
-  publish_at?: string;
-  /**
-   * Defines if the asset should be inaccessable to the public
-   */
-  is_private?: boolean;
-  /**
-   * Includes custom metadata fields for an asset along with the default ones. It also contains the translations of the same if added in the format metafield__i18n__langcode. This field should be used for updating the metadata including the default ones (alt, title, source, copyright)
-   */
-  meta_data?: {
-    [key: string]: unknown;
-  };
-};
-/**
- * Request body for step 1 of the upload process — gets a signed response object.
- */
-type AssetSignRequest = {
-  /**
-   * The filename of the asset to upload
-   */
-  filename: string;
-  /**
-   * Numeric ID of an existing asset. When provided, the upload replaces the file of the specified asset.
-   */
-  id?: number;
-  /**
-   * Optional asset folder ID to place the asset in
-   */
-  asset_folder_id?: number;
-  /**
-   * Defines if the asset should be inaccessible to the public
-   */
-  is_private?: boolean;
-  /**
-   * The dimensions of the asset in the format "<width>X<height>" (e.g., "400X500")
-   */
-  size?: string;
-  /**
-   * Determines whether the upload has to be validated. 1 to validate, 0 to not validate.
-   */
-  validate_upload?: 0 | 1;
-};
-/**
- * Input for updating an asset's metadata.
- */
-type AssetUpdate = {
-  /**
-   * Id of the folder containing this asset
-   */
-  asset_folder_id?: number;
-  /**
-   * Alt text for the asset (default language)
-   */
-  alt?: string;
-  /**
-   * Copyright text for the asset (default language)
-   */
-  copyright?: string;
-  /**
-   * Title of the asset (default language)
-   */
-  title?: string;
-  /**
-   * Source text for the asset (default language)
-   */
-  source?: string;
-  /**
-   * Date when the asset should expire (Format yyyy-MM-dd'T'HH:mm:ssZ)
-   */
-  expire_at?: string;
-  /**
-   * The focus point of the image (Only for image assets)
-   */
-  focus?: string;
-  /**
-   * List of ids of the tags assigned to the asset
-   */
-  internal_tag_ids?: Array<string>;
-  /**
-   * Date when the asset should be made public (Format yyyy-MM-dd'T'HH:mm:ssZ)
-   */
-  publish_at?: string;
-  /**
-   * Defines if the asset should be inaccessable to the public
-   */
-  is_private?: boolean;
-  /**
-   * Includes custom metadata fields for an asset along with the default ones. It also contains the translations of the same if added in the format metafield__i18n__langcode. This field should be used for updating the metadata including the default ones (alt, title, source, copyright)
-   */
-  meta_data?: {
-    [key: string]: unknown;
-  };
-};
-/**
- * Request body for updating an asset.
- */
-type AssetUpdateRequest = {
-  asset?: AssetUpdate;
-};
-/**
- * Signed response object returned from the upload request
- */
-type SignedResponseObject = {
-  /**
-   * The ID of the signed response object
-   */
-  id?: string;
-  /**
-   * The URL to post the file to
-   */
-  post_url?: string;
-  /**
-   * Form fields to include in the upload request
-   */
-  fields?: {
-    [key: string]: unknown;
-  };
-};
-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;
-    /**
-     * Provide the numeric id of a folder to filter the assets by a specific folder. Use value -1 to retrieve deleted assets.
-     */
-    in_folder?: number;
-    /**
-     * Sort assets by specific attribute and order
-     */
-    sort_by?: 'created_at:asc' | 'created_at:desc' | 'updated_at:asc' | 'updated_at:desc' | 'short_filename:asc' | 'short_filename:desc';
-    /**
-     * If "1" it only displays private assets
-     */
-    is_private?: boolean;
-    /**
-     * Provide a search term to filter a specific file by the filename
-     */
-    search?: string;
-    /**
-     * Filter by the alt text of an asset
-     */
-    by_alt?: string;
-    /**
-     * Filter by the copyright of an asset
-     */
-    by_copyright?: string;
-    /**
-     * Filter by the title of an asset
-     */
-    by_title?: string;
-    /**
-     * Filter by specific tag(s). Multiple tags can be provided as a comma-separated string (treated like an OR operator).
-     */
-    with_tags?: string;
-  };
-  url: '/v1/spaces/{space_id}/assets';
-};
-type ListResponses = {
-  /**
-   * List of assets
-   */
-  200: {
-    assets?: Array<Asset>;
-  };
-};
-type SignResponseObjectData = {
-  body: AssetSignRequest;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/assets';
-};
-type SignResponseObjectResponses = {
-  /**
-   * Signed response object for upload
-   */
-  200: SignedResponseObject;
-};
-type DeleteResponses = {
-  /**
-   * Asset deleted
-   */
-  200: {
-    asset?: Asset;
-  };
-};
-type GetResponses = {
-  /**
-   * Asset details
-   */
-  200: Asset;
-};
-type UpdateData = {
-  body: AssetUpdateRequest;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-    /**
-     * The ID of the asset (can be integer or string)
-     */
-    asset_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/assets/{asset_id}';
-};
-type FinalizeResponses = {
-  /**
-   * Upload finalized successfully
-   */
-  200: {
-    /**
-     * Success message indicating the upload was finalized
-     */
-    message?: string;
-  };
-};
-type DeleteManyData = {
-  body: {
-    /**
-     * Array of numeric asset IDs
-     */
-    ids: Array<number>;
-  };
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/assets/bulk_destroy';
-};
-type DeleteManyResponses = {
-  /**
-   * Assets deleted successfully
-   */
-  200: {
-    /**
-     * Success message indicating which assets were deleted
-     */
-    message?: string;
-  };
-};
-type BulkMoveData = {
-  body: {
-    /**
-     * Array of numeric asset IDs
-     */
-    ids: Array<number>;
-    /**
-     * Id of the folder containing this asset
-     */
-    asset_folder_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}/assets/bulk_update';
-};
-type BulkMoveResponses = {
-  /**
-   * Assets moved successfully
-   */
-  200: {
-    /**
-     * Success message indicating which assets were moved
-     */
-    message?: string;
-  };
-};
-type BulkRestoreData = {
-  body: {
-    /**
-     * Array of numeric asset IDs
-     */
-    ids: Array<number>;
-  };
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/assets/bulk_restore';
-};
-type BulkRestoreResponses = {
-  /**
-   * Assets restored successfully
-   */
-  200: {
-    /**
-     * Success message indicating which assets were restored
-     */
-    message?: string;
-  };
-};
-//#endregion
-export { Asset, AssetSignRequest, AssetUpdate, AssetUpdateRequest, BulkMoveData, BulkMoveResponses, BulkRestoreData, BulkRestoreResponses, DeleteManyData, DeleteManyResponses, DeleteResponses, FinalizeResponses, GetResponses, ListData, ListResponses, SignResponseObjectData, SignResponseObjectResponses, SignedResponseObject, UpdateData };
-//# sourceMappingURL=types.gen.d.cts.map