npm - @appwrite.io/console - Versions diffs - 1.8.0 → 1.9.0 - Mend

@appwrite.io/console 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (67) hide show

package/README.md +3 -3
package/dist/cjs/sdk.js +287 -8
package/dist/cjs/sdk.js.map +1 -1
package/dist/esm/sdk.js +288 -9
package/dist/esm/sdk.js.map +1 -1
package/dist/iife/sdk.js +287 -8
package/docs/examples/databases/decrement-document-attribute.md +18 -0
package/docs/examples/databases/increment-document-attribute.md +18 -0
package/docs/examples/databases/upsert-documents.md +1 -1
package/docs/examples/domains/create-record-a-a-a-a.md +1 -1
package/docs/examples/domains/create-record-a.md +1 -1
package/docs/examples/domains/create-record-alias.md +1 -1
package/docs/examples/domains/create-record-c-a-a.md +1 -1
package/docs/examples/domains/create-record-c-n-a-m-e.md +1 -1
package/docs/examples/domains/create-record-h-t-t-p-s.md +1 -1
package/docs/examples/domains/create-record-m-x.md +1 -1
package/docs/examples/domains/create-record-n-s.md +1 -1
package/docs/examples/domains/create-record-s-r-v.md +1 -1
package/docs/examples/domains/create-record-t-x-t.md +1 -1
package/docs/examples/domains/update-record-a-a-a-a.md +1 -1
package/docs/examples/domains/update-record-a.md +1 -1
package/docs/examples/domains/update-record-alias.md +1 -1
package/docs/examples/domains/update-record-c-a-a.md +1 -1
package/docs/examples/domains/update-record-c-n-a-m-e.md +1 -1
package/docs/examples/domains/update-record-h-t-t-p-s.md +1 -1
package/docs/examples/domains/update-record-m-x.md +1 -1
package/docs/examples/domains/update-record-n-s.md +1 -1
package/docs/examples/domains/update-record-s-r-v.md +1 -1
package/docs/examples/domains/update-record-t-x-t.md +1 -1
package/docs/examples/health/{get-queue-stats-usage-dump.md → get-queue-billing-project-aggregation.md} +2 -2
package/docs/examples/health/{get-queue-billing-aggregation.md → get-queue-billing-team-aggregation.md} +1 -1
package/docs/examples/organizations/cancel-downgrade.md +13 -0
package/docs/examples/organizations/estimation-create-organization.md +16 -0
package/docs/examples/organizations/estimation-delete-organization.md +13 -0
package/docs/examples/organizations/estimation-update-plan.md +16 -0
package/docs/examples/organizations/get-usage.md +1 -1
package/docs/examples/organizations/validate-payment.md +14 -0
package/docs/examples/proxy/create-redirect-rule.md +4 -2
package/package.json +1 -1
package/src/client.ts +5 -4
package/src/enums/build-runtime.ts +2 -0
package/src/enums/image-format.ts +1 -0
package/src/enums/proxy-resource-type.ts +4 -0
package/src/enums/runtime.ts +2 -0
package/src/index.ts +1 -0
package/src/models.ts +272 -2
package/src/services/databases.ts +96 -1
package/src/services/health.ts +28 -3
package/src/services/organizations.ts +197 -0
package/src/services/proxy.ts +16 -1
package/types/enums/build-runtime.d.ts +3 -1
package/types/enums/image-format.d.ts +2 -1
package/types/enums/proxy-resource-type.d.ts +4 -0
package/types/enums/runtime.d.ts +3 -1
package/types/index.d.ts +1 -0
package/types/models.d.ts +272 -2
package/types/services/databases.d.ts +27 -1
package/types/services/health.d.ts +10 -2
package/types/services/organizations.d.ts +57 -0
package/types/services/proxy.d.ts +4 -1
package/docs/examples/functions/create-build.md +0 -15
package/docs/examples/functions/get-function-usage.md +0 -14
package/docs/examples/functions/update-deployment-build.md +0 -14
package/docs/examples/functions/update-deployment.md +0 -14
package/docs/examples/proxy/create-rule.md +0 -15
package/src/enums/resource-type.ts +0 -4
package/types/enums/resource-type.d.ts +0 -4

