@appwrite.io/console 12.0.0 → 12.2.0

package/types/services/proxy.d.ts

@@ -9,30 +9,29 @@ export declare class Proxy {
      * Get a list of all the proxy rules. You can use the query params to filter your results.
      *
      * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
-     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
      * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRuleList>}
      */
     listRules(params?: {
         queries?: string[];
-        search?: string;
         total?: boolean;
     }): Promise<Models.ProxyRuleList>;
     /**
      * Get a list of all the proxy rules. You can use the query params to filter your results.
      *
      * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
-     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
      * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRuleList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRules(queries?: string[], search?: string, total?: boolean): Promise<Models.ProxyRuleList>;
+    listRules(queries?: string[], total?: boolean): Promise<Models.ProxyRuleList>;
     /**
      * Create a new proxy rule for serving Appwrite's API on custom domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} params.domain - Domain name.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
@@ -43,6 +42,8 @@ export declare class Proxy {
     /**
      * Create a new proxy rule for serving Appwrite's API on custom domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} domain - Domain name.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
@@ -52,6 +53,8 @@ export declare class Proxy {
     /**
      * Create a new proxy rule for executing Appwrite Function on custom domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} params.domain - Domain name.
      * @param {string} params.functionId - ID of function to be executed.
      * @param {string} params.branch - Name of VCS branch to deploy changes automatically
@@ -66,6 +69,8 @@ export declare class Proxy {
     /**
      * Create a new proxy rule for executing Appwrite Function on custom domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} domain - Domain name.
      * @param {string} functionId - ID of function to be executed.
      * @param {string} branch - Name of VCS branch to deploy changes automatically
@@ -77,6 +82,8 @@ export declare class Proxy {
     /**
      * Create a new proxy rule for to redirect from custom domain to another domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} params.domain - Domain name.
      * @param {string} params.url - Target URL of redirection
      * @param {StatusCode} params.statusCode - Status code of redirection
@@ -95,6 +102,8 @@ export declare class Proxy {
     /**
      * Create a new proxy rule for to redirect from custom domain to another domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} domain - Domain name.
      * @param {string} url - Target URL of redirection
      * @param {StatusCode} statusCode - Status code of redirection
@@ -108,6 +117,8 @@ export declare class Proxy {
     /**
      * Create a new proxy rule for serving Appwrite Site on custom domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} params.domain - Domain name.
      * @param {string} params.siteId - ID of site to be executed.
      * @param {string} params.branch - Name of VCS branch to deploy changes automatically
@@ -122,6 +133,8 @@ export declare class Proxy {
     /**
      * Create a new proxy rule for serving Appwrite Site on custom domain.
      *
+     * Rule ID is automatically generated as MD5 hash of a rule domain for performance purposes.
+     *
      * @param {string} domain - Domain name.
      * @param {string} siteId - ID of site to be executed.
      * @param {string} branch - Name of VCS branch to deploy changes automatically
@@ -169,22 +182,22 @@ export declare class Proxy {
      */
     deleteRule(ruleId: string): Promise<{}>;
     /**
-     * Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.
+     * If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.
      *
      * @param {string} params.ruleId - Rule ID.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      */
-    updateRuleVerification(params: {
+    updateRuleStatus(params: {
         ruleId: string;
     }): Promise<Models.ProxyRule>;
     /**
-     * Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.
+     * If not succeeded yet, retry verification process of a proxy rule domain. This endpoint triggers domain verification by checking DNS records. If verification is successful, a TLS certificate will be automatically provisioned for the domain asynchronously in the background.
      *
      * @param {string} ruleId - Rule ID.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProxyRule>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateRuleVerification(ruleId: string): Promise<Models.ProxyRule>;
+    updateRuleStatus(ruleId: string): Promise<Models.ProxyRule>;
 }

package/types/services/sites.d.ts

@@ -679,25 +679,32 @@ export declare class Sites {
      * Get a list of all variables of a specific site.
      *
      * @param {string} params.siteId - Site unique ID.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.VariableList>}
      */
     listVariables(params: {
         siteId: string;
+        queries?: string[];
+        total?: boolean;
     }): Promise<Models.VariableList>;
     /**
      * Get a list of all variables of a specific site.
      *
      * @param {string} siteId - Site unique ID.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, resourceType, resourceId, secret
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.VariableList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listVariables(siteId: string): Promise<Models.VariableList>;
+    listVariables(siteId: string, queries?: string[], total?: boolean): Promise<Models.VariableList>;
     /**
      * Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
      *
      * @param {string} params.siteId - Site unique ID.
+     * @param {string} params.variableId - Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
      * @param {string} params.key - Variable key. Max length: 255 chars.
      * @param {string} params.value - Variable value. Max length: 8192 chars.
      * @param {boolean} params.secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
@@ -706,6 +713,7 @@ export declare class Sites {
      */
     createVariable(params: {
         siteId: string;
+        variableId: string;
         key: string;
         value: string;
         secret?: boolean;
@@ -714,6 +722,7 @@ export declare class Sites {
      * Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.
      *
      * @param {string} siteId - Site unique ID.
+     * @param {string} variableId - Variable ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
      * @param {string} key - Variable key. Max length: 255 chars.
      * @param {string} value - Variable value. Max length: 8192 chars.
      * @param {boolean} secret - Secret variables can be updated or deleted, but only sites can read them during build and runtime.
@@ -721,7 +730,7 @@ export declare class Sites {
      * @returns {Promise<Models.Variable>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createVariable(siteId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
+    createVariable(siteId: string, variableId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Get a variable by its unique ID.
      *
@@ -758,7 +767,7 @@ export declare class Sites {
     updateVariable(params: {
         siteId: string;
         variableId: string;
-        key: string;
+        key?: string;
         value?: string;
         secret?: boolean;
     }): Promise<Models.Variable>;
@@ -774,7 +783,7 @@ export declare class Sites {
      * @returns {Promise<Models.Variable>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateVariable(siteId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
+    updateVariable(siteId: string, variableId: string, key?: string, value?: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Delete a variable by its unique ID.
      *

package/types/services/tables-db.d.ts

@@ -442,6 +442,90 @@ export declare class TablesDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     listColumns(databaseId: string, tableId: string, queries?: string[], total?: boolean): Promise<Models.ColumnList>;
+    /**
+     * Create a bigint column. Optionally, minimum and maximum values can be provided.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {number | bigint} params.min - Minimum value
+     * @param {number | bigint} params.max - Maximum value
+     * @param {number | bigint} params.xdefault - Default value. Cannot be set when column is required.
+     * @param {boolean} params.array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnBigint>}
+     */
+    createBigIntColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        min?: number | bigint;
+        max?: number | bigint;
+        xdefault?: number | bigint;
+        array?: boolean;
+    }): Promise<Models.ColumnBigint>;
+    /**
+     * Create a bigint column. Optionally, minimum and maximum values can be provided.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {number | bigint} min - Minimum value
+     * @param {number | bigint} max - Maximum value
+     * @param {number | bigint} xdefault - Default value. Cannot be set when column is required.
+     * @param {boolean} array - Is column an array?
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnBigint>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createBigIntColumn(databaseId: string, tableId: string, key: string, required: boolean, min?: number | bigint, max?: number | bigint, xdefault?: number | bigint, array?: boolean): Promise<Models.ColumnBigint>;
+    /**
+     * Update a bigint column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {string} params.key - Column Key.
+     * @param {boolean} params.required - Is column required?
+     * @param {number | bigint} params.xdefault - Default value. Cannot be set when column is required.
+     * @param {number | bigint} params.min - Minimum value
+     * @param {number | bigint} params.max - Maximum value
+     * @param {string} params.newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnBigint>}
+     */
+    updateBigIntColumn(params: {
+        databaseId: string;
+        tableId: string;
+        key: string;
+        required: boolean;
+        xdefault?: number | bigint;
+        min?: number | bigint;
+        max?: number | bigint;
+        newKey?: string;
+    }): Promise<Models.ColumnBigint>;
+    /**
+     * Update a bigint column. Changing the `default` value will not update already existing rows.
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {string} key - Column Key.
+     * @param {boolean} required - Is column required?
+     * @param {number | bigint} xdefault - Default value. Cannot be set when column is required.
+     * @param {number | bigint} min - Minimum value
+     * @param {number | bigint} max - Maximum value
+     * @param {string} newKey - New Column Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnBigint>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateBigIntColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: number | bigint, min?: number | bigint, max?: number | bigint, newKey?: string): Promise<Models.ColumnBigint>;
     /**
      * Create a boolean column.
      *

package/types/services/vcs.d.ts

@@ -108,29 +108,35 @@ export declare class Vcs {
      */
     getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository>;
     /**
-     * Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
+     * Get a list of branches from a GitHub repository in your installation. This endpoint supports filtering by a search term and pagination using query strings such as `Query.limit()`, `Query.offset()`, `Query.cursorAfter()`, and `Query.cursorBefore()`. It returns branch names along with the total number of matches. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
      *
      *
      * @param {string} params.installationId - Installation Id
      * @param {string} params.providerRepositoryId - Repository Id
+     * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, cursorAfter, and cursorBefore
      * @throws {AppwriteException}
      * @returns {Promise<Models.BranchList>}
      */
     listRepositoryBranches(params: {
         installationId: string;
         providerRepositoryId: string;
+        search?: string;
+        queries?: string[];
     }): Promise<Models.BranchList>;
     /**
-     * Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
+     * Get a list of branches from a GitHub repository in your installation. This endpoint supports filtering by a search term and pagination using query strings such as `Query.limit()`, `Query.offset()`, `Query.cursorAfter()`, and `Query.cursorBefore()`. It returns branch names along with the total number of matches. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.
      *
      *
      * @param {string} installationId - Installation Id
      * @param {string} providerRepositoryId - Repository Id
+     * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit, offset, cursorAfter, and cursorBefore
      * @throws {AppwriteException}
      * @returns {Promise<Models.BranchList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList>;
+    listRepositoryBranches(installationId: string, providerRepositoryId: string, search?: string, queries?: string[]): Promise<Models.BranchList>;
     /**
      * Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.
      *