Merge pull request #18 from appwrite/backups

Backups
appwrite · Oct 10, 2024 · 523c2e5 · 523c2e5
2 parents 9b464d1 + fae0fb2
commit 523c2e5
Show file tree

Hide file tree

Showing 71 changed files with 3,808 additions and 40 deletions.
diff --git a/.github/workflows/autoclose.yml b/.github/workflows/autoclose.yml
@@ -8,4 +8,4 @@ jobs:
   auto_close:
     uses: appwrite/.github/.github/workflows/autoclose.yml@main
     secrets:
-      GH_AUTO_CLOSE_PR_TOKEN: ${{ secrets.GH_AUTO_CLOSE_PR_TOKEN }}
+      GH_AUTO_CLOSE_PR_TOKEN: ${{ secrets.GH_AUTO_CLOSE_PR_TOKEN }}
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -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.2.2"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.3.2"></script>
 ```
 
 

diff --git a/docs/examples/account/create-payment-method.md b/docs/examples/account/create-payment-method.md
@@ -0,0 +1,11 @@
+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.createPaymentMethod();
+
+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/account/list-billing-addresses.md b/docs/examples/account/list-billing-addresses.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.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);