@appwrite.io/console 1.2.2 → 1.3.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/docs/examples/console/get-campaign.md

@@ -0,0 +1,13 @@
+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.getCampaign(
+    '<CAMPAIGN_ID>' // campaignId
+);
+
+console.log(result);

package/docs/examples/console/get-copon.md

@@ -0,0 +1,13 @@
+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.getCopon(
+    '<COUPON_ID>' // couponId
+);
+
+console.log(result);

package/docs/examples/console/plans.md

@@ -0,0 +1,11 @@
+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.plans();
+
+console.log(result);

package/docs/examples/console/regions.md

@@ -0,0 +1,11 @@
+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.regions();
+
+console.log(result);

package/docs/examples/health/get-queue-billing-aggregation.md

@@ -0,0 +1,13 @@
+import { Client, Health } 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 health = new Health(client);
+
+const result = await health.getQueueBillingAggregation(
+    null // threshold (optional)
+);
+
+console.log(result);

package/docs/examples/health/get-queue-priority-builds.md

@@ -0,0 +1,13 @@
+import { Client, Health } 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 health = new Health(client);
+
+const result = await health.getQueuePriorityBuilds(
+    null // threshold (optional)
+);
+
+console.log(result);

package/docs/examples/organizations/add-credit.md

@@ -0,0 +1,14 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.addCredit(
+    '<ORGANIZATION_ID>', // organizationId
+    '<COUPON_ID>' // couponId
+);
+
+console.log(result);

package/docs/examples/organizations/create-invoice-payment.md

@@ -0,0 +1,15 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.createInvoicePayment(
+    '<ORGANIZATION_ID>', // organizationId
+    '<INVOICE_ID>', // invoiceId
+    '<PAYMENT_METHOD_ID>' // paymentMethodId
+);
+
+console.log(result);

package/docs/examples/organizations/create.md

@@ -0,0 +1,17 @@
+import { Client, Organizations,  } 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 organizations = new Organizations(client);
+
+const result = await organizations.create(
+    '<ORGANIZATION_ID>', // organizationId
+    '<NAME>', // name
+    .Tier0, // billingPlan
+    '<PAYMENT_METHOD_ID>', // paymentMethodId (optional)
+    '<BILLING_ADDRESS_ID>' // billingAddressId (optional)
+);
+
+console.log(result);

package/docs/examples/organizations/delete-backup-payment-method.md

@@ -0,0 +1,13 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.deleteBackupPaymentMethod(
+    '<ORGANIZATION_ID>' // organizationId
+);
+
+console.log(result);

package/docs/examples/organizations/delete-billing-address.md

@@ -0,0 +1,13 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.deleteBillingAddress(
+    '<ORGANIZATION_ID>' // organizationId
+);
+
+console.log(result);

package/docs/examples/organizations/delete-default-payment-method.md

@@ -0,0 +1,13 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.deleteDefaultPaymentMethod(
+    '<ORGANIZATION_ID>' // organizationId
+);
+
+console.log(result);

package/docs/examples/organizations/delete.md

@@ -0,0 +1,13 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.delete(
+    '<ORGANIZATION_ID>' // organizationId
+);
+
+console.log(result);

package/docs/examples/organizations/get-aggregation.md

@@ -0,0 +1,14 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.getAggregation(
+    '<ORGANIZATION_ID>', // organizationId
+    '<AGGREGATION_ID>' // aggregationId
+);
+
+console.log(result);

package/docs/examples/organizations/get-billing-address.md

@@ -0,0 +1,14 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.getBillingAddress(
+    '<ORGANIZATION_ID>', // organizationId
+    '<BILLING_ADDRESS_ID>' // billingAddressId
+);
+
+console.log(result);

package/docs/examples/organizations/get-credit.md

@@ -0,0 +1,14 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.getCredit(
+    '<ORGANIZATION_ID>', // organizationId
+    '<CREDIT_ID>' // creditId
+);
+
+console.log(result);

package/docs/examples/organizations/get-invoice-download.md

@@ -0,0 +1,14 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.getInvoiceDownload(
+    '<ORGANIZATION_ID>', // organizationId
+    '<INVOICE_ID>' // invoiceId
+);
+
+console.log(result);

package/docs/examples/organizations/get-invoice-view.md

@@ -0,0 +1,14 @@
+import { Client, Organizations } 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 organizations = new Organizations(client);
+
+const result = await organizations.getInvoiceView(
+    '<ORGANIZATION_ID>', // organizationId
+    '<INVOICE_ID>' // invoiceId
+);
+
+console.log(result);