@appwrite.io/console 1.0.1 → 1.1.0-rc.2

package/types/services/organizations.d.ts

@@ -0,0 +1,273 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+import { BillingPlan } from '../enums/billing-plan';
+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
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.TeamList<Preferences>>}
+     */
+    list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
+    /**
+     * Create Organization
+     *
+     * Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.
+     *
+     * @param {string} organizationId
+     * @param {string} name
+     * @param {BillingPlan} billingPlan
+     * @param {string} paymentMethodId
+     * @param {string} billingAddressId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    create<Preferences extends Models.Preferences>(organizationId: string, name: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Delete team
+     *
+     * Delete a team using its ID. Only team members with the owner role can delete the team.
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    delete(organizationId: string): Promise<{}>;
+    /**
+     * List aggregations
+     *
+     *
+     * @param {string} organizationId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AggregationTeamList>}
+     */
+    listAggregations(organizationId: string, queries?: string[]): Promise<Models.AggregationTeamList>;
+    /**
+     * Get invoice
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} aggregationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Invoice>}
+     */
+    getAggregation(organizationId: string, aggregationId: string): Promise<Models.Invoice>;
+    /**
+     * Set team&#039;s billing address
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} billingAddressId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    setBillingAddress<Preferences extends Models.Preferences>(organizationId: string, billingAddressId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Delete team&#039;s billing address
+     *
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteBillingAddress(organizationId: string): Promise<{}>;
+    /**
+     * Get billing address
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} billingAddressId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BillingAddress>}
+     */
+    getBillingAddress(organizationId: string, billingAddressId: string): Promise<Models.BillingAddress>;
+    /**
+     * Set team&#039;s billing email
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} billingEmail
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    setBillingEmail<Preferences extends Models.Preferences>(organizationId: string, billingEmail: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Update organization budget
+     *
+     *
+     * @param {string} organizationId
+     * @param {number} budget
+     * @param {number[]} alerts
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    updateBudget<Preferences extends Models.Preferences>(organizationId: string, budget: number, alerts?: number[]): Promise<Models.Organization<Preferences>>;
+    /**
+     * Add credits from coupon
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} couponId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Credit>}
+     */
+    addCredit(organizationId: string, couponId: string): Promise<Models.Credit>;
+    /**
+     * Get credit details
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} creditId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Credit>}
+     */
+    getCredit(organizationId: string, creditId: string): Promise<Models.Credit>;
+    /**
+     * List invoices
+     *
+     *
+     * @param {string} organizationId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.InvoiceList>}
+     */
+    listInvoices(organizationId: string, queries?: string[]): Promise<Models.InvoiceList>;
+    /**
+     * Get invoice
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} invoiceId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Invoice>}
+     */
+    getInvoice(organizationId: string, invoiceId: string): Promise<Models.Invoice>;
+    /**
+     * View invoice in PDF
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} invoiceId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PaymentMethod>}
+     */
+    getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
+    /**
+     * Initiate payment for failed invoice to pay live from console
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} invoiceId
+     * @param {string} paymentMethodId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Invoice>}
+     */
+    createInvoicePayment(organizationId: string, invoiceId: string, paymentMethodId: string): Promise<Models.Invoice>;
+    /**
+     * View invoice in PDF
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} invoiceId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PaymentMethod>}
+     */
+    getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
+    /**
+     * Set team&#039;s payment method
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} paymentMethodId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    setDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Delete team&#039;s default payment method
+     *
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    deleteDefaultPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Set team&#039;s backup payment method
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} paymentMethodId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    setBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string, paymentMethodId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Delete team&#039;s backup payment method
+     *
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    deleteBackupPaymentMethod<Preferences extends Models.Preferences>(organizationId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Get payment method
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} paymentMethodId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PaymentMethod>}
+     */
+    getPaymentMethod(organizationId: string, paymentMethodId: string): Promise<Models.PaymentMethod>;
+    /**
+     * Get organization billing plan details
+     *
+     *
+     * @param {string} organizationId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.BillingPlan>}
+     */
+    getPlan(organizationId: string): Promise<Models.BillingPlan>;
+    /**
+     * Update organization billing plan
+     *
+     *
+     * @param {string} organizationId
+     * @param {BillingPlan} billingPlan
+     * @param {string} paymentMethodId
+     * @param {string} billingAddressId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    updatePlan<Preferences extends Models.Preferences>(organizationId: string, billingPlan: BillingPlan, paymentMethodId?: string, billingAddressId?: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Set team&#039;s tax Id
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} taxId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Organization<Preferences>>}
+     */
+    setBillingTaxId<Preferences extends Models.Preferences>(organizationId: string, taxId: string): Promise<Models.Organization<Preferences>>;
+    /**
+     * Get team&#039;s usage data
+     *
+     *
+     * @param {string} organizationId
+     * @param {string} startDate
+     * @param {string} endDate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.UsageOrganization>}
+     */
+    getUsage(organizationId: string, startDate?: string, endDate?: string): Promise<Models.UsageOrganization>;
+}

package/types/services/projects.d.ts

