node-appwrite 12.0.1 → 13.0.0

package/docs/examples/account/create.md

@@ -1,14 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
-
-const account = new sdk.Account(client);
-
-const result = await account.create(
-    '<USER_ID>', // userId
-    'email@example.com', // email
-    '', // password
-    '<NAME>' // name (optional)
-);

package/docs/examples/account/delete-identity.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.deleteIdentity(
-    '<IDENTITY_ID>' // identityId
-);

package/docs/examples/account/delete-mfa-authenticator.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.deleteMfaAuthenticator(
-    sdk.AuthenticatorType.Totp, // type
-    '<OTP>' // otp
-);

package/docs/examples/account/delete-session.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.deleteSession(
-    '<SESSION_ID>' // sessionId
-);

package/docs/examples/account/delete-sessions.md

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.deleteSessions();

package/docs/examples/account/get-mfa-recovery-codes.md

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.getMfaRecoveryCodes();

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

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.getPrefs();

package/docs/examples/account/get-session.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.getSession(
-    '<SESSION_ID>' // sessionId
-);

package/docs/examples/account/get.md

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.get();

package/docs/examples/account/list-identities.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.listIdentities(
-    [] // queries (optional)
-);

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

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.listLogs(
-    [] // queries (optional)
-);

package/docs/examples/account/list-mfa-factors.md

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.listMfaFactors();

package/docs/examples/account/list-sessions.md

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.listSessions();

package/docs/examples/account/update-email.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateEmail(
-    'email@example.com', // email
-    'password' // password
-);

package/docs/examples/account/update-m-f-a.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateMFA(
-    false // mfa
-);

package/docs/examples/account/update-magic-u-r-l-session.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
-
-const account = new sdk.Account(client);
-
-const result = await account.updateMagicURLSession(
-    '<USER_ID>', // userId
-    '<SECRET>' // secret
-);

package/docs/examples/account/update-mfa-authenticator.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateMfaAuthenticator(
-    sdk.AuthenticatorType.Totp, // type
-    '<OTP>' // otp
-);

package/docs/examples/account/update-mfa-challenge.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateMfaChallenge(
-    '<CHALLENGE_ID>', // challengeId
-    '<OTP>' // otp
-);

package/docs/examples/account/update-mfa-recovery-codes.md

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateMfaRecoveryCodes();

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

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateName(
-    '<NAME>' // name
-);

package/docs/examples/account/update-password.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updatePassword(
-    '', // password
-    'password' // oldPassword (optional)
-);

package/docs/examples/account/update-phone-session.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2'); // Your project ID
-
-const account = new sdk.Account(client);
-
-const result = await account.updatePhoneSession(
-    '<USER_ID>', // userId
-    '<SECRET>' // secret
-);

package/docs/examples/account/update-phone-verification.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updatePhoneVerification(
-    '<USER_ID>', // userId
-    '<SECRET>' // secret
-);

package/docs/examples/account/update-phone.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updatePhone(
-    '+12065550100', // phone
-    'password' // password
-);

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

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updatePrefs(
-    {} // prefs
-);

package/docs/examples/account/update-recovery.md

@@ -1,14 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateRecovery(
-    '<USER_ID>', // userId
-    '<SECRET>', // secret
-    '' // password
-);

package/docs/examples/account/update-session.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateSession(
-    '<SESSION_ID>' // sessionId
-);

package/docs/examples/account/update-status.md

@@ -1,10 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateStatus();

package/docs/examples/account/update-verification.md

@@ -1,13 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const account = new sdk.Account(client);
-
-const result = await account.updateVerification(
-    '<USER_ID>', // userId
-    '<SECRET>' // secret
-);

package/docs/examples/avatars/get-browser.md

@@ -1,15 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const avatars = new sdk.Avatars(client);
-
-const result = await avatars.getBrowser(
-    sdk.Browser.AvantBrowser, // code
-    0, // width (optional)
-    0, // height (optional)
-    0 // quality (optional)
-);

package/docs/examples/avatars/get-credit-card.md

@@ -1,15 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const avatars = new sdk.Avatars(client);
-
-const result = await avatars.getCreditCard(
-    sdk.CreditCard.AmericanExpress, // code
-    0, // width (optional)
-    0, // height (optional)
-    0 // quality (optional)
-);

package/docs/examples/avatars/get-favicon.md

@@ -1,12 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const avatars = new sdk.Avatars(client);
-
-const result = await avatars.getFavicon(
-    'https://example.com' // url
-);

package/docs/examples/avatars/get-flag.md

@@ -1,15 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const avatars = new sdk.Avatars(client);
-
-const result = await avatars.getFlag(
-    sdk.Flag.Afghanistan, // code
-    0, // width (optional)
-    0, // height (optional)
-    0 // quality (optional)
-);

package/docs/examples/avatars/get-image.md

@@ -1,14 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const avatars = new sdk.Avatars(client);
-
-const result = await avatars.getImage(
-    'https://example.com', // url
-    0, // width (optional)
-    0 // height (optional)
-);

package/docs/examples/avatars/get-initials.md

@@ -1,15 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const avatars = new sdk.Avatars(client);
-
-const result = await avatars.getInitials(
-    '<NAME>', // name (optional)
-    0, // width (optional)
-    0, // height (optional)
-    '' // background (optional)
-);

package/docs/examples/avatars/get-q-r.md

@@ -1,15 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const avatars = new sdk.Avatars(client);
-
-const result = await avatars.getQR(
-    '<TEXT>', // text
-    1, // size (optional)
-    0, // margin (optional)
-    false // download (optional)
-);

package/docs/examples/databases/create-boolean-attribute.md

@@ -1,17 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.createBooleanAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    false, // default (optional)
-    false // array (optional)
-);

package/docs/examples/databases/create-collection.md

@@ -1,17 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.createCollection(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<NAME>', // name
-    ["read("any")"], // permissions (optional)
-    false, // documentSecurity (optional)
-    false // enabled (optional)
-);

package/docs/examples/databases/create-datetime-attribute.md

@@ -1,17 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.createDatetimeAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    '', // default (optional)
-    false // array (optional)
-);

package/docs/examples/databases/create-document.md

@@ -1,16 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setSession(''); // The user session to authenticate with
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.createDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    {}, // data
-    ["read("any")"] // permissions (optional)
-);

package/docs/examples/databases/create-email-attribute.md

@@ -1,17 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.createEmailAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    'email@example.com', // default (optional)
-    false // array (optional)
-);

package/docs/examples/databases/create-enum-attribute.md

@@ -1,18 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.createEnumAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    [], // elements
-    false, // required
-    '<DEFAULT>', // default (optional)
-    false // array (optional)
-);

package/docs/examples/databases/create-float-attribute.md

@@ -1,19 +0,0 @@
-const sdk = require('node-appwrite');
-
-const client = new sdk.Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.createFloatAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    null, // min (optional)
-    null, // max (optional)
-    null, // default (optional)
-    false // array (optional)
-);