@appwrite.io/console 0.6.2 → 0.7.0-rc.1

package/src/services/vcs.ts

@@ -1,14 +1,12 @@
-import { Service } from '../service';
-import { AppwriteException, Client } from '../client';
+import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
 import type { Models } from '../models';
-import type { UploadProgress, Payload } from '../client';
 
-export class Vcs extends Service {
+export class Vcs {
+    client: Client;
 
-     constructor(client: Client)
-     {
-        super(client);
-     }
+    constructor(client: Client) {
+        this.client = client;
+    }
 
     /**
      * List Repositories
@@ -17,26 +15,30 @@ export class Vcs extends Service {
      * @param {string} installationId
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.ProviderRepositoryList>}
+     */
     async listRepositories(installationId: string, search?: string): Promise<Models.ProviderRepositoryList> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         const apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
         const payload: Payload = {};
-
         if (typeof search !== 'undefined') {
             payload['search'] = search;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Create repository
      *
@@ -45,38 +47,39 @@ export class Vcs extends Service {
      * @param {string} name
      * @param {boolean} xprivate
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.ProviderRepository>}
+     */
     async createRepository(installationId: string, name: string, xprivate: boolean): Promise<Models.ProviderRepository> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
         }
-
         if (typeof xprivate === 'undefined') {
             throw new AppwriteException('Missing required parameter: "xprivate"');
         }
-
         const apiPath = '/vcs/github/installations/{installationId}/providerRepositories'.replace('{installationId}', installationId);
         const payload: Payload = {};
-
         if (typeof name !== 'undefined') {
             payload['name'] = name;
         }
-
         if (typeof xprivate !== 'undefined') {
             payload['private'] = xprivate;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('post', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Get repository
      *
@@ -84,26 +87,30 @@ export class Vcs extends Service {
      * @param {string} installationId
      * @param {string} providerRepositoryId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.ProviderRepository>}
+     */
     async getRepository(installationId: string, providerRepositoryId: string): Promise<Models.ProviderRepository> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         if (typeof providerRepositoryId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "providerRepositoryId"');
         }
-
         const apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * List Repository Branches
      *
@@ -111,26 +118,65 @@ export class Vcs extends Service {
      * @param {string} installationId
      * @param {string} providerRepositoryId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.BranchList>}
+     */
     async listRepositoryBranches(installationId: string, providerRepositoryId: string): Promise<Models.BranchList> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         if (typeof providerRepositoryId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "providerRepositoryId"');
         }
-
         const apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/branches'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
+        }
+
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
     }
+    /**
+     * Get files and directories of a VCS repository
+     *
+     *
+     * @param {string} installationId
+     * @param {string} providerRepositoryId
+     * @param {string} providerRootDirectory
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.VcsContentList>}
+     */
+    async getRepositoryContents(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.VcsContentList> {
+        if (typeof installationId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "installationId"');
+        }
+        if (typeof providerRepositoryId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "providerRepositoryId"');
+        }
+        const apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/contents'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
+        const payload: Payload = {};
+        if (typeof providerRootDirectory !== 'undefined') {
+            payload['providerRootDirectory'] = providerRootDirectory;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
 
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Detect runtime settings from source code
      *
@@ -139,30 +185,33 @@ export class Vcs extends Service {
      * @param {string} providerRepositoryId
      * @param {string} providerRootDirectory
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Detection>}
+     */
     async createRepositoryDetection(installationId: string, providerRepositoryId: string, providerRootDirectory?: string): Promise<Models.Detection> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         if (typeof providerRepositoryId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "providerRepositoryId"');
         }
-
         const apiPath = '/vcs/github/installations/{installationId}/providerRepositories/{providerRepositoryId}/detection'.replace('{installationId}', installationId).replace('{providerRepositoryId}', providerRepositoryId);
         const payload: Payload = {};
-
         if (typeof providerRootDirectory !== 'undefined') {
             payload['providerRootDirectory'] = providerRootDirectory;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('post', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Authorize external deployment
      *
@@ -171,34 +220,36 @@ export class Vcs extends Service {
      * @param {string} repositoryId
      * @param {string} providerPullRequestId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     async updateExternalDeployments(installationId: string, repositoryId: string, providerPullRequestId: string): Promise<{}> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         if (typeof repositoryId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "repositoryId"');
         }
-
         if (typeof providerPullRequestId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "providerPullRequestId"');
         }
-
         const apiPath = '/vcs/github/installations/{installationId}/repositories/{repositoryId}'.replace('{installationId}', installationId).replace('{repositoryId}', repositoryId);
         const payload: Payload = {};
-
         if (typeof providerPullRequestId !== 'undefined') {
             payload['providerPullRequestId'] = providerPullRequestId;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('patch', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * List installations
      *
@@ -206,67 +257,82 @@ export class Vcs extends Service {
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.InstallationList>}
+     */
     async listInstallations(queries?: string[], search?: string): Promise<Models.InstallationList> {
         const apiPath = '/vcs/installations';
         const payload: Payload = {};
-
         if (typeof queries !== 'undefined') {
             payload['queries'] = queries;
         }
-
         if (typeof search !== 'undefined') {
             payload['search'] = search;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Get installation
      *
      *
      * @param {string} installationId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Installation>}
+     */
     async getInstallation(installationId: string): Promise<Models.Installation> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         const apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Delete Installation
      *
      *
      * @param {string} installationId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     async deleteInstallation(installationId: string): Promise<{}> {
         if (typeof installationId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "installationId"');
         }
-
         const apiPath = '/vcs/installations/{installationId}'.replace('{installationId}', installationId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('delete', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
+        }
+
+        return await this.client.call(
+            'delete',
+            uri,
+            apiHeaders,
+            payload
+        );
     }
-};
+}

package/types/client.d.ts

@@ -1,30 +1,97 @@
 import { Models } from './models';
+/**
+ * Payload type representing a key-value pair with string keys and any values.
+ */
 declare type Payload = {
     [key: string]: any;
 };
+/**
+ * Headers type representing a key-value pair with string keys and string values.
+ */
 declare type Headers = {
     [key: string]: string;
 };
-export declare type RealtimeResponseEvent<T extends unknown> = {
+/**
+ * Realtime event response structure with generic payload type.
+ */
+declare type RealtimeResponseEvent<T extends unknown> = {
+    /**
+     * List of event names associated with the response.
+     */
     events: string[];
+    /**
+     * List of channel names associated with the response.
+     */
     channels: string[];
+    /**
+     * Timestamp indicating the time of the event.
+     */
     timestamp: number;
+    /**
+     * Payload containing event-specific data.
+     */
     payload: T;
 };
-export declare type UploadProgress = {
+/**
+ * Type representing upload progress information.
+ */
+declare type UploadProgress = {
+    /**
+     * Identifier for the upload progress.
+     */
     $id: string;
+    /**
+     * Current progress of the upload (in percentage).
+     */
     progress: number;
+    /**
+     * Total size uploaded (in bytes) during the upload process.
+     */
     sizeUploaded: number;
+    /**
+     * Total number of chunks that need to be uploaded.
+     */
     chunksTotal: number;
+    /**
+     * Number of chunks that have been successfully uploaded.
+     */
     chunksUploaded: number;
 };
+/**
+ * Exception thrown by the  package
+ */
 declare class AppwriteException extends Error {
+    /**
+     * The error code associated with the exception.
+     */
     code: number;
+    /**
+     * The response string associated with the exception.
+     */
     response: string;
+    /**
+     * Error type.
+     * See [Error Types](https://appwrite.io/docs/response-codes#errorTypes) for more information.
+     */
     type: string;
+    /**
+     * Initializes a Appwrite Exception.
+     *
+     * @param {string} message - The error message.
+     * @param {number} code - The error code. Default is 0.
+     * @param {string} type - The error type. Default is an empty string.
+     * @param {string} response - The response string. Default is an empty string.
+     */
     constructor(message: string, code?: number, type?: string, response?: string);
 }
+/**
+ * Client that handles requests to Appwrite
+ */
 declare class Client {
+    static CHUNK_SIZE: number;
+    /**
+     * Holds configuration such as project.
+     */
     config: {
         endpoint: string;
         endpointRealtime: string;
@@ -34,6 +101,9 @@ declare class Client {
         locale: string;
         mode: string;
     };
+    /**
+     * Custom headers for API requests.
+     */
     headers: Headers;
     /**
      * Set Endpoint
@@ -126,9 +196,17 @@ declare class Client {
      * @returns {() => void} Unsubscribes from events.
      */
     subscribe<T extends unknown>(channels: string | string[], callback: (payload: RealtimeResponseEvent<T>) => void): () => void;
-    call(method: string, url: URL, headers?: Headers, params?: Payload): Promise<any>;
+    prepareRequest(method: string, url: URL, headers?: Headers, params?: Payload): {
+        uri: string;
+        options: RequestInit;
+    };
+    chunkedUpload(method: string, url: URL, headers: Headers | undefined, originalPayload: Payload | undefined, onProgress: (progress: UploadProgress) => void): Promise<any>;
+    redirect(method: string, url: URL, headers?: Headers, params?: Payload): Promise<string>;
+    call(method: string, url: URL, headers?: Headers, params?: Payload, responseType?: string): Promise<any>;
+    static flatten(data: Payload, prefix?: string): Payload;
 }
 export { Client, AppwriteException };
 export { Query } from './query';
-export type { Models, Payload };
+export type { Models, Payload, UploadProgress };
+export type { RealtimeResponseEvent };
 export type { QueryTypes, QueryTypesList } from './query';

package/types/enums/credit-card.d.ts

@@ -2,7 +2,7 @@ export declare enum CreditCard {
     AmericanExpress = "amex",
     Argencard = "argencard",
     Cabal = "cabal",
-    Consosud = "censosud",
+    Cencosud = "cencosud",
     DinersClub = "diners",
     Discover = "discover",
     Elo = "elo",

package/types/enums/email-template-type.d.ts

@@ -3,5 +3,7 @@ export declare enum EmailTemplateType {
     Magicsession = "magicsession",
     Recovery = "recovery",
     Invitation = "invitation",
-    Mfachallenge = "mfachallenge"
+    Mfachallenge = "mfachallenge",
+    Sessionalert = "sessionalert",
+    Otpsession = "otpsession"
 }

package/types/enums/name.d.ts

@@ -6,10 +6,9 @@ export declare enum Name {
     V1functions = "v1-functions",
     V1usage = "v1-usage",
     V1usagedump = "v1-usage-dump",
-    Webhooksv1 = "webhooksv1",
+    V1webhooks = "v1-webhooks",
     V1certificates = "v1-certificates",
     V1builds = "v1-builds",
     V1messaging = "v1-messaging",
-    V1migrations = "v1-migrations",
-    Hamsterv1 = "hamsterv1"
+    V1migrations = "v1-migrations"
 }

package/types/enums/platform-type.d.ts

@@ -11,5 +11,7 @@ export declare enum PlatformType {
     Applewatchos = "apple-watchos",
     Appletvos = "apple-tvos",
     Android = "android",
-    Unity = "unity"
+    Unity = "unity",
+    Reactnativeios = "react-native-ios",
+    Reactnativeandroid = "react-native-android"
 }

package/types/enums/runtime.d.ts

@@ -19,9 +19,6 @@ export declare enum Runtime {
     Python311 = "python-3.11",
     Python312 = "python-3.12",
     Pythonml311 = "python-ml-3.11",
-    Deno121 = "deno-1.21",
-    Deno124 = "deno-1.24",
-    Deno135 = "deno-1.35",
     Deno140 = "deno-1.40",
     Dart215 = "dart-2.15",
     Dart216 = "dart-2.16",
@@ -46,5 +43,6 @@ export declare enum Runtime {
     Kotlin19 = "kotlin-1.9",
     Cpp17 = "cpp-17",
     Cpp20 = "cpp-20",
-    Bun10 = "bun-1.0"
+    Bun10 = "bun-1.0",
+    Go122 = "go-1.22"
 }

package/types/id.d.ts

@@ -1,5 +1,20 @@
+/**
+ * Helper class to generate ID strings for resources.
+ */
 export declare class ID {
     #private;
+    /**
+     * Uses the provided ID as the ID for the resource.
+     *
+     * @param {string} id
+     * @returns {string}
+     */
     static custom(id: string): string;
+    /**
+     * Have Appwrite generate a unique ID for you.
+     *
+     * @param {number} padding. Default is 7.
+     * @returns {string}
+     */
     static unique(padding?: number): string;
 }

package/types/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Appwrite Console SDK
+ *
+ * This SDK is compatible with Appwrite server version 1.6.x.
+ * For older versions, please check
+ * [previous releases](https://github.com/appwrite/sdk-for-console/releases).
+ */
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Avatars } from './services/avatars';