@appwrite.io/console 1.3.1 → 1.4.0

package/dist/iife/sdk.js

@@ -281,7 +281,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '1.3.1',
+                'x-sdk-version': '1.4.0',
                 'X-Appwrite-Response-Format': '1.6.0',
             };
             this.realtime = {
@@ -626,6 +626,11 @@
                 return response;
             });
         }
+        ping() {
+            return __awaiter(this, void 0, void 0, function* () {
+                return this.call('GET', new URL(this.config.endpoint + '/ping'));
+            });
+        }
         call(method, url, headers = {}, params = {}, responseType = 'json') {
             var _a;
             return __awaiter(this, void 0, void 0, function* () {
@@ -789,7 +794,7 @@
          *
          * @param {string[]} queries
          * @throws {AppwriteException}
-         * @returns {Promise<Models.BillingAddress>}
+         * @returns {Promise<Models.BillingAddressList>}
          */
         listBillingAddresses(queries) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -805,6 +810,60 @@
                 return yield this.client.call('get', uri, apiHeaders, payload);
             });
         }
+        /**
+         * Create new billing address
+         *
+         *
+         * @param {string} country
+         * @param {string} streetAddress
+         * @param {string} city
+         * @param {string} state
+         * @param {string} postalCode
+         * @param {string} addressLine2
+         * @throws {AppwriteException}
+         * @returns {Promise<{}>}
+         */
+        createBillingAddress(country, streetAddress, city, state, postalCode, addressLine2) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof country === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "country"');
+                }
+                if (typeof streetAddress === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "streetAddress"');
+                }
+                if (typeof city === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "city"');
+                }
+                if (typeof state === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "state"');
+                }
+                const apiPath = '/account/billing-addresses';
+                const payload = {};
+                if (typeof country !== 'undefined') {
+                    payload['country'] = country;
+                }
+                if (typeof streetAddress !== 'undefined') {
+                    payload['streetAddress'] = streetAddress;
+                }
+                if (typeof city !== 'undefined') {
+                    payload['city'] = city;
+                }
+                if (typeof state !== 'undefined') {
+                    payload['state'] = state;
+                }
+                if (typeof postalCode !== 'undefined') {
+                    payload['postalCode'] = postalCode;
+                }
+                if (typeof addressLine2 !== 'undefined') {
+                    payload['addressLine2'] = addressLine2;
+                }
+                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 billing address
          *
@@ -827,6 +886,86 @@
                 return yield this.client.call('get', uri, apiHeaders, payload);
             });
         }
