@appwrite.io/console 13.1.0 → 14.0.0

package/types/services/account.d.ts

@@ -742,7 +742,7 @@ export declare class Account {
      * Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.
      *
      * @param {string} params.password - New user password. Must be at least 8 chars.
-     * @param {string} params.oldPassword - Current user password. Must be at least 8 chars.
+     * @param {string} params.oldPassword - Current user password. Max length: 256 chars.
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
@@ -754,7 +754,7 @@ export declare class Account {
      * Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.
      *
      * @param {string} password - New user password. Must be at least 8 chars.
-     * @param {string} oldPassword - Current user password. Must be at least 8 chars.
+     * @param {string} oldPassword - Current user password. Max length: 256 chars.
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      * @deprecated Use the object parameter style method for a better developer experience.

package/types/services/advisor.d.ts

@@ -0,0 +1,123 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Advisor {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Get a list of all the project's analyzer reports. 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: appId, type, targetType, target, analyzedAt
+     * @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.ReportList>}
+     */
+    listReports(params?: {
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.ReportList>;
+    /**
+     * Get a list of all the project's analyzer reports. 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: appId, type, targetType, target, analyzedAt
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ReportList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listReports(queries?: string[], total?: boolean): Promise<Models.ReportList>;
+    /**
+     * Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.
+     *
+     *
+     * @param {string} params.reportId - Report ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Report>}
+     */
+    getReport(params: {
+        reportId: string;
+    }): Promise<Models.Report>;
+    /**
+     * Get an analyzer report by its unique ID. The response includes the report's metadata and the nested insights it produced.
+     *
+     *
+     * @param {string} reportId - Report ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Report>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getReport(reportId: string): Promise<Models.Report>;
+    /**
+     * Delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.
+     *
+     *
+     * @param {string} params.reportId - Report ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteReport(params: {
+        reportId: string;
+    }): Promise<{}>;
+    /**
+     * Delete an analyzer report by its unique ID. Nested insights and CTA metadata are removed asynchronously by the deletes worker.
+     *
+     *
+     * @param {string} reportId - Report ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteReport(reportId: string): Promise<{}>;
+    /**
+     * List the insights produced under a single analyzer report. You can use the query params to filter your results further.
+     *
+     *
+     * @param {string} params.reportId - Parent report 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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy
+     * @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.InsightList>}
+     */
+    listInsights(params: {
+        reportId: string;
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.InsightList>;
+    /**
+     * List the insights produced under a single analyzer report. You can use the query params to filter your results further.
+     *
+     *
+     * @param {string} reportId - Parent report 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: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.InsightList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listInsights(reportId: string, queries?: string[], total?: boolean): Promise<Models.InsightList>;
+    /**
+     * Get an insight by its unique ID, scoped to its parent report.
+     *
+     *
+     * @param {string} params.reportId - Parent report ID.
+     * @param {string} params.insightId - Insight ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Insight>}
+     */
+    getInsight(params: {
+        reportId: string;
+        insightId: string;
+    }): Promise<Models.Insight>;
+    /**
+     * Get an insight by its unique ID, scoped to its parent report.
+     *
+     *
+     * @param {string} reportId - Parent report ID.
+     * @param {string} insightId - Insight ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Insight>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getInsight(reportId: string, insightId: string): Promise<Models.Insight>;
+}

package/types/services/apps.d.ts

@@ -0,0 +1,302 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Apps {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * List applications.
+     *
+     * @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.
+     * @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.AppsList>}
+     */
+    list(params?: {
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.AppsList>;
+    /**
+     * List applications.
+     *
+     * @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.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AppsList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    list(queries?: string[], total?: boolean): Promise<Models.AppsList>;
+    /**
+     * Create a new application.
+     *
+     * @param {string} params.appId - Application 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.name - Application name.
+     * @param {string[]} params.redirectUris - Redirect URIs (array of valid URLs).
+     * @param {string} params.description - Application description shown to users during OAuth2 consent.
+     * @param {string} params.clientUri - Application homepage URL shown to users during OAuth2 consent.
+     * @param {string} params.logoUri - Application logo URL shown to users during OAuth2 consent.
+     * @param {string} params.privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
+     * @param {string} params.termsUrl - Application terms of service URL shown to users during OAuth2 consent.
+     * @param {string[]} params.contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
+     * @param {boolean} params.enabled - Is application enabled?
+     * @param {string} params.type - OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` — PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.
+     * @param {boolean} params.deviceFlow - Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.
+     * @param {string} params.teamId - Team unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     */
+    create(params: {
+        appId: string;
+        name: string;
+        redirectUris: string[];
+        description?: string;
+        clientUri?: string;
+        logoUri?: string;
+        privacyPolicyUrl?: string;
+        termsUrl?: string;
+        contacts?: string[];
+        enabled?: boolean;
+        type?: string;
+        deviceFlow?: boolean;
+        teamId?: string;
+    }): Promise<Models.App>;
+    /**
+     * Create a new application.
+     *
+     * @param {string} appId - Application 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} name - Application name.
+     * @param {string[]} redirectUris - Redirect URIs (array of valid URLs).
+     * @param {string} description - Application description shown to users during OAuth2 consent.
+     * @param {string} clientUri - Application homepage URL shown to users during OAuth2 consent.
+     * @param {string} logoUri - Application logo URL shown to users during OAuth2 consent.
+     * @param {string} privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
+     * @param {string} termsUrl - Application terms of service URL shown to users during OAuth2 consent.
+     * @param {string[]} contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
+     * @param {boolean} enabled - Is application enabled?
+     * @param {string} type - OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` — PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.
+     * @param {boolean} deviceFlow - Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.
+     * @param {string} teamId - Team unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    create(appId: string, name: string, redirectUris: string[], description?: string, clientUri?: string, logoUri?: string, privacyPolicyUrl?: string, termsUrl?: string, contacts?: string[], enabled?: boolean, type?: string, deviceFlow?: boolean, teamId?: string): Promise<Models.App>;
+    /**
+     * Get an application by its unique ID.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     */
+    get(params: {
+        appId: string;
+    }): Promise<Models.App>;
+    /**
+     * Get an application by its unique ID.
+     *
+     * @param {string} appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    get(appId: string): Promise<Models.App>;
+    /**
+     * Update an application by its unique ID.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @param {string} params.name - Application name.
+     * @param {string} params.description - Application description shown to users during OAuth2 consent.
+     * @param {string} params.clientUri - Application homepage URL shown to users during OAuth2 consent.
+     * @param {string} params.logoUri - Application logo URL shown to users during OAuth2 consent.
+     * @param {string} params.privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
+     * @param {string} params.termsUrl - Application terms of service URL shown to users during OAuth2 consent.
+     * @param {string[]} params.contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
+     * @param {boolean} params.enabled - Is application enabled?
+     * @param {string[]} params.redirectUris - Redirect URIs (array of valid URLs).
+     * @param {string} params.type - OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` — PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.
+     * @param {boolean} params.deviceFlow - Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     */
+    update(params: {
+        appId: string;
+        name: string;
+        description?: string;
+        clientUri?: string;
+        logoUri?: string;
+        privacyPolicyUrl?: string;
+        termsUrl?: string;
+        contacts?: string[];
+        enabled?: boolean;
+        redirectUris?: string[];
+        type?: string;
+        deviceFlow?: boolean;
+    }): Promise<Models.App>;
+    /**
+     * Update an application by its unique ID.
+     *
+     * @param {string} appId - Application unique ID.
+     * @param {string} name - Application name.
+     * @param {string} description - Application description shown to users during OAuth2 consent.
+     * @param {string} clientUri - Application homepage URL shown to users during OAuth2 consent.
+     * @param {string} logoUri - Application logo URL shown to users during OAuth2 consent.
+     * @param {string} privacyPolicyUrl - Application privacy policy URL shown to users during OAuth2 consent.
+     * @param {string} termsUrl - Application terms of service URL shown to users during OAuth2 consent.
+     * @param {string[]} contacts - Application support or security contact emails. Maximum of 100 contacts are allowed.
+     * @param {boolean} enabled - Is application enabled?
+     * @param {string[]} redirectUris - Redirect URIs (array of valid URLs).
+     * @param {string} type - OAuth2 client type. Use `public` for SPAs, mobile, and native apps that cannot keep a `client_secret` — PKCE is then required at the token endpoint. Use `confidential` for server-side clients that present a `client_secret`. Defaults to `confidential`.
+     * @param {boolean} deviceFlow - Allow this client to use the OAuth2 Device Authorization Grant (RFC 8628) for input-constrained devices such as TVs and CLIs. Defaults to false.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    update(appId: string, name: string, description?: string, clientUri?: string, logoUri?: string, privacyPolicyUrl?: string, termsUrl?: string, contacts?: string[], enabled?: boolean, redirectUris?: string[], type?: string, deviceFlow?: boolean): Promise<Models.App>;
+    /**
+     * Delete an application by its unique ID.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    delete(params: {
+        appId: string;
+    }): Promise<{}>;
+    /**
+     * Delete an application by its unique ID.
+     *
+     * @param {string} appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    delete(appId: string): Promise<{}>;
+    /**
+     * List client secrets for an application.
+     *
+     * @param {string} params.appId - Application 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.
+     * @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.AppSecretList>}
+     */
+    listSecrets(params: {
+        appId: string;
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.AppSecretList>;
+    /**
+     * List client secrets for an application.
+     *
+     * @param {string} appId - Application 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.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AppSecretList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listSecrets(appId: string, queries?: string[], total?: boolean): Promise<Models.AppSecretList>;
+    /**
+     * Create a new client secret for an application.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AppSecretPlaintext>}
+     */
+    createSecret(params: {
+        appId: string;
+    }): Promise<Models.AppSecretPlaintext>;
+    /**
+     * Create a new client secret for an application.
+     *
+     * @param {string} appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AppSecretPlaintext>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createSecret(appId: string): Promise<Models.AppSecretPlaintext>;
+    /**
+     * Get an application client secret by its unique ID.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @param {string} params.secretId - Secret unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AppSecret>}
+     */
+    getSecret(params: {
+        appId: string;
+        secretId: string;
+    }): Promise<Models.AppSecret>;
+    /**
+     * Get an application client secret by its unique ID.
+     *
+     * @param {string} appId - Application unique ID.
+     * @param {string} secretId - Secret unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AppSecret>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getSecret(appId: string, secretId: string): Promise<Models.AppSecret>;
+    /**
+     * Delete an application client secret by its unique ID.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @param {string} params.secretId - Secret unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteSecret(params: {
+        appId: string;
+        secretId: string;
+    }): Promise<{}>;
+    /**
+     * Delete an application client secret by its unique ID.
+     *
+     * @param {string} appId - Application unique ID.
+     * @param {string} secretId - Secret unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteSecret(appId: string, secretId: string): Promise<{}>;
+    /**
+     * Transfer an application to another team by its unique ID.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @param {string} params.teamId - Team ID of the team to transfer application to.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     */
+    updateTeam(params: {
+        appId: string;
+        teamId: string;
+    }): Promise<Models.App>;
+    /**
+     * Transfer an application to another team by its unique ID.
+     *
+     * @param {string} appId - Application unique ID.
+     * @param {string} teamId - Team ID of the team to transfer application to.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.App>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateTeam(appId: string, teamId: string): Promise<Models.App>;
+    /**
+     * Revoke all tokens for an application by its unique ID.
+     *
+     * @param {string} params.appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteTokens(params: {
+        appId: string;
+    }): Promise<{}>;
+    /**
+     * Revoke all tokens for an application by its unique ID.
+     *
+     * @param {string} appId - Application unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteTokens(appId: string): Promise<{}>;
+}