@appwrite.io/console 8.2.0 → 8.3.0

package/dist/iife/sdk.js

@@ -4378,7 +4378,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '8.2.0',
+                'x-sdk-version': '8.3.0',
                 'X-Appwrite-Response-Format': '1.9.0',
             };
             this.realtime = {
@@ -19172,6 +19172,152 @@
             };
             return this.client.call('delete', uri, apiHeaders, payload);
         }
+        listAddons(paramsOrFirst) {
+            let params;
+            if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+                params = (paramsOrFirst || {});
+            }
+            else {
+                params = {
+                    organizationId: paramsOrFirst
+                };
+            }
+            const organizationId = params.organizationId;
+            if (typeof organizationId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "organizationId"');
+            }
+            const apiPath = '/organizations/{organizationId}/addons'.replace('{organizationId}', organizationId);
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            const apiHeaders = {};
+            return this.client.call('get', uri, apiHeaders, payload);
+        }
+        createBaaAddon(paramsOrFirst) {
+            let params;
+            if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+                params = (paramsOrFirst || {});
+            }
+            else {
+                params = {
+                    organizationId: paramsOrFirst
+                };
+            }
+            const organizationId = params.organizationId;
+            if (typeof organizationId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "organizationId"');
+            }
+            const apiPath = '/organizations/{organizationId}/addons/baa'.replace('{organizationId}', organizationId);
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            const apiHeaders = {
+                'content-type': 'application/json',
+            };
+            return this.client.call('post', uri, apiHeaders, payload);
+        }
+        getAddon(paramsOrFirst, ...rest) {
+            let params;
+            if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+                params = (paramsOrFirst || {});
+            }
+            else {
+                params = {
+                    organizationId: paramsOrFirst,
+                    addonId: rest[0]
+                };
+            }
+            const organizationId = params.organizationId;
+            const addonId = params.addonId;
+            if (typeof organizationId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "organizationId"');
+            }
+            if (typeof addonId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "addonId"');
+            }
+            const apiPath = '/organizations/{organizationId}/addons/{addonId}'.replace('{organizationId}', organizationId).replace('{addonId}', addonId);
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            const apiHeaders = {};
+            return this.client.call('get', uri, apiHeaders, payload);
+        }
+        deleteAddon(paramsOrFirst, ...rest) {
+            let params;
+            if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+                params = (paramsOrFirst || {});
+            }
+            else {
+                params = {
+                    organizationId: paramsOrFirst,
+                    addonId: rest[0]
+                };
+            }
+            const organizationId = params.organizationId;
+            const addonId = params.addonId;
+            if (typeof organizationId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "organizationId"');
+            }
+            if (typeof addonId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "addonId"');
+            }
+            const apiPath = '/organizations/{organizationId}/addons/{addonId}'.replace('{organizationId}', organizationId).replace('{addonId}', addonId);
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            const apiHeaders = {
+                'content-type': 'application/json',
+            };
+            return this.client.call('delete', uri, apiHeaders, payload);
+        }
+        confirmAddonPayment(paramsOrFirst, ...rest) {
+            let params;
+            if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+                params = (paramsOrFirst || {});
+            }
+            else {
+                params = {
+                    organizationId: paramsOrFirst,
+                    addonId: rest[0]
+                };
+            }
+            const organizationId = params.organizationId;
+            const addonId = params.addonId;
+            if (typeof organizationId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "organizationId"');
+            }
+            if (typeof addonId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "addonId"');
+            }
+            const apiPath = '/organizations/{organizationId}/addons/{addonId}/confirmations'.replace('{organizationId}', organizationId).replace('{addonId}', addonId);
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            const apiHeaders = {
+                'content-type': 'application/json',
+            };
+            return this.client.call('post', uri, apiHeaders, payload);
+        }
+        getAddonPrice(paramsOrFirst, ...rest) {
+            let params;
+            if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+                params = (paramsOrFirst || {});
+            }
+            else {
+                params = {
+                    organizationId: paramsOrFirst,
+                    addon: rest[0]
+                };
+            }
+            const organizationId = params.organizationId;
+            const addon = params.addon;
+            if (typeof organizationId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "organizationId"');
+            }
+            if (typeof addon === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "addon"');
+            }
+            const apiPath = '/organizations/{organizationId}/addons/{addon}/price'.replace('{organizationId}', organizationId).replace('{addon}', addon);
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            const apiHeaders = {};
+            return this.client.call('get', uri, apiHeaders, payload);
+        }
         listAggregations(paramsOrFirst, ...rest) {
             let params;
             if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
@@ -32893,6 +33039,11 @@
         SupabaseMigrationResource["File"] = "file";
     })(exports.SupabaseMigrationResource || (exports.SupabaseMigrationResource = {}));
 