+        /**
+         * Update billing address
+         *
+         *
+         * @param {string} billingAddressId
+         * @param {string} country
+         * @param {string} streetAddress
+         * @param {string} city
+         * @param {string} state
+         * @param {string} postalCode
+         * @param {string} addressLine2
+         * @throws {AppwriteException}
+         * @returns {Promise<{}>}
+         */
+        updateBillingAddress(billingAddressId, country, streetAddress, city, state, postalCode, addressLine2) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof billingAddressId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "billingAddressId"');
+                }
+                if (typeof country === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "country"');
+                }
+                if (typeof streetAddress === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "streetAddress"');
+                }
+                if (typeof city === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "city"');
+                }
+                if (typeof state === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "state"');
+                }
+                const apiPath = '/account/billing-addresses/{billingAddressId}'.replace('{billingAddressId}', billingAddressId);
+                const payload = {};
+                if (typeof country !== 'undefined') {
+                    payload['country'] = country;
+                }
+                if (typeof streetAddress !== 'undefined') {
+                    payload['streetAddress'] = streetAddress;
+                }
+                if (typeof city !== 'undefined') {
+                    payload['city'] = city;
+                }
+                if (typeof state !== 'undefined') {
+                    payload['state'] = state;
+                }
+                if (typeof postalCode !== 'undefined') {
+                    payload['postalCode'] = postalCode;
+                }
+                if (typeof addressLine2 !== 'undefined') {
+                    payload['addressLine2'] = addressLine2;
+                }
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                const apiHeaders = {
+                    'content-type': 'application/json',
+                };
+                return yield this.client.call('put', uri, apiHeaders, payload);
+            });
+        }
+        /**
+         * Delete billing address
+         *
+         *
+         * @param {string} billingAddressId
+         * @throws {AppwriteException}
+         * @returns {Promise<{}>}
+         */
+        deleteBillingAddress(billingAddressId) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof billingAddressId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "billingAddressId"');
+                }
+                const apiPath = '/account/billing-addresses/{billingAddressId}'.replace('{billingAddressId}', billingAddressId);
+                const payload = {};
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                const apiHeaders = {
+                    'content-type': 'application/json',
+                };
+                return yield this.client.call('delete', uri, apiHeaders, payload);
+            });
+        }
         /**
          * Update email
          *
@@ -2287,32 +2426,6 @@
                 return yield this.client.call('put', uri, apiHeaders, payload);
             });
         }
-        /**
-         * List credits
-         *
-         *
-         * @param {string} organizationId
-         * @param {string[]} queries
-         * @throws {AppwriteException}
-         * @returns {Promise<Models.CreditList>}
-         */
-        listCredits(organizationId, queries) {
-            return __awaiter(this, void 0, void 0, function* () {
-                if (typeof organizationId === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "organizationId"');
-                }
-                const apiPath = '/organizations/{organizationId}/credits'.replace('{organizationId}', organizationId);
-                const payload = {};
-                if (typeof queries !== 'undefined') {
-                    payload['queries'] = queries;
-                }
-                const uri = new URL(this.client.config.endpoint + apiPath);
-                const apiHeaders = {
-                    'content-type': 'application/json',
-                };
-                return yield this.client.call('get', uri, apiHeaders, payload);
-            });
-        }
     }
 
     class Avatars {
@@ -3012,7 +3125,7 @@
          * @throws {AppwriteException}
          * @returns {Promise<Models.Coupon>}
          */
-        getCopon(couponId) {
+        getCoupon(couponId) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof couponId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "couponId"');
@@ -9496,7 +9609,7 @@
          * @param {string[]} queries
          * @param {string} search
          * @throws {AppwriteException}
-         * @returns {Promise<Models.TeamList<Preferences>>}
+         * @returns {Promise<Models.OrganizationList<Preferences>>}
          */
         list(queries, search) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -9619,7 +9732,7 @@
          * @param {string} organizationId
          * @param {string} aggregationId
          * @throws {AppwriteException}
-         * @returns {Promise<Models.Invoice>}
+         * @returns {Promise<Models.AggregationTeam>}
          */
         getAggregation(organizationId, aggregationId) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -9777,6 +9890,32 @@
                 return yield this.client.call('patch', uri, apiHeaders, payload);
             });
         }
