From 7fe827ee19f1e51f8ec6f6e5c8ba7bac8dd6e3cd Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Mon, 18 May 2020 08:55:27 +0300 Subject: [PATCH] Updated SDKs and docs --- .../docs/examples/avatars/get-credit-card.md | 9 +-- .../docs/examples/avatars/get-favicon.md | 9 +-- .../docs/examples/avatars/get-flag.md | 9 +-- .../docs/examples/avatars/get-image.md | 9 +-- .../docs/examples/avatars/get-q-r.md | 9 +-- .../client-flutter/lib/services/avatars.dart | 75 ++++++++++++------- app/sdks/client-web/README.md | 2 +- .../docs/examples/avatars/get-credit-card.md | 8 +- .../docs/examples/avatars/get-favicon.md | 8 +- .../docs/examples/avatars/get-flag.md | 8 +- .../docs/examples/avatars/get-image.md | 8 +- .../docs/examples/avatars/get-q-r.md | 8 +- app/sdks/client-web/src/sdk.js | 55 +++++++------- app/sdks/client-web/src/sdk.min.js | 10 +-- app/sdks/client-web/types/index.d.ts | 20 ++--- app/sdks/console-web/README.md | 2 +- .../docs/examples/avatars/get-credit-card.md | 8 +- .../docs/examples/avatars/get-favicon.md | 8 +- .../docs/examples/avatars/get-flag.md | 8 +- .../docs/examples/avatars/get-image.md | 8 +- .../docs/examples/avatars/get-q-r.md | 8 +- app/sdks/console-web/src/sdk.js | 65 +++++++++------- app/sdks/console-web/src/sdk.min.js | 10 +-- app/sdks/console-web/types/index.d.ts | 20 ++--- app/sdks/server-nodejs/README.md | 2 +- app/sdks/server-php/README.md | 2 +- app/sdks/server-python/README.md | 2 +- app/sdks/server-ruby/README.md | 2 +- 28 files changed, 186 insertions(+), 206 deletions(-) diff --git a/app/sdks/client-flutter/docs/examples/avatars/get-credit-card.md b/app/sdks/client-flutter/docs/examples/avatars/get-credit-card.md index caa57c877..76d8613c5 100644 --- a/app/sdks/client-flutter/docs/examples/avatars/get-credit-card.md +++ b/app/sdks/client-flutter/docs/examples/avatars/get-credit-card.md @@ -8,13 +8,8 @@ client .setProject('5df5acd0d48c2') // Your project ID ; -Future result = avatars.getCreditCard( +String result = avatars.getCreditCard( code: 'amex', ); -result - .then((response) { - print(response); - }).catchError((error) { - print(error); - }); \ No newline at end of file +print(result); // Resource URL string diff --git a/app/sdks/client-flutter/docs/examples/avatars/get-favicon.md b/app/sdks/client-flutter/docs/examples/avatars/get-favicon.md index 488bf3b35..00ea1e9c6 100644 --- a/app/sdks/client-flutter/docs/examples/avatars/get-favicon.md +++ b/app/sdks/client-flutter/docs/examples/avatars/get-favicon.md @@ -8,13 +8,8 @@ client .setProject('5df5acd0d48c2') // Your project ID ; -Future result = avatars.getFavicon( +String result = avatars.getFavicon( url: 'https://example.com', ); -result - .then((response) { - print(response); - }).catchError((error) { - print(error); - }); \ No newline at end of file +print(result); // Resource URL string diff --git a/app/sdks/client-flutter/docs/examples/avatars/get-flag.md b/app/sdks/client-flutter/docs/examples/avatars/get-flag.md index f401bae56..83d0ed3fb 100644 --- a/app/sdks/client-flutter/docs/examples/avatars/get-flag.md +++ b/app/sdks/client-flutter/docs/examples/avatars/get-flag.md @@ -8,13 +8,8 @@ client .setProject('5df5acd0d48c2') // Your project ID ; -Future result = avatars.getFlag( +String result = avatars.getFlag( code: 'af', ); -result - .then((response) { - print(response); - }).catchError((error) { - print(error); - }); \ No newline at end of file +print(result); // Resource URL string diff --git a/app/sdks/client-flutter/docs/examples/avatars/get-image.md b/app/sdks/client-flutter/docs/examples/avatars/get-image.md index d9bee4b20..1b0542df8 100644 --- a/app/sdks/client-flutter/docs/examples/avatars/get-image.md +++ b/app/sdks/client-flutter/docs/examples/avatars/get-image.md @@ -8,13 +8,8 @@ client .setProject('5df5acd0d48c2') // Your project ID ; -Future result = avatars.getImage( +String result = avatars.getImage( url: 'https://example.com', ); -result - .then((response) { - print(response); - }).catchError((error) { - print(error); - }); \ No newline at end of file +print(result); // Resource URL string diff --git a/app/sdks/client-flutter/docs/examples/avatars/get-q-r.md b/app/sdks/client-flutter/docs/examples/avatars/get-q-r.md index 9be7533e0..825bf00de 100644 --- a/app/sdks/client-flutter/docs/examples/avatars/get-q-r.md +++ b/app/sdks/client-flutter/docs/examples/avatars/get-q-r.md @@ -8,13 +8,8 @@ client .setProject('5df5acd0d48c2') // Your project ID ; -Future result = avatars.getQR( +String result = avatars.getQR( text: '[TEXT]', ); -result - .then((response) { - print(response); - }).catchError((error) { - print(error); - }); \ No newline at end of file +print(result); // Resource URL string diff --git a/app/sdks/client-flutter/lib/services/avatars.dart b/app/sdks/client-flutter/lib/services/avatars.dart index a85b66701..2ce6ed263 100644 --- a/app/sdks/client-flutter/lib/services/avatars.dart +++ b/app/sdks/client-flutter/lib/services/avatars.dart @@ -40,20 +40,25 @@ class Avatars extends Service { /// card provider you need. Use width, height and quality arguments to change /// the output settings. /// - Future getCreditCard({@required String code, int width = 100, int height = 100, int quality = 100}) { + String getCreditCard({@required String code, int width = 100, int height = 100, int quality = 100}) { final String path = '/avatars/credit-cards/{code}'.replaceAll(RegExp('{code}'), code); final Map params = { 'width': width, 'height': height, 'quality': quality, + 'project': client.config['project'], }; - final Map headers = { - 'content-type': 'application/json', - }; + Uri endpoint = Uri.parse(client.endPoint); + Uri url = new Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + path, + queryParameters:params, + ); - return client.call(HttpMethod.get, path: path, params: params, headers: headers); + return url.toString(); } /// Get Favicon @@ -61,18 +66,23 @@ class Avatars extends Service { /// Use this endpoint to fetch the favorite icon (AKA favicon) of a any remote /// website URL. /// - Future getFavicon({@required String url}) { + String getFavicon({@required String url}) { final String path = '/avatars/favicon'; final Map params = { 'url': url, + 'project': client.config['project'], }; - final Map headers = { - 'content-type': 'application/json', - }; + Uri endpoint = Uri.parse(client.endPoint); + Uri url = new Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + path, + queryParameters:params, + ); - return client.call(HttpMethod.get, path: path, params: params, headers: headers); + return url.toString(); } /// Get Country Flag @@ -81,20 +91,25 @@ class Avatars extends Service { /// users. The code argument receives the 2 letter country code. Use width, /// height and quality arguments to change the output settings. /// - Future getFlag({@required String code, int width = 100, int height = 100, int quality = 100}) { + String getFlag({@required String code, int width = 100, int height = 100, int quality = 100}) { final String path = '/avatars/flags/{code}'.replaceAll(RegExp('{code}'), code); final Map params = { 'width': width, 'height': height, 'quality': quality, + 'project': client.config['project'], }; - final Map headers = { - 'content-type': 'application/json', - }; + Uri endpoint = Uri.parse(client.endPoint); + Uri url = new Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + path, + queryParameters:params, + ); - return client.call(HttpMethod.get, path: path, params: params, headers: headers); + return url.toString(); } /// Get Image from URL @@ -104,20 +119,25 @@ class Avatars extends Service { /// remote images in your app or in case you want to make sure a 3rd party /// image is properly served using a TLS protocol. /// - Future getImage({@required String url, int width = 400, int height = 400}) { + String getImage({@required String url, int width = 400, int height = 400}) { final String path = '/avatars/image'; final Map params = { 'url': url, 'width': width, 'height': height, + 'project': client.config['project'], }; - final Map headers = { - 'content-type': 'application/json', - }; + Uri endpoint = Uri.parse(client.endPoint); + Uri url = new Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + path, + queryParameters:params, + ); - return client.call(HttpMethod.get, path: path, params: params, headers: headers); + return url.toString(); } /// Get QR Code @@ -125,7 +145,7 @@ class Avatars extends Service { /// Converts a given plain text to a QR code image. You can use the query /// parameters to change the size and style of the resulting image. /// - Future getQR({@required String text, int size = 400, int margin = 1, int download = 0}) { + String getQR({@required String text, int size = 400, int margin = 1, int download = 0}) { final String path = '/avatars/qr'; final Map params = { @@ -133,12 +153,17 @@ class Avatars extends Service { 'size': size, 'margin': margin, 'download': download, + 'project': client.config['project'], }; - final Map headers = { - 'content-type': 'application/json', - }; + Uri endpoint = Uri.parse(client.endPoint); + Uri url = new Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + path, + queryParameters:params, + ); - return client.call(HttpMethod.get, path: path, params: params, headers: headers); + return url.toString(); } } \ No newline at end of file diff --git a/app/sdks/client-web/README.md b/app/sdks/client-web/README.md index 901e03b0d..837c7d6bc 100644 --- a/app/sdks/client-web/README.md +++ b/app/sdks/client-web/README.md @@ -1,4 +1,4 @@ -# Appwrite SDK +# Appwrite Web SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1) ![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1) diff --git a/app/sdks/client-web/docs/examples/avatars/get-credit-card.md b/app/sdks/client-web/docs/examples/avatars/get-credit-card.md index 584f24d8a..7b1f980eb 100644 --- a/app/sdks/client-web/docs/examples/avatars/get-credit-card.md +++ b/app/sdks/client-web/docs/examples/avatars/get-credit-card.md @@ -4,10 +4,6 @@ sdk .setProject('5df5acd0d48c2') // Your project ID ; -let promise = sdk.avatars.getCreditCard('amex'); +let result = sdk.avatars.getCreditCard('amex'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/client-web/docs/examples/avatars/get-favicon.md b/app/sdks/client-web/docs/examples/avatars/get-favicon.md index 292a4f440..ce04d0bab 100644 --- a/app/sdks/client-web/docs/examples/avatars/get-favicon.md +++ b/app/sdks/client-web/docs/examples/avatars/get-favicon.md @@ -4,10 +4,6 @@ sdk .setProject('5df5acd0d48c2') // Your project ID ; -let promise = sdk.avatars.getFavicon('https://example.com'); +let result = sdk.avatars.getFavicon('https://example.com'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/client-web/docs/examples/avatars/get-flag.md b/app/sdks/client-web/docs/examples/avatars/get-flag.md index fc5e6ff64..71c3db876 100644 --- a/app/sdks/client-web/docs/examples/avatars/get-flag.md +++ b/app/sdks/client-web/docs/examples/avatars/get-flag.md @@ -4,10 +4,6 @@ sdk .setProject('5df5acd0d48c2') // Your project ID ; -let promise = sdk.avatars.getFlag('af'); +let result = sdk.avatars.getFlag('af'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/client-web/docs/examples/avatars/get-image.md b/app/sdks/client-web/docs/examples/avatars/get-image.md index 7f5468d4a..2c2b80a8e 100644 --- a/app/sdks/client-web/docs/examples/avatars/get-image.md +++ b/app/sdks/client-web/docs/examples/avatars/get-image.md @@ -4,10 +4,6 @@ sdk .setProject('5df5acd0d48c2') // Your project ID ; -let promise = sdk.avatars.getImage('https://example.com'); +let result = sdk.avatars.getImage('https://example.com'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/client-web/docs/examples/avatars/get-q-r.md b/app/sdks/client-web/docs/examples/avatars/get-q-r.md index 33ae75a2d..cbd0dc8c4 100644 --- a/app/sdks/client-web/docs/examples/avatars/get-q-r.md +++ b/app/sdks/client-web/docs/examples/avatars/get-q-r.md @@ -4,10 +4,6 @@ sdk .setProject('5df5acd0d48c2') // Your project ID ; -let promise = sdk.avatars.getQR('[TEXT]'); +let result = sdk.avatars.getQR('[TEXT]'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/client-web/src/sdk.js b/app/sdks/client-web/src/sdk.js index 62852fea6..f962eaf10 100644 --- a/app/sdks/client-web/src/sdk.js +++ b/app/sdks/client-web/src/sdk.js @@ -900,7 +900,7 @@ * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ getCreditCard: function(code, width = 100, height = 100, quality = 100) { if(code === undefined) { @@ -923,10 +923,11 @@ payload['quality'] = quality; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -937,7 +938,7 @@ * * @param {string} url * @throws {Error} - * @return {Promise} + * @return {string} */ getFavicon: function(url) { if(url === undefined) { @@ -952,10 +953,11 @@ payload['url'] = url; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -970,7 +972,7 @@ * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ getFlag: function(code, width = 100, height = 100, quality = 100) { if(code === undefined) { @@ -993,10 +995,11 @@ payload['quality'] = quality; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -1011,7 +1014,7 @@ * @param {number} width * @param {number} height * @throws {Error} - * @return {Promise} + * @return {string} */ getImage: function(url, width = 400, height = 400) { if(url === undefined) { @@ -1034,10 +1037,11 @@ payload['height'] = height; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -1051,7 +1055,7 @@ * @param {number} margin * @param {number} download * @throws {Error} - * @return {Promise} + * @return {string} */ getQR: function(text, size = 400, margin = 1, download = 0) { if(text === undefined) { @@ -1078,10 +1082,11 @@ payload['download'] = download; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); } }; diff --git a/app/sdks/client-web/src/sdk.min.js b/app/sdks/client-web/src/sdk.min.js index 3fa2a38b3..20feba31d 100644 --- a/app/sdks/client-web/src/sdk.min.js +++ b/app/sdks/client-web/src/sdk.min.js @@ -63,22 +63,22 @@ return http.get(path,{'content-type':'application/json',},payload)},getCreditCar let path='/avatars/credit-cards/{code}'.replace(new RegExp('{code}','g'),code);let payload={};if(width){payload.width=width} if(height){payload.height=height} if(quality){payload.quality=quality} -return http.get(path,{'content-type':'application/json',},payload)},getFavicon:function(url){if(url===undefined){throw new Error('Missing required parameter: "url"')} +payload.project=config.project;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getFavicon:function(url){if(url===undefined){throw new Error('Missing required parameter: "url"')} let path='/avatars/favicon';let payload={};if(url){payload.url=url} -return http.get(path,{'content-type':'application/json',},payload)},getFlag:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')} +payload.project=config.project;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getFlag:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')} let path='/avatars/flags/{code}'.replace(new RegExp('{code}','g'),code);let payload={};if(width){payload.width=width} if(height){payload.height=height} if(quality){payload.quality=quality} -return http.get(path,{'content-type':'application/json',},payload)},getImage:function(url,width=400,height=400){if(url===undefined){throw new Error('Missing required parameter: "url"')} +payload.project=config.project;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getImage:function(url,width=400,height=400){if(url===undefined){throw new Error('Missing required parameter: "url"')} let path='/avatars/image';let payload={};if(url){payload.url=url} if(width){payload.width=width} if(height){payload.height=height} -return http.get(path,{'content-type':'application/json',},payload)},getQR:function(text,size=400,margin=1,download=0){if(text===undefined){throw new Error('Missing required parameter: "text"')} +payload.project=config.project;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getQR:function(text,size=400,margin=1,download=0){if(text===undefined){throw new Error('Missing required parameter: "text"')} let path='/avatars/qr';let payload={};if(text){payload.text=text} if(size){payload.size=size} if(margin){payload.margin=margin} if(download){payload.download=download} -return http.get(path,{'content-type':'application/json',},payload)}};let database={listDocuments:function(collectionId,filters=[],offset=0,limit=50,orderField='$id',orderType='ASC',orderCast='string',search='',first=0,last=0){if(collectionId===undefined){throw new Error('Missing required parameter: "collectionId"')} +payload.project=config.project;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')}};let database={listDocuments:function(collectionId,filters=[],offset=0,limit=50,orderField='$id',orderType='ASC',orderCast='string',search='',first=0,last=0){if(collectionId===undefined){throw new Error('Missing required parameter: "collectionId"')} let path='/database/collections/{collectionId}/documents'.replace(new RegExp('{collectionId}','g'),collectionId);let payload={};if(filters){payload.filters=filters} if(offset){payload.offset=offset} if(limit){payload.limit=limit} diff --git a/app/sdks/client-web/types/index.d.ts b/app/sdks/client-web/types/index.d.ts index 638f15d2d..4b587e392 100644 --- a/app/sdks/client-web/types/index.d.ts +++ b/app/sdks/client-web/types/index.d.ts @@ -338,9 +338,9 @@ declare namespace Appwrite { * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ - getCreditCard(code: string, width: number, height: number, quality: number): Promise; + getCreditCard(code: string, width: number, height: number, quality: number): string; /** * Get Favicon @@ -350,9 +350,9 @@ declare namespace Appwrite { * * @param {string} url * @throws {Error} - * @return {Promise} + * @return {string} */ - getFavicon(url: string): Promise; + getFavicon(url: string): string; /** * Get Country Flag @@ -366,9 +366,9 @@ declare namespace Appwrite { * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ - getFlag(code: string, width: number, height: number, quality: number): Promise; + getFlag(code: string, width: number, height: number, quality: number): string; /** * Get Image from URL @@ -382,9 +382,9 @@ declare namespace Appwrite { * @param {number} width * @param {number} height * @throws {Error} - * @return {Promise} + * @return {string} */ - getImage(url: string, width: number, height: number): Promise; + getImage(url: string, width: number, height: number): string; /** * Get QR Code @@ -397,9 +397,9 @@ declare namespace Appwrite { * @param {number} margin * @param {number} download * @throws {Error} - * @return {Promise} + * @return {string} */ - getQR(text: string, size: number, margin: number, download: number): Promise; + getQR(text: string, size: number, margin: number, download: number): string; } diff --git a/app/sdks/console-web/README.md b/app/sdks/console-web/README.md index 12544deed..5c6508f0a 100644 --- a/app/sdks/console-web/README.md +++ b/app/sdks/console-web/README.md @@ -1,4 +1,4 @@ -# Appwrite SDK +# Appwrite Console SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?v=1) ![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1) diff --git a/app/sdks/console-web/docs/examples/avatars/get-credit-card.md b/app/sdks/console-web/docs/examples/avatars/get-credit-card.md index 45c87c783..3f701e379 100644 --- a/app/sdks/console-web/docs/examples/avatars/get-credit-card.md +++ b/app/sdks/console-web/docs/examples/avatars/get-credit-card.md @@ -5,10 +5,6 @@ sdk .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key ; -let promise = sdk.avatars.getCreditCard('amex'); +let result = sdk.avatars.getCreditCard('amex'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/console-web/docs/examples/avatars/get-favicon.md b/app/sdks/console-web/docs/examples/avatars/get-favicon.md index 2b8d94c4c..037ddb30a 100644 --- a/app/sdks/console-web/docs/examples/avatars/get-favicon.md +++ b/app/sdks/console-web/docs/examples/avatars/get-favicon.md @@ -5,10 +5,6 @@ sdk .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key ; -let promise = sdk.avatars.getFavicon('https://example.com'); +let result = sdk.avatars.getFavicon('https://example.com'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/console-web/docs/examples/avatars/get-flag.md b/app/sdks/console-web/docs/examples/avatars/get-flag.md index a2723be67..630673ca0 100644 --- a/app/sdks/console-web/docs/examples/avatars/get-flag.md +++ b/app/sdks/console-web/docs/examples/avatars/get-flag.md @@ -5,10 +5,6 @@ sdk .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key ; -let promise = sdk.avatars.getFlag('af'); +let result = sdk.avatars.getFlag('af'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/console-web/docs/examples/avatars/get-image.md b/app/sdks/console-web/docs/examples/avatars/get-image.md index c9d6b6cf7..31994d6d8 100644 --- a/app/sdks/console-web/docs/examples/avatars/get-image.md +++ b/app/sdks/console-web/docs/examples/avatars/get-image.md @@ -5,10 +5,6 @@ sdk .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key ; -let promise = sdk.avatars.getImage('https://example.com'); +let result = sdk.avatars.getImage('https://example.com'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/console-web/docs/examples/avatars/get-q-r.md b/app/sdks/console-web/docs/examples/avatars/get-q-r.md index 39938a47b..91a31bf7f 100644 --- a/app/sdks/console-web/docs/examples/avatars/get-q-r.md +++ b/app/sdks/console-web/docs/examples/avatars/get-q-r.md @@ -5,10 +5,6 @@ sdk .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key ; -let promise = sdk.avatars.getQR('[TEXT]'); +let result = sdk.avatars.getQR('[TEXT]'); -promise.then(function (response) { - console.log(response); // Success -}, function (error) { - console.log(error); // Failure -}); \ No newline at end of file +console.log(result); // Resource URL diff --git a/app/sdks/console-web/src/sdk.js b/app/sdks/console-web/src/sdk.js index deea4b7e3..a8b75c525 100644 --- a/app/sdks/console-web/src/sdk.js +++ b/app/sdks/console-web/src/sdk.js @@ -938,7 +938,7 @@ * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ getCreditCard: function(code, width = 100, height = 100, quality = 100) { if(code === undefined) { @@ -961,10 +961,13 @@ payload['quality'] = quality; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + payload['key'] = config.key; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -975,7 +978,7 @@ * * @param {string} url * @throws {Error} - * @return {Promise} + * @return {string} */ getFavicon: function(url) { if(url === undefined) { @@ -990,10 +993,13 @@ payload['url'] = url; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + payload['key'] = config.key; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -1008,7 +1014,7 @@ * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ getFlag: function(code, width = 100, height = 100, quality = 100) { if(code === undefined) { @@ -1031,10 +1037,13 @@ payload['quality'] = quality; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + payload['key'] = config.key; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -1049,7 +1058,7 @@ * @param {number} width * @param {number} height * @throws {Error} - * @return {Promise} + * @return {string} */ getImage: function(url, width = 400, height = 400) { if(url === undefined) { @@ -1072,10 +1081,13 @@ payload['height'] = height; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + payload['key'] = config.key; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); }, /** @@ -1089,7 +1101,7 @@ * @param {number} margin * @param {number} download * @throws {Error} - * @return {Promise} + * @return {string} */ getQR: function(text, size = 400, margin = 1, download = 0) { if(text === undefined) { @@ -1116,10 +1128,13 @@ payload['download'] = download; } - return http - .get(path, { - 'content-type': 'application/json', - }, payload); + payload['project'] = config.project; + + payload['key'] = config.key; + + let query = Object.keys(payload).map(key => key + '=' + encodeURIComponent(payload[key])).join('&'); + + return config.endpoint + path + ((query) ? '?' + query : ''); } }; diff --git a/app/sdks/console-web/src/sdk.min.js b/app/sdks/console-web/src/sdk.min.js index b75329efc..ed8a70b4a 100644 --- a/app/sdks/console-web/src/sdk.min.js +++ b/app/sdks/console-web/src/sdk.min.js @@ -63,22 +63,22 @@ return http.get(path,{'content-type':'application/json',},payload)},getCreditCar let path='/avatars/credit-cards/{code}'.replace(new RegExp('{code}','g'),code);let payload={};if(width){payload.width=width} if(height){payload.height=height} if(quality){payload.quality=quality} -return http.get(path,{'content-type':'application/json',},payload)},getFavicon:function(url){if(url===undefined){throw new Error('Missing required parameter: "url"')} +payload.project=config.project;payload.key=config.key;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getFavicon:function(url){if(url===undefined){throw new Error('Missing required parameter: "url"')} let path='/avatars/favicon';let payload={};if(url){payload.url=url} -return http.get(path,{'content-type':'application/json',},payload)},getFlag:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')} +payload.project=config.project;payload.key=config.key;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getFlag:function(code,width=100,height=100,quality=100){if(code===undefined){throw new Error('Missing required parameter: "code"')} let path='/avatars/flags/{code}'.replace(new RegExp('{code}','g'),code);let payload={};if(width){payload.width=width} if(height){payload.height=height} if(quality){payload.quality=quality} -return http.get(path,{'content-type':'application/json',},payload)},getImage:function(url,width=400,height=400){if(url===undefined){throw new Error('Missing required parameter: "url"')} +payload.project=config.project;payload.key=config.key;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getImage:function(url,width=400,height=400){if(url===undefined){throw new Error('Missing required parameter: "url"')} let path='/avatars/image';let payload={};if(url){payload.url=url} if(width){payload.width=width} if(height){payload.height=height} -return http.get(path,{'content-type':'application/json',},payload)},getQR:function(text,size=400,margin=1,download=0){if(text===undefined){throw new Error('Missing required parameter: "text"')} +payload.project=config.project;payload.key=config.key;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')},getQR:function(text,size=400,margin=1,download=0){if(text===undefined){throw new Error('Missing required parameter: "text"')} let path='/avatars/qr';let payload={};if(text){payload.text=text} if(size){payload.size=size} if(margin){payload.margin=margin} if(download){payload.download=download} -return http.get(path,{'content-type':'application/json',},payload)}};let database={listCollections:function(search='',limit=25,offset=0,orderType='ASC'){let path='/database/collections';let payload={};if(search){payload.search=search} +payload.project=config.project;payload.key=config.key;let query=Object.keys(payload).map(key=>key+'='+encodeURIComponent(payload[key])).join('&');return config.endpoint+path+((query)?'?'+query:'')}};let database={listCollections:function(search='',limit=25,offset=0,orderType='ASC'){let path='/database/collections';let payload={};if(search){payload.search=search} if(limit){payload.limit=limit} if(offset){payload.offset=offset} if(orderType){payload.orderType=orderType} diff --git a/app/sdks/console-web/types/index.d.ts b/app/sdks/console-web/types/index.d.ts index 853057902..5f62d42af 100644 --- a/app/sdks/console-web/types/index.d.ts +++ b/app/sdks/console-web/types/index.d.ts @@ -359,9 +359,9 @@ declare namespace Appwrite { * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ - getCreditCard(code: string, width: number, height: number, quality: number): Promise; + getCreditCard(code: string, width: number, height: number, quality: number): string; /** * Get Favicon @@ -371,9 +371,9 @@ declare namespace Appwrite { * * @param {string} url * @throws {Error} - * @return {Promise} + * @return {string} */ - getFavicon(url: string): Promise; + getFavicon(url: string): string; /** * Get Country Flag @@ -387,9 +387,9 @@ declare namespace Appwrite { * @param {number} height * @param {number} quality * @throws {Error} - * @return {Promise} + * @return {string} */ - getFlag(code: string, width: number, height: number, quality: number): Promise; + getFlag(code: string, width: number, height: number, quality: number): string; /** * Get Image from URL @@ -403,9 +403,9 @@ declare namespace Appwrite { * @param {number} width * @param {number} height * @throws {Error} - * @return {Promise} + * @return {string} */ - getImage(url: string, width: number, height: number): Promise; + getImage(url: string, width: number, height: number): string; /** * Get QR Code @@ -418,9 +418,9 @@ declare namespace Appwrite { * @param {number} margin * @param {number} download * @throws {Error} - * @return {Promise} + * @return {string} */ - getQR(text: string, size: number, margin: number, download: number): Promise; + getQR(text: string, size: number, margin: number, download: number): string; } diff --git a/app/sdks/server-nodejs/README.md b/app/sdks/server-nodejs/README.md index e1a0bb8c0..a6df1832a 100644 --- a/app/sdks/server-nodejs/README.md +++ b/app/sdks/server-nodejs/README.md @@ -1,4 +1,4 @@ -# Appwrite SDK +# Appwrite Node.js SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?v=1) ![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1) diff --git a/app/sdks/server-php/README.md b/app/sdks/server-php/README.md index 5631924b1..a66297ba5 100644 --- a/app/sdks/server-php/README.md +++ b/app/sdks/server-php/README.md @@ -1,4 +1,4 @@ -# Appwrite SDK +# Appwrite PHP SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-php.svg?v=1) ![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1) diff --git a/app/sdks/server-python/README.md b/app/sdks/server-python/README.md index 89e2e939f..546019dac 100644 --- a/app/sdks/server-python/README.md +++ b/app/sdks/server-python/README.md @@ -1,4 +1,4 @@ -# Appwrite SDK +# Appwrite Python SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-python.svg?v=1) ![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1) diff --git a/app/sdks/server-ruby/README.md b/app/sdks/server-ruby/README.md index d260a7d08..758a2dae7 100644 --- a/app/sdks/server-ruby/README.md +++ b/app/sdks/server-ruby/README.md @@ -1,4 +1,4 @@ -# Appwrite SDK +# Appwrite Ruby SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?v=1) ![Version](https://img.shields.io/badge/api%20version-0.6.0-blue.svg?v=1)