+    exports.Addon = void 0;
+    (function (Addon) {
+        Addon["Baa"] = "baa";
+    })(exports.Addon || (exports.Addon = {}));
+
     exports.ProjectUsageRange = void 0;
     (function (ProjectUsageRange) {
         ProjectUsageRange["OneHour"] = "1h";

package/package.json

@@ -2,7 +2,7 @@
   "name": "@appwrite.io/console",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/types/enums/addon.d.ts

@@ -0,0 +1,3 @@
+export declare enum Addon {
+    Baa = "baa"
+}

package/types/index.d.ts

@@ -76,6 +76,7 @@ export { AppwriteMigrationResource } from './enums/appwrite-migration-resource';
 export { FirebaseMigrationResource } from './enums/firebase-migration-resource';
 export { NHostMigrationResource } from './enums/n-host-migration-resource';
 export { SupabaseMigrationResource } from './enums/supabase-migration-resource';
+export { Addon } from './enums/addon';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';
 export { Api } from './enums/api';

package/types/models.d.ts

@@ -4475,6 +4475,18 @@ export declare namespace Models {
          * Whether or not to check the user password for similarity with their personal data.
          */
         authPersonalDataCheck: boolean;
+        /**
+         * Whether or not to disallow disposable email addresses during signup and email updates.
+         */
+        authDisposableEmails: boolean;
+        /**
+         * Whether or not to require canonical email addresses during signup and email updates.
+         */
+        authCanonicalEmails: boolean;
+        /**
+         * Whether or not to disallow free email addresses during signup and email updates.
+         */
+        authFreeEmails: boolean;
         /**
          * An array of mock numbers and their corresponding verification codes (OTPs).
          */
@@ -6230,27 +6242,27 @@ export declare namespace Models {
          */
         trigger: string;
         /**
-         * URL to redirect to. Only applicable if type is "redirect", otherwise empty string.
+         * URL to redirect to. Used if type is "redirect"
          */
         redirectUrl: string;
         /**
-         * Status code to apply during redirect. Only applicable if type is "redirect", defaults to 301.
+         * Status code to apply during redirect. Used if type is "redirect"
          */
         redirectStatusCode: number;
         /**
-         * ID of deployment. Only applicable if type is "deployment", otherwise empty string.
+         * ID of deployment. Used if type is "deployment"
          */
         deploymentId: string;
         /**
-         * Type of deployment. Possible values are "function", "site". Only applicable if type is "deployment", otherwise empty string.
+         * Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
          */
         deploymentResourceType: ProxyRuleDeploymentResourceType;
         /**
-         * ID of deployment's resource. Only applicable if type is "deployment", otherwise empty string.
+         * ID deployment's resource. Used if type is "deployment"
          */
         deploymentResourceId: string;
         /**
-         * Name of Git branch that updates rule. Only applicable if type is "deployment", otherwise empty string.
+         * Name of Git branch that updates rule. Used if type is "deployment"
          */
         deploymentVcsProviderBranch: string;
         /**
@@ -6473,6 +6485,10 @@ export declare namespace Models {
          * Whether the database adapter uses integer sequence IDs.
          */
         supportForIntegerIds: boolean;
+        /**
+         * Whether email verification for console users is required. Can be "true" or "false".
+         */
+        _APP_CONSOLE_EMAIL_VERIFICATION: string;
     };
     /**
      * MFA Challenge
@@ -7512,6 +7528,10 @@ export declare namespace Models {
          * Whether usage addons are calculated per project.
          */
         usagePerProject: boolean;
+        /**
+         * Supported addons for this plan
+         */
+        supportedAddons: BillingPlanSupportedAddons;
         /**
          * How many policies does plan support
          */
@@ -7604,6 +7624,15 @@ export declare namespace Models {
          */
         dailyCredits?: number;
     };
+    /**
+     * BillingPlanSupportedAddons
+     */
+    export type BillingPlanSupportedAddons = {
+        /**
+         * Whether the plan supports BAA (Business Associate Agreement) addon
+         */
+        baa: boolean;
+    };
     /**
      * BillingLimits
      */
@@ -8175,6 +8204,10 @@ export declare namespace Models {
          * Invoice ID against which the payment needs to be validated.
          */
         invoiceId: string;
+        /**
+         * Addon ID to use when calling the addon validate endpoint. Empty when authentication is not for an addon.
+         */
+        addonId: string;
     };
     /**
      * paymentMethod
@@ -9027,6 +9060,88 @@ export declare namespace Models {
          */
         available: boolean;
     };
+    /**
+     * Addon
+     */
+    export type Addon = {
+        /**
+         * Addon ID.
+         */
+        $id: string;
+        /**
+         * Addon creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Addon update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Addon permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+         */
+        $permissions: string[];
+        /**
+         * Addon key
+         */
+        key: string;
+        /**
+         * Resource type (organization or project)
+         */
+        resourceType: string;
+        /**
+         * Resource ID
+         */
+        resourceId: string;
+        /**
+         * Payment status. Possible values: pending (awaiting payment confirmation e.g. 3DS), active (payment confirmed and addon is running).
+         */
+        status: string;
+        /**
+         * Current value for this billing cycle. For toggle addons: 1 (on) or 0 (off). For numeric addons: the active quantity.
+         */
+        currentValue: number;
+        /**
+         * Value to apply at the start of the next billing cycle. Null means no change is scheduled. For toggle addons, 0 means the addon will be removed at the next cycle.
+         */
+        nextValue?: number;
+    };
+    /**
+     * AddonPrice
+     */
+    export type AddonPrice = {
+        /**
+         * Addon key.
+         */
+        addonKey: string;
+        /**
+         * Addon display name.
+         */
+        name: string;
+        /**
+         * Full monthly price of the addon.
+         */
+        monthlyPrice: number;
+        /**
+         * Calculated prorated amount for the current billing cycle.
+         */
+        proratedAmount: number;
+        /**
+         * Days remaining in the current billing cycle.
+         */
+        remainingDays: number;
+        /**
+         * Total days in the billing cycle.
+         */
+        totalCycleDays: number;
+        /**
+         * Currency code.
+         */
+        currency: string;
+        /**
+         * When the current billing cycle ends.
+         */
+        billingCycleEnd: string;
+    };
     /**
      * domainTransferOut
      */
@@ -9053,6 +9168,19 @@ export declare namespace Models {
          */
         timestamp: string;
     };
+    /**
+     * Addons list
+     */
+    export type AddonList = {
+        /**
+         * Total number of addons that matched your query.
+         */
+        total: number;
+        /**
+         * List of addons.
+         */
+        addons: Addon[];
+    };
     /**
      * Activity event list
      */

package/types/services/migrations.d.ts

@@ -204,6 +204,8 @@ export declare class Migrations {
      */
     getFirebaseReport(resources: FirebaseMigrationResource[], serviceAccount: string): Promise<Models.MigrationReport>;
     /**
+     * Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
+     *
      *
      * @param {string} params.resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
      * @param {string} params.filename - The name of the file to be created for the export, excluding the .json extension.
@@ -221,6 +223,8 @@ export declare class Migrations {
         notify?: boolean;
     }): Promise<Models.Migration>;
     /**
+     * Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
+     *
      *
      * @param {string} resourceId - Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.
      * @param {string} filename - The name of the file to be created for the export, excluding the .json extension.
@@ -233,6 +237,8 @@ export declare class Migrations {
      */
     createJSONExport(resourceId: string, filename: string, columns?: string[], queries?: string[], notify?: boolean): Promise<Models.Migration>;
     /**
+     * Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
+     *
      *
      * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string} params.fileId - File ID.
@@ -248,6 +254,8 @@ export declare class Migrations {
         internalFile?: boolean;
     }): Promise<Models.Migration>;
     /**
+     * Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
+     *
      *
      * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string} fileId - File ID.

package/types/services/organizations.d.ts

@@ -1,6 +1,7 @@
 import { Client } from '../client';
 import type { Models } from '../models';
 import { Platform } from '../enums/platform';
+import { Addon } from '../enums/addon';
 import { Scopes } from '../enums/scopes';
 export declare class Organizations {
     client: Client;
@@ -125,6 +126,144 @@ export declare class Organizations {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     delete(organizationId: string): Promise<{}>;
+    /**
+     * List all billing addons for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonList>}
+     */
+    listAddons(params: {
+        organizationId: string;
+    }): Promise<Models.AddonList>;
+    /**
+     * List all billing addons for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listAddons(organizationId: string): Promise<Models.AddonList>;
+    /**
+     * Create the BAA billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    createBaaAddon(params: {
+        organizationId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Create the BAA billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createBaaAddon(organizationId: string): Promise<Models.Addon>;
+    /**
+     * Get the details of a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    getAddon(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Get the details of a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getAddon(organizationId: string, addonId: string): Promise<Models.Addon>;
+    /**
+     * Delete a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteAddon(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteAddon(organizationId: string, addonId: string): Promise<{}>;
+    /**
+     * Confirm payment for a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     */
+    confirmAddonPayment(params: {
+        organizationId: string;
+        addonId: string;
+    }): Promise<Models.Addon>;
+    /**
+     * Confirm payment for a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} addonId - Addon ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Addon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    confirmAddonPayment(organizationId: string, addonId: string): Promise<Models.Addon>;
+    /**
+     * Get the price details for a billing addon for an organization.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {Addon} params.addon - Addon key identifier (e.g. baa).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonPrice>}
+     */
+    getAddonPrice(params: {
+        organizationId: string;
+        addon: Addon;
+    }): Promise<Models.AddonPrice>;
+    /**
+     * Get the price details for a billing addon for an organization.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {Addon} addon - Addon key identifier (e.g. baa).
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AddonPrice>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getAddonPrice(organizationId: string, addon: Addon): Promise<Models.AddonPrice>;
     /**
      * Get a list of all aggregations for an organization.
      *