@appwrite.io/console 8.1.0 → 8.1.1

package/types/services/backups.d.ts

@@ -0,0 +1,277 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+import { BackupServices } from '../enums/backup-services';
+export declare class Backups {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * List all archives for a project.
+     *
+     * @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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupArchiveList>}
+     */
+    listArchives(params?: {
+        queries?: string[];
+    }): Promise<Models.BackupArchiveList>;
+    /**
+     * List all archives for a project.
+     *
+     * @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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupArchiveList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listArchives(queries?: string[]): Promise<Models.BackupArchiveList>;
+    /**
+     * Create a new archive asynchronously for a project.
+     *
+     * @param {BackupServices[]} params.services - Array of services to backup
+     * @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupArchive>}
+     */
+    createArchive(params: {
+        services: BackupServices[];
+        resourceId?: string;
+    }): Promise<Models.BackupArchive>;
+    /**
+     * Create a new archive asynchronously for a project.
+     *
+     * @param {BackupServices[]} services - Array of services to backup
+     * @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupArchive>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createArchive(services: BackupServices[], resourceId?: string): Promise<Models.BackupArchive>;
+    /**
+     * Get a backup archive using it's ID.
+     *
+     * @param {string} params.archiveId - Archive ID. Choose a custom ID`. 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupArchive>}
+     */
+    getArchive(params: {
+        archiveId: string;
+    }): Promise<Models.BackupArchive>;
+    /**
+     * Get a backup archive using it's ID.
+     *
+     * @param {string} archiveId - Archive ID. Choose a custom ID`. 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupArchive>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getArchive(archiveId: string): Promise<Models.BackupArchive>;
+    /**
+     * Delete an existing archive for a project.
+     *
+     * @param {string} params.archiveId - Policy 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteArchive(params: {
+        archiveId: string;
+    }): Promise<{}>;
+    /**
+     * Delete an existing archive for a project.
+     *
+     * @param {string} archiveId - Policy 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteArchive(archiveId: string): Promise<{}>;
+    /**
+     * List all policies for a project.
+     *
+     * @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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicyList>}
+     */
+    listPolicies(params?: {
+        queries?: string[];
+    }): Promise<Models.BackupPolicyList>;
+    /**
+     * List all policies for a project.
+     *
+     * @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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicyList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listPolicies(queries?: string[]): Promise<Models.BackupPolicyList>;
+    /**
+     * Create a new backup policy.
+     *
+     * @param {string} params.policyId - Policy 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 {BackupServices[]} params.services - Array of services to backup
+     * @param {number} params.retention - Days to keep backups before deletion
+     * @param {string} params.schedule - Schedule CRON syntax.
+     * @param {string} params.name - Policy name. Max length: 128 chars.
+     * @param {string} params.resourceId - Resource ID. When set, only this single resource will be backed up.
+     * @param {boolean} params.enabled - Is policy enabled? When set to 'disabled', no backups will be taken
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicy>}
+     */
+    createPolicy(params: {
+        policyId: string;
+        services: BackupServices[];
+        retention: number;
+        schedule: string;
+        name?: string;
+        resourceId?: string;
+        enabled?: boolean;
+    }): Promise<Models.BackupPolicy>;
+    /**
+     * Create a new backup policy.
+     *
+     * @param {string} policyId - Policy 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 {BackupServices[]} services - Array of services to backup
+     * @param {number} retention - Days to keep backups before deletion
+     * @param {string} schedule - Schedule CRON syntax.
+     * @param {string} name - Policy name. Max length: 128 chars.
+     * @param {string} resourceId - Resource ID. When set, only this single resource will be backed up.
+     * @param {boolean} enabled - Is policy enabled? When set to 'disabled', no backups will be taken
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicy>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createPolicy(policyId: string, services: BackupServices[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
+    /**
+     * Get a backup policy using it's ID.
+     *
+     * @param {string} params.policyId - Policy ID. Choose a custom ID`. 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicy>}
+     */
+    getPolicy(params: {
+        policyId: string;
+    }): Promise<Models.BackupPolicy>;
+    /**
+     * Get a backup policy using it's ID.
+     *
+     * @param {string} policyId - Policy ID. Choose a custom ID`. 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicy>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getPolicy(policyId: string): Promise<Models.BackupPolicy>;
+    /**
+     * Update an existing policy using it's ID.
+     *
+     * @param {string} params.policyId - Policy ID. Choose a custom ID`. 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 - Policy name. Max length: 128 chars.
+     * @param {number} params.retention - Days to keep backups before deletion
+     * @param {string} params.schedule - Cron expression
+     * @param {boolean} params.enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicy>}
+     */
+    updatePolicy(params: {
+        policyId: string;
+        name?: string;
+        retention?: number;
+        schedule?: string;
+        enabled?: boolean;
+    }): Promise<Models.BackupPolicy>;
+    /**
+     * Update an existing policy using it's ID.
+     *
+     * @param {string} policyId - Policy ID. Choose a custom ID`. 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 - Policy name. Max length: 128 chars.
+     * @param {number} retention - Days to keep backups before deletion
+     * @param {string} schedule - Cron expression
+     * @param {boolean} enabled - Is Backup enabled? When set to 'disabled', No backup will be taken
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupPolicy>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updatePolicy(policyId: string, name?: string, retention?: number, schedule?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
+    /**
+     * Delete a policy using it's ID.
+     *
+     * @param {string} params.policyId - Policy 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deletePolicy(params: {
+        policyId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a policy using it's ID.
+     *
+     * @param {string} policyId - Policy 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deletePolicy(policyId: string): Promise<{}>;
+    /**
+     * Create and trigger a new restoration for a backup on a project.
+     *
+     * @param {string} params.archiveId - Backup archive ID to restore
+     * @param {BackupServices[]} params.services - Array of services to restore
+     * @param {string} params.newResourceId - Unique 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.newResourceName - Database name. Max length: 128 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupRestoration>}
+     */
+    createRestoration(params: {
+        archiveId: string;
+        services: BackupServices[];
+        newResourceId?: string;
+        newResourceName?: string;
+    }): Promise<Models.BackupRestoration>;
+    /**
+     * Create and trigger a new restoration for a backup on a project.
+     *
+     * @param {string} archiveId - Backup archive ID to restore
+     * @param {BackupServices[]} services - Array of services to restore
+     * @param {string} newResourceId - Unique 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} newResourceName - Database name. Max length: 128 chars.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupRestoration>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createRestoration(archiveId: string, services: BackupServices[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
+    /**
+     * List all backup restorations for a project.
+     *
+     * @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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupRestorationList>}
+     */
+    listRestorations(params?: {
+        queries?: string[];
+    }): Promise<Models.BackupRestorationList>;
+    /**
+     * List all backup restorations for a project.
+     *
+     * @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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupRestorationList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listRestorations(queries?: string[]): Promise<Models.BackupRestorationList>;
+    /**
+     * Get the current status of a backup restoration.
+     *
+     * @param {string} params.restorationId - Restoration ID. Choose a custom ID`. 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupRestoration>}
+     */
+    getRestoration(params: {
+        restorationId: string;
+    }): Promise<Models.BackupRestoration>;
+    /**
+     * Get the current status of a backup restoration.
+     *
+     * @param {string} restorationId - Restoration ID. Choose a custom ID`. 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.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BackupRestoration>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getRestoration(restorationId: string): Promise<Models.BackupRestoration>;
+}

package/types/services/console.d.ts

@@ -0,0 +1,248 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+import { Platform } from '../enums/platform';
+import { ConsoleResourceType } from '../enums/console-resource-type';
+export declare class Console {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Receive the details of a campaign using its ID.
+     *
+     * @param {string} params.campaignId - ID of the campaign
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Campaign>}
+     */
+    getCampaign(params: {
+        campaignId: string;
+    }): Promise<Models.Campaign>;
+    /**
+     * Receive the details of a campaign using its ID.
+     *
+     * @param {string} campaignId - ID of the campaign
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Campaign>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getCampaign(campaignId: string): Promise<Models.Campaign>;
+    /**
+     * Get the details of a coupon using it's coupon ID.
+     *
+     * @param {string} params.couponId - ID of the coupon
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Coupon>}
+     */
+    getCoupon(params: {
+        couponId: string;
+    }): Promise<Models.Coupon>;
+    /**
+     * Get the details of a coupon using it's coupon ID.
+     *
+     * @param {string} couponId - ID of the coupon
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Coupon>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getCoupon(couponId: string): Promise<Models.Coupon>;
+    /**
+     * Return a list of all available plans.
+     *
+     * @param {Platform} params.platform - Platform type
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BillingPlanList>}
+     */
+    getPlans(params?: {
+        platform?: Platform;
+    }): Promise<Models.BillingPlanList>;
+    /**
+     * Return a list of all available plans.
+     *
+     * @param {Platform} platform - Platform type
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BillingPlanList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getPlans(platform?: Platform): Promise<Models.BillingPlanList>;
+    /**
+     * Get the details of a plan using its plan ID.
+     *
+     * @param {string} params.planId - Plan id
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BillingPlan>}
+     */
+    getPlan(params: {
+        planId: string;
+    }): Promise<Models.BillingPlan>;
+    /**
+     * Get the details of a plan using its plan ID.
+     *
+     * @param {string} planId - Plan id
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BillingPlan>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getPlan(planId: string): Promise<Models.BillingPlan>;
+    /**
+     * Receive the details of a program using its ID.
+     *
+     * @param {string} params.programId - ID of the program
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Program>}
+     */
+    getProgram(params: {
+        programId: string;
+    }): Promise<Models.Program>;
+    /**
+     * Receive the details of a program using its ID.
+     *
+     * @param {string} programId - ID of the program
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Program>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getProgram(programId: string): Promise<Models.Program>;
+    /**
+     * Create a new membership for an account to a program.
+     *
+     * @param {string} params.programId - ID of the program
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    createProgramMembership<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
+        programId: string;
+    }): Promise<Models.Organization<Preferences>>;
+    /**
+     * Create a new membership for an account to a program.
+     *
+     * @param {string} programId - ID of the program
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createProgramMembership<Preferences extends Models.Preferences = Models.DefaultPreferences>(programId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Get all available regions for the console.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleRegionList>}
+     */
+    listRegions(): Promise<Models.ConsoleRegionList>;
+    /**
+     * Check if a resource ID is available.
+     *
+     * @param {string} params.value - Resource value.
+     * @param {ConsoleResourceType} params.type - Resource type.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    getResource(params: {
+        value: string;
+        type: ConsoleResourceType;
+    }): Promise<{}>;
+    /**
+     * Check if a resource ID is available.
+     *
+     * @param {string} value - Resource value.
+     * @param {ConsoleResourceType} type - Resource type.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getResource(value: string, type: ConsoleResourceType): Promise<{}>;
+    /**
+     * Create a new source.
+     *
+     * @param {string} params.ref - Ref param
+     * @param {string} params.referrer - Referrer
+     * @param {string} params.utmSource - Utm source
+     * @param {string} params.utmCampaign - Utm campaign
+     * @param {string} params.utmMedium - Utm medium
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    createSource(params?: {
+        ref?: string;
+        referrer?: string;
+        utmSource?: string;
+        utmCampaign?: string;
+        utmMedium?: string;
+    }): Promise<{}>;
+    /**
+     * Create a new source.
+     *
+     * @param {string} ref - Ref param
+     * @param {string} referrer - Referrer
+     * @param {string} utmSource - Utm source
+     * @param {string} utmCampaign - Utm campaign
+     * @param {string} utmMedium - Utm medium
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createSource(ref?: string, referrer?: string, utmSource?: string, utmCampaign?: string, utmMedium?: string): Promise<{}>;
+    /**
+     * Suggests column names and their size limits based on the provided table name. The API will also analyze other tables in the same database to provide context-aware suggestions, ensuring consistency across schema design. Users may optionally provide custom context to further refine the suggestions.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {string} params.context - Optional user provided context to refine suggestions.
+     * @param {number} params.min - Minimum number of suggestions to generate.
+     * @param {number} params.max - Maximum number of suggestions to generate.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnList>}
+     */
+    suggestColumns(params: {
+        databaseId: string;
+        tableId: string;
+        context?: string;
+        min?: number;
+        max?: number;
+    }): Promise<Models.ColumnList>;
+    /**
+     * Suggests column names and their size limits based on the provided table name. The API will also analyze other tables in the same database to provide context-aware suggestions, ensuring consistency across schema design. Users may optionally provide custom context to further refine the suggestions.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {string} context - Optional user provided context to refine suggestions.
+     * @param {number} min - Minimum number of suggestions to generate.
+     * @param {number} max - Maximum number of suggestions to generate.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    suggestColumns(databaseId: string, tableId: string, context?: string, min?: number, max?: number): Promise<Models.ColumnList>;
+    /**
+     * Suggests database indexes for table columns based on the provided table structure and existing columns. The API will also analyze the table's column types, names, and patterns to recommend optimal indexes that improve query performance for common database operations like filtering, sorting, and searching.
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.tableId - Table ID.
+     * @param {number} params.min - Minimum number of suggestions to generate.
+     * @param {number} params.max - Maximum number of suggestions to generate.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnIndexList>}
+     */
+    suggestIndexes(params: {
+        databaseId: string;
+        tableId: string;
+        min?: number;
+        max?: number;
+    }): Promise<Models.ColumnIndexList>;
+    /**
+     * Suggests database indexes for table columns based on the provided table structure and existing columns. The API will also analyze the table's column types, names, and patterns to recommend optimal indexes that improve query performance for common database operations like filtering, sorting, and searching.
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} tableId - Table ID.
+     * @param {number} min - Minimum number of suggestions to generate.
+     * @param {number} max - Maximum number of suggestions to generate.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ColumnIndexList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    suggestIndexes(databaseId: string, tableId: string, min?: number, max?: number): Promise<Models.ColumnIndexList>;
+    /**
+     * Get all Environment Variables that are relevant for the console.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleVariables>}
+     */
+    variables(): Promise<Models.ConsoleVariables>;
+}