@appwrite.io/console 1.5.2 → 1.6.0

package/types/services/organizations.d.ts

@@ -5,8 +5,6 @@ export declare class Organizations {
     client: Client;
     constructor(client: Client);
     /**
-     * List Orgnizations
-     *
      * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
      *
      * @param {string[]} queries
@@ -16,8 +14,6 @@ export declare class Organizations {
      */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.OrganizationList<Preferences>>;
     /**
-     * Create Organization
-     *
      * Create a new organization.
 
      *
@@ -35,8 +31,6 @@ export declare class Organizations {
      */
     create<Preferences extends Models.Preferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
     /**
-     * Delete team
-     *
      * Delete an organization.
      *
      * @param {string} organizationId
@@ -45,8 +39,6 @@ export declare class Organizations {
      */
     delete(organizationId: string): Promise<{}>;
     /**
-     * List aggregations
-     *
      * Get a list of all aggregations for an organization.
      *
      * @param {string} organizationId
@@ -56,19 +48,15 @@ export declare class Organizations {
      */
     listAggregations(organizationId: string, queries?: string[]): Promise<Models.AggregationTeamList>;
     /**
-     * Get invoice
-     *
      * Get a specific aggregation using it&#039;s aggregation ID.
      *
      * @param {string} organizationId
      * @param {string} aggregationId
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Invoice>}
+     * @returns {Promise<Models.AggregationTeam>}
      */
-    getAggregation(organizationId: string, aggregationId: string): Promise<Models.Invoice>;
+    getAggregation(organizationId: string, aggregationId: string): Promise<Models.AggregationTeam>;
     /**
-     * Set team&#039;s billing address
-     *
      * Set a billing address for an organization.
      *
      * @param {string} organizationId
@@ -78,8 +66,6 @@ export declare class Organizations {
      */
     setBillingAddress<Preferences extends Models.Preferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Delete team&#039;s billing address
-     *
      * Delete a team&#039;s billing address.
      *
      * @param {string} organizationId
@@ -88,8 +74,6 @@ export declare class Organizations {
      */
     deleteBillingAddress(organizationId: string): Promise<{}>;
     /**
-     * Get billing address
-     *
      * Get a billing address using it&#039;s ID.
      *
      * @param {string} organizationId
@@ -99,8 +83,6 @@ export declare class Organizations {
      */
     getBillingAddress(organizationId: string, billingAddressId: string): Promise<Models.BillingAddress>;
     /**
-     * Set team&#039;s billing email
-     *
      * Set the current billing email for the organization.
      *
      * @param {string} organizationId
@@ -110,8 +92,6 @@ export declare class Organizations {
      */
     setBillingEmail<Preferences extends Models.Preferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Update organization budget
-     *
      * Update the budget limit for an organization.
      *
      * @param {string} organizationId
@@ -120,10 +100,8 @@ export declare class Organizations {
      * @throws {AppwriteException}
      * @returns {Promise<Models.Organization<Preferences>>}
      */
-    updateBudget<Preferences extends Models.Preferences>(organizationId: string, budget: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
+    updateBudget<Preferences extends Models.Preferences>(organizationId: string, budget?: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
     /**
-     * List credits
-     *
      * List all credits for an organization.
 
      *
@@ -134,8 +112,6 @@ export declare class Organizations {
      */
     listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList>;
     /**
-     * Add credits from coupon
-     *
      * Add credit to an organization using a coupon.
      *
      * @param {string} organizationId
@@ -145,8 +121,6 @@ export declare class Organizations {
      */
     addCredit(organizationId: string, couponId: string): Promise<Models.Credit>;
     /**
-     * Get credit details
-     *
      * Get credit details.
      *
      * @param {string} organizationId
@@ -156,8 +130,6 @@ export declare class Organizations {
      */
     getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
     /**
-     * List invoices
-     *
      * List all invoices for an organization.
      *
      * @param {string} organizationId
@@ -167,8 +139,6 @@ export declare class Organizations {
      */
     listInvoices(organizationId: string, queries?: string[]): Promise<Models.InvoiceList>;
     /**
-     * Get invoice
-     *
      * Get an invoice by its unique ID.
      *
      * @param {string} organizationId
@@ -178,8 +148,6 @@ export declare class Organizations {
      */
     getInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
     /**
-     * Download invoice in PDF
-     *
      * Download invoice in PDF
      *
      * @param {string} organizationId
@@ -189,8 +157,6 @@ export declare class Organizations {
      */
     getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
     /**
-     * Initiate payment for failed invoice to pay live from console
-     *
      * Initiate payment for failed invoice to pay live from console
      *
      * @param {string} organizationId
@@ -201,8 +167,15 @@ export declare class Organizations {
      */
     createInvoicePayment(organizationId: string, invoiceId: string, paymentMethodId: string): Promise<Models.Invoice>;
     /**
-     * View invoice in PDF
+     * Validates the payment linked with the invoice and updates the invoice status if the payment status is changed.
      *
+     * @param {string} organizationId
+     * @param {string} invoiceId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Invoice>}
+     */
+    validateInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
+    /**
      * View invoice in PDF
      *
      * @param {string} organizationId
@@ -212,8 +185,6 @@ export declare class Organizations {
      */
     getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
     /**
-     * Set team&#039;s payment method
-     *
      * Set a organization&#039;s default payment method.
      *
      * @param {string} organizationId
@@ -223,8 +194,6 @@ export declare class Organizations {
      */
     setDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Delete team&#039;s default payment method
-     *
      * Delete the default payment method for an organization.
      *
      * @param {string} organizationId
@@ -233,8 +202,6 @@ export declare class Organizations {
      */
     deleteDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Set team&#039;s backup payment method
-     *
      * Set an organization&#039;s backup payment method.
 
      *
@@ -245,8 +212,6 @@ export declare class Organizations {
      */
     setBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Delete team&#039;s backup payment method
-     *
      * Delete a backup payment method for an organization.
      *
      * @param {string} organizationId
@@ -255,8 +220,6 @@ export declare class Organizations {
      */
     deleteBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Get payment method
-     *
      * Get an organization&#039;s payment method using it&#039;s payment method ID.
      *
      * @param {string} organizationId
@@ -266,8 +229,6 @@ export declare class Organizations {
      */
     getPaymentMethod(organizationId: string, paymentMethodId: string): Promise<Models.PaymentMethod>;
     /**
-     * Get organization billing plan details
-     *
      * Get the details of the current billing plan for an organization.
      *
      * @param {string} organizationId
@@ -276,8 +237,6 @@ export declare class Organizations {
      */
     getPlan(organizationId: string): Promise<Models.BillingPlan>;
     /**
-     * Update organization billing plan
-     *
      * Update the billing plan for an organization.
      *
      * @param {string} organizationId
@@ -293,8 +252,6 @@ export declare class Organizations {
      */
     updatePlan<Preferences extends Models.Preferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string, invites?: string[], couponId?: string, taxId?: string, budget?: number): Promise<Models.Organization<Preferences>>;
     /**
-     * Get Scopes
-     *
      * Get Scopes
      *
      * @param {string} organizationId
@@ -303,8 +260,6 @@ export declare class Organizations {
      */
     getScopes(organizationId: string): Promise<Models.Roles>;
     /**
-     * Set team&#039;s tax Id
-     *
      * Set an organization&#039;s billing tax ID.
      *
      * @param {string} organizationId
@@ -314,8 +269,6 @@ export declare class Organizations {
      */
     setBillingTaxId<Preferences extends Models.Preferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
     /**
-     * Get team&#039;s usage data
-     *
      * Get the usage data for an organization.
      *
      * @param {string} organizationId

package/types/services/project.d.ts

@@ -5,8 +5,6 @@ export declare class Project {
     client: Client;
     constructor(client: Client);
     /**
-     * Get project usage stats
-     *
      * Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.
      *
      * @param {string} startDate
@@ -17,8 +15,6 @@ export declare class Project {
      */
     getUsage(startDate: string, endDate: string, period?: ProjectUsageRange): Promise<Models.UsageProject>;
     /**
-     * List variables
-     *
      * Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.
      *
      * @throws {AppwriteException}
@@ -26,8 +22,6 @@ export declare class Project {
      */
     listVariables(): Promise<Models.VariableList>;
     /**
-     * Create variable
-     *
      * Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.
      *
      * @param {string} key
@@ -37,8 +31,6 @@ export declare class Project {
      */
     createVariable(key: string, value: string): Promise<Models.Variable>;
     /**
-     * Get variable
-     *
      * Get a project variable by its unique ID.
      *
      * @param {string} variableId
@@ -47,8 +39,6 @@ export declare class Project {
      */
     getVariable(variableId: string): Promise<Models.Variable>;
     /**
-     * Update variable
-     *
      * Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.
      *
      * @param {string} variableId
@@ -59,8 +49,6 @@ export declare class Project {
      */
     updateVariable(variableId: string, key: string, value?: string): Promise<Models.Variable>;
     /**
-     * Delete variable
-     *
      * Delete a project variable by its unique ID.
      *
      * @param {string} variableId