@appwrite.io/console 1.10.0 → 2.0.0

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

@@ -6,10 +6,10 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.createInvoicePayment(
-    '<ORGANIZATION_ID>', // organizationId
-    '<INVOICE_ID>', // invoiceId
-    '<PAYMENT_METHOD_ID>' // paymentMethodId
-);
+const result = await organizations.createInvoicePayment({
+    organizationId: '<ORGANIZATION_ID>',
+    invoiceId: '<INVOICE_ID>',
+    paymentMethodId: '<PAYMENT_METHOD_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/create.md

@@ -1,4 +1,4 @@
-import { Client, Organizations,  } from "@appwrite.io/console";
+import { Client, Organizations, Platform } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,16 +6,17 @@ const client = new Client()
 
 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)
-    [], // invites (optional)
-    '<COUPON_ID>', // couponId (optional)
-    '<TAX_ID>', // taxId (optional)
-    0 // budget (optional)
-);
+const result = await organizations.create({
+    organizationId: '<ORGANIZATION_ID>',
+    name: '<NAME>',
+    billingPlan: 'tier-0',
+    paymentMethodId: '<PAYMENT_METHOD_ID>', // optional
+    billingAddressId: '<BILLING_ADDRESS_ID>', // optional
+    invites: [], // optional
+    couponId: '<COUPON_ID>', // optional
+    taxId: '<TAX_ID>', // optional
+    budget: 0, // optional
+    platform: Platform.Appwrite // optional
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.deleteBackupPaymentMethod(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.deleteBackupPaymentMethod({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.deleteBillingAddress(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.deleteBillingAddress({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.deleteDefaultPaymentMethod(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.deleteDefaultPaymentMethod({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/delete.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.delete(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.delete({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/estimation-create-organization.md

@@ -1,4 +1,4 @@
-import { Client, Organizations,  } from "@appwrite.io/console";
+import { Client, Organizations, Platform } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,11 +6,12 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.estimationCreateOrganization(
-    .Tier0, // billingPlan
-    '<PAYMENT_METHOD_ID>', // paymentMethodId (optional)
-    [], // invites (optional)
-    '<COUPON_ID>' // couponId (optional)
-);
+const result = await organizations.estimationCreateOrganization({
+    billingPlan: 'tier-0',
+    paymentMethodId: '<PAYMENT_METHOD_ID>', // optional
+    invites: [], // optional
+    couponId: '<COUPON_ID>', // optional
+    platform: Platform.Appwrite // optional
+});
 
 console.log(result);

package/docs/examples/organizations/estimation-delete-organization.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.estimationDeleteOrganization(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.estimationDeleteOrganization({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/estimation-update-plan.md

@@ -1,4 +1,4 @@
-import { Client, Organizations,  } from "@appwrite.io/console";
+import { Client, Organizations } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,11 +6,11 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.estimationUpdatePlan(
-    '<ORGANIZATION_ID>', // organizationId
-    .Tier0, // billingPlan
-    [], // invites (optional)
-    '<COUPON_ID>' // couponId (optional)
-);
+const result = await organizations.estimationUpdatePlan({
+    organizationId: '<ORGANIZATION_ID>',
+    billingPlan: 'tier-0',
+    invites: [], // optional
+    couponId: '<COUPON_ID>' // optional
+});
 
 console.log(result);

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

@@ -6,9 +6,11 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getAggregation(
-    '<ORGANIZATION_ID>', // organizationId
-    '<AGGREGATION_ID>' // aggregationId
-);
+const result = await organizations.getAggregation({
+    organizationId: '<ORGANIZATION_ID>',
+    aggregationId: '<AGGREGATION_ID>',
+    limit: 0, // optional
+    offset: null // optional
+});
 
 console.log(result);

package/docs/examples/organizations/get-available-credits.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getAvailableCredits(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.getAvailableCredits({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getBillingAddress(
-    '<ORGANIZATION_ID>', // organizationId
-    '<BILLING_ADDRESS_ID>' // billingAddressId
-);
+const result = await organizations.getBillingAddress({
+    organizationId: '<ORGANIZATION_ID>',
+    billingAddressId: '<BILLING_ADDRESS_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getCredit(
-    '<ORGANIZATION_ID>', // organizationId
-    '<CREDIT_ID>' // creditId
-);
+const result = await organizations.getCredit({
+    organizationId: '<ORGANIZATION_ID>',
+    creditId: '<CREDIT_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getInvoiceDownload(
-    '<ORGANIZATION_ID>', // organizationId
-    '<INVOICE_ID>' // invoiceId
-);
+const result = await organizations.getInvoiceDownload({
+    organizationId: '<ORGANIZATION_ID>',
+    invoiceId: '<INVOICE_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getInvoiceView(
-    '<ORGANIZATION_ID>', // organizationId
-    '<INVOICE_ID>' // invoiceId
-);
+const result = await organizations.getInvoiceView({
+    organizationId: '<ORGANIZATION_ID>',
+    invoiceId: '<INVOICE_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getInvoice(
-    '<ORGANIZATION_ID>', // organizationId
-    '<INVOICE_ID>' // invoiceId
-);
+const result = await organizations.getInvoice({
+    organizationId: '<ORGANIZATION_ID>',
+    invoiceId: '<INVOICE_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/get-payment-method.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getPaymentMethod(
-    '<ORGANIZATION_ID>', // organizationId
-    '<PAYMENT_METHOD_ID>' // paymentMethodId
-);
+const result = await organizations.getPaymentMethod({
+    organizationId: '<ORGANIZATION_ID>',
+    paymentMethodId: '<PAYMENT_METHOD_ID>'
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getPlan(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.getPlan({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

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

@@ -6,8 +6,8 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getScopes(
-    '<ORGANIZATION_ID>' // organizationId
-);
+const result = await organizations.getScopes({
+    organizationId: '<ORGANIZATION_ID>'
+});
 
 console.log(result);

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

@@ -6,10 +6,10 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.getUsage(
-    '<ORGANIZATION_ID>', // organizationId
-    '', // startDate (optional)
-    '' // endDate (optional)
-);
+const result = await organizations.getUsage({
+    organizationId: '<ORGANIZATION_ID>',
+    startDate: '', // optional
+    endDate: '' // optional
+});
 
 console.log(result);

package/docs/examples/organizations/list-aggregations.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.listAggregations(
-    '<ORGANIZATION_ID>', // organizationId
-    [] // queries (optional)
-);
+const result = await organizations.listAggregations({
+    organizationId: '<ORGANIZATION_ID>',
+    queries: [] // optional
+});
 
 console.log(result);

package/docs/examples/organizations/list-credits.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.listCredits(
-    '<ORGANIZATION_ID>', // organizationId
-    [] // queries (optional)
-);
+const result = await organizations.listCredits({
+    organizationId: '<ORGANIZATION_ID>',
+    queries: [] // optional
+});
 
 console.log(result);

package/docs/examples/organizations/list-invoices.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.listInvoices(
-    '<ORGANIZATION_ID>', // organizationId
-    [] // queries (optional)
-);
+const result = await organizations.listInvoices({
+    organizationId: '<ORGANIZATION_ID>',
+    queries: [] // optional
+});
 
 console.log(result);

package/docs/examples/organizations/list.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.list(
-    [], // queries (optional)
-    '<SEARCH>' // search (optional)
-);
+const result = await organizations.list({
+    queries: [], // optional
+    search: '<SEARCH>' // optional
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.setBackupPaymentMethod(
-    '<ORGANIZATION_ID>', // organizationId
-    '<PAYMENT_METHOD_ID>' // paymentMethodId
-);
+const result = await organizations.setBackupPaymentMethod({
+    organizationId: '<ORGANIZATION_ID>',
+    paymentMethodId: '<PAYMENT_METHOD_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.setBillingAddress(
-    '<ORGANIZATION_ID>', // organizationId
-    '<BILLING_ADDRESS_ID>' // billingAddressId
-);
+const result = await organizations.setBillingAddress({
+    organizationId: '<ORGANIZATION_ID>',
+    billingAddressId: '<BILLING_ADDRESS_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/set-billing-email.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.setBillingEmail(
-    '<ORGANIZATION_ID>', // organizationId
-    'email@example.com' // billingEmail
-);
+const result = await organizations.setBillingEmail({
+    organizationId: '<ORGANIZATION_ID>',
+    billingEmail: 'email@example.com'
+});
 
 console.log(result);

package/docs/examples/organizations/set-billing-tax-id.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.setBillingTaxId(
-    '<ORGANIZATION_ID>', // organizationId
-    '<TAX_ID>' // taxId
-);
+const result = await organizations.setBillingTaxId({
+    organizationId: '<ORGANIZATION_ID>',
+    taxId: '<TAX_ID>'
+});
 
 console.log(result);

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

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.setDefaultPaymentMethod(
-    '<ORGANIZATION_ID>', // organizationId
-    '<PAYMENT_METHOD_ID>' // paymentMethodId
-);
+const result = await organizations.setDefaultPaymentMethod({
+    organizationId: '<ORGANIZATION_ID>',
+    paymentMethodId: '<PAYMENT_METHOD_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/update-budget.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.updateBudget(
-    '<ORGANIZATION_ID>', // organizationId
-    0, // budget
-    [] // alerts (optional)
-);
+const result = await organizations.updateBudget({
+    organizationId: '<ORGANIZATION_ID>',
+    budget: 0,
+    alerts: [] // optional
+});
 
 console.log(result);

package/docs/examples/organizations/update-plan.md

@@ -1,4 +1,4 @@
-import { Client, Organizations,  } from "@appwrite.io/console";
+import { Client, Organizations } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -6,15 +6,15 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.updatePlan(
-    '<ORGANIZATION_ID>', // organizationId
-    .Tier0, // billingPlan
-    '<PAYMENT_METHOD_ID>', // paymentMethodId (optional)
-    '<BILLING_ADDRESS_ID>', // billingAddressId (optional)
-    [], // invites (optional)
-    '<COUPON_ID>', // couponId (optional)
-    '<TAX_ID>', // taxId (optional)
-    0 // budget (optional)
-);
+const result = await organizations.updatePlan({
+    organizationId: '<ORGANIZATION_ID>',
+    billingPlan: 'tier-0',
+    paymentMethodId: '<PAYMENT_METHOD_ID>', // optional
+    billingAddressId: '<BILLING_ADDRESS_ID>', // optional
+    invites: [], // optional
+    couponId: '<COUPON_ID>', // optional
+    taxId: '<TAX_ID>', // optional
+    budget: 0 // optional
+});
 
 console.log(result);

package/docs/examples/organizations/update-projects.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.updateProjects(
-    '<ORGANIZATION_ID>', // organizationId
-    [] // projects (optional)
-);
+const result = await organizations.updateProjects({
+    organizationId: '<ORGANIZATION_ID>',
+    projects: [] // optional
+});
 
 console.log(result);

package/docs/examples/organizations/validate-invoice.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.validateInvoice(
-    '<ORGANIZATION_ID>', // organizationId
-    '<INVOICE_ID>' // invoiceId
-);
+const result = await organizations.validateInvoice({
+    organizationId: '<ORGANIZATION_ID>',
+    invoiceId: '<INVOICE_ID>'
+});
 
 console.log(result);

package/docs/examples/organizations/validate-payment.md

@@ -6,9 +6,9 @@ const client = new Client()
 
 const organizations = new Organizations(client);
 
-const result = await organizations.validatePayment(
-    '<ORGANIZATION_ID>', // organizationId
-    [] // invites (optional)
-);
+const result = await organizations.validatePayment({
+    organizationId: '<ORGANIZATION_ID>',
+    invites: [] // optional
+});
 
 console.log(result);

package/docs/examples/project/create-variable.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const project = new Project(client);
 
-const result = await project.createVariable(
-    '<KEY>', // key
-    '<VALUE>', // value
-    false // secret (optional)
-);
+const result = await project.createVariable({
+    key: '<KEY>',
+    value: '<VALUE>',
+    secret: false // optional
+});
 
 console.log(result);

package/docs/examples/project/delete-variable.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const project = new Project(client);
 
-const result = await project.deleteVariable(
-    '<VARIABLE_ID>' // variableId
-);
+const result = await project.deleteVariable({
+    variableId: '<VARIABLE_ID>'
+});
 
 console.log(result);

package/docs/examples/project/get-usage.md

@@ -6,10 +6,10 @@ const client = new Client()
 
 const project = new Project(client);
 
-const result = await project.getUsage(
-    '', // startDate
-    '', // endDate
-    ProjectUsageRange.OneHour // period (optional)
-);
+const result = await project.getUsage({
+    startDate: '',
+    endDate: '',
+    period: ProjectUsageRange.OneHour // optional
+});
 
 console.log(result);

package/docs/examples/project/get-variable.md

@@ -6,8 +6,8 @@ const client = new Client()
 
 const project = new Project(client);
 
-const result = await project.getVariable(
-    '<VARIABLE_ID>' // variableId
-);
+const result = await project.getVariable({
+    variableId: '<VARIABLE_ID>'
+});
 
 console.log(result);

package/docs/examples/project/update-variable.md

@@ -6,11 +6,11 @@ const client = new Client()
 
 const project = new Project(client);
 
-const result = await project.updateVariable(
-    '<VARIABLE_ID>', // variableId
-    '<KEY>', // key
-    '<VALUE>', // value (optional)
-    false // secret (optional)
-);
+const result = await project.updateVariable({
+    variableId: '<VARIABLE_ID>',
+    key: '<KEY>',
+    value: '<VALUE>', // optional
+    secret: false // optional
+});
 
 console.log(result);