@appwrite.io/console 2.1.3 → 2.2.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
@@ -47,7 +47,7 @@ export declare class Organizations {
     create<Preferences extends Models.Preferences = Models.DefaultPreferences>(params: {
         organizationId: string;
         name: string;
-        billingPlan: BillingPlan;
+        billingPlan: string;
         paymentMethodId?: string;
         billingAddressId?: string;
         invites?: string[];
@@ -62,7 +62,7 @@ export declare class Organizations {
      *
      * @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
@@ -74,11 +74,11 @@ export declare class Organizations {
      * @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> | Models.PaymentAuthentication>;
+    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
@@ -87,7 +87,7 @@ export declare class Organizations {
      * @returns {Promise<Models.Estimation>}
      */
     estimationCreateOrganization(params: {
-        billingPlan: BillingPlan;
+        billingPlan: string;
         paymentMethodId?: string;
         invites?: string[];
         couponId?: string;
@@ -96,7 +96,7 @@ export declare class Organizations {
     /**
      * 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
@@ -105,7 +105,7 @@ export declare class Organizations {
      * @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, platform?: Platform): Promise<Models.Estimation>;
+    estimationCreateOrganization(billingPlan: string, paymentMethodId?: string, invites?: string[], couponId?: string, platform?: Platform): Promise<Models.Estimation>;
     /**
      * Delete an organization.
      *
@@ -395,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}
@@ -403,7 +403,7 @@ export declare class Organizations {
      */
     estimationUpdatePlan(params: {
         organizationId: string;
-        billingPlan: BillingPlan;
+        billingPlan: string;
         invites?: string[];
         couponId?: string;
     }): Promise<Models.EstimationUpdatePlan>;
@@ -411,14 +411,14 @@ 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.
      *
@@ -587,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.
      *
@@ -716,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
@@ -728,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[];
@@ -740,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
@@ -751,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.
      *
@@ -793,6 +918,25 @@ export declare class Organizations {
      * @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>>;
+    /**
+     * Get all available regions for an organization.
+     *
+     * @param {string} params.organizationId - Team ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleRegionList>}
+     */
+    listRegions(params: {
+        organizationId: string;
+    }): Promise<Models.ConsoleRegionList>;
+    /**
+     * Get all available regions for an organization.
+     *
+     * @param {string} organizationId - Team ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ConsoleRegionList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listRegions(organizationId: string): Promise<Models.ConsoleRegionList>;
     /**
      * Get Scopes
      *

package/types/services/projects.d.ts

@@ -3,6 +3,7 @@ import type { Models } from '../models';
 import { Region } from '../enums/region';
 import { Api } from '../enums/api';
 import { AuthMethod } from '../enums/auth-method';
+import { Scopes } from '../enums/scopes';
 import { OAuthProvider } from '../enums/o-auth-provider';
 import { PlatformType } from '../enums/platform-type';
 import { ApiService } from '../enums/api-service';
@@ -652,27 +653,27 @@ export declare class Projects {
      * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
      *
      * @param {string} params.projectId - Project unique ID.
-     * @param {string[]} params.scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
+     * @param {Scopes[]} params.scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
      * @param {number} params.duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Jwt>}
      */
     createJWT(params: {
         projectId: string;
-        scopes: string[];
+        scopes: Scopes[];
         duration?: number;
     }): Promise<Models.Jwt>;
     /**
      * Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
      *
      * @param {string} projectId - Project unique ID.
-     * @param {string[]} scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
+     * @param {Scopes[]} scopes - List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.
      * @param {number} duration - Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Jwt>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createJWT(projectId: string, scopes: string[], duration?: number): Promise<Models.Jwt>;
+    createJWT(projectId: string, scopes: Scopes[], duration?: number): Promise<Models.Jwt>;
     /**
      * Get a list of all API keys from the current project.
      *
@@ -700,7 +701,7 @@ export declare class Projects {
      *
      * @param {string} params.projectId - Project unique ID.
      * @param {string} params.name - Key name. Max length: 128 chars.
-     * @param {string[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @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>}
@@ -708,7 +709,7 @@ export declare class Projects {
     createKey(params: {
         projectId: string;
         name: string;
-        scopes?: string[];
+        scopes?: Scopes[];
         expire?: string;
     }): Promise<Models.Key>;
     /**
@@ -716,13 +717,13 @@ export declare class Projects {
      *
      * @param {string} projectId - Project unique ID.
      * @param {string} name - Key name. Max length: 128 chars.
-     * @param {string[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @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(projectId: string, name: string, scopes?: string[], expire?: string): Promise<Models.Key>;
+    createKey(projectId: 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 project including it's scopes.
      *
@@ -751,7 +752,7 @@ export declare class Projects {
      * @param {string} params.projectId - Project unique ID.
      * @param {string} params.keyId - Key unique ID.
      * @param {string} params.name - Key name. Max length: 128 chars.
-     * @param {string[]} params.scopes - Key scopes list. Maximum of 100 events are allowed.
+     * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 events 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>}
@@ -760,7 +761,7 @@ export declare class Projects {
         projectId: string;
         keyId: string;
         name: string;
-        scopes?: string[];
+        scopes?: Scopes[];
         expire?: string;
     }): Promise<Models.Key>;
     /**
@@ -769,13 +770,13 @@ export declare class Projects {
      * @param {string} projectId - Project unique ID.
      * @param {string} keyId - Key unique ID.
      * @param {string} name - Key name. Max length: 128 chars.
-     * @param {string[]} scopes - Key scopes list. Maximum of 100 events are allowed.
+     * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 events 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(projectId: string, keyId: string, name: string, scopes?: string[], expire?: string): Promise<Models.Key>;
+    updateKey(projectId: 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.
      *

package/types/services/sites.d.ts

@@ -3,6 +3,8 @@ import type { Models } from '../models';
 import { Framework } from '../enums/framework';
 import { BuildRuntime } from '../enums/build-runtime';
 import { Adapter } from '../enums/adapter';
+import { Frameworks } from '../enums/frameworks';
+import { UseCases } from '../enums/use-cases';
 import { UsageRange } from '../enums/usage-range';
 import { TemplateReferenceType } from '../enums/template-reference-type';
 import { VCSReferenceType } from '../enums/vcs-reference-type';
@@ -122,31 +124,31 @@ export declare class Sites {
     /**
      * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
-     * @param {string[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
-     * @param {string[]} params.useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
+     * @param {Frameworks[]} params.frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
+     * @param {UseCases[]} params.useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
      * @param {number} params.limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
      * @param {number} params.offset - Offset the list of returned templates. Maximum offset is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TemplateSiteList>}
      */
     listTemplates(params?: {
-        frameworks?: string[];
-        useCases?: string[];
+        frameworks?: Frameworks[];
+        useCases?: UseCases[];
         limit?: number;
         offset?: number;
     }): Promise<Models.TemplateSiteList>;
     /**
      * List available site templates. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *
-     * @param {string[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
-     * @param {string[]} useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
+     * @param {Frameworks[]} frameworks - List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.
+     * @param {UseCases[]} useCases - List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.
      * @param {number} limit - Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.
      * @param {number} offset - Offset the list of returned templates. Maximum offset is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TemplateSiteList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTemplates(frameworks?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
+    listTemplates(frameworks?: Frameworks[], useCases?: UseCases[], limit?: number, offset?: number): Promise<Models.TemplateSiteList>;
     /**
      * Get a site template using ID. You can use template details in [createSite](/docs/references/cloud/server-nodejs/sites#create) method.
      *