New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@appwrite.io/console

Package Overview
Dependencies
Maintainers
0
Versions
58
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@appwrite.io/console - npm Package Compare versions

Comparing version 1.1.0-rc.2 to 1.1.0-rc.3

docs/examples/functions/delete-execution.md

3

docs/examples/account/delete-mfa-authenticator.md

@@ -10,6 +10,5 @@ import { Client, Account, AuthenticatorType } from "@appwrite.io/console";

const result = await account.deleteMfaAuthenticator(
AuthenticatorType.Totp, // type
'<OTP>' // otp
AuthenticatorType.Totp // type
);
console.log(result);

@@ -14,5 +14,6 @@ import { Client, Databases } from "@appwrite.io/console";

false, // required
false // default
false, // default
'' // newKey (optional)
);
console.log(result);

@@ -14,5 +14,6 @@ import { Client, Databases } from "@appwrite.io/console";

false, // required
'' // default
'', // default
'' // newKey (optional)
);
console.log(result);

@@ -14,5 +14,6 @@ import { Client, Databases } from "@appwrite.io/console";

false, // required
'email@example.com' // default
'email@example.com', // default
'' // newKey (optional)
);
console.log(result);

@@ -15,5 +15,6 @@ import { Client, Databases } from "@appwrite.io/console";

false, // required
'<DEFAULT>' // default
'<DEFAULT>', // default
'' // newKey (optional)
);
console.log(result);

@@ -16,5 +16,6 @@ import { Client, Databases } from "@appwrite.io/console";

null, // max
null // default
null, // default
'' // newKey (optional)
);
console.log(result);

@@ -16,5 +16,6 @@ import { Client, Databases } from "@appwrite.io/console";

null, // max
null // default
null, // default
'' // newKey (optional)
);
console.log(result);

@@ -14,5 +14,6 @@ import { Client, Databases } from "@appwrite.io/console";

false, // required
'' // default
'', // default
'' // newKey (optional)
);
console.log(result);

@@ -13,5 +13,6 @@ import { Client, Databases, RelationMutate } from "@appwrite.io/console";

'', // key
RelationMutate.Cascade // onDelete (optional)
RelationMutate.Cascade, // onDelete (optional)
'' // newKey (optional)
);
console.log(result);

@@ -14,5 +14,7 @@ import { Client, Databases } from "@appwrite.io/console";

false, // required
'<DEFAULT>' // default
'<DEFAULT>', // default
null, // size (optional)
'' // newKey (optional)
);
console.log(result);

@@ -14,5 +14,6 @@ import { Client, Databases } from "@appwrite.io/console";

false, // required
'https://example.com' // default
'https://example.com', // default
'' // newKey (optional)
);
console.log(result);

@@ -12,5 +12,5 @@ import { Client, Functions } from "@appwrite.io/console";

'<DEPLOYMENT_ID>', // deploymentId
'<BUILD_ID>' // buildId
'<BUILD_ID>' // buildId (optional)
);
console.log(result);

@@ -15,5 +15,6 @@ import { Client, Functions, ExecutionMethod } from "@appwrite.io/console";

ExecutionMethod.GET, // method (optional)
{} // headers (optional)
{}, // headers (optional)
'' // scheduledAt (optional)
);
console.log(result);

@@ -21,2 +21,3 @@ import { Client, Functions, } from "@appwrite.io/console";

'<COMMANDS>', // commands (optional)
[], // scopes (optional)
'<INSTALLATION_ID>', // installationId (optional)

@@ -30,5 +31,6 @@ '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)

'<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional)
'<TEMPLATE_BRANCH>' // templateBranch (optional)
'<TEMPLATE_VERSION>', // templateVersion (optional)
'' // specification (optional)
);
console.log(result);

@@ -21,2 +21,3 @@ import { Client, Functions, } from "@appwrite.io/console";

'<COMMANDS>', // commands (optional)
[], // scopes (optional)
'<INSTALLATION_ID>', // installationId (optional)

@@ -26,5 +27,6 @@ '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional)

false, // providerSilentMode (optional)
'<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional)
'<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional)
'' // specification (optional)
);
console.log(result);

