@appwrite.io/console 1.4.4 → 1.4.6

package/dist/iife/sdk.js

@@ -281,12 +281,13 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '1.4.4',
+                'x-sdk-version': '1.4.6',
                 'X-Appwrite-Response-Format': '1.6.0',
             };
             this.realtime = {
                 socket: undefined,
                 timeout: undefined,
+                heartbeat: undefined,
                 url: '',
                 channels: new Set(),
                 subscriptions: new Map(),
@@ -312,6 +313,17 @@
                             return 60000;
                     }
                 },
+                createHeartbeat: () => {
+                    if (this.realtime.heartbeat) {
+                        clearTimeout(this.realtime.heartbeat);
+                    }
+                    this.realtime.heartbeat = window === null || window === void 0 ? void 0 : window.setInterval(() => {
+                        var _a;
+                        (_a = this.realtime.socket) === null || _a === void 0 ? void 0 : _a.send(JSON.stringify({
+                            type: 'ping'
+                        }));
+                    }, 20000);
+                },
                 createSocket: () => {
                     var _a, _b, _c;
                     if (this.realtime.channels.size < 1) {
@@ -340,6 +352,7 @@
                         this.realtime.socket.addEventListener('message', this.realtime.onMessage);
                         this.realtime.socket.addEventListener('open', _event => {
                             this.realtime.reconnectAttempts = 0;
+                            this.realtime.createHeartbeat();
                         });
                         this.realtime.socket.addEventListener('close', event => {
                             var _a, _b, _c;
@@ -966,6 +979,28 @@
                 return yield this.client.call('delete', uri, apiHeaders, payload);
             });
         }
+        /**
+         * Get coupon details
+         *
+         *
+         * @param {string} couponId
+         * @throws {AppwriteException}
+         * @returns {Promise<Models.Coupon>}
+         */
+        getCoupon(couponId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof couponId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "couponId"');
+                }
+                const apiPath = '/account/coupons/{couponId}'.replace('{couponId}', couponId);
+                const payload = {};
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                const apiHeaders = {
+                    'content-type': 'application/json',
+                };
+                return yield this.client.call('get', uri, apiHeaders, payload);
+            });
+        }
         /**
          * Update email
          *
@@ -2190,7 +2225,7 @@
         /**
          * Create magic URL token
          *
-         * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user&#039;s email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.
+         * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user&#039;s email address is valid for 1 hour.
 
     A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
 
@@ -3157,6 +3192,28 @@
                 return yield this.client.call('get', uri, apiHeaders, payload);
             });
         }
+        /**
+         * Create program membership
+         *
+         *
+         * @param {string} programId
+         * @throws {AppwriteException}
+         * @returns {Promise<{}>}
+         */
+        createProgramMembership(programId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof programId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "programId"');
+                }
+                const apiPath = '/console/programs/{programId}/memberships'.replace('{programId}', programId);
+                const payload = {};
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                const apiHeaders = {
+                    'content-type': 'application/json',
+                };
+                return yield this.client.call('post', uri, apiHeaders, payload);
+            });
+        }
         /**
          * Get Regions
          *
@@ -9096,7 +9153,7 @@
             });
         }
         /**
-         * Migrate Firebase data (Service Account)
+         * Migrate Firebase data
          *
          *
          * @param {string[]} resources
@@ -9127,74 +9184,6 @@
                 return yield this.client.call('post', uri, apiHeaders, payload);
             });
         }
-        /**
-         * Revoke Appwrite&#039;s authorization to access Firebase projects
-         *
-         *
-         * @throws {AppwriteException}
-         * @returns {Promise<{}>}
-         */
-        deleteFirebaseAuth() {
-            return __awaiter(this, void 0, void 0, function* () {
-                const apiPath = '/migrations/firebase/deauthorize';
-                const payload = {};
-                const uri = new URL(this.client.config.endpoint + apiPath);
-                const apiHeaders = {
-                    'content-type': 'application/json',
-                };
-                return yield this.client.call('get', uri, apiHeaders, payload);
-            });
-        }
-        /**
-         * Migrate Firebase data (OAuth)
-         *
-         *
-         * @param {string[]} resources
-         * @param {string} projectId
-         * @throws {AppwriteException}
-         * @returns {Promise<Models.Migration>}
-         */
-        createFirebaseOAuthMigration(resources, projectId) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (typeof resources === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "resources"');
-                }
-                if (typeof projectId === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "projectId"');
-                }
-                const apiPath = '/migrations/firebase/oauth';
-                const payload = {};
-                if (typeof resources !== 'undefined') {
-                    payload['resources'] = resources;
-                }
-                if (typeof projectId !== 'undefined') {
-                    payload['projectId'] = projectId;
-                }
-                const uri = new URL(this.client.config.endpoint + apiPath);
-                const apiHeaders = {
-                    'content-type': 'application/json',
-                };
-                return yield this.client.call('post', uri, apiHeaders, payload);
-            });
-        }
-        /**
-         * List Firebase projects
-         *
-         *
-         * @throws {AppwriteException}
-         * @returns {Promise<Models.FirebaseProjectList>}
-         */
-        listFirebaseProjects() {
-            return __awaiter(this, void 0, void 0, function* () {
-                const apiPath = '/migrations/firebase/projects';
-                const payload = {};
-                const uri = new URL(this.client.config.endpoint + apiPath);
-                const apiHeaders = {
-                    'content-type': 'application/json',
-                };
-                return yield this.client.call('get', uri, apiHeaders, payload);
-            });
-        }
         /**
          * Generate a report on Firebase data
          *
@@ -9227,38 +9216,6 @@
                 return yield this.client.call('get', uri, apiHeaders, payload);
             });
         }
-        /**
-         * Generate a report on Firebase data using OAuth
-         *
-         *
-         * @param {string[]} resources
-         * @param {string} projectId
-         * @throws {AppwriteException}
-         * @returns {Promise<Models.MigrationReport>}
-         */
-        getFirebaseReportOAuth(resources, projectId) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (typeof resources === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "resources"');
-                }
-                if (typeof projectId === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "projectId"');
-                }
-                const apiPath = '/migrations/firebase/report/oauth';
-                const payload = {};
-                if (typeof resources !== 'undefined') {
-                    payload['resources'] = resources;
-                }
-                if (typeof projectId !== 'undefined') {
-                    payload['projectId'] = projectId;
-                }
-                const uri = new URL(this.client.config.endpoint + apiPath);
-                const apiHeaders = {
-                    'content-type': 'application/json',
-                };
-                return yield this.client.call('get', uri, apiHeaders, payload);
-            });
-        }
         /**
          * Migrate NHost data
          *
@@ -9732,7 +9689,7 @@
          * @param {string} organizationId
          * @param {string} aggregationId
          * @throws {AppwriteException}
-         * @returns {Promise<Models.AggregationTeam>}
+         * @returns {Promise<Models.Invoice>}
          */
         getAggregation(organizationId, aggregationId) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -10024,7 +9981,7 @@
             });
         }
         /**
-         * View invoice in PDF
+         * Download invoice in PDF
          *
          *
          * @param {string} organizationId
@@ -15589,6 +15546,7 @@
         Runtime["Bun11"] = "bun-1.1";
         Runtime["Go123"] = "go-1.23";
         Runtime["Static1"] = "static-1";
+        Runtime["Flutter324"] = "flutter-3.24";
     })(exports.Runtime || (exports.Runtime = {}));
 
     exports.FunctionUsageRange = void 0;

package/docs/examples/{migrations/delete-firebase-auth.md → account/get-coupon.md}

@@ -1,11 +1,13 @@
-import { Client, Migrations } 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 migrations = new Migrations(client);
+const account = new Account(client);
 
-const result = await migrations.deleteFirebaseAuth();
+const result = await account.getCoupon(
+    '<COUPON_ID>' // couponId
+);
 
 console.log(result);

package/docs/examples/account/update-payment-method.md

@@ -9,7 +9,7 @@ const account = new Account(client);
 const result = await account.updatePaymentMethod(
     '<PAYMENT_METHOD_ID>', // paymentMethodId
     1, // expiryMonth
-    2024 // expiryYear
+    2025 // expiryYear
 );
 
 console.log(result);

package/docs/examples/console/create-program-membership.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.createProgramMembership(
+    '<PROGRAM_ID>' // programId
+);
+
+console.log(result);

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 abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "1.4.4",
+  "version": "1.4.6",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -19,9 +19,9 @@ type Headers = {
  */
 type RealtimeResponse = {
     /**
-     * Type of the response: 'error', 'event', 'connected', or 'response'.
+     * Type of the response: 'error', 'event', 'connected', 'pong', or 'response'.
      */
-    type: 'error' | 'event' | 'connected' | 'response';
+    type: 'error' | 'event' | 'connected' | 'response' | 'pong';
 
     /**
      * Data associated with the response based on the response type.
@@ -129,6 +129,8 @@ type RealtimeRequestAuthenticate = {
     session: string;
 }
 
+type TimeoutHandle = ReturnType<typeof setTimeout> | number;
+
 /**
  * Realtime interface representing the structure of a realtime communication object.
  */
@@ -139,9 +141,14 @@ type Realtime = {
     socket?: WebSocket;
 
     /**
-     * Timeout duration for communication operations.
+     * Timeout for reconnect operations.
      */
-    timeout?: number;
+    timeout?: TimeoutHandle;
+
+    /**
+     * Heartbeat interval for the realtime connection.
+    */
+    heartbeat?: TimeoutHandle;
 
     /**
      * URL for establishing the WebSocket connection.
@@ -196,6 +203,11 @@ type Realtime = {
      */
     createSocket: () => void;
 
+    /**
+     * Function to create a new heartbeat interval.
+     */
+    createHeartbeat: () => void;
+
     /**
      * Function to clean up resources associated with specified channels.
      *
@@ -304,7 +316,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '1.4.4',
+        'x-sdk-version': '1.4.6',
         'X-Appwrite-Response-Format': '1.6.0',
     };
 
@@ -407,6 +419,7 @@ class Client {
     private realtime: Realtime = {
         socket: undefined,
         timeout: undefined,
+        heartbeat: undefined,
         url: '',
         channels: new Set(),
         subscriptions: new Map(),
@@ -432,6 +445,17 @@ class Client {
                     return 60_000;
             }
         },
+        createHeartbeat: () => {
+            if (this.realtime.heartbeat) {
+                clearTimeout(this.realtime.heartbeat);
+            }
+
+            this.realtime.heartbeat = window?.setInterval(() => {
+                this.realtime.socket?.send(JSON.stringify({
+                    type: 'ping'
+                }));
+            }, 20_000);
+        },
         createSocket: () => {
             if (this.realtime.channels.size < 1) {
                 this.realtime.reconnect = false;
@@ -465,6 +489,7 @@ class Client {
                 this.realtime.socket.addEventListener('message', this.realtime.onMessage);
                 this.realtime.socket.addEventListener('open', _event => {
                     this.realtime.reconnectAttempts = 0;
+                    this.realtime.createHeartbeat();
                 });
                 this.realtime.socket.addEventListener('close', event => {
                     if (

package/src/enums/runtime.ts

@@ -54,4 +54,5 @@ export enum Runtime {
     Bun11 = 'bun-1.1',
     Go123 = 'go-1.23',
     Static1 = 'static-1',
+    Flutter324 = 'flutter-3.24',
 }

package/src/models.ts

@@ -496,19 +496,6 @@ export namespace Models {
          */
         migrations: Migration[];
     }
-    /**
-     * Migrations Firebase Projects List
-     */
-    export type FirebaseProjectList = {
-        /**
-         * Total number of projects documents that matched your query.
-         */
-        total: number;
-        /**
-         * List of projects.
-         */
-        projects: FirebaseProject[];
-    }
     /**
      * Specifications List
      */
@@ -1941,7 +1928,7 @@ export namespace Models {
          */
         events: string[];
         /**
-         * Function execution schedult in CRON format.
+         * Function execution schedule in CRON format.
          */
         schedule: string;
         /**
@@ -3110,7 +3097,7 @@ export namespace Models {
         /**
          * Resource ID.
          */
-        resourceId: string;
+        resourceId?: string;
         /**
          * Resource name.
          */
@@ -3119,6 +3106,10 @@ export namespace Models {
          * The value of this metric at the timestamp.
          */
         value: number;
+        /**
+         * The estimated value of this metric at the end of the period.
+         */
+        estimate?: number;
     }
     /**
      * UsageDatabases
@@ -3556,6 +3547,18 @@ export namespace Models {
          * Aggregated breakdown in totals of functions storage size (in bytes).
          */
         functionsStorageBreakdown: MetricBreakdown[];
+        /**
+         * Total aggregated number of phone auth.
+         */
+        authPhoneTotal: number;
+        /**
+         * Estimated total aggregated cost of phone auth.
+         */
+        authPhoneEstimate: number;
+        /**
+         * Aggregated breakdown in totals of phone auth by country.
+         */
+        authPhoneCountryBreakdown: MetricBreakdown[];
     }
     /**
      * Headers
@@ -4086,19 +4089,6 @@ export namespace Models {
          */
         version: string;
     }
