appbuild-oceanbase-console 1.12.2 → 1.13.0

package/types/services/backups.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { BackupServices } from '../enums/backup-services';
 export declare class Backups {
     client: Client;
     constructor(client: Client);
@@ -25,25 +26,25 @@ export declare class Backups {
     /**
      * Create a new archive asynchronously for a project.
      *
-     * @param {string[]} params.services - Array of services to backup
+     * @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: string[];
+        services: BackupServices[];
         resourceId?: string;
     }): Promise<Models.BackupArchive>;
     /**
      * Create a new archive asynchronously for a project.
      *
-     * @param {string[]} services - Array of services to backup
+     * @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: string[], resourceId?: string): Promise<Models.BackupArchive>;
+    createArchive(services: BackupServices[], resourceId?: string): Promise<Models.BackupArchive>;
     /**
      * Get a backup archive using it's ID.
      *
@@ -105,7 +106,7 @@ export declare class Backups {
      * 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 {string[]} params.services - Array of services to backup
+     * @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.
@@ -116,7 +117,7 @@ export declare class Backups {
      */
     createPolicy(params: {
         policyId: string;
-        services: string[];
+        services: BackupServices[];
         retention: number;
         schedule: string;
         name?: string;
@@ -127,7 +128,7 @@ export declare class Backups {
      * 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 {string[]} services - Array of services to backup
+     * @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.
@@ -137,7 +138,7 @@ export declare class Backups {
      * @returns {Promise<Models.BackupPolicy>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createPolicy(policyId: string, services: string[], retention: number, schedule: string, name?: string, resourceId?: string, enabled?: boolean): Promise<Models.BackupPolicy>;
+    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.
      *
@@ -211,7 +212,7 @@ export declare class Backups {
      * Create and trigger a new restoration for a backup on a project.
      *
      * @param {string} params.archiveId - Backup archive ID to restore
-     * @param {string[]} params.services - Array of services 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}
@@ -219,7 +220,7 @@ export declare class Backups {
      */
     createRestoration(params: {
         archiveId: string;
-        services: string[];
+        services: BackupServices[];
         newResourceId?: string;
         newResourceName?: string;
     }): Promise<Models.BackupRestoration>;
@@ -227,14 +228,14 @@ export declare class Backups {
      * Create and trigger a new restoration for a backup on a project.
      *
      * @param {string} archiveId - Backup archive ID to restore
-     * @param {string[]} services - Array of services 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: string[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
+    createRestoration(archiveId: string, services: BackupServices[], newResourceId?: string, newResourceName?: string): Promise<Models.BackupRestoration>;
     /**
      * List all backup restorations for a project.
      *

package/types/services/console.d.ts

@@ -50,7 +50,7 @@ export declare class Console {
      * @throws {AppwriteException}
      * @returns {Promise<Models.BillingPlanList>}
      */
-    plans(params?: {
+    getPlans(params?: {
         platform?: Platform;
     }): Promise<Models.BillingPlanList>;
     /**
@@ -61,7 +61,45 @@ export declare class Console {
      * @returns {Promise<Models.BillingPlanList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    plans(platform?: Platform): Promise<Models.BillingPlanList>;
+    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.
      *
@@ -87,7 +125,7 @@ export declare class Console {
      * @throws {AppwriteException}
      * @returns {Promise<Models.ConsoleRegionList>}
      */
-    regions(): Promise<Models.ConsoleRegionList>;
+    listRegions(): Promise<Models.ConsoleRegionList>;
     /**
      * Check if a resource ID is available.
      *