@@ -5,3 +5,3 @@ {

"description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
"version": "1.1.0-rc.2",
"version": "1.1.0-rc.3",
"license": "BSD-3-Clause",

@@ -8,0 +8,0 @@ "main": "dist/cjs/sdk.js",

# Appwrite Console SDK
![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.5.10-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.6.0-blue.svg?style=flat-square)
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)

@@ -9,3 +9,3 @@ [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)

**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
**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).**

@@ -37,3 +37,3 @@ Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)

```html
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.1.0-rc.2"></script>
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@1.1.0-rc.3"></script>
```

@@ -40,0 +40,0 @@

@@ -307,4 +307,4 @@ import { Models } from './models';

'x-sdk-language': 'web',
'x-sdk-version': '1.1.0-rc.2',
'X-Appwrite-Response-Format': '1.5.0',
'x-sdk-version': '1.1.0-rc.3',
'X-Appwrite-Response-Format': '1.6.0',
};

@@ -311,0 +311,0 @@

@@ -7,2 +7,4 @@ export enum EmailTemplateType {

Mfachallenge = 'mfachallenge',
Sessionalert = 'sessionalert',
Otpsession = 'otpsession',
}

@@ -15,2 +15,4 @@ export enum PlatformType {

Unity = 'unity',
Reactnativeios = 'react-native-ios',
Reactnativeandroid = 'react-native-android',
}

