@appwrite.io/console 1.5.2 → 1.7.0

package/src/services/storage.ts

@@ -14,8 +14,6 @@ export class Storage {
     }
 
     /**
-     * List buckets
-     *
      * Get a list of all the storage buckets. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -23,7 +21,7 @@ export class Storage {
      * @throws {AppwriteException}
      * @returns {Promise<Models.BucketList>}
      */
-    async listBuckets(queries?: string[], search?: string): Promise<Models.BucketList> {
+    listBuckets(queries?: string[], search?: string): Promise<Models.BucketList> {
         const apiPath = '/storage/buckets';
         const payload: Payload = {};
         if (typeof queries !== 'undefined') {
@@ -35,13 +33,9 @@ export class Storage {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,
@@ -49,8 +43,6 @@ export class Storage {
         );
     }
     /**
-     * Create bucket
-     *
      * Create a new storage bucket.
      *
      * @param {string} bucketId
@@ -66,7 +58,7 @@ export class Storage {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      */
-    async createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket> {
+    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -111,10 +103,7 @@ export class Storage {
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'post',
             uri,
             apiHeaders,
@@ -122,15 +111,13 @@ export class Storage {
         );
     }
     /**
-     * Get bucket
-     *
      * Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
      *
      * @param {string} bucketId
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      */
-    async getBucket(bucketId: string): Promise<Models.Bucket> {
+    getBucket(bucketId: string): Promise<Models.Bucket> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -139,13 +126,9 @@ export class Storage {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,
@@ -153,8 +136,6 @@ export class Storage {
         );
     }
     /**
-     * Update bucket
-     *
      * Update a storage bucket by its unique ID.
      *
      * @param {string} bucketId
@@ -170,7 +151,7 @@ export class Storage {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      */
-    async updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket> {
+    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -212,10 +193,7 @@ export class Storage {
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'put',
             uri,
             apiHeaders,
@@ -223,15 +201,13 @@ export class Storage {
         );
     }
     /**
-     * Delete bucket
-     *
      * Delete a storage bucket by its unique ID.
      *
      * @param {string} bucketId
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    async deleteBucket(bucketId: string): Promise<{}> {
+    deleteBucket(bucketId: string): Promise<{}> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -243,10 +219,7 @@ export class Storage {
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'delete',
             uri,
             apiHeaders,
@@ -254,8 +227,6 @@ export class Storage {
         );
     }
     /**
-     * List files
-     *
      * Get a list of all the user files. You can use the query params to filter your results.
      *
      * @param {string} bucketId
@@ -264,7 +235,7 @@ export class Storage {
      * @throws {AppwriteException}
      * @returns {Promise<Models.FileList>}
      */
-    async listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList> {
+    listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -279,13 +250,9 @@ export class Storage {
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,
@@ -293,8 +260,6 @@ export class Storage {
         );
     }
     /**
-     * Create file
-     *
      * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
 
 Larger files should be uploaded using multiple requests with the [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.
@@ -311,7 +276,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
      * @throws {AppwriteException}
      * @returns {Promise<Models.File>}
      */
-    async createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress = (progress: UploadProgress) => {}): Promise<Models.File> {
+    createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress = (progress: UploadProgress) => {}): Promise<Models.File> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -338,10 +303,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
             'content-type': 'multipart/form-data',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.chunkedUpload(
+        return this.client.chunkedUpload(
             'post',
             uri,
             apiHeaders,
@@ -350,8 +312,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         );
     }
     /**
-     * Get file
-     *
      * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
      *
      * @param {string} bucketId
@@ -359,7 +319,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
      * @throws {AppwriteException}
      * @returns {Promise<Models.File>}
      */
-    async getFile(bucketId: string, fileId: string): Promise<Models.File> {
+    getFile(bucketId: string, fileId: string): Promise<Models.File> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -371,13 +331,9 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,
@@ -385,8 +341,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         );
     }
     /**
-     * Update file
-     *
      * Update a file by its unique ID. Only users with write permissions have access to update this resource.
      *
      * @param {string} bucketId
@@ -396,7 +350,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
      * @throws {AppwriteException}
      * @returns {Promise<Models.File>}
      */
-    async updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File> {
+    updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -417,10 +371,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'put',
             uri,
             apiHeaders,
@@ -428,8 +379,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         );
     }
     /**
-     * Delete file
-     *
      * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
      *
      * @param {string} bucketId
@@ -437,7 +386,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    async deleteFile(bucketId: string, fileId: string): Promise<{}> {
+    deleteFile(bucketId: string, fileId: string): Promise<{}> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -452,10 +401,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
             'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'delete',
             uri,
             apiHeaders,
@@ -463,16 +409,15 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         );
     }
     /**
-     * Get file for download
-     *
      * Get a file content by its unique ID. The endpoint response return with a &#039;Content-Disposition: attachment&#039; header that tells the browser to start downloading the file to user downloads directory.
      *
      * @param {string} bucketId
      * @param {string} fileId
+     * @param {string} token
      * @throws {AppwriteException}
      * @returns {string}
      */
-    getFileDownload(bucketId: string, fileId: string): string {
+    getFileDownload(bucketId: string, fileId: string, token?: string): string {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -481,10 +426,12 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         }
         const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         const payload: Payload = {};
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         payload['project'] = this.client.config.project;
@@ -492,12 +439,10 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-
+        
         return uri.toString();
     }
     /**
-     * Get file preview
-     *
      * Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.
      *
      * @param {string} bucketId
@@ -513,10 +458,11 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
      * @param {number} rotation
      * @param {string} background
      * @param {ImageFormat} output
+     * @param {string} token
      * @throws {AppwriteException}
      * @returns {string}
      */
-    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat): string {
+    getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: ImageGravity, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: ImageFormat, token?: string): string {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -558,10 +504,12 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         if (typeof output !== 'undefined') {
             payload['output'] = output;
         }
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         payload['project'] = this.client.config.project;
@@ -569,20 +517,19 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-
+        
         return uri.toString();
     }
     /**
-     * Get file for view
-     *
      * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no  &#039;Content-Disposition: attachment&#039; header.
      *
      * @param {string} bucketId
      * @param {string} fileId
+     * @param {string} token
      * @throws {AppwriteException}
      * @returns {string}
      */
-    getFileView(bucketId: string, fileId: string): string {
+    getFileView(bucketId: string, fileId: string, token?: string): string {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -591,10 +538,12 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         }
         const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         const payload: Payload = {};
+        if (typeof token !== 'undefined') {
+            payload['token'] = token;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
         payload['project'] = this.client.config.project;
@@ -602,12 +551,10 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         for (const [key, value] of Object.entries(Service.flatten(payload))) {
             uri.searchParams.append(key, value);
         }
-
+        
         return uri.toString();
     }
     /**
-     * Get storage usage stats
-     *
      * Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
 
      *
@@ -615,7 +562,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
      * @throws {AppwriteException}
      * @returns {Promise<Models.UsageStorage>}
      */
-    async getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage> {
+    getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage> {
         const apiPath = '/storage/usage';
         const payload: Payload = {};
         if (typeof range !== 'undefined') {
@@ -624,13 +571,9 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,
@@ -638,8 +581,6 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         );
     }
     /**
-     * Get bucket usage stats
-     *
      * Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
 
      *
@@ -648,7 +589,7 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
      * @throws {AppwriteException}
      * @returns {Promise<Models.UsageBuckets>}
      */
-    async getBucketUsage(bucketId: string, range?: StorageUsageRange): Promise<Models.UsageBuckets> {
+    getBucketUsage(bucketId: string, range?: StorageUsageRange): Promise<Models.UsageBuckets> {
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -660,13 +601,9 @@ If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunk
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
         }
 
-        payload['project'] = this.client.config.project;
-
-
-        return await this.client.call(
+        return this.client.call(
             'get',
             uri,
             apiHeaders,