react-native-appwrite 0.11.0 → 0.12.0

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

@@ -6,11 +6,11 @@ const client = new Client()
 
 const avatars = new Avatars(client);
 
-const result = avatars.getInitials(
-    '<NAME>', // name (optional)
-    0, // width (optional)
-    0, // height (optional)
-    '' // background (optional)
-);
+const result = avatars.getInitials({
+    name: '<NAME>', // optional
+    width: 0, // optional
+    height: 0, // optional
+    background: '' // optional
+});
 
 console.log(result);

package/docs/examples/avatars/{get-q-r.md → get-qr.md}

@@ -6,11 +6,11 @@ const client = new Client()
 
 const avatars = new Avatars(client);
 
-const result = avatars.getQR(
-    '<TEXT>', // text
-    1, // size (optional)
-    0, // margin (optional)
-    false // download (optional)
-);
+const result = avatars.getQR({
+    text: '<TEXT>',
+    size: 1, // optional
+    margin: 0, // optional
+    download: false // optional
+});
 
 console.log(result);

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

@@ -6,12 +6,12 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.createDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    {}, // data
-    ["read("any")"] // permissions (optional)
-);
+const result = await databases.createDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    data: {},
+    permissions: ["read("any")"] // optional
+});
 
 console.log(result);

package/docs/examples/databases/decrement-document-attribute.md

@@ -6,13 +6,13 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.decrementDocumentAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    '', // attribute
-    null, // value (optional)
-    null // min (optional)
-);
+const result = await databases.decrementDocumentAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    attribute: '',
+    value: null, // optional
+    min: null // optional
+});
 
 console.log(result);

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

@@ -6,10 +6,10 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.deleteDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>' // documentId
-);
+const result = await databases.deleteDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>'
+});
 
 console.log(result);

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

@@ -6,11 +6,11 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.getDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    [] // queries (optional)
-);
+const result = await databases.getDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    queries: [] // optional
+});
 
 console.log(result);

package/docs/examples/databases/increment-document-attribute.md

@@ -6,13 +6,13 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.incrementDocumentAttribute(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    '', // attribute
-    null, // value (optional)
-    null // max (optional)
-);
+const result = await databases.incrementDocumentAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    attribute: '',
+    value: null, // optional
+    max: null // optional
+});
 
 console.log(result);

package/docs/examples/databases/list-documents.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.listDocuments(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    [] // queries (optional)
-);
+const result = await databases.listDocuments({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    queries: [] // optional
+});
 
 console.log(result);

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

@@ -6,12 +6,12 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.updateDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    {}, // data (optional)
-    ["read("any")"] // permissions (optional)
-);
+const result = await databases.updateDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    data: {}, // optional
+    permissions: ["read("any")"] // optional
+});
 
 console.log(result);

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

@@ -6,12 +6,12 @@ const client = new Client()
 
 const databases = new Databases(client);
 
-const result = await databases.upsertDocument(
-    '<DATABASE_ID>', // databaseId
-    '<COLLECTION_ID>', // collectionId
-    '<DOCUMENT_ID>', // documentId
-    {}, // data
-    ["read("any")"] // permissions (optional)
-);
+const result = await databases.upsertDocument({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    documentId: '<DOCUMENT_ID>',
+    data: {},
+    permissions: ["read("any")"] // optional
+});
 
 console.log(result);

package/docs/examples/functions/create-execution.md

@@ -6,14 +6,14 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.createExecution(
-    '<FUNCTION_ID>', // functionId
-    '<BODY>', // body (optional)
-    false, // async (optional)
-    '<PATH>', // path (optional)
-    ExecutionMethod.GET, // method (optional)
-    {}, // headers (optional)
-    '' // scheduledAt (optional)
-);
+const result = await functions.createExecution({
+    functionId: '<FUNCTION_ID>',
+    body: '<BODY>', // optional
+    async: false, // optional
+    path: '<PATH>', // optional
+    method: ExecutionMethod.GET, // optional
+    headers: {}, // optional
+    scheduledAt: '<SCHEDULED_AT>' // optional
+});
 
 console.log(result);

package/docs/examples/functions/get-execution.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.getExecution(
-    '<FUNCTION_ID>', // functionId
-    '<EXECUTION_ID>' // executionId
-);
+const result = await functions.getExecution({
+    functionId: '<FUNCTION_ID>',
+    executionId: '<EXECUTION_ID>'
+});
 
 console.log(result);

package/docs/examples/functions/list-executions.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = await functions.listExecutions(
-    '<FUNCTION_ID>', // functionId
-    [] // queries (optional)
-);
+const result = await functions.listExecutions({
+    functionId: '<FUNCTION_ID>',
+    queries: [] // optional
+});
 
 console.log(result);

package/docs/examples/graphql/mutation.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const graphql = new Graphql(client);
 
-const result = await graphql.mutation(
-    {} // query
-);
+const result = await graphql.mutation({
+    query: {}
+});
 
 console.log(result);

package/docs/examples/graphql/query.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const graphql = new Graphql(client);
 
-const result = await graphql.query(
-    {} // query
-);
+const result = await graphql.query({
+    query: {}
+});
 
 console.log(result);

package/docs/examples/messaging/create-subscriber.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const messaging = new Messaging(client);
 
