@appwrite.io/console 1.8.0 → 1.10.0

package/src/services/organizations.ts

@@ -18,7 +18,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.OrganizationList<Preferences>>}
      */
-    list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>> {
+    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>> {
         const apiPath = '/organizations';
         const payload: Payload = {};
         if (typeof queries !== 'undefined') {
@@ -39,9 +39,10 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Create a new organization.
-
+     * 
      *
      * @param {string} organizationId
      * @param {string} name
@@ -55,7 +56,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    create<Preferences extends Models.Preferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>> {
+    create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -107,6 +108,49 @@ export class Organizations {
             payload
         );
     }
+
+    /**
+     * Get estimation for creating an organization.
+     *
+     * @param {BillingPlan} billingPlan
+     * @param {string} paymentMethodId
+     * @param {string[]} invites
+     * @param {string} couponId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Estimation>}
+     */
+    estimationCreateOrganization(billingPlan: BillingPlan, paymentMethodId?: string, invites?: string[], couponId?: string): Promise<Models.Estimation> {
+        if (typeof billingPlan === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "billingPlan"');
+        }
+        const apiPath = '/organizations/estimations/create-organization';
+        const payload: Payload = {};
+        if (typeof billingPlan !== 'undefined') {
+            payload['billingPlan'] = billingPlan;
+        }
+        if (typeof paymentMethodId !== 'undefined') {
+            payload['paymentMethodId'] = paymentMethodId;
+        }
+        if (typeof invites !== 'undefined') {
+            payload['invites'] = invites;
+        }
+        if (typeof couponId !== 'undefined') {
+            payload['couponId'] = couponId;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
     /**
      * Delete an organization.
      *
@@ -133,6 +177,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Get a list of all aggregations for an organization.
      *
@@ -162,6 +207,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Get a specific aggregation using it&#039;s aggregation ID.
      *
@@ -191,6 +237,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Set a billing address for an organization.
      *
@@ -199,7 +246,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    setBillingAddress<Preferences extends Models.Preferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>> {
+    setBillingAddress<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -224,6 +271,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Delete a team&#039;s billing address.
      *
@@ -250,6 +298,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Get a billing address using it&#039;s ID.
      *
@@ -279,6 +328,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Set the current billing email for the organization.
      *
@@ -287,7 +337,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    setBillingEmail<Preferences extends Models.Preferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>> {
+    setBillingEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -312,6 +362,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Update the budget limit for an organization.
      *
@@ -321,7 +372,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    updateBudget<Preferences extends Models.Preferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>> {
+    updateBudget<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -349,9 +400,10 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * List all credits for an organization.
-
+     * 
      *
      * @param {string} organizationId
      * @param {string[]} queries
@@ -379,6 +431,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Add credit to an organization using a coupon.
      *
@@ -412,6 +465,33 @@ export class Organizations {
             payload
         );
     }
+
+    /**
+     * Get total available valid credits for an organization.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.CreditAvailable>}
+     */
+    getAvailableCredits(organizationId: string): Promise<Models.CreditAvailable> {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/credits/available'.replace('{organizationId}', organizationId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+        }
+
+        return this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
     /**
      * Get credit details.
      *
@@ -441,6 +521,76 @@ export class Organizations {
             payload
         );
     }
+
+    /**
+     * Get estimation for deleting an organization.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EstimationDeleteOrganization>}
+     */
+    estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization> {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/estimations/delete-organization'.replace('{organizationId}', organizationId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
+    /**
+     * Get estimation for updating the organization plan.
+     *
+     * @param {string} organizationId
+     * @param {BillingPlan} billingPlan
+     * @param {string[]} invites
+     * @param {string} couponId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EstimationUpdatePlan>}
+     */
+    estimationUpdatePlan(organizationId: string, billingPlan: BillingPlan, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan> {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        if (typeof billingPlan === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "billingPlan"');
+        }
+        const apiPath = '/organizations/{organizationId}/estimations/update-plan'.replace('{organizationId}', organizationId);
+        const payload: Payload = {};
+        if (typeof billingPlan !== 'undefined') {
+            payload['billingPlan'] = billingPlan;
+        }
+        if (typeof invites !== 'undefined') {
+            payload['invites'] = invites;
+        }
+        if (typeof couponId !== 'undefined') {
+            payload['couponId'] = couponId;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
     /**
      * List all invoices for an organization.
      *
@@ -470,6 +620,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Get an invoice by its unique ID.
      *
@@ -499,6 +650,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Download invoice in PDF
      *
@@ -528,6 +680,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Initiate payment for failed invoice to pay live from console
      *
@@ -565,6 +718,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
      *
@@ -595,6 +749,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * View invoice in PDF
      *
@@ -624,6 +779,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Set a organization&#039;s default payment method.
      *
@@ -632,7 +788,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    setDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>> {
+    setDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -657,6 +813,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Delete the default payment method for an organization.
      *
@@ -664,7 +821,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    deleteDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>> {
+    deleteDefaultPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -683,16 +840,17 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Set an organization&#039;s backup payment method.
-
+     * 
      *
      * @param {string} organizationId
      * @param {string} paymentMethodId
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    setBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>> {
+    setBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -717,6 +875,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Delete a backup payment method for an organization.
      *
@@ -724,7 +883,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    deleteBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>> {
+    deleteBackupPaymentMethod<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -743,6 +902,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Get an organization&#039;s payment method using it&#039;s payment method ID.
      *
@@ -772,6 +932,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Get the details of the current billing plan for an organization.
      *
@@ -797,6 +958,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Update the billing plan for an organization.
      *
@@ -811,7 +973,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    updatePlan<Preferences extends Models.Preferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>> {
+    updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -854,6 +1016,65 @@ export class Organizations {
             payload
         );
     }
+
+    /**
+     * Cancel the downgrade initiated for an organization.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>> {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/plan/cancel'.replace('{organizationId}', organizationId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
+    /**
+     * Update selected projects to keep in the organization.
+     *
+     * @param {string} organizationId
+     * @param {string[]} projects
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, projects?: string[]): Promise<Models.Organization<Preferences>> {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/projects'.replace('{organizationId}', organizationId);
+        const payload: Payload = {};
+        if (typeof projects !== 'undefined') {
+            payload['projects'] = projects;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
     /**
      * Get Scopes
      *
@@ -879,6 +1100,7 @@ export class Organizations {
             payload
         );
     }
+
     /**
      * Set an organization&#039;s billing tax ID.
      *
@@ -887,7 +1109,7 @@ export class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    setBillingTaxId<Preferences extends Models.Preferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>> {
+    setBillingTaxId<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>> {
         if (typeof organizationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "organizationId"');
         }
@@ -912,4 +1134,69 @@ export class Organizations {
             payload
         );
     }
+
+    /**
+     * Get the usage data for an organization.
+     *
+     * @param {string} organizationId
+     * @param {string} startDate
+     * @param {string} endDate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageOrganization>}
+     */
+    getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization> {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/usage'.replace('{organizationId}', organizationId);
+        const payload: Payload = {};
+        if (typeof startDate !== 'undefined') {
+            payload['startDate'] = startDate;
+        }
+        if (typeof endDate !== 'undefined') {
+            payload['endDate'] = endDate;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+        }
+
+        return this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
+    /**
+     * Validate payment for team after creation or upgrade.
+     *
+     * @param {string} organizationId
+     * @param {string[]} invites
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    validatePayment<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>> {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/validate'.replace('{organizationId}', organizationId);
+        const payload: Payload = {};
+        if (typeof invites !== 'undefined') {
+            payload['invites'] = invites;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
 }

package/src/services/project.ts

@@ -49,6 +49,7 @@ export class Project {
             payload
         );
     }
+
     /**
      * Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.
      *
@@ -70,6 +71,7 @@ export class Project {
             payload
         );
     }
+
     /**
      * Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.
      *
@@ -110,6 +112,7 @@ export class Project {
             payload
         );
     }
+
     /**
      * Get a project variable by its unique ID.
      *
@@ -135,6 +138,7 @@ export class Project {
             payload
         );
     }
+
     /**
      * Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.
      *
@@ -176,6 +180,7 @@ export class Project {
             payload
         );
     }
+
     /**
      * Delete a project variable by its unique ID. 
      *