-    /**
-     * MigrationFirebaseProject
-     */
-    export type FirebaseProject = {
-        /**
-         * Project ID.
-         */
-        projectId: string;
-        /**
-         * Project display name.
-         */
-        displayName: string;
-    }
     /**
      * AdditionalResource
      */
@@ -4319,6 +4309,10 @@ export namespace Models {
          * Plan name
          */
         name: string;
+        /**
+         * Plan order
+         */
+        order: number;
         /**
          * Price
          */
@@ -4411,6 +4405,26 @@ export namespace Models {
          * Can user change the plan themselves
          */
         selfService: boolean;
+        /**
+         * Does plan enable premium support
+         */
+        premiumSupport: boolean;
+        /**
+         * Does plan support budget cap
+         */
+        budgeting: boolean;
+        /**
+         * Does plan support mock numbers
+         */
+        supportsMockNumbers: boolean;
+        /**
+         * Does plan support backup policies.
+         */
+        backupsEnabled: boolean;
+        /**
+         * How many policies does plan support
+         */
+        backupPolicies: number;
     }
     /**
      * Campaign
@@ -4692,7 +4706,7 @@ export namespace Models {
         /**
          * Project budget limit
          */
-        budgetAlerts: string[];
+        budgetAlerts: number[];
         /**
          * Billing plan selected. Can be one of `tier-0`, `tier-1` or `tier-2`.
          */
@@ -5068,6 +5082,14 @@ export namespace Models {
          * Aggregated stats for total storage.
          */
         storageTotal: number;
+        /**
+         * Aggregated stats for total phone authentication SMS.
+         */
+        authPhoneTotal: number;
+        /**
+         * Aggregated stats for estimated phone authentication SMS cost.
+         */
+        authPhoneEstimate: number;
         /**
          * Aggregated stats for each projects.
          */
@@ -5105,6 +5127,14 @@ export namespace Models {
          * Aggregated stats for number of documents.
          */
         storage: number;
+        /**
+         * Aggregated stats for phone authentication.
+         */
+        authPhoneTotal: number;
+        /**
+         * Aggregated stats for phone authentication estimated cost.
+         */
+        authPhoneEstimate: number;
     }
     /**
      * Aggregation team list

package/src/services/account.ts

@@ -320,6 +320,34 @@ export class Account {
             payload
         );
     }
+    /**
+     * Get coupon details
+     *
+     *
+     * @param {string} couponId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Coupon>}
+     */
+    async getCoupon(couponId: string): Promise<Models.Coupon> {
+        if (typeof couponId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "couponId"');
+        }
+        const apiPath = '/account/coupons/{couponId}'.replace('{couponId}', couponId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Update email
      *
@@ -1817,7 +1845,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
     /**
      * Create magic URL token
      *
-     * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user&#039;s email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.
+     * Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user&#039;s email address is valid for 1 hour.
 
 A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
 

package/src/services/console.ts

@@ -89,6 +89,34 @@ export class Console {
             payload
         );
     }
+    /**
+     * Create program membership
+     *
+     *
+     * @param {string} programId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    async createProgramMembership(programId: string): Promise<{}> {
+        if (typeof programId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "programId"');
+        }
+        const apiPath = '/console/programs/{programId}/memberships'.replace('{programId}', programId);
+        const payload: Payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+
+        return await this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Get Regions
      *