@appwrite.io/console 0.0.1 → 0.0.2-preview-0.0

package/types/services/functions.d.ts

@@ -0,0 +1,280 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+import type { UploadProgress } from '../client';
+export declare class Functions extends Service {
+    constructor(client: Client);
+    /**
+     * List Functions
+     *
+     * Get a list of all the project's functions. You can use the query params to
+     * filter your results.
+     *
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    list(queries?: string[], search?: string): Promise<Models.FunctionList>;
+    /**
+     * Create Function
+     *
+     * Create a new function. You can pass a list of
+     * [permissions](/docs/permissions) to allow different project users or team
+     * with access to execute the function using the client API.
+     *
+     * @param {string} functionId
+     * @param {string} name
+     * @param {string[]} execute
+     * @param {string} runtime
+     * @param {string[]} events
+     * @param {string} schedule
+     * @param {number} timeout
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    create(functionId: string, name: string, execute: string[], runtime: string, events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
+    /**
+     * List runtimes
+     *
+     * Get a list of all runtimes that are currently active on your instance.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listRuntimes(): Promise<Models.RuntimeList>;
+    /**
+     * Get Functions Usage
+     *
+     *
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getUsage(range?: string): Promise<Models.UsageFunctions>;
+    /**
+     * Get Function
+     *
+     * Get a function by its unique ID.
+     *
+     * @param {string} functionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get(functionId: string): Promise<Models.Function>;
+    /**
+     * Update Function
+     *
+     * Update function by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} name
+     * @param {string[]} execute
+     * @param {string[]} events
+     * @param {string} schedule
+     * @param {number} timeout
+     * @param {boolean} enabled
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    update(functionId: string, name: string, execute: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean): Promise<Models.Function>;
+    /**
+     * Delete Function
+     *
+     * Delete a function by its unique ID.
+     *
+     * @param {string} functionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    delete(functionId: string): Promise<{}>;
+    /**
+     * List Deployments
+     *
+     * Get a list of all the project's code deployments. You can use the query
+     * params to filter your results.
+     *
+     * @param {string} functionId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
+    /**
+     * Create Deployment
+     *
+     * Create a new function code deployment. Use this endpoint to upload a new
+     * version of your code function. To execute your newly uploaded code, you'll
+     * need to update the function's deployment to use your new deployment UID.
+     *
+     * This endpoint accepts a tar.gz file compressed with your code. Make sure to
+     * include any dependencies your code has within the compressed file. You can
+     * learn more about code packaging in the [Appwrite Cloud Functions
+     * tutorial](/docs/functions).
+     *
+     * Use the "command" param to set the entry point used to execute your code.
+     *
+     * @param {string} functionId
+     * @param {string} entrypoint
+     * @param {File} code
+     * @param {boolean} activate
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createDeployment(functionId: string, entrypoint: string, code: File, activate: boolean, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    /**
+     * Get Deployment
+     *
+     * Get a code deployment by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
+    /**
+     * Update Function Deployment
+     *
+     * Update the function code deployment ID using the unique function ID. Use
+     * this endpoint to switch the code deployment that should be executed by the
+     * execution endpoint.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
+    /**
+     * Delete Deployment
+     *
+     * Delete a code deployment by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
+    /**
+     * Create Build
+     *
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @param {string} buildId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}>;
+    /**
+     * List Executions
+     *
+     * Get a list of all the current user function execution logs. You can use the
+     * query params to filter your results.
+     *
+     * @param {string} functionId
+     * @param {string[]} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
+    /**
+     * Create Execution
+     *
+     * Trigger a function execution. The returned object will return you the
+     * current execution status. You can ping the `Get Execution` endpoint to get
+     * updates on the current execution status. Once this endpoint is called, your
+     * function execution process will start asynchronously.
+     *
+     * @param {string} functionId
+     * @param {string} data
+     * @param {boolean} async
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createExecution(functionId: string, data?: string, async?: boolean): Promise<Models.Execution>;
+    /**
+     * Get Execution
+     *
+     * Get a function execution log by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} executionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
+    /**
+     * Get Function Usage
+     *
+     *
+     * @param {string} functionId
+     * @param {string} range
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getFunctionUsage(functionId: string, range?: string): Promise<Models.UsageFunctions>;
+    /**
+     * List Variables
+     *
+     * Get a list of all variables of a specific function.
+     *
+     * @param {string} functionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listVariables(functionId: string): Promise<Models.VariableList>;
+    /**
+     * Create Variable
+     *
+     * Create a new function variable. These variables can be accessed within
+     * function in the `env` object under the request variable.
+     *
+     * @param {string} functionId
+     * @param {string} key
+     * @param {string} value
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
+    /**
+     * Get Variable
+     *
+     * Get a variable by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} variableId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getVariable(functionId: string, variableId: string): Promise<Models.Variable>;
+    /**
+     * Update Variable
+     *
+     * Update variable by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} variableId
+     * @param {string} key
+     * @param {string} value
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
+    /**
+     * Delete Variable
+     *
+     * Delete a variable by its unique ID.
+     *
+     * @param {string} functionId
+     * @param {string} variableId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    deleteVariable(functionId: string, variableId: string): Promise<{}>;
+}

package/types/services/graphql.d.ts

@@ -0,0 +1,25 @@
+import { Service } from '../service';
+import { Client } from '../client';
+export declare class Graphql extends Service {
+    constructor(client: Client);
+    /**
+     * GraphQL Endpoint
+     *
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    query(query: object): Promise<{}>;
+    /**
+     * GraphQL Endpoint
+     *
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    mutation(query: object): Promise<{}>;
+}

package/types/services/health.d.ts

@@ -0,0 +1,106 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Health extends Service {
+    constructor(client: Client);
+    /**
+     * Get HTTP
+     *
+     * Check the Appwrite HTTP server is up and responsive.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get(): Promise<Models.HealthStatus>;
+    /**
+     * Get Antivirus
+     *
+     * Check the Appwrite Antivirus server is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getAntivirus(): Promise<Models.HealthAntivirus>;
+    /**
+     * Get Cache
+     *
+     * Check the Appwrite in-memory cache server is up and connection is
+     * successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getCache(): Promise<Models.HealthStatus>;
+    /**
+     * Get DB
+     *
+     * Check the Appwrite database server is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getDB(): Promise<Models.HealthStatus>;
+    /**
+     * Get Certificates Queue
+     *
+     * Get the number of certificates that are waiting to be issued against
+     * [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
+     * server.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getQueueCertificates(): Promise<Models.HealthQueue>;
+    /**
+     * Get Functions Queue
+     *
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getQueueFunctions(): Promise<Models.HealthQueue>;
+    /**
+     * Get Logs Queue
+     *
+     * Get the number of logs that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getQueueLogs(): Promise<Models.HealthQueue>;
+    /**
+     * Get Webhooks Queue
+     *
+     * Get the number of webhooks that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getQueueWebhooks(): Promise<Models.HealthQueue>;
+    /**
+     * Get Local Storage
+     *
+     * Check the Appwrite local storage device is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getStorageLocal(): Promise<Models.HealthStatus>;
+    /**
+     * Get Time
+     *
+     * Check the Appwrite server time is synced with Google remote NTP server. We
+     * use this technology to smoothly handle leap seconds with no disruptive
+     * events. The [Network Time
+     * Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is
+     * used by hundreds of millions of computers and devices to synchronize their
+     * clocks over the Internet. If your computer sets its own clock, it likely
+     * uses NTP.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getTime(): Promise<Models.HealthTime>;
+}

package/types/services/locale.d.ts

@@ -0,0 +1,81 @@
+import { Service } from '../service';
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Locale extends Service {
+    constructor(client: Client);
+    /**
+     * Get User Locale
+     *
+     * Get the current user location based on IP. Returns an object with user
+     * country code, country name, continent name, continent code, ip address and
+     * suggested currency. You can use the locale header to get the data in a
+     * supported language.
+     *
+     * ([IP Geolocation by DB-IP](https://db-ip.com))
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    get(): Promise<Models.Locale>;
+    /**
+     * List Continents
+     *
+     * List of all continents. You can use the locale header to get the data in a
+     * supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listContinents(): Promise<Models.ContinentList>;
+    /**
+     * List Countries
+     *
+     * List of all countries. You can use the locale header to get the data in a
+     * supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listCountries(): Promise<Models.CountryList>;
+    /**
+     * List EU Countries
+     *
+     * List of all countries that are currently members of the EU. You can use the
+     * locale header to get the data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listCountriesEU(): Promise<Models.CountryList>;
+    /**
+     * List Countries Phone Codes
+     *
+     * List of all countries phone codes. You can use the locale header to get the
+     * data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listCountriesPhones(): Promise<Models.PhoneList>;
+    /**
+     * List Currencies
+     *
+     * List of all currencies, including currency symbol, name, plural, and
+     * decimal digits for all major and minor currencies. You can use the locale
+     * header to get the data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listCurrencies(): Promise<Models.CurrencyList>;
+    /**
+     * List Languages
+     *
+     * List of all languages classified by ISO 639-1 including 2-letter code, name
+     * in English, and name in the respective language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    listLanguages(): Promise<Models.LanguageList>;
+}