jamespot-user-api 1.0.118 → 1.0.120

package/lib/src/apis/file.d.ts

@@ -1,62 +0,0 @@
-import { ApiWrapper, FileCropConfig, FileResponse, JFileExtended, UploadConfig } from '../types';
-import { JBaseApi } from './base';
-export declare class JFileApi extends JBaseApi {
-    /**
-     * Upload a file to the server. use the same token to link the file to an article
-     * @param config configuration object. One of "file" and "url" is mandatory
-     */
-    upload(config: UploadConfig): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages>>;
-    /**
-     * Upload a list of files to the server. use the same token to link the file to an article
-     * @param attrName file name (attachment, image, bannerImage, etc.)
-     * @param files files
-     * @param token token
-     */
-    uploadMany(configArray: Array<UploadConfig>): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages>[]>;
-    get<T extends JFileExtended>(idFile: number, format?: string): Promise<ApiWrapper<T>>;
-    /**
-     * Crop an image
-     * @param config crop configuration
-     * @returns
-     */
-    update(idFile: number | string, type: string, config: FileCropConfig): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages> | {
-        result: {
-            crop: {
-                width: any;
-                height: any;
-                x: any;
-                y: any;
-                rotation: any;
-            };
-            id: string;
-            name: string;
-            type: string;
-            token?: string;
-            size: string;
-            mediaKey: string;
-            imagesize: import("../types").ImageSize;
-        };
-        o: string;
-        f: string;
-        error: number;
-        messages: import("../types").BaseMessages;
-        errorMsg?: string;
-    }>;
-    /**
-     * delete file. This action is not automatic. You need to update the content associated with the deleted image with the same token
-     * @param idFile file id
-     * @param attrName attribute name
-     * @param token token
-     * @returns
-     */
-    deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<ApiWrapper<"", import("../types").BaseMessages>>;
-    /**
-     * delete the image associated with a content. This action is permanent. There is no two step process with a token
-     * @param id content id
-     * @param type content type
-     * @returns
-     */
-    deleteImage(id: number | string, type: string): Promise<ApiWrapper<{
-        id: number;
-    }, import("../types").BaseMessages>>;
-}