@storyblok/management-api-client 0.1.0 → 0.1.2

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

@@ -0,0 +1,611 @@
+declare namespace types_gen_d_exports {
+  export { Asset, AssetId, BulkMoveData, BulkMoveErrors, BulkMoveResponse, BulkMoveResponses, BulkRestoreData, BulkRestoreErrors, BulkRestoreResponse, BulkRestoreResponses, ClientOptions, DeleteData, DeleteErrors, DeleteManyData, DeleteManyErrors, DeleteManyResponse, DeleteManyResponses, DeleteResponse, DeleteResponses, FinalizeData, FinalizeErrors, FinalizeResponse, FinalizeResponses, GetData, GetErrors, GetResponse, GetResponses, ListData, ListErrors, ListResponse, ListResponses, Page, SignedResponseObject, SpaceId, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses, UploadData, UploadErrors, UploadResponse, UploadResponses };
+}
+/**
+ * A single asset object
+ */
+type Asset = {
+  /**
+   * The numeric ID
+   */
+  id?: number;
+  /**
+   * Full path of the asset, including the file name
+   */
+  filename?: string;
+  /**
+   * Space ID in which the asset is connected
+   */
+  space_id?: number;
+  /**
+   * Creation date (Format yyyy-MM-dd'T'HH:mm:ssZ)
+   */
+  created_at?: string;
+  /**
+   * Latest update date (Format yyyy-MM-dd'T'HH:mm:ssZ)
+   */
+  updated_at?: string;
+  /**
+   * Represents a File object when uploading an asset. Returns null when retrieving asset details.
+   */
+  file?: {
+    [key: string]: unknown;
+  };
+  /**
+   * 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
+   */
+  short_filename?: string;
+  /**
+   * The MIME type of the asset
+   */
+  content_type?: string;
+  /**
+   * The content length in bytes
+   */
+  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;
+  };
+};
+/**
+ * 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;
+  };
+};
+/**
+ * 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;
+/**
+ * The ID of the asset (can be integer or string)
+ */
+type AssetId = 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 assets per page. Default is 25, maximum is 100.
+     */
+    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 ListErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Space not found
+   */
+  404: unknown;
+};
+type ListResponses = {
+  /**
+   * List of assets
+   */
+  200: {
+    assets?: Array<Asset>;
+  };
+};
+type ListResponse = ListResponses[keyof ListResponses];
+type UploadData = {
+  body: {
+    /**
+     * The filename of the asset to upload
+     */
+    filename: string;
+    /**
+     * The size of the asset (e.g., "400X500")
+     */
+    size: string;
+    /**
+     * Optional asset folder ID to place the asset in
+     */
+    asset_folder_id?: number;
+    /**
+     * Must be set to 1 to validate the upload
+     */
+    validate_upload: 1;
+  };
+  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 UploadErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Space not found
+   */
+  404: unknown;
+};
+type UploadResponses = {
+  /**
+   * Signed response object for upload
+   */
+  200: SignedResponseObject;
+};
+type UploadResponse = UploadResponses[keyof UploadResponses];
+type DeleteData = {
+  body?: never;
+  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 DeleteErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Asset not found
+   */
+  404: unknown;
+};
+type DeleteResponses = {
+  /**
+   * Asset deleted
+   */
+  200: {
+    asset?: Asset;
+  };
+};
+type DeleteResponse = DeleteResponses[keyof DeleteResponses];
+type GetData = {
+  body?: never;
+  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 GetErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Asset not found
+   */
+  404: unknown;
+};
+type GetResponses = {
+  /**
+   * Asset details
+   */
+  200: {
+    asset?: Asset;
+  };
+};
+type GetResponse = GetResponses[keyof GetResponses];
+type UpdateData = {
+  body: {
+    /**
+     * A single asset object with updatable properties
+     */
+    asset?: {
+      /**
+       * 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;
+      };
+    };
+  };
+  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 UpdateErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Asset not found
+   */
+  404: unknown;
+};
+type UpdateResponses = {
+  /**
+   * Asset updated
+   */
+  200: {
+    asset?: Asset;
+  };
+};
+type UpdateResponse = UpdateResponses[keyof UpdateResponses];
+type FinalizeData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The ID from the signed response object
+     */
+    signed_response_object_id: string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/assets/{signed_response_object_id}/finish_upload';
+};
+type FinalizeErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Asset not found
+   */
+  404: unknown;
+};
+type FinalizeResponses = {
+  /**
+   * Upload finalized successfully
+   */
+  200: {
+    /**
+     * Success message indicating the upload was finalized
+     */
+    message?: string;
+  };
+};
+type FinalizeResponse = FinalizeResponses[keyof FinalizeResponses];
+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 DeleteManyErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Space not found
+   */
+  404: unknown;
+};
+type DeleteManyResponses = {
+  /**
+   * Assets deleted successfully
+   */
+  200: {
+    /**
+     * Success message indicating which assets were deleted
+     */
+    message?: string;
+  };
+};
+type DeleteManyResponse = DeleteManyResponses[keyof DeleteManyResponses];
+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 BulkMoveErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Space not found
+   */
+  404: unknown;
+};
+type BulkMoveResponses = {
+  /**
+   * Assets moved successfully
+   */
+  200: {
+    /**
+     * Success message indicating which assets were moved
+     */
+    message?: string;
+  };
+};
+type BulkMoveResponse = BulkMoveResponses[keyof BulkMoveResponses];
+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 BulkRestoreErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Space not found
+   */
+  404: unknown;
+};
+type BulkRestoreResponses = {
+  /**
+   * Assets restored successfully
+   */
+  200: {
+    /**
+     * Success message indicating which assets were restored
+     */
+    message?: string;
+  };
+};
+type BulkRestoreResponse = BulkRestoreResponses[keyof BulkRestoreResponses];
+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 { Asset, AssetId, BulkMoveData, BulkMoveErrors, BulkMoveResponse, BulkMoveResponses, BulkRestoreData, BulkRestoreErrors, BulkRestoreResponse, BulkRestoreResponses, ClientOptions, DeleteData, DeleteErrors, DeleteManyData, DeleteManyErrors, DeleteManyResponse, DeleteManyResponses, DeleteResponse, DeleteResponses, FinalizeData, FinalizeErrors, FinalizeResponse, FinalizeResponses, GetData, GetErrors, GetResponse, GetResponses, ListData, ListErrors, ListResponse, ListResponses, Page, SignedResponseObject, SpaceId, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses, UploadData, UploadErrors, UploadResponse, UploadResponses, types_gen_d_exports };
+//# sourceMappingURL=types.gen.d.mts.map