-const result = await messaging.createSubscriber(
-    '<TOPIC_ID>', // topicId
-    '<SUBSCRIBER_ID>', // subscriberId
-    '<TARGET_ID>' // targetId
-);
+const result = await messaging.createSubscriber({
+    topicId: '<TOPIC_ID>',
+    subscriberId: '<SUBSCRIBER_ID>',
+    targetId: '<TARGET_ID>'
+});
 
 console.log(result);

package/docs/examples/messaging/delete-subscriber.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const messaging = new Messaging(client);
 
-const result = await messaging.deleteSubscriber(
-    '<TOPIC_ID>', // topicId
-    '<SUBSCRIBER_ID>' // subscriberId
-);
+const result = await messaging.deleteSubscriber({
+    topicId: '<TOPIC_ID>',
+    subscriberId: '<SUBSCRIBER_ID>'
+});
 
 console.log(result);

package/docs/examples/storage/create-file.md

@@ -6,11 +6,11 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = await storage.createFile(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>', // fileId
-    await pickSingle(), // file
-    ["read("any")"] // permissions (optional)
-);
+const result = await storage.createFile({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>',
+    file: await pickSingle(),
+    permissions: ["read("any")"] // optional
+});
 
 console.log(result);

package/docs/examples/storage/delete-file.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = await storage.deleteFile(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>' // fileId
-);
+const result = await storage.deleteFile({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>'
+});
 
 console.log(result);

package/docs/examples/storage/get-file-download.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = storage.getFileDownload(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>', // fileId
-    '<TOKEN>' // token (optional)
-);
+const result = storage.getFileDownload({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>',
+    token: '<TOKEN>' // optional
+});
 
 console.log(result);

package/docs/examples/storage/get-file-preview.md

@@ -6,21 +6,21 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = storage.getFilePreview(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>', // fileId
-    0, // width (optional)
-    0, // height (optional)
-    ImageGravity.Center, // gravity (optional)
-    -1, // quality (optional)
-    0, // borderWidth (optional)
-    '', // borderColor (optional)
-    0, // borderRadius (optional)
-    0, // opacity (optional)
-    -360, // rotation (optional)
-    '', // background (optional)
-    ImageFormat.Jpg, // output (optional)
-    '<TOKEN>' // token (optional)
-);
+const result = storage.getFilePreview({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>',
+    width: 0, // optional
+    height: 0, // optional
+    gravity: ImageGravity.Center, // optional
+    quality: -1, // optional
+    borderWidth: 0, // optional
+    borderColor: '', // optional
+    borderRadius: 0, // optional
+    opacity: 0, // optional
+    rotation: -360, // optional
+    background: '', // optional
+    output: ImageFormat.Jpg, // optional
+    token: '<TOKEN>' // optional
+});
 
 console.log(result);

package/docs/examples/storage/get-file-view.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = storage.getFileView(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>', // fileId
-    '<TOKEN>' // token (optional)
-);
+const result = storage.getFileView({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>',
+    token: '<TOKEN>' // optional
+});
 
 console.log(result);

package/docs/examples/storage/get-file.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = await storage.getFile(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>' // fileId
-);
+const result = await storage.getFile({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>'
+});
 
 console.log(result);

package/docs/examples/storage/list-files.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = await storage.listFiles(
-    '<BUCKET_ID>', // bucketId
-    [], // queries (optional)
-    '<SEARCH>' // search (optional)
-);
+const result = await storage.listFiles({
+    bucketId: '<BUCKET_ID>',
+    queries: [], // optional
+    search: '<SEARCH>' // optional
+});
 
 console.log(result);

package/docs/examples/storage/update-file.md

@@ -6,11 +6,11 @@ const client = new Client()
 
 const storage = new Storage(client);
 
-const result = await storage.updateFile(
-    '<BUCKET_ID>', // bucketId
-    '<FILE_ID>', // fileId
-    '<NAME>', // name (optional)
-    ["read("any")"] // permissions (optional)
-);
+const result = await storage.updateFile({
+    bucketId: '<BUCKET_ID>',
+    fileId: '<FILE_ID>',
+    name: '<NAME>', // optional
+    permissions: ["read("any")"] // optional
+});
 
 console.log(result);

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

@@ -0,0 +1,17 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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.createRow({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    data: {},
+    permissions: ["read("any")"] // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/decrement-row-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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.decrementRowColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    column: '',
+    value: null, // optional
+    min: null // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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.deleteRow({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>'
+});
+
+console.log(result);

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

@@ -0,0 +1,16 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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.getRow({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    queries: [] // optional
+});
+
+console.log(result);

package/docs/examples/tablesdb/increment-row-column.md

@@ -0,0 +1,18 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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.incrementRowColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    column: '',
+    value: null, // optional
+    max: null // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,15 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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.listRows({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    queries: [] // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,17 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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.updateRow({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    rowId: '<ROW_ID>',
+    data: {}, // optional
+    permissions: ["read("any")"] // optional
+});
+
+console.log(result);

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

@@ -0,0 +1,17 @@
+import { Client, TablesDB } from "react-native-appwrite";
+
+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: {}, // optional
+    permissions: ["read("any")"] // optional
+});
+
+console.log(result);

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

@@ -6,14 +6,14 @@ const client = new Client()
 
 const teams = new Teams(client);
 
-const result = await teams.createMembership(
-    '<TEAM_ID>', // teamId
-    [], // roles
-    'email@example.com', // email (optional)
-    '<USER_ID>', // userId (optional)
-    '+12065550100', // phone (optional)
-    'https://example.com', // url (optional)
-    '<NAME>' // name (optional)
-);
+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);