+        /**
+         * List credits
+         *
+         *
+         * @param {string} organizationId
+         * @param {string[]} queries
+         * @throws {AppwriteException}
+         * @returns {Promise<Models.CreditList>}
+         */
+        listCredits(organizationId, queries) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof organizationId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "organizationId"');
+                }
+                const apiPath = '/organizations/{organizationId}/credits'.replace('{organizationId}', organizationId);
+                const payload = {};
+                if (typeof queries !== 'undefined') {
+                    payload['queries'] = queries;
+                }
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                const apiHeaders = {
+                    'content-type': 'application/json',
+                };
+                return yield this.client.call('get', uri, apiHeaders, payload);
+            });
+        }
         /**
          * Add credits from coupon
          *

package/docs/examples/account/create-billing-address.md

@@ -0,0 +1,18 @@
+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.createBillingAddress(
+    '<COUNTRY>', // country
+    '<STREET_ADDRESS>', // streetAddress
+    '<CITY>', // city
+    '<STATE>', // state
+    '<POSTAL_CODE>', // postalCode (optional)
+    '<ADDRESS_LINE2>' // addressLine2 (optional)
+);
+
+console.log(result);

package/docs/examples/account/delete-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.deleteBillingAddress(
+    '<BILLING_ADDRESS_ID>' // billingAddressId
+);
+
+console.log(result);

package/docs/examples/account/update-billing-address.md

@@ -0,0 +1,19 @@
+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.updateBillingAddress(
+    '<BILLING_ADDRESS_ID>', // billingAddressId
+    '<COUNTRY>', // country
+    '<STREET_ADDRESS>', // streetAddress
+    '<CITY>', // city
+    '<STATE>', // state
+    '<POSTAL_CODE>', // postalCode (optional)
+    '<ADDRESS_LINE2>' // addressLine2 (optional)
+);
+
+console.log(result);

package/docs/examples/console/get-coupon.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.getCoupon(
+    '<COUPON_ID>' // couponId
+);
+
+console.log(result);

package/docs/examples/organizations/list-credits.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.listCredits(
+    '<ORGANIZATION_ID>', // organizationId
+    [] // queries (optional)
+);
+
+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.3.1",
+  "version": "1.4.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -304,7 +304,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '1.3.1',
+        'x-sdk-version': '1.4.0',
         'X-Appwrite-Response-Format': '1.6.0',
     };
 
@@ -682,6 +682,10 @@ class Client {
         return response;
     }
 
+    async ping(): Promise<string> {
+        return this.call('GET', new URL(this.config.endpoint + '/ping'));
+    }
+
     async call(method: string, url: URL, headers: Headers = {}, params: Payload = {}, responseType = 'json'): Promise<any> {
         const { uri, options } = this.prepareRequest(method, url, headers, params);
 

package/src/models.ts

@@ -4366,7 +4366,7 @@ export namespace Models {
         /**
          * Additional resources
          */
-        addons: AdditionalResource[];
+        addons: AdditionalResource;
         /**
          * Custom SMTP
          */
