1
0
Fork 0
mirror of synced 2024-06-29 03:30:34 +12:00

Updated SDK examples

This commit is contained in:
eldadfux 2019-10-01 21:10:33 +03:00
parent e56f5e755c
commit 179fb9c39c
305 changed files with 658 additions and 783 deletions

View file

@ -8,18 +8,18 @@ class Auth extends Service {
/// Allow the user to login into his account by providing a valid email and
/// password combination. Use the success and failure arguments to provide a
/// redirect URL\'s back to your app when login is completed.
/// redirect URL\'s back to your app when login is completed.
///
/// Please notice that in order to avoid a [Redirect
/// Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
/// the only valid redirect URL's are the once from domains you have set when
/// the only valid redirect URL's are the once from domains you have set when
/// added your platforms in the console interface.
///
/// When not using the success or failure redirect arguments this endpoint will
/// result with a 200 status code and the user account object on success and
/// with 401 status error on failure. This behavior was applied to help the web
/// clients deal with browsers who don't allow to set 3rd party HTTP cookies
/// needed for saving the account session token.
/// When accessing this route using Javascript from the browser, success and
/// failure parameter URLs are required. Appwrite server will respond with a
/// 301 redirect status code and will set the user session cookie. This
/// behavior is enforced because modern browsers are limiting 3rd party cookies
/// in XHR of fetch requests to protect user privacy.
Future<Response> login({email, password, success, failure}) async {
String path = '/auth/login';
@ -54,16 +54,6 @@ class Auth extends Service {
return await this.client.call('delete', path: path, params: params);
}
Future<Response> oauthCallback({projectId, provider, code, state = null}) async {
String path = '/auth/oauth/callback/{provider}/{projectId}'.replaceAll(RegExp('{projectId}'), projectId).replaceAll(RegExp('{provider}'), provider);
Map<String, dynamic> params = {
'code': code,
'state': state,
};
return await this.client.call('get', path: path, params: params);
}
Future<Response> oauth({provider, success = null, failure = null}) async {
String path = '/auth/oauth/{provider}'.replaceAll(RegExp('{provider}'), provider);
@ -80,12 +70,12 @@ class Auth extends Service {
/// values attached to the URL query string. Use the query string params to
/// submit a request to the /auth/password/reset endpoint to complete the
/// process.
Future<Response> recovery({email, redirect}) async {
Future<Response> recovery({email, reset}) async {
String path = '/auth/recovery';
Map<String, dynamic> params = {
'email': email,
'redirect': redirect,
'reset': reset,
};
return await this.client.call('post', path: path, params: params);
@ -97,7 +87,7 @@ class Auth extends Service {
///
/// Please notice that in order to avoid a [Redirect
/// Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
/// the only valid redirect URL&#039;s are the once from domains you have set when
/// the only valid redirect URL's are the once from domains you have set when
/// added your platforms in the console interface.
Future<Response> recoveryReset({userId, token, passwordA, passwordB}) async {
String path = '/auth/recovery/reset';
@ -112,32 +102,32 @@ class Auth extends Service {
return await this.client.call('put', path: path, params: params);
}
/// Use this endpoint to allow a new user to register an account in your
/// project. Use the success and failure URL&#039;s to redirect users back to your
/// project. Use the success and failure URL's to redirect users back to your
/// application after signup completes.
///
/// If registration completes successfully user will be sent with a
/// confirmation email in order to confirm he is the owner of the account email
/// address. Use the redirect parameter to redirect the user from the
/// address. Use the confirmation parameter to redirect the user from the
/// confirmation email back to your app. When the user is redirected, use the
/// /auth/confirm endpoint to complete the account confirmation.
///
/// Please notice that in order to avoid a [Redirect
/// Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
/// the only valid redirect URL&#039;s are the once from domains you have set when
/// the only valid redirect URL's are the once from domains you have set when
/// added your platforms in the console interface.
///
/// When not using the success or failure redirect arguments this endpoint will
/// result with a 200 status code and the user account object on success and
/// with 401 status error on failure. This behavior was applied to help the web
/// clients deal with browsers who don&#039;t allow to set 3rd party HTTP cookies
/// needed for saving the account session token.
Future<Response> register({email, password, redirect, success, failure, name = null}) async {
/// When accessing this route using Javascript from the browser, success and
/// failure parameter URLs are required. Appwrite server will respond with a
/// 301 redirect status code and will set the user session cookie. This
/// behavior is enforced because modern browsers are limiting 3rd party cookies
/// in XHR of fetch requests to protect user privacy.
Future<Response> register({email, password, confirm, success = null, failure = null, name = null}) async {
String path = '/auth/register';
Map<String, dynamic> params = {
'email': email,
'password': password,
'redirect': redirect,
'confirm': confirm,
'success': success,
'failure': failure,
'name': name,
@ -165,13 +155,13 @@ class Auth extends Service {
///
/// Please notice that in order to avoid a [Redirect
/// Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
/// the only valid redirect URL&#039;s are the once from domains you have set when
/// the only valid redirect URL's are the once from domains you have set when
/// added your platforms in the console interface.
Future<Response> confirmResend({redirect}) async {
Future<Response> confirmResend({confirm}) async {
String path = '/auth/register/confirm/resend';
Map<String, dynamic> params = {
'redirect': redirect,
'confirm': confirm,
};
return await this.client.call('post', path: path, params: params);

View file

@ -70,7 +70,7 @@ class Storage extends Service {
return await this.client.call('delete', path: path, params: params);
}
/// Get file content by its unique ID. The endpoint response return with a
/// &#039;Content-Disposition: attachment&#039; header that tells the browser to start
/// 'Content-Disposition: attachment' header that tells the browser to start
/// downloading the file to user downloads directory.
Future<Response> getFileDownload({fileId}) async {
String path = '/storage/files/{fileId}/download'.replaceAll(RegExp('{fileId}'), fileId);
@ -98,7 +98,7 @@ class Storage extends Service {
return await this.client.call('get', path: path, params: params);
}
/// Get file content by its unique ID. This endpoint is similar to the download
/// method but returns with no &#039;Content-Disposition: attachment&#039; header.
/// method but returns with no 'Content-Disposition: attachment' header.
Future<Response> getFileView({fileId, as = null}) async {
String path = '/storage/files/{fileId}/view'.replaceAll(RegExp('{fileId}'), fileId);

View file

@ -78,7 +78,7 @@ class Teams extends Service {
}
/// Use this endpoint to invite a new member to your team. An email with a link
/// to join the team will be sent to the new member email address. If member
/// doesn&#039;t exists in the project it will be automatically created.
/// doesn't exists in the project it will be automatically created.
///
/// Use the redirect parameter to redirect the user from the invitation email
/// back to your app. When the user is redirected, use the
@ -87,7 +87,7 @@ class Teams extends Service {
///
/// Please notice that in order to avoid a [Redirect
/// Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
/// the only valid redirect URL&#039;s are the once from domains you have set when
/// the only valid redirect URL's are the once from domains you have set when
/// added your platforms in the console interface.
Future<Response> createTeamMembership({teamId, email, roles, redirect, name = null}) async {
String path = '/teams/{teamId}/memberships'.replaceAll(RegExp('{teamId}'), teamId);
@ -124,18 +124,18 @@ class Teams extends Service {
}
/// Use this endpoint to let user accept an invitation to join a team after he
/// is being redirect back to your app from the invitation email. Use the
/// success and failure URL&#039;s to redirect users back to your application after
/// success and failure URL's to redirect users back to your application after
/// the request completes.
///
/// Please notice that in order to avoid a [Redirect
/// Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
/// the only valid redirect URL&#039;s are the once from domains you have set when
/// the only valid redirect URL's are the once from domains you have set when
/// added your platforms in the console interface.
///
/// When not using the success or failure redirect arguments this endpoint will
/// result with a 200 status code on success and with 401 status error on
/// failure. This behavior was applied to help the web clients deal with
/// browsers who don&#039;t allow to set 3rd party HTTP cookies needed for saving
/// browsers who don't allow to set 3rd party HTTP cookies needed for saving
/// the account session token.
Future<Response> updateTeamMembershipStatus({teamId, inviteId, userId, secret, success = null, failure = null}) async {
String path = '/teams/{teamId}/memberships/{inviteId}/status'.replaceAll(RegExp('{teamId}'), teamId).replaceAll(RegExp('{inviteId}'), inviteId);

View file

@ -3,6 +3,8 @@
![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1)
![Version](https://img.shields.io/badge/api%20version-0.1.15-blue.svg?v=1)
This SDK if compitable with Appwrite server version 0.2.0 for older versions check previous releases.
Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.delete();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.getPrefs();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.getSecurity();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.getSessions();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.get();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.updateEmail('email@example.com', 'password');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.updateName('[NAME]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.updatePassword('password', 'password');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.account.updatePrefs('{}');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.confirmResend('https://example.com');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.login('email@example.com', 'password', 'https://example.com', 'https://example.com');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.logoutBySession('[ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.logout();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.oauth('bitbucket');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.recoveryReset('[USER_ID]', '[TOKEN]', 'password', 'password');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.recovery('email@example.com', 'https://example.com');

View file

@ -1,10 +1,10 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.auth.register('email@example.com', 'password', 'https://example.com', 'https://example.com', 'https://example.com');
let promise = sdk.auth.register('email@example.com', 'password', 'https://example.com');
promise.then(function (response) {
console.log(response);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.avatars.getBrowser('aa');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.avatars.getCreditCard('amex');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.avatars.getFavicon('https://example.com');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.avatars.getFlag('af');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.avatars.getImage('https://example.com');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.avatars.getQR('[TEXT]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.createCollection('[NAME]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.createDocument('[COLLECTION_ID]', '{}');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.deleteCollection('[COLLECTION_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.deleteDocument('[COLLECTION_ID]', '[DOCUMENT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.getCollection('[COLLECTION_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.getDocument('[COLLECTION_ID]', '[DOCUMENT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.listCollections();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.listDocuments('[COLLECTION_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.updateCollection('[COLLECTION_ID]', '[NAME]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.database.updateDocument('[COLLECTION_ID]', '[DOCUMENT_ID]', '{}');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.locale.getCountriesEU();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.locale.getCountriesPhones();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.locale.getCountries();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.locale.getCurrencies();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.locale.getLocale();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.createKey('[PROJECT_ID]', '[NAME]', []);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.createPlatform('[PROJECT_ID]', 'web', '[NAME]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.createProject('[NAME]', '[TEAM_ID]');

View file

@ -1,10 +1,10 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.createTask('[PROJECT_ID]', '[NAME]', 'play', '', 0, 'GET', 'https://example.com');
let promise = sdk.projects.createTask('[PROJECT_ID]', '[NAME]', 'play', '', 1, 'GET', 'https://example.com');
promise.then(function (response) {
console.log(response);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.createWebhook('[PROJECT_ID]', '[NAME]', [], '[URL]', 0);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.deleteKey('[PROJECT_ID]', '[KEY_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.deletePlatform('[PROJECT_ID]', '[PLATFORM_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.deleteProject('[PROJECT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.deleteTask('[PROJECT_ID]', '[TASK_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.deleteWebhook('[PROJECT_ID]', '[WEBHOOK_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.getKey('[PROJECT_ID]', '[KEY_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.getPlatform('[PROJECT_ID]', '[PLATFORM_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.getProjectUsage('[PROJECT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.getProject('[PROJECT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.getTask('[PROJECT_ID]', '[TASK_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.getWebhook('[PROJECT_ID]', '[WEBHOOK_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.listKeys('[PROJECT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.listPlatforms('[PROJECT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.listProjects();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.listTasks('[PROJECT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.listWebhooks('[PROJECT_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.updateKey('[PROJECT_ID]', '[KEY_ID]', '[NAME]', []);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.updatePlatform('[PROJECT_ID]', '[PLATFORM_ID]', '[NAME]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.updateProjectOAuth('[PROJECT_ID]', 'bitbucket');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.updateProject('[PROJECT_ID]', '[NAME]');

View file

@ -1,10 +1,10 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.updateTask('[PROJECT_ID]', '[TASK_ID]', '[NAME]', 'play', '', 0, 'GET', 'https://example.com');
let promise = sdk.projects.updateTask('[PROJECT_ID]', '[TASK_ID]', '[NAME]', 'play', '', 1, 'GET', 'https://example.com');
promise.then(function (response) {
console.log(response);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.projects.updateWebhook('[PROJECT_ID]', '[WEBHOOK_ID]', '[NAME]', [], '[URL]', 1);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.createFile(document.getElementById('uploader').files[0]);

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.deleteFile('[FILE_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.getFileDownload('[FILE_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.getFilePreview('[FILE_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.getFileView('[FILE_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.getFile('[FILE_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.listFiles();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.storage.updateFile('[FILE_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.createTeamMembershipResend('[TEAM_ID]', '[INVITE_ID]', 'https://example.com');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.createTeamMembership('[TEAM_ID]', 'email@example.com', [], 'https://example.com');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.createTeam('[NAME]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.deleteTeamMembership('[TEAM_ID]', '[INVITE_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.deleteTeam('[TEAM_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.getTeamMembers('[TEAM_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.getTeam('[TEAM_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.listTeams();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.updateTeamMembershipStatus('[TEAM_ID]', '[INVITE_ID]', '[USER_ID]', '[SECRET]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.teams.updateTeam('[TEAM_ID]', '[NAME]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.createUser('email@example.com', 'password');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.deleteUserSessions('[USER_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.deleteUsersSession('[USER_ID]', '[SESSION_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.getUserLogs('[USER_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.getUserPrefs('[USER_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.getUserSessions('[USER_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.getUser('[USER_ID]');

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.listUsers();

View file

@ -1,7 +1,7 @@
let sdk = new Appwrite();
sdk
setProject('')
.setProject('')
;
let promise = sdk.users.updateUserStatus('[USER_ID]', '1');

View file

@ -2,7 +2,7 @@
"name": "appwrite",
"homepage": "https://appwrite.io/support",
"description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)",
"version": "1.0.21",
"version": "1.0.22",
"license": "BSD-3-Clause",
"main": "src/sdk.js",
"repository": {

View file

@ -138,7 +138,7 @@
globalParams.push({key: key, value: value});
};
addGlobalHeader('x-sdk-version', 'appwrite:javascript:1.0.21');
addGlobalHeader('x-sdk-version', 'appwrite:javascript:1.0.22');
addGlobalHeader('content-type', '');
/**
@ -500,11 +500,11 @@
* the only valid redirect URL's are the once from domains you have set when
* added your platforms in the console interface.
*
* When not using the success or failure redirect arguments this endpoint will
* result with a 200 status code and the user account object on success and
* with 401 status error on failure. This behavior was applied to help the web
* clients deal with browsers who don't allow to set 3rd party HTTP cookies
* needed for saving the account session token.
* When accessing this route using Javascript from the browser, success and
* failure parameter URLs are required. Appwrite server will respond with a
* 301 redirect status code and will set the user session cookie. This
* behavior is enforced because modern browsers are limiting 3rd party cookies
* in XHR of fetch requests to protect user privacy.
*
* @param {string} email
* @param {string} password
@ -580,39 +580,6 @@
});
},
/**
* OAuth Callback
*
*
* @param {string} projectId
* @param {string} provider
* @param {string} code
* @param {string} state
* @throws {Error}
* @return {Promise} */
oauthCallback: function(projectId, provider, code, state = '') {
if(projectId === undefined) {
throw new Error('Missing required parameter: "projectId"');
}
if(provider === undefined) {
throw new Error('Missing required parameter: "provider"');
}
if(code === undefined) {
throw new Error('Missing required parameter: "code"');
}
let path = '/auth/oauth/callback/{provider}/{projectId}'.replace(new RegExp('{projectId}', 'g'), projectId).replace(new RegExp('{provider}', 'g'), provider);
return http
.get(path, {'content-type': 'application/json'},
{
'code': code,
'state': state
});
},
/**
* OAuth Login
*
@ -648,16 +615,16 @@
* process.
*
* @param {string} email
* @param {string} redirect
* @param {string} reset
* @throws {Error}
* @return {Promise} */
recovery: function(email, redirect) {
recovery: function(email, reset) {
if(email === undefined) {
throw new Error('Missing required parameter: "email"');
}
if(redirect === undefined) {
throw new Error('Missing required parameter: "redirect"');
if(reset === undefined) {
throw new Error('Missing required parameter: "reset"');
}
let path = '/auth/recovery';
@ -666,7 +633,7 @@
.post(path, {'content-type': 'application/json'},
{
'email': email,
'redirect': redirect
'reset': reset
});
},
@ -727,7 +694,7 @@
*
* If registration completes successfully user will be sent with a
* confirmation email in order to confirm he is the owner of the account email
* address. Use the redirect parameter to redirect the user from the
* address. Use the confirmation parameter to redirect the user from the
* confirmation email back to your app. When the user is redirected, use the
* /auth/confirm endpoint to complete the account confirmation.
*
@ -736,21 +703,21 @@
* the only valid redirect URL's are the once from domains you have set when
* added your platforms in the console interface.
*
* When not using the success or failure redirect arguments this endpoint will
* result with a 200 status code and the user account object on success and
* with 401 status error on failure. This behavior was applied to help the web
* clients deal with browsers who don't allow to set 3rd party HTTP cookies
* needed for saving the account session token.
* When accessing this route using Javascript from the browser, success and
* failure parameter URLs are required. Appwrite server will respond with a
* 301 redirect status code and will set the user session cookie. This
* behavior is enforced because modern browsers are limiting 3rd party cookies
* in XHR of fetch requests to protect user privacy.
*
* @param {string} email
* @param {string} password
* @param {string} redirect
* @param {string} confirm
* @param {string} success
* @param {string} failure
* @param {string} name
* @throws {Error}
* @return {null} */
register: function(email, password, redirect, success, failure, name = '') {
register: function(email, password, confirm, success = '', failure = '', name = '') {
if(email === undefined) {
throw new Error('Missing required parameter: "email"');
}
@ -759,16 +726,8 @@
throw new Error('Missing required parameter: "password"');
}
if(redirect === undefined) {
throw new Error('Missing required parameter: "redirect"');
}
if(success === undefined) {
throw new Error('Missing required parameter: "success"');
}
if(failure === undefined) {
throw new Error('Missing required parameter: "failure"');
if(confirm === undefined) {
throw new Error('Missing required parameter: "confirm"');
}
let path = '/auth/register';
@ -776,7 +735,7 @@
return iframe('post', path, {project: config.project,
'email': email,
'password': password,
'redirect': redirect,
'confirm': confirm,
'success': success,
'failure': failure,
'name': name
@ -826,12 +785,12 @@
* the only valid redirect URL's are the once from domains you have set when
* added your platforms in the console interface.
*
* @param {string} redirect
* @param {string} confirm
* @throws {Error}
* @return {Promise} */
confirmResend: function(redirect) {
if(redirect === undefined) {
throw new Error('Missing required parameter: "redirect"');
confirmResend: function(confirm) {
if(confirm === undefined) {
throw new Error('Missing required parameter: "confirm"');
}
let path = '/auth/register/confirm/resend';
@ -839,7 +798,7 @@
return http
.post(path, {'content-type': 'application/json'},
{
'redirect': redirect
'confirm': confirm
});
}
};

View file

@ -1,5 +1,5 @@
(function(window){window.Appwrite=function(){let config={endpoint:'https://appwrite.test/v1',project:'',key:'',locale:'',mode:'',};let setEndpoint=function(endpoint){config.endpoint=endpoint;return this};let setProject=function(value){http.addGlobalHeader('X-Appwrite-Project',value);config.project=value;return this};let setKey=function(value){http.addGlobalHeader('X-Appwrite-Key',value);config.key=value;return this};let setLocale=function(value){http.addGlobalHeader('X-Appwrite-Locale',value);config.locale=value;return this};let setMode=function(value){http.addGlobalHeader('X-Appwrite-Mode',value);config.mode=value;return this};let http=function(document){let globalParams=[],globalHeaders=[];let addParam=function(url,param,value){let a=document.createElement('a'),regex=/(?:\?|&amp;|&)+([^=]+)(?:=([^&]*))*/g;let match,str=[];a.href=url;param=encodeURIComponent(param);while(match=regex.exec(a.search))if(param!==match[1])str.push(match[1]+(match[2]?"="+match[2]:""));str.push(param+(value?"="+encodeURIComponent(value):""));a.search=str.join("&");return a.href};let buildQuery=function(params){let str=[];for(let p in params){if(Array.isArray(params[p])){for(let index=0;index<params[p].length;index++){let param=params[p][index];str.push(encodeURIComponent(p+'[]')+"="+encodeURIComponent(param))}}else{str.push(encodeURIComponent(p)+"="+encodeURIComponent(params[p]))}}
return str.join("&")};let addGlobalHeader=function(key,value){globalHeaders[key]={key:key.toLowerCase(),value:value.toLowerCase()}};let addGlobalParam=function(key,value){globalParams.push({key:key,value:value})};addGlobalHeader('x-sdk-version','appwrite:javascript:1.0.21');addGlobalHeader('content-type','');let call=function(method,path,headers={},params={},progress=null){let i;path=config.endpoint+path;if(-1===['GET','POST','PUT','DELETE','TRACE','HEAD','OPTIONS','CONNECT','PATCH'].indexOf(method)){throw new Error('var method must contain a valid HTTP method name')}
return str.join("&")};let addGlobalHeader=function(key,value){globalHeaders[key]={key:key.toLowerCase(),value:value.toLowerCase()}};let addGlobalParam=function(key,value){globalParams.push({key:key,value:value})};addGlobalHeader('x-sdk-version','appwrite:javascript:1.0.22');addGlobalHeader('content-type','');let call=function(method,path,headers={},params={},progress=null){let i;path=config.endpoint+path;if(-1===['GET','POST','PUT','DELETE','TRACE','HEAD','OPTIONS','CONNECT','PATCH'].indexOf(method)){throw new Error('var method must contain a valid HTTP method name')}
if(typeof path!=='string'){throw new Error('var path must be of type string')}
if(typeof headers!=='object'){throw new Error('var headers must be of type object')}
for(i=0;i<globalParams.length;i++){path=addParam(path,globalParams[i].key,globalParams[i].value)}
@ -22,25 +22,20 @@ if(password===undefined){throw new Error('Missing required parameter: "password"
if(success===undefined){throw new Error('Missing required parameter: "success"')}
if(failure===undefined){throw new Error('Missing required parameter: "failure"')}
let path='/auth/login';return iframe('post',path,{project:config.project,'email':email,'password':password,'success':success,'failure':failure})},logout:function(){let path='/auth/logout';return http.delete(path,{'content-type':'application/json'},{})},logoutBySession:function(id){if(id===undefined){throw new Error('Missing required parameter: "id"')}
let path='/auth/logout/{id}'.replace(new RegExp('{id}','g'),id);return http.delete(path,{'content-type':'application/json'},{})},oauthCallback:function(projectId,provider,code,state=''){if(projectId===undefined){throw new Error('Missing required parameter: "projectId"')}
if(provider===undefined){throw new Error('Missing required parameter: "provider"')}
if(code===undefined){throw new Error('Missing required parameter: "code"')}
let path='/auth/oauth/callback/{provider}/{projectId}'.replace(new RegExp('{projectId}','g'),projectId).replace(new RegExp('{provider}','g'),provider);return http.get(path,{'content-type':'application/json'},{'code':code,'state':state})},oauth:function(provider,success='',failure=''){if(provider===undefined){throw new Error('Missing required parameter: "provider"')}
let path='/auth/oauth/{provider}'.replace(new RegExp('{provider}','g'),provider);return http.get(path,{'content-type':'application/json'},{'success':success,'failure':failure})},recovery:function(email,redirect){if(email===undefined){throw new Error('Missing required parameter: "email"')}
if(redirect===undefined){throw new Error('Missing required parameter: "redirect"')}
let path='/auth/recovery';return http.post(path,{'content-type':'application/json'},{'email':email,'redirect':redirect})},recoveryReset:function(userId,token,passwordA,passwordB){if(userId===undefined){throw new Error('Missing required parameter: "userId"')}
let path='/auth/logout/{id}'.replace(new RegExp('{id}','g'),id);return http.delete(path,{'content-type':'application/json'},{})},oauth:function(provider,success='',failure=''){if(provider===undefined){throw new Error('Missing required parameter: "provider"')}
let path='/auth/oauth/{provider}'.replace(new RegExp('{provider}','g'),provider);return http.get(path,{'content-type':'application/json'},{'success':success,'failure':failure})},recovery:function(email,reset){if(email===undefined){throw new Error('Missing required parameter: "email"')}
if(reset===undefined){throw new Error('Missing required parameter: "reset"')}
let path='/auth/recovery';return http.post(path,{'content-type':'application/json'},{'email':email,'reset':reset})},recoveryReset:function(userId,token,passwordA,passwordB){if(userId===undefined){throw new Error('Missing required parameter: "userId"')}
if(token===undefined){throw new Error('Missing required parameter: "token"')}
if(passwordA===undefined){throw new Error('Missing required parameter: "passwordA"')}
if(passwordB===undefined){throw new Error('Missing required parameter: "passwordB"')}
let path='/auth/recovery/reset';return http.put(path,{'content-type':'application/json'},{'userId':userId,'token':token,'password-a':passwordA,'password-b':passwordB})},register:function(email,password,redirect,success,failure,name=''){if(email===undefined){throw new Error('Missing required parameter: "email"')}
let path='/auth/recovery/reset';return http.put(path,{'content-type':'application/json'},{'userId':userId,'token':token,'password-a':passwordA,'password-b':passwordB})},register:function(email,password,confirm,success='',failure='',name=''){if(email===undefined){throw new Error('Missing required parameter: "email"')}
if(password===undefined){throw new Error('Missing required parameter: "password"')}
if(redirect===undefined){throw new Error('Missing required parameter: "redirect"')}
if(success===undefined){throw new Error('Missing required parameter: "success"')}
if(failure===undefined){throw new Error('Missing required parameter: "failure"')}
let path='/auth/register';return iframe('post',path,{project:config.project,'email':email,'password':password,'redirect':redirect,'success':success,'failure':failure,'name':name})},confirm:function(userId,token){if(userId===undefined){throw new Error('Missing required parameter: "userId"')}
if(confirm===undefined){throw new Error('Missing required parameter: "confirm"')}
let path='/auth/register';return iframe('post',path,{project:config.project,'email':email,'password':password,'confirm':confirm,'success':success,'failure':failure,'name':name})},confirm:function(userId,token){if(userId===undefined){throw new Error('Missing required parameter: "userId"')}
if(token===undefined){throw new Error('Missing required parameter: "token"')}
let path='/auth/register/confirm';return http.post(path,{'content-type':'application/json'},{'userId':userId,'token':token})},confirmResend:function(redirect){if(redirect===undefined){throw new Error('Missing required parameter: "redirect"')}
let path='/auth/register/confirm/resend';return http.post(path,{'content-type':'application/json'},{'redirect':redirect})}};let avatars={getBrowser:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')}
let path='/auth/register/confirm';return http.post(path,{'content-type':'application/json'},{'userId':userId,'token':token})},confirmResend:function(confirm){if(confirm===undefined){throw new Error('Missing required parameter: "confirm"')}
let path='/auth/register/confirm/resend';return http.post(path,{'content-type':'application/json'},{'confirm':confirm})}};let avatars={getBrowser:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')}
let path='/avatars/browsers/{code}'.replace(new RegExp('{code}','g'),code);return http.get(path,{'content-type':'application/json'},{'width':width,'height':height,'quality':quality})},getCreditCard:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')}
let path='/avatars/credit-cards/{code}'.replace(new RegExp('{code}','g'),code);return http.get(path,{'content-type':'application/json'},{'width':width,'height':height,'quality':quality})},getFavicon:function(url){if(url===undefined){throw new Error('Missing required parameter: "url"')}
let path='/avatars/favicon';return http.get(path,{'content-type':'application/json'},{'url':url})},getFlag:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')}

View file

@ -3,6 +3,8 @@
![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?v=1)
![Version](https://img.shields.io/badge/api%20version-0.1.15-blue.svg?v=1)
This SDK if compitable with Appwrite server version 0.2.0 for older versions check previous releases.
Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)

Some files were not shown because too many files have changed in this diff Show more