@appwrite.io/console 1.0.1 → 1.1.0-rc.2

package/docs/examples/{functions/list-specifications.md → 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);

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

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/{functions/get-template.md → 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);

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-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/functions/create-build.md

@@ -9,7 +9,7 @@ const functions = new Functions(client);
 const result = await functions.createBuild(
     '<FUNCTION_ID>', // functionId
     '<DEPLOYMENT_ID>', // deploymentId
-    '<BUILD_ID>' // buildId (optional)
+    '<BUILD_ID>' // buildId
 );
 
 console.log(result);

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

@@ -12,8 +12,7 @@ const result = await functions.createExecution(
     false, // async (optional)
     '<PATH>', // path (optional)
     ExecutionMethod.GET, // method (optional)
-    {}, // headers (optional)
-    '' // scheduledAt (optional)
+    {} // headers (optional)
 );
 
 console.log(result);

package/docs/examples/functions/create.md

@@ -18,7 +18,6 @@ const result = await functions.create(
     false, // logging (optional)
     '<ENTRYPOINT>', // entrypoint (optional)
     '<COMMANDS>', // commands (optional)
-    [], // scopes (optional)
     '<INSTALLATION_ID>', // installationId (optional)
     '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)
     '<PROVIDER_BRANCH>', // providerBranch (optional)
@@ -27,8 +26,7 @@ const result = await functions.create(
     '<TEMPLATE_REPOSITORY>', // templateRepository (optional)
     '<TEMPLATE_OWNER>', // templateOwner (optional)
     '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional)
-    '<TEMPLATE_VERSION>', // templateVersion (optional)
-    '' // specification (optional)
+    '<TEMPLATE_BRANCH>' // templateBranch (optional)
 );
 
 console.log(result);

package/docs/examples/functions/{get-deployment-download.md → download-deployment.md}

@@ -6,7 +6,7 @@ const client = new Client()
 
 const functions = new Functions(client);
 
-const result = functions.getDeploymentDownload(
+const result = functions.downloadDeployment(
     '<FUNCTION_ID>', // functionId
     '<DEPLOYMENT_ID>' // deploymentId
 );

package/docs/examples/functions/update.md

@@ -18,13 +18,11 @@ const result = await functions.update(
     false, // logging (optional)
     '<ENTRYPOINT>', // entrypoint (optional)
     '<COMMANDS>', // commands (optional)
-    [], // scopes (optional)
     '<INSTALLATION_ID>', // installationId (optional)
     '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)
     '<PROVIDER_BRANCH>', // providerBranch (optional)
     false, // providerSilentMode (optional)
-    '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional)
-    '' // specification (optional)
+    '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (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);