Merge pull request #3 from OpenSTFoundation/release-0.9.1

Release 0.9.1

Author: Kedar

LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018 OST.com Ltd.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE.txt

@@ -1,5 +1,5 @@
-# OST Javascript SDK
-The official [OST Javascript SDK](https://dev.ost.com/).
+# OST JavaScript SDK
+The official [OST JavaScript SDK](https://dev.ost.com/).
 
 ## Requirements
 
@@ -14,23 +14,24 @@ To use this node module, developers will need to:
 
 ## Installation
 
-Install OST Javascript SDK
+Install OST JavaScript SDK
 
 ```bash
-> npm install @ostdotcom/ost-sdk
+> npm install @ostdotcom/ost-sdk-js
 ```
 
 ## Example Usage
 
 Require the SDK:
 
 ```node.js
-const OSTSDK = require('@ostdotcom/ost-sdk');
+const OSTSDK = require('@ostdotcom/ost-sdk-js');
 ```
 
 Initialize the SDK object:
 
 ```node.js
+// the currently valid API endpoint is "https://playgroundapi.ost.com", this may change in the future
 const ostObj = new OSTSDK({apiKey: <api_key>, apiSecret: <api_secret>, apiEndpoint: <api_endpoint>});
 ```
 
@@ -45,39 +46,39 @@ const transactionKindService = ostObj.services.transactionKind;
 Create new transaction types:
 
 ```node.js
-transactionKindService.create({name: 'Like', kind: 'user_to_user', currency_type: 'usd', currency_value: '1.25', commission_percent: '12'}).then(console.log).catch(console.log);
+transactionKindService.create({name: 'Like', kind: 'user_to_user', currency_type: 'usd', currency_value: '1.25', commission_percent: '12'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 ```node.js
-transactionKindService.create({name: 'Grant', kind: 'company_to_user', currency_type: 'bt', currency_value: '12', commission_percent: '0'}).then(console.log).catch(console.log);
+transactionKindService.create({name: 'Grant', kind: 'company_to_user', currency_type: 'bt', currency_value: '12', commission_percent: '0'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 ```node.js
-transactionKindService.create({name: 'Buy', kind: 'user_to_company', currency_type: 'bt', currency_value: '100', commission_percent: '0'}).then(console.log).catch(console.log);
+transactionKindService.create({name: 'Buy', kind: 'user_to_company', currency_type: 'bt', currency_value: '100', commission_percent: '0'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 Get a list of existing transaction kinds and other data:
 
 ```node.js
-transactionKindService.list().then(console.log).catch(console.log);
+transactionKindService.list().then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 Edit an existing transaction kind:
 
 ```node.js
-transactionKindService.edit({client_transaction_id: '12', name: 'New Transaction Kind'}).then(console.log).catch(console.log);
+transactionKindService.edit({client_transaction_id: '12', name: 'New Transaction Kind'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 Execute a branded token transfer by transaction kind:
 
 ```node.js
-transactionKindService.execute({from_uuid: '1234-1928-1081dsds-djhksjd', to_uuid: '1234-1928-1081-1223232', transaction_kind: 'Purchase'}).then(console.log).catch(console.log);
+transactionKindService.execute({from_uuid: '1234-1928-1081dsds-djhksjd', to_uuid: '1234-1928-1081-1223232', transaction_kind: 'Purchase'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 Get the status of an executed transaction:
 
 ```node.js
-transactionKindService.status({transaction_uuids: ['5f79063f-e22a-4d28-99d7-dd095f02c72e']}).then(console.log).catch(console.log);
+transactionKindService.status({transaction_uuids: ['5f79063f-e22a-4d28-99d7-dd095f02c72e']}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 ### User Module
@@ -91,29 +92,29 @@ const userService = ostObj.services.user;
 Create a new user:
 
 ```node.js
-userService.create({name: 'Alice'}).then(console.log).catch(console.log);
+userService.create({name: 'Alice'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 Get a list of users and other data:
 
 ```node.js
-userService.list().then(console.log).catch(console.log);
+userService.list().then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 Edit an existing user:
 
 ```node.js
-userService.edit({uuid: '1234-1928-1081dsds-djhksjd', name: 'Bob'}).then(console.log).catch(console.log);
+userService.edit({uuid: '1234-1928-1081dsds-djhksjd', name: 'Bob'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 Airdrop branded tokens to users:
 
 ```node.js
-userService.airdropTokens({amount: 1, list_type: 'all'}).then(console.log).catch(console.log);
+userService.airdropTokens({amount: 1, list_type: 'all'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```
 
 As airdropping tokens is an asynchronous task, you can check the airdrop's status:
 
 ```node.js
-userService.airdropStatus({airdrop_uuid: 'd8303e01-5ce0-401f-8ae4-d6a0bcdb2e24'}).then(console.log).catch(console.log);
+userService.airdropStatus({airdrop_uuid: 'd8303e01-5ce0-401f-8ae4-d6a0bcdb2e24'}).then(function(res) { console.log(JSON.stringify(res)); }).catch(function(err) { console.log(JSON.stringify(err)); });
 ```

README.md

@@ -1 +1 @@
-0.0.1
+0.9.1

VERSION

@@ -1,6 +1,6 @@
 {
-  "name": "@ostdotcom/ost-sdk",
-  "version": "0.0.1-beta.1",
+  "name": "@ostdotcom/ost-sdk-js",
+  "version": "0.9.1",
   "description": "The official OST Javascript SDK",
   "main": "index.js",
   "scripts": {