Backups beta

appwrite · Aug 28, 2024 · a132bc0 · a132bc0
1 parent 5b34417
commit a132bc0
Show file tree

Hide file tree

Showing 84 changed files with 3,497 additions and 809 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # Appwrite Console SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.6.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.5.10-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.6.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
+**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
 
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
@@ -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.0.1"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.1.0-rc.1"></script>
 ```
 
 

diff --git a/...examples/functions/list-specifications.md → ...examples/account/create-payment-method.md b/...examples/functions/list-specifications.md → ...examples/account/create-payment-method.md
@@ -1,11 +1,11 @@
-import { Client, Functions } from "@appwrite.io/console";
+import { Client, Account } 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 functions = new Functions(client);
+const account = new Account(client);
 
-const result = await functions.listSpecifications();
+const result = await account.createPaymentMethod();
 
 console.log(result);
diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md
@@ -7,7 +7,8 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.deleteMfaAuthenticator(
-    AuthenticatorType.Totp // type
+    AuthenticatorType.Totp, // type
+    '<OTP>' // otp
 );
 
 console.log(result);
diff --git a/docs/examples/account/delete-payment-method.md b/docs/examples/account/delete-payment-method.md
@@ -0,0 +1,13 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.deletePaymentMethod(
+    '<PAYMENT_METHOD_ID>' // paymentMethodId
+);
+
+console.log(result);
diff --git a/docs/examples/account/get-billing-address.md b/docs/examples/account/get-billing-address.md
@@ -0,0 +1,13 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.getBillingAddress(
+    '<BILLING_ADDRESS_ID>' // billingAddressId
+);
+
+console.log(result);
diff --git a/docs/examples/account/get-payment-method.md b/docs/examples/account/get-payment-method.md
@@ -0,0 +1,13 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.getPaymentMethod(
+    '<PAYMENT_METHOD_ID>' // paymentMethodId
+);
+
+console.log(result);
diff --git a/docs/examples/functions/get-template.md → ...xamples/account/list-billing-addresses.md b/docs/examples/functions/get-template.md → ...xamples/account/list-billing-addresses.md
@@ -1,13 +1,13 @@
-import { Client, Functions } from "@appwrite.io/console";
+import { Client, Account } 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 functions = new Functions(client);
+const account = new Account(client);
 
-const result = await functions.getTemplate(
-    '<TEMPLATE_ID>' // templateId
+const result = await account.listBillingAddresses(
+    '' // queries (optional)
 );
 
 console.log(result);
diff --git a/docs/examples/account/list-credits.md b/docs/examples/account/list-credits.md
@@ -0,0 +1,14 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.listCredits(
+    '<ORGANIZATION_ID>', // organizationId
+    '' // queries (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/account/list-invoices.md b/docs/examples/account/list-invoices.md
@@ -0,0 +1,13 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.listInvoices(
+    '' // queries (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/account/list-payment-methods.md b/docs/examples/account/list-payment-methods.md
@@ -0,0 +1,13 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.listPaymentMethods(
+    '' // queries (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/account/update-payment-method-mandate-options.md b/docs/examples/account/update-payment-method-mandate-options.md
@@ -0,0 +1,13 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.updatePaymentMethodMandateOptions(
+    '<PAYMENT_METHOD_ID>' // paymentMethodId
+);
+
+console.log(result);
diff --git a/docs/examples/account/update-payment-method-provider.md b/docs/examples/account/update-payment-method-provider.md
@@ -0,0 +1,15 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.updatePaymentMethodProvider(
+    '<PAYMENT_METHOD_ID>', // paymentMethodId
+    '<PROVIDER_METHOD_ID>', // providerMethodId
+    '<NAME>' // name
+);
+
+console.log(result);
diff --git a/docs/examples/account/update-payment-method.md b/docs/examples/account/update-payment-method.md
@@ -0,0 +1,15 @@
+import { Client, Account } 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 account = new Account(client);
+
+const result = await account.updatePaymentMethod(
+    '<PAYMENT_METHOD_ID>', // paymentMethodId
+    1, // expiryMonth
+    2024 // expiryYear
+);
+
+console.log(result);
diff --git a/docs/examples/backups/create-archive.md b/docs/examples/backups/create-archive.md
@@ -0,0 +1,14 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.createArchive(
+    [], // services
+    '<RESOURCE_ID>' // resourceId (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/backups/create-policy.md b/docs/examples/backups/create-policy.md
@@ -0,0 +1,19 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.createPolicy(
+    '<POLICY_ID>', // policyId
+    [], // services
+    1, // retention
+    '', // schedule
+    '<NAME>', // name (optional)
+    '<RESOURCE_ID>', // resourceId (optional)
+    false // enabled (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/backups/create-restoration.md b/docs/examples/backups/create-restoration.md
@@ -0,0 +1,16 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.createRestoration(
+    '<ARCHIVE_ID>', // archiveId
+    [], // services
+    '<NEW_RESOURCE_ID>', // newResourceId (optional)
+    '<NEW_RESOURCE_NAME>' // newResourceName (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/backups/delete-archive.md b/docs/examples/backups/delete-archive.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.deleteArchive(
+    '<ARCHIVE_ID>' // archiveId
+);
+
+console.log(result);
diff --git a/docs/examples/backups/delete-policy.md b/docs/examples/backups/delete-policy.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.deletePolicy(
+    '<POLICY_ID>' // policyId
+);
+
+console.log(result);
diff --git a/docs/examples/backups/get-archive.md b/docs/examples/backups/get-archive.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.getArchive(
+    '<ARCHIVE_ID>' // archiveId
+);
+
+console.log(result);
diff --git a/docs/examples/backups/get-policy.md b/docs/examples/backups/get-policy.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.getPolicy(
+    '<POLICY_ID>' // policyId
+);
+
+console.log(result);
diff --git a/docs/examples/backups/get-restoration.md b/docs/examples/backups/get-restoration.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.getRestoration(
+    '<RESTORATION_ID>' // restorationId
+);
+
+console.log(result);
diff --git a/docs/examples/backups/list-archives.md b/docs/examples/backups/list-archives.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.listArchives(
+    '' // queries (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/backups/list-policies.md b/docs/examples/backups/list-policies.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.listPolicies(
+    '' // queries (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/backups/list-restorations.md b/docs/examples/backups/list-restorations.md
@@ -0,0 +1,13 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.listRestorations(
+    '' // queries (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/backups/update-policy.md b/docs/examples/backups/update-policy.md
@@ -0,0 +1,17 @@
+import { Client, Backups } 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 backups = new Backups(client);
+
+const result = await backups.updatePolicy(
+    '<POLICY_ID>', // policyId
+    '<NAME>', // name (optional)
+    1, // retention (optional)
+    '', // schedule (optional)
+    false // enabled (optional)
+);
+
+console.log(result);
diff --git a/docs/examples/console/create-source.md b/docs/examples/console/create-source.md
@@ -0,0 +1,17 @@
+import { Client, Console } 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 console = new Console(client);
+
+const result = await console.createSource(
+    '<REF>', // ref (optional)
+    'https://example.com', // referrer (optional)
+    '<UTM_SOURCE>', // utmSource (optional)
+    '<UTM_CAMPAIGN>', // utmCampaign (optional)
+    '<UTM_MEDIUM>' // utmMedium (optional)
+);
+
+console.log(result);