@appwrite.io/console 0.2.0 → 0.4.0

package/types/services/storage.d.ts

@@ -14,7 +14,7 @@ export declare class Storage extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listBuckets(queries?: string[], search?: string): Promise<Models.BucketList>;
     /**
      * Create bucket
@@ -33,10 +33,10 @@ export declare class Storage extends Service {
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
     /**
-     * Get Bucket
+     * Get bucket
      *
      * Get a storage bucket by its unique ID. This endpoint response returns a
      * JSON object with the storage bucket metadata.
@@ -44,10 +44,10 @@ export declare class Storage extends Service {
      * @param {string} bucketId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getBucket(bucketId: string): Promise<Models.Bucket>;
     /**
-     * Update Bucket
+     * Update bucket
      *
      * Update a storage bucket by its unique ID.
      *
@@ -63,20 +63,20 @@ export declare class Storage extends Service {
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
     /**
-     * Delete Bucket
+     * Delete bucket
      *
      * Delete a storage bucket by its unique ID.
      *
      * @param {string} bucketId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteBucket(bucketId: string): Promise<{}>;
     /**
-     * List Files
+     * List files
      *
      * Get a list of all the user files. You can use the query params to filter
      * your results.
@@ -86,15 +86,15 @@ export declare class Storage extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
     /**
-     * Create File
+     * Create file
      *
      * Create a new file. Before using this route, you should create a new bucket
      * resource using either a [server
-     * integration](/docs/server/storage#storageCreateBucket) API or directly from
-     * your Appwrite console.
+     * 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)
@@ -116,10 +116,10 @@ export declare class Storage extends Service {
      * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     createFile(bucketId: string, fileId: string, file: File, permissions?: string[], onProgress?: (progress: UploadProgress) => void): Promise<Models.File>;
     /**
-     * Get File
+     * Get file
      *
      * Get a file by its unique ID. This endpoint response returns a JSON object
      * with the file metadata.
@@ -128,21 +128,22 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getFile(bucketId: string, fileId: string): Promise<Models.File>;
     /**
-     * Update File
+     * Update file
      *
      * 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}
-     */
-    updateFile(bucketId: string, fileId: string, permissions?: string[]): Promise<Models.File>;
+    */
+    updateFile(bucketId: string, fileId: string, name?: string, permissions?: string[]): Promise<Models.File>;
     /**
      * Delete File
      *
@@ -153,10 +154,10 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteFile(bucketId: string, fileId: string): Promise<{}>;
     /**
-     * Get File for Download
+     * 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
@@ -166,10 +167,10 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {URL}
-     */
+    */
     getFileDownload(bucketId: string, fileId: string): URL;
     /**
-     * Get File Preview
+     * 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,
@@ -192,10 +193,10 @@ export declare class Storage extends Service {
      * @param {string} output
      * @throws {AppwriteException}
      * @returns {URL}
-     */
+    */
     getFilePreview(bucketId: string, fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): URL;
     /**
-     * Get File for View
+     * 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'
@@ -205,7 +206,7 @@ export declare class Storage extends Service {
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {URL}
-     */
+    */
     getFileView(bucketId: string, fileId: string): URL;
     /**
      * Get usage stats for storage
@@ -214,7 +215,7 @@ export declare class Storage extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getUsage(range?: string): Promise<Models.UsageStorage>;
     /**
      * Get usage stats for storage bucket
@@ -224,6 +225,6 @@ export declare class Storage extends Service {
      * @param {string} range
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getBucketUsage(bucketId: string, range?: string): Promise<Models.UsageBuckets>;
 }

package/types/services/teams.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Teams extends Service {
     constructor(client: Client);
     /**
-     * List Teams
+     * 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.
@@ -13,10 +13,10 @@ export declare class Teams extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
     /**
-     * Create Team
+     * 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
@@ -27,20 +27,20 @@ export declare class Teams extends Service {
      * @param {string[]} roles
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
     /**
-     * Get Team
+     * Get team
      *
      * Get a team by its ID. All team members have read access for this resource.
      *
      * @param {string} teamId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>>;
     /**
-     * Update Name
+     * Update name
      *
      * Update the team's name by its unique ID.
      *
@@ -48,10 +48,10 @@ export declare class Teams extends Service {
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
     /**
-     * Delete Team
+     * Delete team
      *
      * Delete a team using its ID. Only team members with the owner role can
      * delete the team.
@@ -59,10 +59,10 @@ export declare class Teams extends Service {
      * @param {string} teamId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     delete(teamId: string): Promise<{}>;
     /**
-     * List Team Logs
+     * List team logs
      *
      * Get the team activity logs list by its unique ID.
      *
@@ -70,10 +70,10 @@ export declare class Teams extends Service {
      * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listLogs(teamId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List Team Memberships
+     * 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.
@@ -83,10 +83,10 @@ export declare class Teams extends Service {
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
     /**
-     * Create Team Membership
+     * 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
@@ -101,8 +101,8 @@ export declare class Teams extends Service {
      *
      * 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](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow
-     * the user to accept the invitation to the team.
+     * 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)
@@ -112,17 +112,17 @@ export declare class Teams extends Service {
      *
      * @param {string} teamId
      * @param {string[]} roles
-     * @param {string} url
      * @param {string} email
      * @param {string} userId
      * @param {string} phone
+     * @param {string} url
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    createMembership(teamId: string, roles: string[], url: string, email?: string, userId?: string, phone?: string, name?: string): 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 team membership
      *
      * Get a team member by the membership unique id. All team members have read
      * access for this resource.
@@ -131,24 +131,25 @@ export declare class Teams extends Service {
      * @param {string} membershipId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
     /**
-     * Update Membership Roles
+     * 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](/docs/permissions).
+     * permissions](https://appwrite.io/docs/permissions).
+     *
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @param {string[]} roles
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
-    updateMembershipRoles(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
+    */
+    updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
     /**
-     * Delete Team 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
@@ -158,10 +159,10 @@ export declare class Teams extends Service {
      * @param {string} membershipId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     deleteMembership(teamId: string, membershipId: string): Promise<{}>;
     /**
-     * Update Team Membership Status
+     * 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
@@ -177,22 +178,22 @@ export declare class Teams extends Service {
      * @param {string} secret
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
     /**
-     * Get Team Preferences
+     * 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](/docs/client/account#accountGetPrefs).
+     * preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
      *
      * @param {string} teamId
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences>;
     /**
-     * Update 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
@@ -202,6 +203,6 @@ export declare class Teams extends Service {
      * @param {object} prefs
      * @throws {AppwriteException}
      * @returns {Promise}
-     */
+    */
     updatePrefs<Preferences extends Models.Preferences>(teamId: string, prefs: object): Promise<Preferences>;
 }