@@ -133,16 +133,6 @@ export declare class Projects {
      * @returns {Promise<Models.Project>}
      */
     updateAuthSessionsLimit(projectId: string, limit: number): Promise<Models.Project>;
-    /**
-     * Update the mock numbers for the project
-     *
-     *
-     * @param {string} projectId
-     * @param {object[]} numbers
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.Project>}
-     */
-    updateMockNumbers(projectId: string, numbers: object[]): Promise<Models.Project>;
     /**
      * Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password
      *
@@ -173,16 +163,6 @@ export declare class Projects {
      * @returns {Promise<Models.Project>}
      */
     updatePersonalDataCheck(projectId: string, enabled: boolean): Promise<Models.Project>;
-    /**
-     * Update project sessions emails
-     *
-     *
-     * @param {string} projectId
-     * @param {boolean} alerts
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.Project>}
-     */
-    updateSessionAlerts(projectId: string, alerts: boolean): Promise<Models.Project>;
     /**
      * Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.
      *
@@ -194,17 +174,6 @@ export declare class Projects {
      * @returns {Promise<Models.Project>}
      */
     updateAuthStatus(projectId: string, method: AuthMethod, status: boolean): Promise<Models.Project>;
-    /**
-     * Create JWT
-     *
-     *
-     * @param {string} projectId
-     * @param {string[]} scopes
-     * @param {number} duration
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.Jwt>}
-     */
-    createJWT(projectId: string, scopes: string[], duration?: number): Promise<Models.Jwt>;
     /**
      * List keys
      *
@@ -387,7 +356,7 @@ export declare class Projects {
      */
     createSmtpTest(projectId: string, emails: string[], senderName: string, senderEmail: string, host: string, replyTo?: string, port?: number, username?: string, password?: string, secure?: SMTPSecure): Promise<{}>;
     /**
-     * Update project team
+     * Update Project Team
      *
      *
      * @param {string} projectId

package/types/services/users.d.ts

@@ -193,18 +193,6 @@ export declare class Users {
      * @returns {Promise<Models.User<Preferences>>}
      */
     updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
-    /**
-     * Create user JWT
-     *
-     * Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.
-     *
-     * @param {string} userId
-     * @param {string} sessionId
-     * @param {number} duration
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.Jwt>}
-     */
-    createJWT(userId: string, sessionId?: string, duration?: number): Promise<Models.Jwt>;
     /**
      * Update user labels
      *

package/types/services/vcs.d.ts

@@ -44,17 +44,6 @@ export declare class Vcs {
      * @returns {Promise<Models.BranchList>}
      */
     listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList>;
-    /**
-     * Get files and directories of a VCS repository
-     *
-     *
-     * @param {string} installationId
-     * @param {string} providerRepositoryId
-     * @param {string} providerRootDirectory
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.VcsContentList>}
-     */
-    getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList>;
     /**
      * Detect runtime settings from source code
      *

package/docs/examples/functions/delete-execution.md

@@ -1,14 +0,0 @@
-import { Client, Functions } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const functions = new Functions(client);
-
-const result = await functions.deleteExecution(
-    '<FUNCTION_ID>', // functionId
-    '<EXECUTION_ID>' // executionId
-);
-
-console.log(result);

package/docs/examples/functions/list-templates.md

@@ -1,16 +0,0 @@
-import { Client, Functions } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const functions = new Functions(client);
-
-const result = await functions.listTemplates(
-    [], // runtimes (optional)
-    [], // useCases (optional)
-    1, // limit (optional)
-    0 // offset (optional)
-);
-
-console.log(result);

package/docs/examples/functions/update-deployment-build.md

@@ -1,14 +0,0 @@
-import { Client, Functions } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const functions = new Functions(client);
-
-const result = await functions.updateDeploymentBuild(
-    '<FUNCTION_ID>', // functionId
-    '<DEPLOYMENT_ID>' // deploymentId
-);
-
-console.log(result);

package/docs/examples/projects/create-j-w-t.md

@@ -1,15 +0,0 @@
-import { Client, Projects } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const projects = new Projects(client);
-
-const result = await projects.createJWT(
-    '<PROJECT_ID>', // projectId
-    [], // scopes
-    0 // duration (optional)
-);
-
-console.log(result);

package/docs/examples/projects/update-mock-numbers.md

@@ -1,14 +0,0 @@
-import { Client, Projects } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const projects = new Projects(client);
-
-const result = await projects.updateMockNumbers(
-    '<PROJECT_ID>', // projectId
-    [] // numbers
-);
-
-console.log(result);

package/docs/examples/projects/update-session-alerts.md

@@ -1,14 +0,0 @@
-import { Client, Projects } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const projects = new Projects(client);
-
-const result = await projects.updateSessionAlerts(
-    '<PROJECT_ID>', // projectId
-    false // alerts
-);
-
-console.log(result);

package/docs/examples/users/create-j-w-t.md

@@ -1,15 +0,0 @@
-import { Client, Users } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const users = new Users(client);
-
-const result = await users.createJWT(
-    '<USER_ID>', // userId
-    '<SESSION_ID>', // sessionId (optional)
-    0 // duration (optional)
-);
-
-console.log(result);

package/docs/examples/vcs/get-repository-contents.md

@@ -1,15 +0,0 @@
-import { Client, Vcs } from "@appwrite.io/console";
-
-const client = new Client()
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
-
-const vcs = new Vcs(client);
-
-const result = await vcs.getRepositoryContents(
-    '<INSTALLATION_ID>', // installationId
-    '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId
-    '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional)
-);
-
-console.log(result);