@appwrite.io/console 1.7.0 → 1.9.0

package/types/services/databases.d.ts

@@ -478,7 +478,7 @@ export declare class Databases {
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      */
-    upsertDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents?: object[]): Promise<Models.DocumentList<Document>>;
+    upsertDocuments<Document extends Models.Document>(databaseId: string, collectionId: string, documents: object[]): Promise<Models.DocumentList<Document>>;
     /**
      * Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.
      *
@@ -511,6 +511,18 @@ export declare class Databases {
      * @returns {Promise<Document>}
      */
     getDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Document>;
+    /**
+     * Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {object} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    upsertDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document>;
     /**
      * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
      *
@@ -544,6 +556,32 @@ export declare class Databases {
      * @returns {Promise<Models.LogList>}
      */
     listDocumentLogs(databaseId: string, collectionId: string, documentId: string, queries?: string[]): Promise<Models.LogList>;
+    /**
+     * 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<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, attribute: string, value?: number, min?: number): Promise<Document>;
+    /**
+     * 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<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, attribute: string, value?: number, max?: number): Promise<Document>;
     /**
      * List indexes in the collection.
      *

package/types/services/functions.d.ts

@@ -38,14 +38,10 @@ export declare class Functions {
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
      * @param {string} specification
-     * @param {string} templateRepository
-     * @param {string} templateOwner
-     * @param {string} templateRootDirectory
-     * @param {string} templateVersion
      * @throws {AppwriteException}
      * @returns {Promise<Models.Function>}
      */
-    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string): Promise<Models.Function>;
+    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *

package/types/services/health.d.ts

@@ -48,13 +48,21 @@ export declare class Health {
      */
     getPubSub(): Promise<Models.HealthStatus>;
     /**
-     * Get billing aggregation queue
+     * Get billing project aggregation queue
      *
      * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
-    getQueueBillingAggregation(threshold?: number): Promise<Models.HealthQueue>;
+    getQueueBillingProjectAggregation(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get billing team aggregation queue
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueBillingTeamAggregation(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
      *

package/types/services/organizations.d.ts

@@ -30,6 +30,17 @@ export declare class Organizations {
      * @returns {Promise<Models.Organization<Preferences>>}
      */
     create<Preferences extends Models.Preferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
+    /**
+     * Get estimation for creating an organization.
+     *
+     * @param {BillingPlan} billingPlan
+     * @param {string} paymentMethodId
+     * @param {string[]} invites
+     * @param {string} couponId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Estimation>}
+     */
+    estimationCreateOrganization(billingPlan: BillingPlan, paymentMethodId?: string, invites?: string[], couponId?: string): Promise<Models.Estimation>;
     /**
      * Delete an organization.
      *
@@ -129,6 +140,25 @@ export declare class Organizations {
      * @returns {Promise<Models.Credit>}
      */
     getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
+    /**
+     * Get estimation for deleting an organization.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EstimationDeleteOrganization>}
+     */
+    estimationDeleteOrganization(organizationId: string): Promise<Models.EstimationDeleteOrganization>;
+    /**
+     * Get estimation for updating the organization plan.
+     *
+     * @param {string} organizationId
+     * @param {BillingPlan} billingPlan
+     * @param {string[]} invites
+     * @param {string} couponId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EstimationUpdatePlan>}
+     */
+    estimationUpdatePlan(organizationId: string, billingPlan: BillingPlan, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
     /**
      * List all invoices for an organization.
      *
@@ -251,6 +281,14 @@ export declare class Organizations {
      * @returns {Promise<Models.Organization<Preferences>>}
      */
     updatePlan<Preferences extends Models.Preferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
+    /**
+     * Cancel the downgrade initiated for an organization.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    cancelDowngrade<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
     /**
      * Get Scopes
      *
@@ -268,4 +306,23 @@ export declare class Organizations {
      * @returns {Promise<Models.Organization<Preferences>>}
      */
     setBillingTaxId<Preferences extends Models.Preferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Get the usage data for an organization.
+     *
+     * @param {string} organizationId
+     * @param {string} startDate
+     * @param {string} endDate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageOrganization>}
+     */
+    getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization>;
+    /**
+     * Validate payment for team after creation or upgrade.
+     *
+     * @param {string} organizationId
+     * @param {string[]} invites
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    validatePayment<Preferences extends Models.Preferences>(organizationId: string, invites?: string[]): Promise<Models.Organization<Preferences>>;
 }

package/types/services/proxy.d.ts

@@ -1,6 +1,7 @@
 import { Client } from '../client';
 import type { Models } from '../models';
 import { StatusCode } from '../enums/status-code';
+import { ProxyResourceType } from '../enums/proxy-resource-type';
 export declare class Proxy {
     client: Client;
     constructor(client: Client);
@@ -37,10 +38,12 @@ export declare 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: string, url: string, statusCode: StatusCode): Promise<Models.ProxyRule>;
+    createRedirectRule(domain: string, url: string, statusCode: StatusCode, resourceId: string, resourceType: ProxyResourceType): Promise<Models.ProxyRule>;
     /**
      * Create a new proxy rule for serving Appwrite Site on custom domain.
      *

package/types/services/tokens.d.ts

@@ -14,7 +14,7 @@ export declare class Tokens {
      */
     list(bucketId: string, fileId: string, queries?: string[]): Promise<Models.ResourceTokenList>;
     /**
-     * Create a new token. A token is linked to a file. Token can be passed as a header or request get parameter.
+     * Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.
      *
      * @param {string} bucketId
      * @param {string} fileId

package/docs/examples/functions/create-build.md

@@ -1,15 +0,0 @@
-import { Client, Functions } 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 functions = new Functions(client);
-
-const result = await functions.createBuild(
-    '<FUNCTION_ID>', // functionId
-    '<DEPLOYMENT_ID>', // deploymentId
-    '<BUILD_ID>' // buildId (optional)
-);
-
-console.log(result);

package/docs/examples/functions/get-function-usage.md

@@ -1,14 +0,0 @@
-import { Client, Functions, FunctionUsageRange } 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 functions = new Functions(client);
-
-const result = await functions.getFunctionUsage(
-    '<FUNCTION_ID>', // functionId
-    FunctionUsageRange.TwentyFourHours // range (optional)
-);
-
-console.log(result);

package/docs/examples/functions/update-deployment-build.md

@@ -1,14 +0,0 @@
-import { Client, Functions } 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 functions = new Functions(client);
-
-const result = await functions.updateDeploymentBuild(
-    '<FUNCTION_ID>', // functionId
-    '<DEPLOYMENT_ID>' // deploymentId
-);
-
-console.log(result);

package/docs/examples/functions/update-deployment.md

@@ -1,14 +0,0 @@
-import { Client, Functions } 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 functions = new Functions(client);
-
-const result = await functions.updateDeployment(
-    '<FUNCTION_ID>', // functionId
-    '<DEPLOYMENT_ID>' // deploymentId
-);
-
-console.log(result);

package/docs/examples/proxy/create-rule.md

@@ -1,15 +0,0 @@
-import { Client, Proxy,  } 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 proxy = new Proxy(client);
-
-const result = await proxy.createRule(
-    '', // domain
-    .Api, // resourceType
-    '<RESOURCE_ID>' // resourceId (optional)
-);
-
-console.log(result);

package/src/enums/resource-type.ts

@@ -1,4 +0,0 @@
-export enum ResourceType {
-    Api = 'api',
-    Function = 'function',
-}

package/types/enums/resource-type.d.ts

@@ -1,4 +0,0 @@
-export declare enum ResourceType {
-    Api = "api",
-    Function = "function"
-}