@storyblok/management-api-client 0.2.1 → 0.2.3

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

@@ -1,6 +1,4 @@
-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, PerPage, SignedResponseObject, SpaceId, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses, UploadData, UploadErrors, UploadResponse, UploadResponses };
-}
+//#region src/generated/assets/types.gen.d.ts
 /**
  * A single asset object
  */
@@ -8,29 +6,23 @@ type Asset = {
   /**
    * The numeric ID
    */
-  id?: number;
+  readonly id: number;
   /**
    * Full path of the asset, including the file name
    */
-  filename?: string;
+  readonly filename: string;
   /**
    * Space ID in which the asset is connected
    */
-  space_id?: number;
+  readonly space_id: number;
   /**
    * Creation date (Format yyyy-MM-dd'T'HH:mm:ssZ)
    */
-  created_at?: string;
+  readonly 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;
-  };
+  readonly updated_at: string;
   /**
    * Id of the folder containing this asset
    */
@@ -42,15 +34,15 @@ type Asset = {
   /**
    * The file name of the asset
    */
-  short_filename?: string;
+  readonly short_filename: string;
   /**
    * The MIME type of the asset
    */
-  content_type?: string;
+  readonly content_type: string;
   /**
    * The content length in bytes
    */
-  content_length?: number;
+  readonly content_length: number;
   /**
    * Alt text for the asset (default language)
    */
@@ -111,6 +103,92 @@ type Asset = {
     [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
  */
@@ -130,22 +208,6 @@ type SignedResponseObject = {
     [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;
-/**
- * Number of items per page. Default is 25.
- */
-type PerPage = number;
-/**
- * The ID of the asset (can be integer or string)
- */
-type AssetId = number | string;
 type ListData = {
   body?: never;
   path: {
@@ -198,20 +260,6 @@ type ListData = {
   };
   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
@@ -220,26 +268,8 @@ type ListResponses = {
     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;
-  };
+type SignResponseObjectData = {
+  body: AssetSignRequest;
   path: {
     /**
      * The ID of the Storyblok space (can be integer or string)
@@ -249,56 +279,12 @@ type UploadData = {
   query?: never;
   url: '/v1/spaces/{space_id}/assets';
 };
-type UploadErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-};
-type UploadResponses = {
+type SignResponseObjectResponses = {
   /**
    * 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
@@ -307,99 +293,14 @@ type DeleteResponses = {
     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;
-  };
+  200: 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;
-      };
-    };
-  };
+  body: AssetUpdateRequest;
   path: {
     /**
      * The ID of the Storyblok space (can be integer or string)
@@ -413,58 +314,6 @@ type UpdateData = {
   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
@@ -476,7 +325,6 @@ type FinalizeResponses = {
     message?: string;
   };
 };
-type FinalizeResponse = FinalizeResponses[keyof FinalizeResponses];
 type DeleteManyData = {
   body: {
     /**
@@ -493,20 +341,6 @@ type DeleteManyData = {
   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
@@ -518,7 +352,6 @@ type DeleteManyResponses = {
     message?: string;
   };
 };
-type DeleteManyResponse = DeleteManyResponses[keyof DeleteManyResponses];
 type BulkMoveData = {
   body: {
     /**
@@ -539,20 +372,6 @@ type BulkMoveData = {
   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
@@ -564,7 +383,6 @@ type BulkMoveResponses = {
     message?: string;
   };
 };
-type BulkMoveResponse = BulkMoveResponses[keyof BulkMoveResponses];
 type BulkRestoreData = {
   body: {
     /**
@@ -581,20 +399,6 @@ type BulkRestoreData = {
   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
@@ -606,10 +410,6 @@ type BulkRestoreResponses = {
     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.storyblokchina.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, PerPage, SignedResponseObject, SpaceId, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses, UploadData, UploadErrors, UploadResponse, UploadResponses, types_gen_d_exports };
+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