@appwrite.io/console 0.6.4 → 0.7.0-rc.2

package/types/services/storage.d.ts

@@ -1,24 +1,22 @@
-import { Service } from '../service';
-import { Client } from '../client';
+import { Client, UploadProgress } from '../client';
 import type { Models } from '../models';
-import type { UploadProgress } from '../client';
 import { Compression } from '../enums/compression';
 import { ImageGravity } from '../enums/image-gravity';
 import { ImageFormat } from '../enums/image-format';
 import { StorageUsageRange } from '../enums/storage-usage-range';
-export declare class Storage extends Service {
+export declare class Storage {
+    client: Client;
     constructor(client: Client);
     /**
      * List buckets
      *
-     * Get a list of all the storage buckets. You can use the query params to
-     * filter your results.
+     * Get a list of all the storage buckets. You can use the query params to filter your results.
      *
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.BucketList>}
+     */
     listBuckets(queries?: string[], search?: string): Promise<Models.BucketList>;
     /**
      * Create bucket
@@ -36,19 +34,18 @@ export declare class Storage extends Service {
      * @param {boolean} encryption
      * @param {boolean} antivirus
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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>;
     /**
      * Get bucket
      *
-     * Get a storage bucket by its unique ID. This endpoint response returns a
-     * JSON object with the storage bucket metadata.
+     * 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}
-    */
+     * @returns {Promise<Models.Bucket>}
+     */
     getBucket(bucketId: string): Promise<Models.Bucket>;
     /**
      * Update bucket
@@ -66,8 +63,8 @@ export declare class Storage extends Service {
      * @param {boolean} encryption
      * @param {boolean} antivirus
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {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>;
     /**
      * Delete bucket
@@ -76,111 +73,91 @@ export declare class Storage extends Service {
      *
      * @param {string} bucketId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteBucket(bucketId: string): Promise<{}>;
     /**
      * List files
      *
-     * Get a list of all the user files. You can use the query params to filter
-     * your results.
+     * Get a list of all the user files. You can use the query params to filter your results.
      *
      * @param {string} bucketId
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.FileList>}
+     */
     listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
     /**
      * 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.
-     *
-     * When the first request is sent, the server will return the **File** object,
-     * and the subsequent part request must include the file's **id** in
-     * `x-appwrite-id` header to allow the server to know that the partial upload
-     * is for the existing file and not for a new one.
-     *
-     * If you're creating a new file using one of the Appwrite SDKs, all the
-     * chunking logic will be managed by the SDK internally.
-     *
+     * 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.
+
+When the first request is sent, the server will return the **File** object, and the subsequent part request must include the file&#039;s **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.
+
+If you&#039;re creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.
+
      *
      * @param {string} bucketId
      * @param {string} fileId
      * @param {File} file
      * @param {string[]} permissions
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.File>}
+     */
     createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
     /**
      * Get file
      *
-     * Get a file by its unique ID. This endpoint response returns a JSON object
-     * with the file metadata.
+     * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
      *
      * @param {string} bucketId
      * @param {string} fileId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.File>}
+     */
     getFile(bucketId: string, fileId: string): Promise<Models.File>;
     /**
      * Update file
      *
-     * Update a file by its unique ID. Only users with write permissions have
-     * access to update this resource.
+     * Update a file by its unique ID. Only users with write permissions have access to update this resource.
      *
      * @param {string} bucketId
      * @param {string} fileId
      * @param {string} name
      * @param {string[]} permissions
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.File>}
+     */
     updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
     /**
      * Delete File
      *
-     * Delete a file by its unique ID. Only users with write permissions have
-     * access to delete this resource.
+     * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
      *
      * @param {string} bucketId
      * @param {string} fileId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteFile(bucketId: string, fileId: string): Promise<{}>;
     /**
      * Get file for download
      *
-     * Get a file content by its unique ID. The endpoint response return with a
-     * 'Content-Disposition: attachment' header that tells the browser to start
-     * downloading the file to user downloads directory.
+     * 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
      * @throws {AppwriteException}
-     * @returns {URL}
-    */
-    getFileDownload(bucketId: string, fileId: string): URL;
+     * @returns {string}
+     */
+    getFileDownload(bucketId: string, fileId: string): string;
     /**
      * 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.
+     * 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
      * @param {string} fileId
@@ -196,30 +173,28 @@ export declare class Storage extends Service {
      * @param {string} background
      * @param {ImageFormat} output
      * @throws {AppwriteException}
-     * @returns {URL}
-    */
-    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): URL;
+     * @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;
     /**
      * Get file for view
      *
-     * Get a file content by its unique ID. This endpoint is similar to the
-     * download method but returns with no  'Content-Disposition: attachment'
-     * header.
+     * 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
      * @throws {AppwriteException}
-     * @returns {URL}
-    */
-    getFileView(bucketId: string, fileId: string): URL;
+     * @returns {string}
+     */
+    getFileView(bucketId: string, fileId: string): string;
     /**
      * Get storage usage stats
      *
      *
      * @param {StorageUsageRange} range
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.UsageStorage>}
+     */
     getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage>;
     /**
      * Get bucket usage stats
@@ -228,7 +203,7 @@ export declare class Storage extends Service {
      * @param {string} bucketId
      * @param {StorageUsageRange} range
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.UsageBuckets>}
+     */
     getBucketUsage(bucketId: string, range?: StorageUsageRange): Promise<Models.UsageBuckets>;
 }

