@appwrite.io/console 8.1.0 → 8.1.1

package/docs/examples/tablesdb/update-url-column.md

@@ -1,20 +0,0 @@
-```javascript
-import { Client, TablesDB } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tablesDB = new TablesDB(client);
-
-const result = await tablesDB.updateUrlColumn({
-    databaseId: '<DATABASE_ID>',
-    tableId: '<TABLE_ID>',
-    key: '',
-    required: false,
-    default: 'https://example.com',
-    newKey: '' // optional
-});
-
-console.log(result);
-```

package/docs/examples/tablesdb/update-varchar-column.md

@@ -1,21 +0,0 @@
-```javascript
-import { Client, TablesDB } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tablesDB = new TablesDB(client);
-
-const result = await tablesDB.updateVarcharColumn({
-    databaseId: '<DATABASE_ID>',
-    tableId: '<TABLE_ID>',
-    key: '',
-    required: false,
-    default: '<DEFAULT>',
-    size: 1, // optional
-    newKey: '' // optional
-});
-
-console.log(result);
-```

package/docs/examples/tablesdb/update.md

@@ -1,17 +0,0 @@
-```javascript
-import { Client, TablesDB } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tablesDB = new TablesDB(client);
-
-const result = await tablesDB.update({
-    databaseId: '<DATABASE_ID>',
-    name: '<NAME>', // optional
-    enabled: false // optional
-});
-
-console.log(result);
-```

package/docs/examples/tablesdb/upsert-row.md

@@ -1,26 +0,0 @@
-```javascript
-import { Client, TablesDB, Permission, Role } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tablesDB = new TablesDB(client);
-
-const result = await tablesDB.upsertRow({
-    databaseId: '<DATABASE_ID>',
-    tableId: '<TABLE_ID>',
-    rowId: '<ROW_ID>',
-    data: {
-        "username": "walter.obrien",
-        "email": "walter.obrien@example.com",
-        "fullName": "Walter O'Brien",
-        "age": 33,
-        "isAdmin": false
-    }, // optional
-    permissions: [Permission.read(Role.any())], // optional
-    transactionId: '<TRANSACTION_ID>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/tablesdb/upsert-rows.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, TablesDB } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tablesDB = new TablesDB(client);
-
-const result = await tablesDB.upsertRows({
-    databaseId: '<DATABASE_ID>',
-    tableId: '<TABLE_ID>',
-    rows: [],
-    transactionId: '<TRANSACTION_ID>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/teams/create-membership.md

@@ -1,21 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.createMembership({
-    teamId: '<TEAM_ID>',
-    roles: [],
-    email: 'email@example.com', // optional
-    userId: '<USER_ID>', // optional
-    phone: '+12065550100', // optional
-    url: 'https://example.com', // optional
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/teams/create.md

@@ -1,17 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.create({
-    teamId: '<TEAM_ID>',
-    name: '<NAME>',
-    roles: [] // optional
-});
-
-console.log(result);
-```