@@ -4810,6 +4810,14 @@ export namespace Models {
          * Name of the owner
          */
         name: string;
+        /**
+         * Mandate ID of the payment method
+         */
+        mandateId: string;
+        /**
+         * Country of the payment method
+         */
+        country: string;
         /**
          * Last payment error associated with the payment method.
          */
@@ -5032,6 +5040,10 @@ export namespace Models {
          * Aggregated stats for total databases storage.
          */
         databasesStorageTotal: number;
+        /**
+         * Aggregated stats for total backups storage.
+         */
+        backupsStorageTotal: number;
         /**
          * Aggregated stats for total storage.
          */
@@ -5139,6 +5151,19 @@ export namespace Models {
          */
         invoices: Invoice[];
     }
+    /**
+     * Billing address list
+     */
+    export type BillingAddressList = {
+        /**
+         * Total number of billingAddresses documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of billingAddresses.
+         */
+        billingAddresses: BillingAddress[];
+    }
     /**
      * Billing plan list
      */
@@ -5152,6 +5177,19 @@ export namespace Models {
          */
         plans: BillingPlan[];
     }
+    /**
+     * Organizations List
+     */
+    export type OrganizationList<Preferences extends Models.Preferences> = {
+        /**
+         * Total number of teams documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of teams.
+         */
+        teams: Organization<Preferences>[];
+    }
     /**
      * Payment Methods List
      */

package/src/services/account.ts

@@ -118,9 +118,9 @@ export class Account {
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise<Models.BillingAddress>}
+     * @returns {Promise<Models.BillingAddressList>}
      */
-    async listBillingAddresses(queries?: string[]): Promise<Models.BillingAddress> {
+    async listBillingAddresses(queries?: string[]): Promise<Models.BillingAddressList> {
         const apiPath = '/account/billing-addresses';
         const payload: Payload = {};
         if (typeof queries !== 'undefined') {
@@ -140,6 +140,66 @@ export class Account {
             payload
         );
     }
+    /**
+     * Create new billing address
+     *
+     *
+     * @param {string} country
+     * @param {string} streetAddress
+     * @param {string} city
+     * @param {string} state
+     * @param {string} postalCode
+     * @param {string} addressLine2
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    async createBillingAddress(country: string, streetAddress: string, city: string, state: string, postalCode?: string, addressLine2?: string): Promise<{}> {
+        if (typeof country === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "country"');
+        }
+        if (typeof streetAddress === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "streetAddress"');
+        }
+        if (typeof city === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "city"');
+        }
+        if (typeof state === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "state"');
+        }
+        const apiPath = '/account/billing-addresses';
+        const payload: Payload = {};
+        if (typeof country !== 'undefined') {
+            payload['country'] = country;
+        }
+        if (typeof streetAddress !== 'undefined') {
+            payload['streetAddress'] = streetAddress;
+        }
+        if (typeof city !== 'undefined') {
+            payload['city'] = city;
+        }
+        if (typeof state !== 'undefined') {
+            payload['state'] = state;
+        }
+        if (typeof postalCode !== 'undefined') {
+            payload['postalCode'] = postalCode;
+        }
+        if (typeof addressLine2 !== 'undefined') {
+            payload['addressLine2'] = addressLine2;
+        }
+        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 billing address
      *
@@ -168,6 +228,98 @@ export class Account {
             payload
         );
     }
+    /**
+     * Update billing address
+     *
+     *
+     * @param {string} billingAddressId
+     * @param {string} country
+     * @param {string} streetAddress
+     * @param {string} city
+     * @param {string} state
+     * @param {string} postalCode
+     * @param {string} addressLine2
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    async updateBillingAddress(billingAddressId: string, country: string, streetAddress: string, city: string, state: string, postalCode?: string, addressLine2?: string): Promise<{}> {
+        if (typeof billingAddressId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "billingAddressId"');
+        }
+        if (typeof country === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "country"');
+        }
+        if (typeof streetAddress === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "streetAddress"');
+        }
+        if (typeof city === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "city"');
+        }
+        if (typeof state === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "state"');
+        }
+        const apiPath = '/account/billing-addresses/{billingAddressId}'.replace('{billingAddressId}', billingAddressId);
+        const payload: Payload = {};
+        if (typeof country !== 'undefined') {
+            payload['country'] = country;
+        }
+        if (typeof streetAddress !== 'undefined') {
+            payload['streetAddress'] = streetAddress;
+        }
+        if (typeof city !== 'undefined') {
+            payload['city'] = city;
+        }
+        if (typeof state !== 'undefined') {
+            payload['state'] = state;
+        }
+        if (typeof postalCode !== 'undefined') {
+            payload['postalCode'] = postalCode;
+        }
+        if (typeof addressLine2 !== 'undefined') {
+            payload['addressLine2'] = addressLine2;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+
+        return await this.client.call(
+            'put',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+    /**
+     * Delete billing address
+     *
+     *
+     * @param {string} billingAddressId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    async deleteBillingAddress(billingAddressId: string): Promise<{}> {
+        if (typeof billingAddressId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "billingAddressId"');
+        }
+        const apiPath = '/account/billing-addresses/{billingAddressId}'.replace('{billingAddressId}', billingAddressId);
+        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(
+            'delete',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Update email
      *
@@ -1940,36 +2092,4 @@ Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/
             payload
         );
     }
-    /**
-     * List credits
-     *
-     *
-     * @param {string} organizationId
-     * @param {string[]} queries
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.CreditList>}
-     */
-    async listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList> {
-        if (typeof organizationId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "organizationId"');
-        }
-        const apiPath = '/organizations/{organizationId}/credits'.replace('{organizationId}', organizationId);
-        const payload: Payload = {};
-        if (typeof queries !== 'undefined') {
-            payload['queries'] = queries;
-        }
-        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
-        );
-    }
 }

package/src/services/console.ts

@@ -45,7 +45,7 @@ export class Console {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Coupon>}
      */
-    async getCopon(couponId: string): Promise<Models.Coupon> {
+    async getCoupon(couponId: string): Promise<Models.Coupon> {
         if (typeof couponId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "couponId"');
         }