appbuild-oceanbase-console 1.12.2 → 1.13.0

package/types/services/users.d.ts

@@ -10,7 +10,7 @@ export declare class Users {
     /**
      * Get a list of all the project's users. 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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
+     * @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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator
      * @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}
@@ -24,7 +24,7 @@ export declare class Users {
     /**
      * Get a list of all the project's users. 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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
+     * @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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels, impersonator
      * @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}
@@ -411,6 +411,30 @@ export declare class Users {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     updateEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
+    /**
+     * Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.
+     *
+     *
+     * @param {string} params.userId - User ID.
+     * @param {boolean} params.impersonator - Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.User<Preferences>>}
+     */
+    updateImpersonator<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
+        userId: string;
+        impersonator: boolean;
+    }): Promise<Models.User<Preferences>>;
+    /**
+     * Enable or disable whether a user can impersonate other users. When impersonation headers are used, the request runs as the target user for API behavior, while internal audit logs still attribute the action to the original impersonator and store the impersonated target details only in internal audit payload data.
+     *
+     *
+     * @param {string} userId - User ID.
+     * @param {boolean} impersonator - Whether the user can impersonate other users. When true, the user can browse project users to choose a target and can pass impersonation headers to act as that user. Internal audit logs still attribute impersonated actions to the original impersonator and store the target user details only in internal audit payload data.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.User<Preferences>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateImpersonator<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, impersonator: boolean): Promise<Models.User<Preferences>>;
     /**
      * Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.
      *

package/types/services/vcs.d.ts

@@ -38,6 +38,7 @@ export declare class Vcs {
      * @param {string} params.installationId - Installation Id
      * @param {VCSDetectionType} params.type - Detector type. Must be one of the following: runtime, framework
      * @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 and offset
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProviderRepositoryFrameworkList>}
      */
@@ -45,6 +46,7 @@ export declare class Vcs {
         installationId: string;
         type: VCSDetectionType;
         search?: string;
+        queries?: string[];
     }): Promise<Models.ProviderRepositoryFrameworkList>;
     /**
      * Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.
@@ -52,11 +54,12 @@ export declare class Vcs {
      * @param {string} installationId - Installation Id
      * @param {VCSDetectionType} type - Detector type. Must be one of the following: runtime, framework
      * @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 and offset
      * @throws {AppwriteException}
      * @returns {Promise<Models.ProviderRepositoryFrameworkList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRepositories(installationId: string, type: VCSDetectionType, search?: string): Promise<Models.ProviderRepositoryFrameworkList>;
+    listRepositories(installationId: string, type: VCSDetectionType, search?: string, queries?: string[]): Promise<Models.ProviderRepositoryFrameworkList>;
     /**
      * Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.
      *

package/types/services/webhooks.d.ts

@@ -0,0 +1,165 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Webhooks {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Get a list of all webhooks belonging to the project. 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: name, url, httpUser, security, events, enabled, logs, attempts
+     * @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.WebhookList>}
+     */
+    list(params?: {
+        queries?: string[];
+        total?: boolean;
+    }): Promise<Models.WebhookList>;
+    /**
+     * Get a list of all webhooks belonging to the project. 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: name, url, httpUser, security, events, enabled, logs, attempts
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.WebhookList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    list(queries?: string[], total?: boolean): Promise<Models.WebhookList>;
+    /**
+     * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
+     *
+     * @param {string} params.webhookId - Webhook 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.url - Webhook URL.
+     * @param {string} params.name - Webhook name. Max length: 128 chars.
+     * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
+     * @param {boolean} params.enabled - Enable or disable a webhook.
+     * @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
+     * @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
+     * @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     */
+    create(params: {
+        webhookId: string;
+        url: string;
+        name: string;
+        events: string[];
+        enabled?: boolean;
+        security?: boolean;
+        httpUser?: string;
+        httpPass?: string;
+    }): Promise<Models.Webhook>;
+    /**
+     * Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
+     *
+     * @param {string} webhookId - Webhook 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} url - Webhook URL.
+     * @param {string} name - Webhook name. Max length: 128 chars.
+     * @param {string[]} events - Events list. Maximum of 100 events are allowed.
+     * @param {boolean} enabled - Enable or disable a webhook.
+     * @param {boolean} security - Certificate verification, false for disabled or true for enabled.
+     * @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
+     * @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    create(webhookId: string, url: string, name: string, events: string[], enabled?: boolean, security?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
+    /**
+     * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
+     *
+     * @param {string} params.webhookId - Webhook ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     */
+    get(params: {
+        webhookId: string;
+    }): Promise<Models.Webhook>;
+    /**
+     * Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
+     *
+     * @param {string} webhookId - Webhook ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    get(webhookId: string): Promise<Models.Webhook>;
+    /**
+     * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
+     *
+     * @param {string} params.webhookId - Webhook ID.
+     * @param {string} params.name - Webhook name. Max length: 128 chars.
+     * @param {string} params.url - Webhook URL.
+     * @param {string[]} params.events - Events list. Maximum of 100 events are allowed.
+     * @param {boolean} params.enabled - Enable or disable a webhook.
+     * @param {boolean} params.security - Certificate verification, false for disabled or true for enabled.
+     * @param {string} params.httpUser - Webhook HTTP user. Max length: 256 chars.
+     * @param {string} params.httpPass - Webhook HTTP password. Max length: 256 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     */
+    update(params: {
+        webhookId: string;
+        name: string;
+        url: string;
+        events: string[];
+        enabled?: boolean;
+        security?: boolean;
+        httpUser?: string;
+        httpPass?: string;
+    }): Promise<Models.Webhook>;
+    /**
+     * Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
+     *
+     * @param {string} webhookId - Webhook ID.
+     * @param {string} name - Webhook name. Max length: 128 chars.
+     * @param {string} url - Webhook URL.
+     * @param {string[]} events - Events list. Maximum of 100 events are allowed.
+     * @param {boolean} enabled - Enable or disable a webhook.
+     * @param {boolean} security - Certificate verification, false for disabled or true for enabled.
+     * @param {string} httpUser - Webhook HTTP user. Max length: 256 chars.
+     * @param {string} httpPass - Webhook HTTP password. Max length: 256 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    update(webhookId: string, name: string, url: string, events: string[], enabled?: boolean, security?: boolean, httpUser?: string, httpPass?: string): Promise<Models.Webhook>;
+    /**
+     * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
+     *
+     * @param {string} params.webhookId - Webhook ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    delete(params: {
+        webhookId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
+     *
+     * @param {string} webhookId - Webhook ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    delete(webhookId: string): Promise<{}>;
+    /**
+     * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
+     *
+     * @param {string} params.webhookId - Webhook ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     */
+    updateSignature(params: {
+        webhookId: string;
+    }): Promise<Models.Webhook>;
+    /**
+     * Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
+     *
+     * @param {string} webhookId - Webhook ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Webhook>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateSignature(webhookId: string): Promise<Models.Webhook>;
+}