node-appwrite 12.1.0-rc.4 → 13.0.0

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)
-);

package/docs/examples/databases/create-index.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.createIndex(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    sdk.IndexType.Key, // type
-    [], // attributes
-    [] // orders (optional)
-);

package/docs/examples/databases/create-integer-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.createIntegerAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    null, // min (optional)
-    null, // max (optional)
-    null, // default (optional)
-    false // array (optional)
-);

package/docs/examples/databases/create-ip-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.createIpAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    '', // default (optional)
-    false // array (optional)
-);

package/docs/examples/databases/create-relationship-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.createRelationshipAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<RELATED_COLLECTION_ID>', // relatedCollectionId
-    sdk.RelationshipType.OneToOne, // type
-    false, // twoWay (optional)
-    '', // key (optional)
-    '', // twoWayKey (optional)
-    sdk.RelationMutate.Cascade // onDelete (optional)
-);

package/docs/examples/databases/create-string-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.createStringAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    1, // size
-    false, // required
-    '<DEFAULT>', // default (optional)
-    false, // array (optional)
-    false // encrypt (optional)
-);

package/docs/examples/databases/create-url-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.createUrlAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    'https://example.com', // default (optional)
-    false // array (optional)
-);

package/docs/examples/databases/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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.create(
-    '<DATABASE_ID>', // databaseId
-    '<NAME>', // name
-    false // enabled (optional)
-);

package/docs/examples/databases/delete-attribute.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.deleteAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '' // key
-);

package/docs/examples/databases/delete-collection.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.deleteCollection(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>' // collectionId
-);

package/docs/examples/databases/delete-document.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 databases = new sdk.Databases(client);
-
-const result = await databases.deleteDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>' // documentId
-);

package/docs/examples/databases/delete-index.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.deleteIndex(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '' // key
-);

package/docs/examples/databases/delete.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.delete(
-    '<DATABASE_ID>' // databaseId
-);

package/docs/examples/databases/get-attribute.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.getAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '' // key
-);

package/docs/examples/databases/get-collection.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.getCollection(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>' // collectionId
-);

package/docs/examples/databases/get-document.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 databases = new sdk.Databases(client);
-
-const result = await databases.getDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    [] // queries (optional)
-);

package/docs/examples/databases/get-index.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.getIndex(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '' // key
-);

package/docs/examples/databases/get.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.get(
-    '<DATABASE_ID>' // databaseId
-);

package/docs/examples/databases/list-attributes.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.listAttributes(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    [] // queries (optional)
-);

package/docs/examples/databases/list-collections.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.listCollections(
-    '<DATABASE_ID>', // databaseId
-    [], // queries (optional)
-    '<SEARCH>' // search (optional)
-);

package/docs/examples/databases/list-documents.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 databases = new sdk.Databases(client);
-
-const result = await databases.listDocuments(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    [] // queries (optional)
-);

package/docs/examples/databases/list-indexes.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.listIndexes(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    [] // queries (optional)
-);

package/docs/examples/databases/list.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.list(
-    [], // queries (optional)
-    '<SEARCH>' // search (optional)
-);

package/docs/examples/databases/update-boolean-attribute.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.updateBooleanAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    false // default
-);

package/docs/examples/databases/update-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.updateCollection(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<NAME>', // name
-    ["read("any")"], // permissions (optional)
-    false, // documentSecurity (optional)
-    false // enabled (optional)
-);

package/docs/examples/databases/update-datetime-attribute.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
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
-
-const databases = new sdk.Databases(client);
-
-const result = await databases.updateDatetimeAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '', // key
-    false, // required
-    '' // default
-);