@appwrite.io/console 1.8.0 → 1.10.0

package/src/services/storage.ts

@@ -42,6 +42,7 @@ export class Storage {
             payload
         );
     }
+
     /**
      * Create a new storage bucket.
      *
@@ -110,6 +111,7 @@ export class Storage {
             payload
         );
     }
+
     /**
      * Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
      *
@@ -135,6 +137,7 @@ export class Storage {
             payload
         );
     }
+
     /**
      * Update a storage bucket by its unique ID.
      *
@@ -200,6 +203,7 @@ export class Storage {
             payload
         );
     }
+
     /**
      * Delete a storage bucket by its unique ID.
      *
@@ -226,6 +230,7 @@ export class Storage {
             payload
         );
     }
+
     /**
      * Get a list of all the user files. You can use the query params to filter your results.
      *
@@ -259,15 +264,16 @@ export class Storage {
             payload
         );
     }
+
     /**
      * 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.
-
+     * 
+     * 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.
+     * 
      *
      * @param {string} bucketId
      * @param {string} fileId
@@ -311,6 +317,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
             onProgress
         );
     }
+
     /**
      * Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
      *
@@ -340,6 +347,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
             payload
         );
     }
+
     /**
      * Update a file by its unique ID. Only users with write permissions have access to update this resource.
      *
@@ -378,6 +386,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
             payload
         );
     }
+
     /**
      * Delete a file by its unique ID. Only users with write permissions have access to delete this resource.
      *
@@ -408,6 +417,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
             payload
         );
     }
+
     /**
      * 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.
      *
@@ -442,6 +452,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
         
         return uri.toString();
     }
+
     /**
      * 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.
      *
@@ -520,6 +531,7 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
         
         return uri.toString();
     }
+
     /**
      * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no  'Content-Disposition: attachment' header.
      *
@@ -554,9 +566,10 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
         
         return uri.toString();
     }
+
     /**
      * 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.
-
+     * 
      *
      * @param {StorageUsageRange} range
      * @throws {AppwriteException}
@@ -580,9 +593,10 @@ If you're creating a new file using one of the Appwrite SDKs, all the chunk
             payload
         );
     }
+
     /**
      * 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.
-
+     * 
      *
      * @param {string} bucketId
      * @param {StorageUsageRange} range

package/src/services/teams.ts

@@ -17,7 +17,7 @@ export class Teams {
      * @throws {AppwriteException}
      * @returns {Promise<Models.TeamList<Preferences>>}
      */
-    list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>> {
+    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>> {
         const apiPath = '/teams';
         const payload: Payload = {};
         if (typeof queries !== 'undefined') {
@@ -38,6 +38,7 @@ export class Teams {
             payload
         );
     }
+
     /**
      * 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.
      *
@@ -47,7 +48,7 @@ export class Teams {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Team<Preferences>>}
      */
-    create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>> {
+    create<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
@@ -78,6 +79,7 @@ export class Teams {
             payload
         );
     }
+
     /**
      * Get a team by its ID. All team members have read access for this resource.
      *
@@ -85,7 +87,7 @@ export class Teams {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Team<Preferences>>}
      */
-    get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>> {
+    get<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string): Promise<Models.Team<Preferences>> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
@@ -103,6 +105,7 @@ export class Teams {
             payload
         );
     }
+
     /**
      * Update the team&#039;s name by its unique ID.
      *
@@ -111,7 +114,7 @@ export class Teams {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Team<Preferences>>}
      */
-    updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>> {
+    updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, name: string): Promise<Models.Team<Preferences>> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
@@ -136,6 +139,7 @@ export class Teams {
             payload
         );
     }
+
     /**
      * Delete a team using its ID. Only team members with the owner role can delete the team.
      *
@@ -162,6 +166,7 @@ export class Teams {
             payload
         );
     }
+
     /**
      * Get the team activity logs list by its unique ID.
      *
@@ -191,6 +196,7 @@ export class Teams {
             payload
         );
     }
+
     /**
      * 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. Hide sensitive attributes from the response by toggling membership privacy in the Console.
      *
@@ -224,15 +230,16 @@ export class Teams {
             payload
         );
     }
+
     /**
      * 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.
-
+     * 
+     * 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
@@ -284,6 +291,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
             payload
         );
     }
+
     /**
      * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.
      *
@@ -313,9 +321,10 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
             payload
         );
     }
+
     /**
      * 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
@@ -351,6 +360,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
             payload
         );
     }
+
     /**
      * 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.
      *
@@ -381,11 +391,12 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
             payload
         );
     }
+
     /**
      * 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.
-
+     * 
+     * If the request is successful, a session for the user is automatically created.
+     * 
      *
      * @param {string} teamId
      * @param {string} membershipId
@@ -428,6 +439,7 @@ If the request is successful, a session for the user is automatically created.
             payload
         );
     }
+
     /**
      * 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).
      *
@@ -435,7 +447,7 @@ If the request is successful, a session for the user is automatically created.
      * @throws {AppwriteException}
      * @returns {Promise<Preferences>}
      */
-    getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences> {
+    getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string): Promise<Preferences> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
@@ -453,6 +465,7 @@ If the request is successful, a session for the user is automatically created.
             payload
         );
     }
+
     /**
      * 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.
      *
@@ -461,7 +474,7 @@ If the request is successful, a session for the user is automatically created.
      * @throws {AppwriteException}
      * @returns {Promise<Preferences>}
      */
-    updatePrefs<Preferences extends Models.Preferences>(teamId: string, prefs: object): Promise<Preferences> {
+    updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(teamId: string, prefs: object): Promise<Preferences> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }

package/src/services/tokens.ts

@@ -42,6 +42,7 @@ export class Tokens {
             payload
         );
     }
+
     /**
      * Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.
      *
@@ -76,6 +77,7 @@ export class Tokens {
             payload
         );
     }
+
     /**
      * Get a token by its unique ID.
      *
@@ -101,6 +103,7 @@ export class Tokens {
             payload
         );
     }
+
     /**
      * Update a token by its unique ID. Use this endpoint to update a token's expiry date.
      *
@@ -131,6 +134,7 @@ export class Tokens {
             payload
         );
     }
+
     /**
      * Delete a token by its unique ID.
      *