package/README.md CHANGED Viewed

@@ -1,12 +1,12 @@
 # Appwrite Console SDK
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.7.2-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.7.4-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
-**This SDK is compatible with Appwrite server version 1.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
+**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
@@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.8.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.9.0"></script>
 ```

package/dist/cjs/sdk.js CHANGED Viewed

@@ -280,7 +280,7 @@ class Client {
             'x-sdk-name': 'Console',
             'x-sdk-platform': 'console',
             'x-sdk-language': 'web',
-            'x-sdk-version': '1.8.0',
+            'x-sdk-version': '1.9.0',
             'X-Appwrite-Response-Format': '1.7.0',
         };
         this.realtime = {
@@ -615,9 +615,10 @@ class Client {
         return { uri: url.toString(), options };
     }
     chunkedUpload(method, url, headers = {}, originalPayload = {}, onProgress) {
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const file = Object.values(originalPayload).find((value) => value instanceof File);
-            if (!file) {
+            const [fileParam, file] = (_a = Object.entries(originalPayload).find(([_, value]) => value instanceof File)) !== null && _a !== void 0 ? _a : [];
+            if (!file || !fileParam) {
                 throw new Error('File not found in payload');
             }
             if (file.size <= Client.CHUNK_SIZE) {
@@ -632,7 +633,8 @@ class Client {
                 }
                 headers['content-range'] = `bytes ${start}-${end - 1}/${file.size}`;
                 const chunk = file.slice(start, end);
-                let payload = Object.assign(Object.assign({}, originalPayload), { file: new File([chunk], file.name) });
+                let payload = Object.assign({}, originalPayload);
+                payload[fileParam] = new File([chunk], file.name);
                 response = yield this.call(method, url, headers, payload);
                 if (onProgress && typeof onProgress === 'function') {
                     onProgress({
@@ -4421,6 +4423,9 @@ class Databases {
         if (typeof collectionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "collectionId"');
         }
+        if (typeof documents === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "documents"');
+        }
         const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId);
         const payload = {};
         if (typeof documents !== 'undefined') {
@@ -4648,6 +4653,84 @@ class Databases {
         const apiHeaders = {};
         return this.client.call('get', uri, apiHeaders, payload);
     }
+    /**
+     * Decrement a specific attribute of a document by a given value.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {string} attribute
+     * @param {number} value
+     * @param {number} min
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    decrementDocumentAttribute(databaseId, collectionId, documentId, attribute, value, min) {
+        if (typeof databaseId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "databaseId"');
+        }
+        if (typeof collectionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "collectionId"');
+        }
+        if (typeof documentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "documentId"');
+        }
+        if (typeof attribute === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "attribute"');
+        }
+        const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId).replace('{attribute}', attribute);
+        const payload = {};
+        if (typeof value !== 'undefined') {
+            payload['value'] = value;
+        }
+        if (typeof min !== 'undefined') {
+            payload['min'] = min;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        const apiHeaders = {
+            'content-type': 'application/json',
+        };
+        return this.client.call('patch', uri, apiHeaders, payload);
+    }
+    /**
+     * Increment a specific attribute of a document by a given value.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {string} attribute
+     * @param {number} value
+     * @param {number} max
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    incrementDocumentAttribute(databaseId, collectionId, documentId, attribute, value, max) {
+        if (typeof databaseId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "databaseId"');
+        }
+        if (typeof collectionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "collectionId"');
+        }
+        if (typeof documentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "documentId"');
+        }
+        if (typeof attribute === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "attribute"');
+        }
+        const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId).replace('{attribute}', attribute);
+        const payload = {};
+        if (typeof value !== 'undefined') {
+            payload['value'] = value;
+        }
+        if (typeof max !== 'undefined') {
+            payload['max'] = max;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        const apiHeaders = {
+            'content-type': 'application/json',
+        };
+        return this.client.call('patch', uri, apiHeaders, payload);
+    }
     /**
      * List indexes in the collection.
      *
@@ -7430,14 +7513,31 @@ class Health {
         return this.client.call('get', uri, apiHeaders, payload);
     }
     /**
-     * Get billing aggregation queue
+     * Get billing project aggregation queue
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueBillingProjectAggregation(threshold) {
+        const apiPath = '/health/queue/billing-project-aggregation';
+        const payload = {};
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        const apiHeaders = {};
+        return this.client.call('get', uri, apiHeaders, payload);
+    }
+    /**
+     * Get billing team aggregation queue
      *
      * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
-    getQueueBillingAggregation(threshold) {
-        const apiPath = '/health/queue/billing-aggregation';
+    getQueueBillingTeamAggregation(threshold) {
+        const apiPath = '/health/queue/billing-team-aggregation';
         const payload = {};
         if (typeof threshold !== 'undefined') {
             payload['threshold'] = threshold;
@@ -10280,6 +10380,40 @@ class Organizations {
         };
         return this.client.call('post', uri, apiHeaders, 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, paymentMethodId, invites, couponId) {
+        if (typeof billingPlan === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "billingPlan"');
+        }
+        const apiPath = '/organizations/estimations/create-organization';
+        const 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 = {
+            'content-type': 'application/json',
+        };
+        return this.client.call('patch', uri, apiHeaders, payload);
+    }
     /**
      * Delete an organization.
      *
@@ -10532,6 +10666,59 @@ class Organizations {
         const apiHeaders = {};
         return this.client.call('get', uri, apiHeaders, payload);
     }
+    /**
+     * Get estimation for deleting an organization.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EstimationDeleteOrganization>}
+     */
+    estimationDeleteOrganization(organizationId) {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/estimations/delete-organization'.replace('{organizationId}', organizationId);
+        const payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        const apiHeaders = {
+            '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, billingPlan, invites, couponId) {
+        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 = {};
+        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 = {
+            'content-type': 'application/json',
+        };
+        return this.client.call('patch', uri, apiHeaders, payload);
+    }
     /**
      * List all invoices for an organization.
      *
@@ -10848,6 +11035,25 @@ class Organizations {
         };
         return this.client.call('patch', uri, apiHeaders, payload);
     }
+    /**
+     * Cancel the downgrade initiated for an organization.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    cancelDowngrade(organizationId) {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/plan/cancel'.replace('{organizationId}', organizationId);
+        const payload = {};
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        const apiHeaders = {
+            'content-type': 'application/json',
+        };
+        return this.client.call('patch', uri, apiHeaders, payload);
+    }
     /**
      * Get Scopes
      *
@@ -10891,6 +11097,54 @@ class Organizations {
         };
         return this.client.call('patch', uri, apiHeaders, 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, startDate, endDate) {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/usage'.replace('{organizationId}', organizationId);
+        const 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 = {};
+        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(organizationId, invites) {
+        if (typeof organizationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "organizationId"');
+        }
+        const apiPath = '/organizations/{organizationId}/validate'.replace('{organizationId}', organizationId);
+        const payload = {};
+        if (typeof invites !== 'undefined') {
+            payload['invites'] = invites;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        const apiHeaders = {
+            'content-type': 'application/json',
+        };
+        return this.client.call('patch', uri, apiHeaders, payload);
+    }
 }
 class Project {
@@ -12767,10 +13021,12 @@ class Proxy {
      * @param {string} domain
      * @param {string} url
      * @param {StatusCode} statusCode
+     * @param {string} resourceId
+     * @param {ProxyResourceType} resourceType
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    createRedirectRule(domain, url, statusCode) {
+    createRedirectRule(domain, url, statusCode, resourceId, resourceType) {
         if (typeof domain === 'undefined') {
             throw new AppwriteException('Missing required parameter: "domain"');
         }
@@ -12780,6 +13036,12 @@ class Proxy {
         if (typeof statusCode === 'undefined') {
             throw new AppwriteException('Missing required parameter: "statusCode"');
         }
+        if (typeof resourceId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "resourceId"');
+        }
+        if (typeof resourceType === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "resourceType"');
+        }
         const apiPath = '/proxy/rules/redirect';
         const payload = {};
         if (typeof domain !== 'undefined') {
@@ -12791,6 +13053,12 @@ class Proxy {
         if (typeof statusCode !== 'undefined') {
             payload['statusCode'] = statusCode;
         }
+        if (typeof resourceId !== 'undefined') {
+            payload['resourceId'] = resourceId;
+        }
+        if (typeof resourceType !== 'undefined') {
+            payload['resourceType'] = resourceType;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
         const apiHeaders = {
             'content-type': 'application/json',
@@ -16768,6 +17036,7 @@ exports.Runtime = void 0;
     Runtime["Dart31"] = "dart-3.1";
     Runtime["Dart33"] = "dart-3.3";
     Runtime["Dart35"] = "dart-3.5";
+    Runtime["Dart38"] = "dart-3.8";
     Runtime["Dotnet60"] = "dotnet-6.0";
     Runtime["Dotnet70"] = "dotnet-7.0";
     Runtime["Dotnet80"] = "dotnet-8.0";
@@ -16794,6 +17063,7 @@ exports.Runtime = void 0;
     Runtime["Flutter324"] = "flutter-3.24";
     Runtime["Flutter327"] = "flutter-3.27";
     Runtime["Flutter329"] = "flutter-3.29";
+    Runtime["Flutter332"] = "flutter-3.32";
 })(exports.Runtime || (exports.Runtime = {}));
 exports.FunctionUsageRange = void 0;
@@ -17231,6 +17501,12 @@ exports.StatusCode = void 0;
     StatusCode["PermanentRedirect308"] = "308";
 })(exports.StatusCode || (exports.StatusCode = {}));
+exports.ProxyResourceType = void 0;
+(function (ProxyResourceType) {
+    ProxyResourceType["Site"] = "site";
+    ProxyResourceType["Function"] = "function";
+})(exports.ProxyResourceType || (exports.ProxyResourceType = {}));
 exports.Framework = void 0;
 (function (Framework) {
     Framework["Analog"] = "analog";
@@ -17285,6 +17561,7 @@ exports.BuildRuntime = void 0;
     BuildRuntime["Dart31"] = "dart-3.1";
     BuildRuntime["Dart33"] = "dart-3.3";
     BuildRuntime["Dart35"] = "dart-3.5";
+    BuildRuntime["Dart38"] = "dart-3.8";
     BuildRuntime["Dotnet60"] = "dotnet-6.0";
     BuildRuntime["Dotnet70"] = "dotnet-7.0";
     BuildRuntime["Dotnet80"] = "dotnet-8.0";
@@ -17311,6 +17588,7 @@ exports.BuildRuntime = void 0;
     BuildRuntime["Flutter324"] = "flutter-3.24";
     BuildRuntime["Flutter327"] = "flutter-3.27";
     BuildRuntime["Flutter329"] = "flutter-3.29";
+    BuildRuntime["Flutter332"] = "flutter-3.32";
 })(exports.BuildRuntime || (exports.BuildRuntime = {}));
 exports.Adapter = void 0;
@@ -17354,6 +17632,7 @@ exports.ImageFormat = void 0;
     ImageFormat["Webp"] = "webp";
     ImageFormat["Heic"] = "heic";
     ImageFormat["Avif"] = "avif";
+    ImageFormat["Gif"] = "gif";
 })(exports.ImageFormat || (exports.ImageFormat = {}));
 exports.StorageUsageRange = void 0;