appbuild-oceanbase-console 1.12.2 → 1.13.0

package/types/services/organizations.d.ts

@@ -1,7 +1,7 @@
 import { Client } from '../client';
 import type { Models } from '../models';
-import { BillingPlan } from '../enums/billing-plan';
 import { Platform } from '../enums/platform';
+import { Scopes } from '../enums/scopes';
 export declare class Organizations {
     client: Client;
     constructor(client: Client);
@@ -33,7 +33,7 @@ export declare class Organizations {
      *
      * @param {string} params.organizationId - Organization 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 - Organization name. Max length: 128 chars.
-     * @param {BillingPlan} params.billingPlan - Organization billing plan chosen
+     * @param {string} params.billingPlan - Organization billing plan chosen
      * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
      * @param {string} params.billingAddressId - Unique ID of billing address
      * @param {string[]} params.invites - Additional member invites
@@ -42,12 +42,12 @@ export declare class Organizations {
      * @param {number} params.budget - Budget limit for additional usage set for the organization
      * @param {Platform} params.platform - Platform type
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Organization<Preferences>>}
+     * @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
      */
     create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
         organizationId: string;
         name: string;
-        billingPlan: BillingPlan;
+        billingPlan: string;
         paymentMethodId?: string;
         billingAddressId?: string;
         invites?: string[];
@@ -55,14 +55,14 @@ export declare class Organizations {
         taxId?: string;
         budget?: number;
         platform?: Platform;
-    }): Promise<Models.Organization<Preferences>>;
+    }): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
     /**
      * Create a new organization.
      *
      *
      * @param {string} organizationId - Organization 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 - Organization name. Max length: 128 chars.
-     * @param {BillingPlan} billingPlan - Organization billing plan chosen
+     * @param {string} billingPlan - Organization billing plan chosen
      * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
      * @param {string} billingAddressId - Unique ID of billing address
      * @param {string[]} invites - Additional member invites
@@ -71,38 +71,41 @@ export declare class Organizations {
      * @param {number} budget - Budget limit for additional usage set for the organization
      * @param {Platform} platform - Platform type
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Organization<Preferences>>}
+     * @returns {Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform): Promise<Models.Organization<Preferences>>;
+    create<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, name: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number, platform?: Platform): Promise<Models.Organization<Preferences> | Models.PaymentAuthentication>;
     /**
      * Get estimation for creating an organization.
      *
-     * @param {BillingPlan} params.billingPlan - Organization billing plan chosen
+     * @param {string} params.billingPlan - Organization billing plan chosen
      * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
      * @param {string[]} params.invites - Additional member invites
      * @param {string} params.couponId - Coupon id
+     * @param {Platform} params.platform - Platform type
      * @throws {AppwriteException}
      * @returns {Promise<Models.Estimation>}
      */
     estimationCreateOrganization(params: {
-        billingPlan: BillingPlan;
+        billingPlan: string;
         paymentMethodId?: string;
         invites?: string[];
         couponId?: string;
+        platform?: Platform;
     }): Promise<Models.Estimation>;
     /**
      * Get estimation for creating an organization.
      *
-     * @param {BillingPlan} billingPlan - Organization billing plan chosen
+     * @param {string} billingPlan - Organization billing plan chosen
      * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
      * @param {string[]} invites - Additional member invites
      * @param {string} couponId - Coupon id
+     * @param {Platform} platform - Platform type
      * @throws {AppwriteException}
      * @returns {Promise<Models.Estimation>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    estimationCreateOrganization(billingPlan: BillingPlan, paymentMethodId?: string, invites?: string[], couponId?: string): Promise<Models.Estimation>;
+    estimationCreateOrganization(billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform): Promise<Models.Estimation>;
     /**
      * Delete an organization.
      *
@@ -149,23 +152,29 @@ export declare class Organizations {
      *
      * @param {string} params.organizationId - Organization ID
      * @param {string} params.aggregationId - Invoice unique ID
+     * @param {number} params.limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
+     * @param {number} params.offset - Offset value. The default value is 0. Use this param to manage pagination.
      * @throws {AppwriteException}
      * @returns {Promise<Models.AggregationTeam>}
      */
     getAggregation(params: {
         organizationId: string;
         aggregationId: string;
+        limit?: number;
+        offset?: number;
     }): Promise<Models.AggregationTeam>;
     /**
      * Get a specific aggregation using it's aggregation ID.
      *
      * @param {string} organizationId - Organization ID
      * @param {string} aggregationId - Invoice unique ID
+     * @param {number} limit - Maximum number of project aggregations to return in response. By default will return maximum 5 results. Maximum of 10 results allowed per request.
+     * @param {number} offset - Offset value. The default value is 0. Use this param to manage pagination.
      * @throws {AppwriteException}
      * @returns {Promise<Models.AggregationTeam>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getAggregation(organizationId: string, aggregationId: string): Promise<Models.AggregationTeam>;
+    getAggregation(organizationId: string, aggregationId: string, limit?: number, offset?: number): Promise<Models.AggregationTeam>;
     /**
      * Set a billing address for an organization.
      *
@@ -386,7 +395,7 @@ export declare class Organizations {
      * Get estimation for updating the organization plan.
      *
      * @param {string} params.organizationId - Organization ID
-     * @param {BillingPlan} params.billingPlan - Organization billing plan chosen
+     * @param {string} params.billingPlan - Organization billing plan chosen
      * @param {string[]} params.invites - Additional member invites
      * @param {string} params.couponId - Coupon id
      * @throws {AppwriteException}
@@ -394,7 +403,7 @@ export declare class Organizations {
      */
     estimationUpdatePlan(params: {
         organizationId: string;
-        billingPlan: BillingPlan;
+        billingPlan: string;
         invites?: string[];
         couponId?: string;
     }): Promise<Models.EstimationUpdatePlan>;
