Merge pull request #29 from appwrite/dev

christyjacob4 · web-flow · commit 3222d4e47fdd · 2024-11-06T18:34:22.000+01:00
feat: add update teams sensitive attributes
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.4.1"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.4.2"></script>
 ```
 
 
diff --git a/docs/examples/databases/update-string-attribute.md b/docs/examples/databases/update-string-attribute.md
@@ -12,7 +12,7 @@ const result = await databases.updateStringAttribute(
     '', // key
     false, // required
     '<DEFAULT>', // default
-    null, // size (optional)
+    1, // size (optional)
     '' // newKey (optional)
 );
 
diff --git a/docs/examples/projects/update-teams-sensitive-attributes.md b/docs/examples/projects/update-teams-sensitive-attributes.md
@@ -0,0 +1,14 @@
+import { Client, Projects } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const projects = new Projects(client);
+
+const result = await projects.updateTeamsSensitiveAttributes(
+    '<PROJECT_ID>', // projectId
+    false // enabled
+);
+
+console.log(result);
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "@appwrite.io/console",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
diff --git a/src/client.ts b/src/client.ts
@@ -304,7 +304,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '1.4.1',
+        'x-sdk-version': '1.4.2',
         'X-Appwrite-Response-Format': '1.6.0',
     };
 
diff --git a/src/enums/runtime.ts b/src/enums/runtime.ts
@@ -53,4 +53,5 @@ export enum Runtime {
     Bun10 = 'bun-1.0',
     Bun11 = 'bun-1.1',
     Go123 = 'go-1.23',
+    Static1 = 'static-1',
 }
diff --git a/src/models.ts b/src/models.ts
@@ -1848,11 +1848,11 @@ export namespace Models {
          */
         userId: string;
         /**
-         * User name.
+         * User name. Hide this attribute by disabling teams sensitive data in the Console.
          */
         userName: string;
         /**
-         * User email address.
+         * User email address. Hide this attribute by disabling teams sensitive data in the Console.
          */
         userEmail: string;
         /**
@@ -1876,7 +1876,7 @@ export namespace Models {
          */
         confirm: boolean;
         /**
-         * Multi factor authentication status, true if the user has MFA enabled or false otherwise.
+         * Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by disabling teams sensitive data in the Console.
          */
         mfa: boolean;
         /**
@@ -2549,6 +2549,10 @@ export namespace Models {
          * Whether or not to send session alert emails to users.
          */
         authSessionAlerts: boolean;
+        /**
+         * Whether or not to show sensitive attributes in the teams API.
+         */
+        teamsSensitiveAttributes: boolean;
         /**
          * List of Auth Providers.
          */
@@ -3979,6 +3983,10 @@ export namespace Models {
          * The target identifier.
          */
         identifier: string;
+        /**
+         * Is the target expired.
+         */
+        expired: boolean;
     }
     /**
      * Migration
@@ -4009,7 +4017,11 @@ export namespace Models {
          */
         source: string;
         /**
-         * Resources to migration.
+         * A string containing the type of destination of the migration.
+         */
+        destination: string;
+        /**
+         * Resources to migrate.
          */
         resources: string[];
         /**
diff --git a/src/services/projects.ts b/src/services/projects.ts
@@ -614,6 +614,41 @@ export class Projects {
         }
 
 
+        return await this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * Update project team sensitive attributes
+     *
+     *
+     * @param {string} projectId
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Project>}
+     */
+    async updateTeamsSensitiveAttributes(projectId: string, enabled: boolean): Promise<Models.Project> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+        if (typeof enabled === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "enabled"');
+        }
+        const apiPath = '/projects/{projectId}/auth/teams-sensitive-attributes'.replace('{projectId}', projectId);
+        const payload: Payload = {};
+        if (typeof enabled !== 'undefined') {
+            payload['enabled'] = enabled;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+
         return await this.client.call(
             'patch',
             uri,
diff --git a/src/services/teams.ts b/src/services/teams.ts
@@ -215,7 +215,7 @@ export class Teams {
     /**
      * List team memberships
      *
-     * 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.
+     * 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 (userName, userEmail and mfa) from the response by disabling teams sensitive data in the Console.
      *
      * @param {string} teamId
      * @param {string[]} queries
@@ -315,7 +315,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
     /**
      * 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. Hide sensitive attributes (userName, userEmail and mfa) from the response by disabling teams sensitive data in the Console.
      *
      * @param {string} teamId
      * @param {string} membershipId

-Original file line number
+Diff line change
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 ```html
 -<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/[email protected].1"></script>
 +<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/[email protected].2"></script>
 ```
Original file line number	Diff line number	Diff line change
`@@ -53,4 +53,5 @@ export enum Runtime {`
`53`	`53`	`Bun10 = 'bun-1.0',`
`54`	`54`	`Bun11 = 'bun-1.1',`
`55`	`55`	`Go123 = 'go-1.23',`
	`56`	`+ Static1 = 'static-1',`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ export class Teams {`
`215`	`215`	`/**`
`216`	`216`	`* List team memberships`
`217`	`217`	`*`
`218`		`- * Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.`
	`218`	`+ * Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes (userName, userEmail and mfa) from the response by disabling teams sensitive data in the Console.`
`219`	`219`	`*`
`220`	`220`	`* @param {string} teamId`
`221`	`221`	`* @param {string[]} queries`
`@@ -315,7 +315,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee`
`315`	`315`	`/**`
`316`	`316`	`* Get team membership`
`317`	`317`	`*`
`318`		`- * Get a team member by the membership unique id. All team members have read access for this resource.`
	`318`	`+ * Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes (userName, userEmail and mfa) from the response by disabling teams sensitive data in the Console.`
`319`	`319`	`*`
`320`	`320`	`* @param {string} teamId`
`321`	`321`	`* @param {string} membershipId`