package/types/services/teams.d.ts

@@ -1,33 +1,30 @@
-import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
-export declare class Teams extends Service {
+export declare class Teams {
+    client: Client;
     constructor(client: Client);
     /**
      * List teams
      *
-     * Get a list of all the teams in which the current user is a member. You can
-     * use the parameters to filter your results.
+     * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
      *
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.TeamList<Preferences>>}
+     */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
     /**
      * Create team
      *
-     * Create a new team. The user who creates the team will automatically be
-     * assigned as the owner of the team. Only the users with the owner role can
-     * invite new members, add new owners and delete or update the team.
+     * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
      *
      * @param {string} teamId
      * @param {string} name
      * @param {string[]} roles
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Team<Preferences>>}
+     */
     create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
     /**
      * Get team
@@ -36,30 +33,29 @@ export declare class Teams extends Service {
      *
      * @param {string} teamId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Team<Preferences>>}
+     */
     get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>>;
     /**
      * Update name
      *
-     * Update the team's name by its unique ID.
+     * Update the team&#039;s name by its unique ID.
      *
      * @param {string} teamId
      * @param {string} name
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Team<Preferences>>}
+     */
     updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
     /**
      * Delete team
      *
-     * Delete a team using its ID. Only team members with the owner role can
-     * delete the team.
+     * Delete a team using its ID. Only team members with the owner role can delete the team.
      *
      * @param {string} teamId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     delete(teamId: string): Promise<{}>;
     /**
      * List team logs
@@ -69,46 +65,32 @@ export declare class Teams extends Service {
      * @param {string} teamId
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.LogList>}
+     */
     listLogs(teamId: string, queries?: string[]): Promise<Models.LogList>;
     /**
      * List team memberships
      *
-     * Use this endpoint to list a team's members using the team's ID. All team
-     * members have read access to this endpoint.
+     * Use this endpoint to list a team&#039;s members using the team&#039;s ID. All team members have read access to this endpoint.
      *
      * @param {string} teamId
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.MembershipList>}
+     */
     listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
     /**
      * Create team membership
      *
-     * Invite a new member to join your team. Provide an ID for existing users, or
-     * invite unregistered users using an email or phone number. If initiated from
-     * a Client SDK, Appwrite will send an email or sms with a link to join the
-     * team to the invited user, and an account will be created for them if one
-     * doesn't exist. If initiated from a Server SDK, the new member will be added
-     * automatically to the team.
-     *
-     * You only need to provide one of a user ID, email, or phone number. Appwrite
-     * will prioritize accepting the user ID > email > phone number if you provide
-     * more than one of these parameters.
-     *
-     * Use the `url` parameter to redirect the user from the invitation email to
-     * your app. After the user is redirected, use the [Update Team Membership
-     * Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus)
-     * endpoint to allow the user to accept the invitation to the team.
-     *
-     * Please note that to avoid a [Redirect
-     * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
-     * Appwrite will accept the only redirect URLs under the domains you have
-     * added as a platform on the Appwrite Console.
-     *
+     * Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn&#039;t exist. If initiated from a Server SDK, the new member will be added automatically to the team.
+
+You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID &gt; email &gt; phone number if you provide more than one of these parameters.
+
+Use the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team.
+
+Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.
+
      *
      * @param {string} teamId
      * @param {string[]} roles
@@ -118,91 +100,79 @@ export declare class Teams extends Service {
      * @param {string} url
      * @param {string} name
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
     /**
      * Get team membership
      *
-     * Get a team member by the membership unique id. All team members have read
-     * access for this resource.
+     * Get a team member by the membership unique id. All team members have read access for this resource.
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
     /**
      * Update membership
      *
-     * Modify the roles of a team member. Only team members with the owner role
-     * have access to this endpoint. Learn more about [roles and
-     * permissions](https://appwrite.io/docs/permissions).
-     *
+     * Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https://appwrite.io/docs/permissions).
+
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @param {string[]} roles
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
     /**
      * Delete team membership
      *
-     * This endpoint allows a user to leave a team or for a team owner to delete
-     * the membership of any other team member. You can also use this endpoint to
-     * delete a user membership even if it is not accepted.
+     * This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     deleteMembership(teamId: string, membershipId: string): Promise<{}>;
     /**
      * Update team membership status
      *
-     * Use this endpoint to allow a user to accept an invitation to join a team
-     * after being redirected back to your app from the invitation email received
-     * by the user.
-     *
-     * If the request is successful, a session for the user is automatically
-     * created.
-     *
+     * Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.
+
+If the request is successful, a session for the user is automatically created.
+
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @param {string} userId
      * @param {string} secret
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
     /**
      * Get team preferences
      *
-     * Get the team's shared preferences by its unique ID. If a preference doesn't
-     * need to be shared by all team members, prefer storing them in [user
-     * preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
+     * Get the team&#039;s shared preferences by its unique ID. If a preference doesn&#039;t need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
      *
      * @param {string} teamId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Preferences>}
+     */
     getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences>;
     /**
      * Update preferences
      *
-     * Update the team's preferences by its unique ID. The object you pass is
-     * stored as is and replaces any previous value. The maximum allowed prefs
-     * size is 64kB and throws an error if exceeded.
+     * Update the team&#039;s preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.
      *
      * @param {string} teamId
      * @param {object} prefs
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Preferences>}
+     */
     updatePrefs<Preferences extends Models.Preferences>(teamId: string, prefs: object): Promise<Preferences>;
 }