package/docs/examples/teams/delete-membership.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.deleteMembership({
-    teamId: '<TEAM_ID>',
-    membershipId: '<MEMBERSHIP_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/teams/delete.md

@@ -1,15 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.delete({
-    teamId: '<TEAM_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/teams/get-membership.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.getMembership({
-    teamId: '<TEAM_ID>',
-    membershipId: '<MEMBERSHIP_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/teams/get-prefs.md

@@ -1,15 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.getPrefs({
-    teamId: '<TEAM_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/teams/get.md

@@ -1,15 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.get({
-    teamId: '<TEAM_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/teams/list-logs.md

@@ -1,17 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.listLogs({
-    teamId: '<TEAM_ID>',
-    queries: [], // optional
-    total: false // optional
-});
-
-console.log(result);
-```

package/docs/examples/teams/list-memberships.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.listMemberships({
-    teamId: '<TEAM_ID>',
-    queries: [], // optional
-    search: '<SEARCH>', // optional
-    total: false // optional
-});
-
-console.log(result);
-```

package/docs/examples/teams/list.md

@@ -1,17 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.list({
-    queries: [], // optional
-    search: '<SEARCH>', // optional
-    total: false // optional
-});
-
-console.log(result);
-```

package/docs/examples/teams/update-membership-status.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.updateMembershipStatus({
-    teamId: '<TEAM_ID>',
-    membershipId: '<MEMBERSHIP_ID>',
-    userId: '<USER_ID>',
-    secret: '<SECRET>'
-});
-
-console.log(result);
-```

package/docs/examples/teams/update-membership.md

@@ -1,17 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.updateMembership({
-    teamId: '<TEAM_ID>',
-    membershipId: '<MEMBERSHIP_ID>',
-    roles: []
-});
-
-console.log(result);
-```

package/docs/examples/teams/update-name.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.updateName({
-    teamId: '<TEAM_ID>',
-    name: '<NAME>'
-});
-
-console.log(result);
-```

package/docs/examples/teams/update-prefs.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Teams } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const teams = new Teams(client);
-
-const result = await teams.updatePrefs({
-    teamId: '<TEAM_ID>',
-    prefs: {}
-});
-
-console.log(result);
-```

package/docs/examples/tokens/create-file-token.md

@@ -1,17 +0,0 @@
-```javascript
-import { Client, Tokens } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tokens = new Tokens(client);
-
-const result = await tokens.createFileToken({
-    bucketId: '<BUCKET_ID>',
-    fileId: '<FILE_ID>',
-    expire: '' // optional
-});
-
-console.log(result);
-```

package/docs/examples/tokens/delete.md

@@ -1,15 +0,0 @@
-```javascript
-import { Client, Tokens } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tokens = new Tokens(client);
-
-const result = await tokens.delete({
-    tokenId: '<TOKEN_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/tokens/get.md

@@ -1,15 +0,0 @@
-```javascript
-import { Client, Tokens } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tokens = new Tokens(client);
-
-const result = await tokens.get({
-    tokenId: '<TOKEN_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/tokens/list.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, Tokens } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tokens = new Tokens(client);
-
-const result = await tokens.list({
-    bucketId: '<BUCKET_ID>',
-    fileId: '<FILE_ID>',
-    queries: [], // optional
-    total: false // optional
-});
-
-console.log(result);
-```

package/docs/examples/tokens/update.md

@@ -1,16 +0,0 @@
-```javascript
-import { Client, Tokens } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const tokens = new Tokens(client);
-
-const result = await tokens.update({
-    tokenId: '<TOKEN_ID>',
-    expire: '' // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-argon-2-user.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createArgon2User({
-    userId: '<USER_ID>',
-    email: 'email@example.com',
-    password: 'password',
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-bcrypt-user.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createBcryptUser({
-    userId: '<USER_ID>',
-    email: 'email@example.com',
-    password: 'password',
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-jwt.md

@@ -1,17 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createJWT({
-    userId: '<USER_ID>',
-    sessionId: '<SESSION_ID>', // optional
-    duration: 0 // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-md-5-user.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createMD5User({
-    userId: '<USER_ID>',
-    email: 'email@example.com',
-    password: 'password',
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-mfa-recovery-codes.md

@@ -1,15 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createMFARecoveryCodes({
-    userId: '<USER_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/users/create-ph-pass-user.md

@@ -1,18 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createPHPassUser({
-    userId: '<USER_ID>',
-    email: 'email@example.com',
-    password: 'password',
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-scrypt-modified-user.md

@@ -1,21 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createScryptModifiedUser({
-    userId: '<USER_ID>',
-    email: 'email@example.com',
-    password: 'password',
-    passwordSalt: '<PASSWORD_SALT>',
-    passwordSaltSeparator: '<PASSWORD_SALT_SEPARATOR>',
-    passwordSignerKey: '<PASSWORD_SIGNER_KEY>',
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-scrypt-user.md

@@ -1,23 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createScryptUser({
-    userId: '<USER_ID>',
-    email: 'email@example.com',
-    password: 'password',
-    passwordSalt: '<PASSWORD_SALT>',
-    passwordCpu: null,
-    passwordMemory: null,
-    passwordParallel: null,
-    passwordLength: null,
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```

package/docs/examples/users/create-session.md

@@ -1,15 +0,0 @@
-```javascript
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createSession({
-    userId: '<USER_ID>'
-});
-
-console.log(result);
-```

package/docs/examples/users/create-sha-user.md

@@ -1,19 +0,0 @@
-```javascript
-import { Client, Users, PasswordHash } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createSHAUser({
-    userId: '<USER_ID>',
-    email: 'email@example.com',
-    password: 'password',
-    passwordVersion: PasswordHash.Sha1, // optional
-    name: '<NAME>' // optional
-});
-
-console.log(result);
-```