@@ -47,2 +47,3 @@ export enum Runtime {

Bun10 = 'bun-1.0',
Go123 = 'go-1.23',
}
/**
* Appwrite Console SDK
*
* This SDK is compatible with Appwrite server version 1.5.x.
* This SDK is compatible with Appwrite server version 1.6.x.
* For older versions, please check

@@ -11,3 +11,2 @@ * [previous releases](https://github.com/appwrite/sdk-for-console/releases).

export { Avatars } from './services/avatars';
export { Backups } from './services/backups';
export { Assistant } from './services/assistant';

@@ -22,3 +21,2 @@ export { Console } from './services/console';

export { Migrations } from './services/migrations';
export { Organizations } from './services/organizations';
export { Project } from './services/project';

@@ -51,3 +49,2 @@ export { Projects } from './services/projects';

export { SmtpEncryption } from './enums/smtp-encryption';
export { BillingPlan } from './enums/billing-plan';
export { ProjectUsageRange } from './enums/project-usage-range';

@@ -54,0 +51,0 @@ export { Region } from './enums/region';

@@ -13,122 +13,2 @@ import { Service } from '../service';

/**
* Get coupon details
*
*
* @param {string} couponId
* @throws {AppwriteException}
* @returns {Promise<Models.Coupon>}
*/
async getCopon(couponId: string): Promise<Models.Coupon> {
if (typeof couponId === 'undefined') {
throw new AppwriteException('Missing required parameter: "couponId"');
}
const apiPath = '/console/coupons/{couponId}'.replace('{couponId}', couponId);
const payload: Payload = {};
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
);
}
/**
* Get plans
*
*
* @throws {AppwriteException}
* @returns {Promise<Models.BillingPlanList>}
*/
async plans(): Promise<Models.BillingPlanList> {
const apiPath = '/console/plans';
const payload: Payload = {};
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
);
}
/**
* Get Regions
*
*
* @throws {AppwriteException}
* @returns {Promise<Models.ConsoleRegionList>}
*/
async regions(): Promise<Models.ConsoleRegionList> {
const apiPath = '/console/regions';
const payload: Payload = {};
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
);
}
/**
* Create source
*
*
* @param {string} ref
* @param {string} referrer
* @param {string} utmSource
* @param {string} utmCampaign
* @param {string} utmMedium
* @throws {AppwriteException}
* @returns {Promise<{}>}
*/
async createSource(ref?: string, referrer?: string, utmSource?: string, utmCampaign?: string, utmMedium?: string): Promise<{}> {
const apiPath = '/console/sources';
const payload: Payload = {};
if (typeof ref !== 'undefined') {
payload['ref'] = ref;
}
if (typeof referrer !== 'undefined') {
payload['referrer'] = referrer;
}
if (typeof utmSource !== 'undefined') {
payload['utmSource'] = utmSource;
}
if (typeof utmCampaign !== 'undefined') {
payload['utmCampaign'] = utmCampaign;
}
if (typeof utmMedium !== 'undefined') {
payload['utmMedium'] = utmMedium;
}
const uri = new URL(this.client.config.endpoint + apiPath);
const apiHeaders: { [header: string]: string } = {
'content-type': 'application/json',
}
return await this.client.call(
'post',
uri,
apiHeaders,
payload
);
}
/**
* Get variables

@@ -135,0 +15,0 @@ *

@@ -64,2 +64,3 @@ import { Service } from '../service';

* @param {string} commands
* @param {string[]} scopes
* @param {string} installationId

@@ -73,7 +74,8 @@ * @param {string} providerRepositoryId

* @param {string} templateRootDirectory
* @param {string} templateBranch
* @param {string} templateVersion
* @param {string} specification
* @throws {AppwriteException}
* @returns {Promise<Models.Function>}
*/
async create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function> {
async create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string, specification?: string): Promise<Models.Function> {
if (typeof functionId === 'undefined') {

@@ -123,2 +125,5 @@ throw new AppwriteException('Missing required parameter: "functionId"');

}
if (typeof scopes !== 'undefined') {
payload['scopes'] = scopes;
}
if (typeof installationId !== 'undefined') {

@@ -148,5 +153,8 @@ payload['installationId'] = installationId;

}
if (typeof templateBranch !== 'undefined') {
payload['templateBranch'] = templateBranch;
if (typeof templateVersion !== 'undefined') {
payload['templateVersion'] = templateVersion;
}
if (typeof specification !== 'undefined') {
payload['specification'] = specification;
}
const uri = new URL(this.client.config.endpoint + apiPath);

@@ -192,2 +200,98 @@

/**
* List available function runtime specifications
*
* List allowed function specifications for this instance.
*
* @throws {AppwriteException}
* @returns {Promise<Models.SpecificationList>}
*/
async listSpecifications(): Promise<Models.SpecificationList> {
const apiPath = '/functions/specifications';
const payload: Payload = {};
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
);
}
/**
* List function templates
*
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
*
* @param {string[]} runtimes
* @param {string[]} useCases
* @param {number} limit
* @param {number} offset
* @throws {AppwriteException}
* @returns {Promise<Models.TemplateFunctionList>}
*/
async listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateFunctionList> {
const apiPath = '/functions/templates';
const payload: Payload = {};
if (typeof runtimes !== 'undefined') {
payload['runtimes'] = runtimes;
}
if (typeof useCases !== 'undefined') {
payload['useCases'] = useCases;
}
if (typeof limit !== 'undefined') {
payload['limit'] = limit;
}
if (typeof offset !== 'undefined') {
payload['offset'] = offset;
}
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
);
}
/**
* Get function template
*
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
*
* @param {string} templateId
* @throws {AppwriteException}
* @returns {Promise<Models.TemplateFunction>}
*/
async getTemplate(templateId: string): Promise<Models.TemplateFunction> {
if (typeof templateId === 'undefined') {
throw new AppwriteException('Missing required parameter: "templateId"');
}
const apiPath = '/functions/templates/{templateId}'.replace('{templateId}', templateId);
const payload: Payload = {};
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
);
}
/**
* Get functions usage

@@ -265,2 +369,3 @@ *

* @param {string} commands
* @param {string[]} scopes
* @param {string} installationId

@@ -271,6 +376,7 @@ * @param {string} providerRepositoryId

* @param {string} providerRootDirectory
* @param {string} specification
* @throws {AppwriteException}
* @returns {Promise<Models.Function>}
*/
async update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function> {
async update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function> {
if (typeof functionId === 'undefined') {

@@ -314,2 +420,5 @@ throw new AppwriteException('Missing required parameter: "functionId"');

}
if (typeof scopes !== 'undefined') {
payload['scopes'] = scopes;
}
if (typeof installationId !== 'undefined') {

@@ -330,2 +439,5 @@ payload['installationId'] = installationId;

}
if (typeof specification !== 'undefined') {
payload['specification'] = specification;
}
const uri = new URL(this.client.config.endpoint + apiPath);

@@ -567,5 +679,4 @@

/**
* Create build
* Rebuild deployment
*
* Create a new build for an Appwrite Function deployment. This endpoint can be used to retry a failed build.
*

@@ -578,3 +689,3 @@ * @param {string} functionId

*/
async createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}> {
async createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}> {
if (typeof functionId === 'undefined') {

@@ -586,7 +697,7 @@ throw new AppwriteException('Missing required parameter: "functionId"');

}
if (typeof buildId === 'undefined') {
throw new AppwriteException('Missing required parameter: "buildId"');
const apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
const payload: Payload = {};
if (typeof buildId !== 'undefined') {
payload['buildId'] = buildId;
}
const apiPath = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId).replace('{buildId}', buildId);
const payload: Payload = {};
const uri = new URL(this.client.config.endpoint + apiPath);

@@ -607,2 +718,34 @@

/**
* Cancel deployment
*
*
* @param {string} functionId
* @param {string} deploymentId
* @throws {AppwriteException}
* @returns {Promise<Models.Build>}
*/
async updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build> {
if (typeof functionId === 'undefined') {
throw new AppwriteException('Missing required parameter: "functionId"');
}
if (typeof deploymentId === 'undefined') {
throw new AppwriteException('Missing required parameter: "deploymentId"');
}
const apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId);
const payload: Payload = {};
const uri = new URL(this.client.config.endpoint + apiPath);
const apiHeaders: { [header: string]: string } = {
'content-type': 'application/json',
}
return await this.client.call(
'patch',
uri,
apiHeaders,
payload
);
}
/**
* Download deployment

@@ -617,3 +760,3 @@ *

*/
downloadDeployment(functionId: string, deploymentId: string): string {
getDeploymentDownload(functionId: string, deploymentId: string): string {
if (typeof functionId === 'undefined') {

@@ -694,6 +837,7 @@ throw new AppwriteException('Missing required parameter: "functionId"');

* @param {object} headers
* @param {string} scheduledAt
* @throws {AppwriteException}
* @returns {Promise<Models.Execution>}
*/
async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution> {
async createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution> {
if (typeof functionId === 'undefined') {

@@ -719,2 +863,5 @@ throw new AppwriteException('Missing required parameter: "functionId"');

}
if (typeof scheduledAt !== 'undefined') {
payload['scheduledAt'] = scheduledAt;
}
const uri = new URL(this.client.config.endpoint + apiPath);

@@ -768,2 +915,36 @@

/**
* Delete execution
*
* Delete a function execution by its unique ID.
*
* @param {string} functionId
* @param {string} executionId
* @throws {AppwriteException}
* @returns {Promise<{}>}
*/
async deleteExecution(functionId: string, executionId: string): Promise<{}> {
if (typeof functionId === 'undefined') {
throw new AppwriteException('Missing required parameter: "functionId"');
}
if (typeof executionId === 'undefined') {
throw new AppwriteException('Missing required parameter: "executionId"');
}
const apiPath = '/functions/{functionId}/executions/{executionId}'.replace('{functionId}', functionId).replace('{executionId}', executionId);
const payload: Payload = {};
const uri = new URL(this.client.config.endpoint + apiPath);
const apiHeaders: { [header: string]: string } = {
'content-type': 'application/json',
}
return await this.client.call(
'delete',
uri,
apiHeaders,
payload
);
}
/**
* Get function usage

@@ -770,0 +951,0 @@ *

@@ -692,2 +692,39 @@ import { Service } from '../service';

/**
* 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>}
*/
async createJWT(userId: string, sessionId?: string, duration?: number): Promise<Models.Jwt> {
if (typeof userId === 'undefined') {
throw new AppwriteException('Missing required parameter: "userId"');
}
const apiPath = '/users/{userId}/jwts'.replace('{userId}', userId);
const payload: Payload = {};
if (typeof sessionId !== 'undefined') {
payload['sessionId'] = sessionId;
}
if (typeof duration !== 'undefined') {
payload['duration'] = duration;
}
const uri = new URL(this.client.config.endpoint + apiPath);
const apiHeaders: { [header: string]: string } = {
'content-type': 'application/json',
}
return await this.client.call(
'post',
uri,
apiHeaders,
payload
);
}
/**
* Update user labels

@@ -694,0 +731,0 @@ *

@@ -151,2 +151,38 @@ import { Service } from '../service';

/**
* 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

@@ -153,0 +189,0 @@ *

@@ -6,3 +6,5 @@ export declare enum EmailTemplateType {

Invitation = "invitation",
Mfachallenge = "mfachallenge"
Mfachallenge = "mfachallenge",
Sessionalert = "sessionalert",
Otpsession = "otpsession"
}

@@ -14,3 +14,5 @@ export declare enum PlatformType {

Android = "android",
Unity = "unity"
Unity = "unity",
Reactnativeios = "react-native-ios",
Reactnativeandroid = "react-native-android"
}

@@ -46,3 +46,4 @@ export declare enum Runtime {

Cpp20 = "cpp-20",
Bun10 = "bun-1.0"
Bun10 = "bun-1.0",
Go123 = "go-1.23"
}
/**
* Appwrite Console SDK
*
* This SDK is compatible with Appwrite server version 1.5.x.
* This SDK is compatible with Appwrite server version 1.6.x.
* For older versions, please check

@@ -11,3 +11,2 @@ * [previous releases](https://github.com/appwrite/sdk-for-console/releases).

export { Avatars } from './services/avatars';
export { Backups } from './services/backups';
export { Assistant } from './services/assistant';

@@ -22,3 +21,2 @@ export { Console } from './services/console';

export { Migrations } from './services/migrations';
export { Organizations } from './services/organizations';
export { Project } from './services/project';

@@ -51,3 +49,2 @@ export { Projects } from './services/projects';

export { SmtpEncryption } from './enums/smtp-encryption';
export { BillingPlan } from './enums/billing-plan';
export { ProjectUsageRange } from './enums/project-usage-range';

@@ -54,0 +51,0 @@ export { Region } from './enums/region';

@@ -41,20 +41,2 @@ import { Client } from '../client';

/**
* List billing addresses
*
*
* @param {string[]} queries
* @throws {AppwriteException}
* @returns {Promise<Models.BillingAddress>}
*/
listBillingAddresses(queries?: string[]): Promise<Models.BillingAddress>;
/**
* Get billing address
*
*
* @param {string} billingAddressId
* @throws {AppwriteException}
* @returns {Promise<Models.BillingAddress>}
*/
getBillingAddress(billingAddressId: string): Promise<Models.BillingAddress>;
/**
* Update email

@@ -93,11 +75,2 @@ *

/**
* List invoices
*
*
* @param {string[]} queries
* @throws {AppwriteException}
* @returns {Promise<Models.InvoiceList>}
*/
listInvoices(queries?: string[]): Promise<Models.InvoiceList>;
/**
* Create JWT

@@ -158,7 +131,6 @@ *

* @param {AuthenticatorType} type
* @param {string} otp
* @throws {AppwriteException}
* @returns {Promise<{}>}
*/
deleteMfaAuthenticator(type: AuthenticatorType, otp: string): Promise<{}>;
deleteMfaAuthenticator(type: AuthenticatorType): Promise<{}>;
/**

@@ -243,68 +215,2 @@ * Create MFA Challenge

/**
* List payment methods
*
*
* @param {string[]} queries
* @throws {AppwriteException}
* @returns {Promise<Models.PaymentMethodList>}
*/
listPaymentMethods(queries?: string[]): Promise<Models.PaymentMethodList>;
/**
* Create new payment method
*
*
* @throws {AppwriteException}
* @returns {Promise<Models.PaymentMethod>}
*/
createPaymentMethod(): Promise<Models.PaymentMethod>;
/**
* Get payment method
*
*
* @param {string} paymentMethodId
* @throws {AppwriteException}
* @returns {Promise<Models.PaymentMethod>}
*/
getPaymentMethod(paymentMethodId: string): Promise<Models.PaymentMethod>;
/**
* Update payment method
*
*
* @param {string} paymentMethodId
* @param {number} expiryMonth
* @param {number} expiryYear
* @throws {AppwriteException}
* @returns {Promise<Models.PaymentMethod>}
*/
updatePaymentMethod(paymentMethodId: string, expiryMonth: number, expiryYear: number): Promise<Models.PaymentMethod>;
/**
* Delete payment method
*
*
* @param {string} paymentMethodId
* @throws {AppwriteException}
* @returns {Promise<{}>}
*/
deletePaymentMethod(paymentMethodId: string): Promise<{}>;
/**
* Update payment method provider id
*
*
* @param {string} paymentMethodId
* @param {string} providerMethodId
* @param {string} name
* @throws {AppwriteException}
* @returns {Promise<Models.PaymentMethod>}
*/
updatePaymentMethodProvider(paymentMethodId: string, providerMethodId: string, name: string): Promise<Models.PaymentMethod>;
/**
* Update payment method with new setup with mandates for indian cards
*
*
* @param {string} paymentMethodId
* @throws {AppwriteException}
* @returns {Promise<Models.PaymentMethod>}
*/
updatePaymentMethodMandateOptions(paymentMethodId: string): Promise<Models.PaymentMethod>;
/**
* Update phone

@@ -628,12 +534,2 @@ *

updatePhoneVerification(userId: string, secret: string): Promise<Models.Token>;
/**
* List credits
*
*
* @param {string} organizationId
* @param {string[]} queries
* @throws {AppwriteException}
* @returns {Promise<Models.CreditList>}
*/
listCredits(organizationId: string, queries?: string[]): Promise<Models.CreditList>;
}

@@ -7,40 +7,2 @@ import { Client } from '../client';

/**
* Get coupon details
*
*
* @param {string} couponId
* @throws {AppwriteException}
* @returns {Promise<Models.Coupon>}
*/
getCopon(couponId: string): Promise<Models.Coupon>;
/**
* Get plans
*
*
* @throws {AppwriteException}
* @returns {Promise<Models.BillingPlanList>}
*/
plans(): Promise<Models.BillingPlanList>;
/**
* Get Regions
*
*
* @throws {AppwriteException}
* @returns {Promise<Models.ConsoleRegionList>}
*/
regions(): Promise<Models.ConsoleRegionList>;
/**
* Create source
*
*
* @param {string} ref
* @param {string} referrer
* @param {string} utmSource
* @param {string} utmCampaign
* @param {string} utmMedium
* @throws {AppwriteException}
* @returns {Promise<{}>}
*/
createSource(ref?: string, referrer?: string, utmSource?: string, utmCampaign?: string, utmMedium?: string): Promise<{}>;
/**
* Get variables

@@ -47,0 +9,0 @@ *

@@ -177,6 +177,7 @@ import { Client } from '../client';

* @param {boolean} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeBoolean>}
*/
updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean>;
updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean, newKey?: string): Promise<Models.AttributeBoolean>;
/**

@@ -207,6 +208,7 @@ * Create datetime attribute

* @param {string} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeDatetime>}
*/
updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime>;
updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeDatetime>;
/**

@@ -239,6 +241,7 @@ * Create email attribute

* @param {string} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeEmail>}
*/
updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail>;
updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEmail>;
/**

@@ -273,6 +276,7 @@ * Create enum attribute

* @param {string} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeEnum>}
*/
updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum>;
updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeEnum>;
/**

@@ -309,6 +313,7 @@ * Create float attribute

* @param {number} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeFloat>}
*/
updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat>;
updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeFloat>;
/**

@@ -345,6 +350,7 @@ * Create integer attribute

* @param {number} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeInteger>}
*/
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger>;
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number, newKey?: string): Promise<Models.AttributeInteger>;
/**

@@ -377,6 +383,7 @@ * Create IP address attribute

* @param {string} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeIp>}
*/
updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp>;
updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeIp>;
/**

@@ -429,6 +436,8 @@ * Create relationship attribute

* @param {string} xdefault
* @param {number} size
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeString>}
*/
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString>;
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeString>;
/**

@@ -461,6 +470,7 @@ * Create URL attribute

* @param {string} xdefault
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeUrl>}
*/
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl>;
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeUrl>;
/**

@@ -500,6 +510,7 @@ * Get attribute

* @param {RelationMutate} onDelete
* @param {string} newKey
* @throws {AppwriteException}
* @returns {Promise<Models.AttributeRelationship>}
*/
updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
/**

@@ -506,0 +517,0 @@ * List documents

@@ -36,2 +36,3 @@ import { Client, UploadProgress } from '../client';

* @param {string} commands
* @param {string[]} scopes
* @param {string} installationId

@@ -45,7 +46,8 @@ * @param {string} providerRepositoryId

* @param {string} templateRootDirectory
* @param {string} templateBranch
* @param {string} templateVersion
* @param {string} specification
* @throws {AppwriteException}
* @returns {Promise<Models.Function>}
*/
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function>;
create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: string, specification?: string): Promise<Models.Function>;
/**

@@ -61,2 +63,35 @@ * List runtimes

/**
* List available function runtime specifications
*
* List allowed function specifications for this instance.
*
* @throws {AppwriteException}
* @returns {Promise<Models.SpecificationList>}
*/
listSpecifications(): Promise<Models.SpecificationList>;
/**
* List function templates
*
* List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
*
* @param {string[]} runtimes
* @param {string[]} useCases
* @param {number} limit
* @param {number} offset
* @throws {AppwriteException}
* @returns {Promise<Models.TemplateFunctionList>}
*/
listTemplates(runtimes?: string[], useCases?: string[], limit?: number, offset?: number): Promise<Models.TemplateFunctionList>;
/**
* Get function template
*
* Get a function template using ID. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.
*
* @param {string} templateId
* @throws {AppwriteException}
* @returns {Promise<Models.TemplateFunction>}
*/
getTemplate(templateId: string): Promise<Models.TemplateFunction>;
/**
* Get functions usage

@@ -96,2 +131,3 @@ *

* @param {string} commands
* @param {string[]} scopes
* @param {string} installationId

@@ -102,6 +138,7 @@ * @param {string} providerRepositoryId

* @param {string} providerRootDirectory
* @param {string} specification
* @throws {AppwriteException}
* @returns {Promise<Models.Function>}
*/
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
/**

@@ -181,5 +218,4 @@ * Delete function

/**
* Create build
* Rebuild deployment
*
* Create a new build for an Appwrite Function deployment. This endpoint can be used to retry a failed build.
*

@@ -192,4 +228,14 @@ * @param {string} functionId

*/
createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}>;
createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
/**
* Cancel deployment
*
*
* @param {string} functionId
* @param {string} deploymentId
* @throws {AppwriteException}
* @returns {Promise<Models.Build>}
*/
updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
/**
* Download deployment

@@ -204,3 +250,3 @@ *

*/
downloadDeployment(functionId: string, deploymentId: string): string;
getDeploymentDownload(functionId: string, deploymentId: string): string;
/**

@@ -229,6 +275,7 @@ * List executions

* @param {object} headers
* @param {string} scheduledAt
* @throws {AppwriteException}
* @returns {Promise<Models.Execution>}
*/
createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution>;
createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object, scheduledAt?: string): Promise<Models.Execution>;
/**

@@ -246,2 +293,14 @@ * Get execution

/**
* Delete execution
*
* Delete a function execution by its unique ID.
*
* @param {string} functionId
* @param {string} executionId
* @throws {AppwriteException}
* @returns {Promise<{}>}
*/
deleteExecution(functionId: string, executionId: string): Promise<{}>;
/**
* Get function usage

@@ -248,0 +307,0 @@ *

@@ -137,2 +137,12 @@ import { Client } from '../client';

/**
* 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

@@ -168,2 +178,12 @@ *

/**
* 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.

@@ -180,2 +200,13 @@ *

/**
* 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

@@ -362,3 +393,3 @@ *

/**
* Update Project Team
* Update project team
*

@@ -365,0 +396,0 @@ *

@@ -197,2 +197,14 @@ import { Client } from '../client';

/**
* 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

@@ -199,0 +211,0 @@ *

@@ -48,2 +48,13 @@ import { Client } from '../client';

/**
* 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

@@ -50,0 +61,0 @@ *

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is too big to display

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc