@appwrite.io/console 11.0.0 → 12.1.0

package/types/services/account.d.ts

@@ -1076,7 +1076,7 @@ export declare class Account {
      * 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).
      *
      *
-     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} params.success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} params.failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1097,7 +1097,7 @@ export declare class Account {
      * 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).
      *
      *
-     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1353,7 +1353,7 @@ export declare class Account {
      *
      * 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).
      *
-     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} params.success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} params.failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1373,7 +1373,7 @@ export declare class Account {
      *
      * 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).
      *
-     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, fusionauth, github, gitlab, google, keycloak, kick, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.

package/types/services/console.d.ts

@@ -2,6 +2,7 @@ import { Client } from '../client';
 import type { Models } from '../models';
 import { Platform } from '../enums/platform';
 import { ConsoleResourceType } from '../enums/console-resource-type';
+import { QuerySuggestionResource } from '../enums/query-suggestion-resource';
 export declare class Console {
     client: Client;
     constructor(client: Client);
@@ -43,6 +44,13 @@ export declare class Console {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     getCoupon(couponId: string): Promise<Models.Coupon>;
+    /**
+     * List all OAuth2 providers supported by the Appwrite server, along with the parameters required to configure each provider. The response excludes mock providers but includes sandbox providers.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleOAuth2ProviderList>}
+     */
+    listOAuth2Providers(): Promise<Models.ConsoleOAuth2ProviderList>;
     /**
      * Return a list of all available plans.
      *
@@ -148,6 +156,13 @@ export declare class Console {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     getResource(value: string, type: ConsoleResourceType): Promise<{}>;
+    /**
+     * List all scopes available for project API keys, along with a description for each scope.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleKeyScopeList>}
+     */
+    listProjectScopes(): Promise<Models.ConsoleKeyScopeList>;
     /**
      * Create a new source.
      *
@@ -238,6 +253,36 @@ export declare class Console {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     suggestIndexes(databaseId: string, tableId: string, min?: number, max?: number): Promise<Models.ColumnIndexList>;
+    /**
+     * Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `resource` — for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.
+     *
+     *
+     * @param {QuerySuggestionResource} params.resource - Resource to generate queries for.
+     * @param {string} params.input - Natural language query intent used to generate filters/sorting/pagination.
+     * @param {string} params.databaseId - Database ID. Required when resource is `tables` or `rows`.
+     * @param {string} params.tableId - Table ID. Required when resource is `rows`.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    suggestQueries(params: {
+        resource: QuerySuggestionResource;
+        input: string;
+        databaseId?: string;
+        tableId?: string;
+    }): Promise<{}>;
+    /**
+     * Suggest valid Appwrite query JSON objects for a supported list resource from free-text user intent. The endpoint picks a validator based on `resource` — for system resources it uses the static validator and its allowed attributes, and for user-owned table rows it loads the table schema and validates against those attributes at request time. The returned queries are guaranteed to parse and pass the relevant queries validator.
+     *
+     *
+     * @param {QuerySuggestionResource} resource - Resource to generate queries for.
+     * @param {string} input - Natural language query intent used to generate filters/sorting/pagination.
+     * @param {string} databaseId - Database ID. Required when resource is `tables` or `rows`.
+     * @param {string} tableId - Table ID. Required when resource is `rows`.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    suggestQueries(resource: QuerySuggestionResource, input: string, databaseId?: string, tableId?: string): Promise<{}>;
     /**
      * Get all Environment Variables that are relevant for the console.
      *

package/types/services/domains.d.ts

@@ -129,25 +129,25 @@ export declare class Domains {
     /**
      *     Finalize a domain purchase initiated with Create Purchase. Verifies that any required 3D Secure authentication is complete, registers the domain, captures the payment, and provisions default DNS records. Returns a 402 error if authentication is still pending.
      *
-     * @param {string} params.domainId - Domain ID to confirm purchase for.
+     * @param {string} params.invoiceId - Invoice ID.
      * @param {string} params.organizationId - Team ID that owns the domain.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DomainPurchase>}
      */
     updatePurchase(params: {
-        domainId: string;
+        invoiceId: string;
         organizationId: string;
     }): Promise<Models.DomainPurchase>;
     /**
      *     Finalize a domain purchase initiated with Create Purchase. Verifies that any required 3D Secure authentication is complete, registers the domain, captures the payment, and provisions default DNS records. Returns a 402 error if authentication is still pending.
      *
-     * @param {string} domainId - Domain ID to confirm purchase for.
+     * @param {string} invoiceId - Invoice ID.
      * @param {string} organizationId - Team ID that owns the domain.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DomainPurchase>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updatePurchase(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
+    updatePurchase(invoiceId: string, organizationId: string): Promise<Models.DomainPurchase>;
     /**
      *     List domain suggestions.
      *
@@ -216,25 +216,25 @@ export declare class Domains {
     /**
      *     Finalize a domain transfer-in initiated with Create Transfer In. Verifies that any required 3D Secure authentication is complete, submits the transfer with the authorization code, captures the payment, and sends a confirmation email. Returns a 402 error if authentication is still pending.
      *
-     * @param {string} params.domainId - Domain ID to confirm transfer for.
+     * @param {string} params.invoiceId - Invoice ID.
      * @param {string} params.organizationId - Team ID that owns the domain.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DomainPurchase>}
      */
     updateTransferIn(params: {
-        domainId: string;
+        invoiceId: string;
         organizationId: string;
     }): Promise<Models.DomainPurchase>;
     /**
      *     Finalize a domain transfer-in initiated with Create Transfer In. Verifies that any required 3D Secure authentication is complete, submits the transfer with the authorization code, captures the payment, and sends a confirmation email. Returns a 402 error if authentication is still pending.
      *
-     * @param {string} domainId - Domain ID to confirm transfer for.
+     * @param {string} invoiceId - Invoice ID.
      * @param {string} organizationId - Team ID that owns the domain.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DomainPurchase>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateTransferIn(domainId: string, organizationId: string): Promise<Models.DomainPurchase>;
+    updateTransferIn(invoiceId: string, organizationId: string): Promise<Models.DomainPurchase>;
     /**
      *     Initiate a domain transfer-out by generating an authorization code for the specified domain. The returned `authCode` should be provided to the gaining provider to complete the transfer. If the domain has auto-renewal enabled, it will be automatically disabled as part of this operation.
      *

package/types/services/manager.d.ts

@@ -0,0 +1,110 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+import { ResourceType } from '../enums/resource-type';
+export declare class Manager {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Creates a new resource block.
+     *
+     * @param {string} params.projectId - Project ID
+     * @param {ResourceType} params.resourceType - Resource type to block (e.g., projects, functions, databases, storage, etc.)
+     * @param {string} params.resourceId - Optional resource ID (if omitted, all resources of this type will be blocked)
+     * @param {string} params.reason - Optional reason why the resource is blocked
+     * @param {string} params.expiredAt - Optional expiration date for the block
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Block>}
+     */
+    createBlock(params: {
+        projectId: string;
+        resourceType: ResourceType;
+        resourceId?: string;
+        reason?: string;
+        expiredAt?: string;
+    }): Promise<Models.Block>;
+    /**
+     * Creates a new resource block.
+     *
+     * @param {string} projectId - Project ID
+     * @param {ResourceType} resourceType - Resource type to block (e.g., projects, functions, databases, storage, etc.)
+     * @param {string} resourceId - Optional resource ID (if omitted, all resources of this type will be blocked)
+     * @param {string} reason - Optional reason why the resource is blocked
+     * @param {string} expiredAt - Optional expiration date for the block
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Block>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createBlock(projectId: string, resourceType: ResourceType, resourceId?: string, reason?: string, expiredAt?: string): Promise<Models.Block>;
+    /**
+     * Deletes resource blocks for a project.
+     *
+     * @param {string} params.projectId - Project ID
+     * @param {ResourceType} params.resourceType - Resource type to unblock
+     * @param {string} params.resourceId - Optional resource ID (if omitted, all blocks of this type will be removed)
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BlockDelete>}
+     */
+    deleteBlock(params: {
+        projectId: string;
+        resourceType: ResourceType;
+        resourceId?: string;
+    }): Promise<Models.BlockDelete>;
+    /**
+     * Deletes resource blocks for a project.
+     *
+     * @param {string} projectId - Project ID
+     * @param {ResourceType} resourceType - Resource type to unblock
+     * @param {string} resourceId - Optional resource ID (if omitted, all blocks of this type will be removed)
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BlockDelete>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteBlock(projectId: string, resourceType: ResourceType, resourceId?: string): Promise<Models.BlockDelete>;
+    /**
+     * Lists all resource blocks for a project.
+     *
+     * @param {string} params.projectId - Project ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BlockList>}
+     */
+    listBlocks(params: {
+        projectId: string;
+    }): Promise<Models.BlockList>;
+    /**
+     * Lists all resource blocks for a project.
+     *
+     * @param {string} projectId - Project ID
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BlockList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listBlocks(projectId: string): Promise<Models.BlockList>;
+    /**
+     * Updates a console user status using a user ID or email address.
+     *
+     * @param {boolean} params.status - User status. Set to `false` to block and `true` to unblock.
+     * @param {string} params.userId - User ID.
+     * @param {string} params.email - User email address.
+     * @param {string} params.reason - Optional reason when blocking a user. Accepted for parity with the CLI task but not persisted.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.User<Preferences>>}
+     */
+    updateUserStatus<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
+        status: boolean;
+        userId?: string;
+        email?: string;
+        reason?: string;
+    }): Promise<Models.User<Preferences>>;
+    /**
+     * Updates a console user status using a user ID or email address.
+     *
+     * @param {boolean} status - User status. Set to `false` to block and `true` to unblock.
+     * @param {string} userId - User ID.
+     * @param {string} email - User email address.
+     * @param {string} reason - Optional reason when blocking a user. Accepted for parity with the CLI task but not persisted.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.User<Preferences>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateUserStatus<Preferences extends Models.Preferences = Models.DefaultPreferences>(status: boolean, userId?: string, email?: string, reason?: string): Promise<Models.User<Preferences>>;
+}

package/types/services/organizations.d.ts

@@ -1035,6 +1035,36 @@ export declare class Organizations {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Create a billing plan estimation for upgrading or downgrading an organization plan.
+     *
+     *
+     * @param {string} params.organizationId - Organization ID
+     * @param {string} params.billingPlan - Target billing plan
+     * @param {string[]} params.invites - Additional member invites
+     * @param {string} params.couponId - Coupon id
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EstimationPlanChange>}
+     */
+    createPlanEstimation(params: {
+        organizationId: string;
+        billingPlan: string;
+        invites?: string[];
+        couponId?: string;
+    }): Promise<Models.EstimationPlanChange>;
+    /**
+     * Create a billing plan estimation for upgrading or downgrading an organization plan.
+     *
+     *
+     * @param {string} organizationId - Organization ID
+     * @param {string} billingPlan - Target billing plan
+     * @param {string[]} invites - Additional member invites
+     * @param {string} couponId - Coupon id
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.EstimationPlanChange>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createPlanEstimation(organizationId: string, billingPlan: string, invites?: string[], couponId?: string): Promise<Models.EstimationPlanChange>;
     /**
      * Get all available regions for an organization.
      *