@@ -402,19 +411,52 @@ export declare class Organizations {
      * Get estimation for updating the organization plan.
      *
      * @param {string} organizationId - Organization ID
-     * @param {BillingPlan} billingPlan - Organization billing plan chosen
+     * @param {string} billingPlan - Organization billing plan chosen
      * @param {string[]} invites - Additional member invites
      * @param {string} couponId - Coupon id
      * @throws {AppwriteException}
      * @returns {Promise<Models.EstimationUpdatePlan>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    estimationUpdatePlan(organizationId: string, billingPlan: BillingPlan, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
+    estimationUpdatePlan(organizationId: string, billingPlan: string, invites?: string[], couponId?: string): Promise<Models.EstimationUpdatePlan>;
+    /**
+     * Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
+     *
+     *
+     * @param {string} params.organizationId - Organization Unique ID
+     * @param {string} params.reason - Feedback reason
+     * @param {string} params.message - Feedback message
+     * @param {string} params.fromPlanId - Plan downgrading from
+     * @param {string} params.toPlanId - Plan downgrading to
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DowngradeFeedback>}
+     */
+    createDowngradeFeedback(params: {
+        organizationId: string;
+        reason: string;
+        message: string;
+        fromPlanId: string;
+        toPlanId: string;
+    }): Promise<Models.DowngradeFeedback>;
+    /**
+     * Submit feedback about downgrading from a paid plan to a lower tier. This helps the team understand user experience and improve the platform.
+     *
+     *
+     * @param {string} organizationId - Organization Unique ID
+     * @param {string} reason - Feedback reason
+     * @param {string} message - Feedback message
+     * @param {string} fromPlanId - Plan downgrading from
+     * @param {string} toPlanId - Plan downgrading to
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.DowngradeFeedback>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createDowngradeFeedback(organizationId: string, reason: string, message: string, fromPlanId: string, toPlanId: string): Promise<Models.DowngradeFeedback>;
     /**
      * List all invoices for an organization.
      *
      * @param {string} params.organizationId - Organization 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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
+     * @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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount
      * @throws {AppwriteException}
      * @returns {Promise<Models.InvoiceList>}
      */
@@ -426,7 +468,7 @@ export declare class Organizations {
      * List all invoices for an organization.
      *
      * @param {string} organizationId - Organization 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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount
      * @throws {AppwriteException}
      * @returns {Promise<Models.InvoiceList>}
      * @deprecated Use the object parameter style method for a better developer experience.
@@ -545,6 +587,131 @@ export declare class Organizations {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
+    /**
+     * Get a list of all API keys from the current organization.
+     *
+     * @param {string} params.organizationId - Organization Unique ID
+     * @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.KeyList>}
+     */
+    listKeys(params: {
+        organizationId: string;
+        total?: boolean;
+    }): Promise<Models.KeyList>;
+    /**
+     * Get a list of all API keys from the current organization.
+     *
+     * @param {string} organizationId - Organization Unique ID
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.KeyList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listKeys(organizationId: string, total?: boolean): Promise<Models.KeyList>;
+    /**
+     * Create a new organization API key.
+     *
+     * @param {string} params.organizationId - Organization Unique ID
+     * @param {string} params.name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    createKey(params: {
+        organizationId: string;
+        name: string;
+        scopes: Scopes[];
+        expire?: string;
+    }): Promise<Models.Key>;
+    /**
+     * Create a new organization API key.
+     *
+     * @param {string} organizationId - Organization Unique ID
+     * @param {string} name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createKey(organizationId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
+    /**
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your organization including it's scopes.
+     *
+     * @param {string} params.organizationId - Organization Unique ID
+     * @param {string} params.keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    getKey(params: {
+        organizationId: string;
+        keyId: string;
+    }): Promise<Models.Key>;
+    /**
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your organization including it's scopes.
+     *
+     * @param {string} organizationId - Organization Unique ID
+     * @param {string} keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getKey(organizationId: string, keyId: string): Promise<Models.Key>;
+    /**
+     * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
+     *
+     * @param {string} params.organizationId - Organization Unique ID
+     * @param {string} params.keyId - Key unique ID.
+     * @param {string} params.name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    updateKey(params: {
+        organizationId: string;
+        keyId: string;
+        name: string;
+        scopes: Scopes[];
+        expire?: string;
+    }): Promise<Models.Key>;
+    /**
+     * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
+     *
+     * @param {string} organizationId - Organization Unique ID
+     * @param {string} keyId - Key unique ID.
+     * @param {string} name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateKey(organizationId: string, keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
+    /**
+     * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
+     *
+     * @param {string} params.organizationId - Organization Unique ID
+     * @param {string} params.keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteKey(params: {
+        organizationId: string;
+        keyId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
+     *
+     * @param {string} organizationId - Organization Unique ID
+     * @param {string} keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteKey(organizationId: string, keyId: string): Promise<{}>;
     /**
      * Set a organization's default payment method.
      *
@@ -674,7 +841,7 @@ export declare class Organizations {
      * Update the billing plan for an organization.
      *
      * @param {string} params.organizationId - Organization Unique ID
-     * @param {BillingPlan} params.billingPlan - Organization billing plan chosen
+     * @param {string} params.billingPlan - Organization billing plan chosen
      * @param {string} params.paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
      * @param {string} params.billingAddressId - Unique ID of billing address
      * @param {string[]} params.invites - Additional member invites
@@ -686,7 +853,7 @@ export declare class Organizations {
      */
     updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
         organizationId: string;
-        billingPlan: BillingPlan;
+        billingPlan: string;
         paymentMethodId?: string;
         billingAddressId?: string;
         invites?: string[];
@@ -698,7 +865,7 @@ export declare class Organizations {
      * Update the billing plan for an organization.
      *
      * @param {string} organizationId - Organization Unique ID
-     * @param {BillingPlan} billingPlan - Organization billing plan chosen
+     * @param {string} billingPlan - Organization billing plan chosen
      * @param {string} paymentMethodId - Payment method ID. Required for pro plans when trial is not available and user doesn't have default payment method set.
      * @param {string} billingAddressId - Unique ID of billing address
      * @param {string[]} invites - Additional member invites
@@ -709,7 +876,7 @@ export declare class Organizations {
      * @returns {Promise<Models.Organization<Preferences>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
+    updatePlan<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, billingPlan: string, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
     /**
      * Cancel the downgrade initiated for an organization.
      *
@@ -730,46 +897,46 @@ export declare class Organizations {
      */
     cancelDowngrade<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Update selected projects to keep in the organization.
+     * Get all available regions for an organization.
      *
-     * @param {string} params.organizationId - Organization Unique ID
-     * @param {string[]} params.projects - List of project IDs to be selected for the organization
+     * @param {string} params.organizationId - Team ID.
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Organization<Preferences>>}
+     * @returns {Promise<Models.ConsoleRegionList>}
      */
-    updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
+    listRegions(params: {
         organizationId: string;
-        projects?: string[];
-    }): Promise<Models.Organization<Preferences>>;
+    }): Promise<Models.ConsoleRegionList>;
     /**
-     * Update selected projects to keep in the organization.
+     * Get all available regions for an organization.
      *
-     * @param {string} organizationId - Organization Unique ID
-     * @param {string[]} projects - List of project IDs to be selected for the organization
+     * @param {string} organizationId - Team ID.
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Organization<Preferences>>}
+     * @returns {Promise<Models.ConsoleRegionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateProjects<Preferences extends Models.Preferences = Models.DefaultPreferences>(organizationId: string, projects?: string[]): Promise<Models.Organization<Preferences>>;
+    listRegions(organizationId: string): Promise<Models.ConsoleRegionList>;
     /**
      * Get Scopes
      *
      * @param {string} params.organizationId - Organization id
+     * @param {string} params.projectId - Project id
      * @throws {AppwriteException}
      * @returns {Promise<Models.Roles>}
      */
     getScopes(params: {
         organizationId: string;
+        projectId?: string;
     }): Promise<Models.Roles>;
     /**
      * Get Scopes
      *
      * @param {string} organizationId - Organization id
+     * @param {string} projectId - Project id
      * @throws {AppwriteException}
      * @returns {Promise<Models.Roles>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    getScopes(organizationId: string): Promise<Models.Roles>;
+    getScopes(organizationId: string, projectId?: string): Promise<Models.Roles>;
     /**
      * Set an organization's billing tax ID.
      *