particle-api-js 9.4.0 → 10.0.0

package/lib/Particle.js

@@ -16,10 +16,6 @@ var _createClass2 = require('babel-runtime/helpers/createClass');
 
 var _createClass3 = _interopRequireDefault(_createClass2);
 
-var _superagentBinaryParser = require('./superagent-binary-parser');
-
-var _superagentBinaryParser2 = _interopRequireDefault(_superagentBinaryParser);
-
 var _Defaults = require('./Defaults');
 
 var _Defaults2 = _interopRequireDefault(_Defaults);
@@ -1185,16 +1181,14 @@ var Particle = function () {
 			    headers = _ref38.headers,
 			    context = _ref38.context;
 
-			var req = this.request({
+			return this.request({
 				uri: '/v1/binaries/' + binaryId,
 				method: 'get',
 				auth: auth,
 				headers: headers,
 				context: context,
-				raw: true
+				isBuffer: true
 			});
-
-			return this._provideFileData(req);
 		}
 
 		/**
@@ -2158,8 +2152,7 @@ var Particle = function () {
 			    headers = _ref70.headers,
 			    context = _ref70.context;
 
-			var req = this.request({ uri: uri, method: 'get', headers: headers, context: context, raw: true });
-			return this._provideFileData(req);
+			return this.request({ uri: uri, method: 'get', headers: headers, context: context, isBuffer: true });
 		}
 
 		/**
@@ -2449,30 +2442,13 @@ var Particle = function () {
 			    headers = _ref81.headers,
 			    context = _ref81.context;
 
-			var req = this.request({
+			return this.request({
 				uri: '/v1/products/' + product + '/firmware/' + version + '/binary',
 				method: 'get',
 				auth: auth,
 				headers: headers,
 				context: context,
-				raw: true
-			});
-
-			return this._provideFileData(req);
-		}
-	}, {
-		key: '_provideFileData',
-		value: function _provideFileData(req) {
-			if (this.agent.isForBrowser()) {
-				req = req.responseType('arraybuffer').then(function (res) {
-					res.body = res.xhr.response;
-					return res;
-				});
-			} else {
-				req = req.buffer(true).parse(_superagentBinaryParser2.default);
-			}
-			return req.then(function (res) {
-				return res.body;
+				isBuffer: true
 			});
 		}
 
@@ -3102,6 +3078,541 @@ var Particle = function () {
 			});
 		}
 
+		/**
+   * Creates a new logic block in the specified organization using the provided block data.
+   *
+   * When you create a logic block with PubSub matchers, events will immediately
+   * start being handled by the block code.
+   *
+   * When you create a Chron matcher, it will immediately be scheduled at the next time
+   * according to the cron and start_at properties.
+   *
+   * @param {Object} options         The options for creating the logic block.
+   * @param {Object} options.auth    Access token
+   * @param {string} options.org     The name of the organization.
+   * @param {Block}  options.block   The block object containing the block details.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {block: ResponseBlock}, statusCode: int}>} A promise that resolves to the created logic block data.
+   */
+
+	}, {
+		key: 'createLogicBlock',
+		value: function createLogicBlock(_ref103) {
+			var auth = _ref103.auth,
+			    org = _ref103.org,
+			    block = _ref103.block,
+			    headers = _ref103.headers,
+			    context = _ref103.context;
+
+			return this.post({
+				uri: '/v1/orgs/' + org + '/blocks',
+				auth: auth,
+				data: { block: block },
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Get a logic block in the specified organization by block ID.
+   *
+   * @param {Object} options         The options for the logic block.
+   * @param {Object} options.auth    Access token
+   * @param {string} options.org     The name of the organization.
+   * @param {Block}  options.blockId The ID of the block to retrieve.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {block: ResponseBlock}, statusCode: int}>} A promise that resolves to the specified logic block data.
+   */
+
+	}, {
+		key: 'getLogicBlock',
+		value: function getLogicBlock(_ref104) {
+			var auth = _ref104.auth,
+			    org = _ref104.org,
+			    blockId = _ref104.blockId,
+			    headers = _ref104.headers,
+			    context = _ref104.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/blocks/' + blockId,
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Updates an existing logic block in the specified organization using the provided block data.
+   *
+   * If you include an id on a matcher, it will update the matcher in place.
+   *
+   * @param {Object} options          The options for updating the logic block.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {string} options.blockId  The ID of the block to update.
+   * @param {Block} options.block     The block object containing the block details.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: {block: ResponseBlock}, statusCode: int}>} A promise that resolves to the updated logic block data.
+   */
+
+	}, {
+		key: 'updateLogicBlock',
+		value: function updateLogicBlock(_ref105) {
+			var auth = _ref105.auth,
+			    org = _ref105.org,
+			    blockId = _ref105.blockId,
+			    block = _ref105.block,
+			    headers = _ref105.headers,
+			    context = _ref105.context;
+
+			return this.put({
+				uri: '/v1/orgs/' + org + '/blocks/' + blockId,
+				auth: auth,
+				data: { block: block },
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Deletes a logic block in the specified organization by block ID.
+   *
+   * @param {Object} options          The options for deleting the logic block.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {string} options.blockId  The ID of the block to delete.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: {block_id: int}, statusCode: int}>} A promise that resolves to an object containing the deleted block ID.
+   */
+
+	}, {
+		key: 'deleteLogicBlock',
+		value: function deleteLogicBlock(_ref106) {
+			var auth = _ref106.auth,
+			    org = _ref106.org,
+			    blockId = _ref106.blockId,
+			    headers = _ref106.headers,
+			    context = _ref106.context;
+
+			return this.delete({
+				uri: '/v1/orgs/' + org + '/blocks/' + blockId,
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Lists all logic blocks in the specified organization.
+   *
+   * @param {Object} options          The options for listing logic blocks.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: {blocks: ResponseBlock[]}, statusCode: int}>} A promise that resolves to an array of logic block data.
+   */
+
+	}, {
+		key: 'listLogicBlocks',
+		value: function listLogicBlocks(_ref107) {
+			var auth = _ref107.auth,
+			    org = _ref107.org,
+			    headers = _ref107.headers,
+			    context = _ref107.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/blocks',
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Lists all block runs for the specified block.
+   *
+   * @param {Object} options          The options for the request.
+   * @param {Object} options.auth     Access token
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {number} options.blockId  The ID of the block for which to retrieve the block runs.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {block_runs: BlockRun[]}, statusCode: int}>} A promise that resolves to an array of block run data.
+   */
+
+	}, {
+		key: 'listBlockRuns',
+		value: function listBlockRuns(_ref108) {
+			var auth = _ref108.auth,
+			    org = _ref108.org,
+			    blockId = _ref108.blockId,
+			    headers = _ref108.headers,
+			    context = _ref108.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/blocks/' + blockId + '/runs',
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Retrieves a block run by its ID for the specified block.
+   *
+   * @param {Object} options          The options for the request.
+   * @param {Object} options.auth     Access token
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {number} options.blockId  The ID of the block for which to retrieve the block run.
+   * @param {number} options.runId    The ID of the block run to retrieve.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {block_run: BlockRun}, statusCode: int}>} A promise that resolves to an array of block run data for the specified block run ID.
+   */
+
+	}, {
+		key: 'getBlockRun',
+		value: function getBlockRun(_ref109) {
+			var auth = _ref109.auth,
+			    org = _ref109.org,
+			    blockId = _ref109.blockId,
+			    runId = _ref109.runId,
+			    headers = _ref109.headers,
+			    context = _ref109.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/blocks/' + blockId + '/runs/' + runId,
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Retrieves the logs for a block run by its ID for the specified block.
+   *
+   * @param {Object} options          The options for the request.
+   * @param {Object} options.auth     Access token
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {number} options.blockId  The ID of the block for which to retrieve the block run logs.
+   * @param {number} options.runId    The ID of the block run for which to retrieve the logs.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {block_run_log: BlockRunLog}, statusCode: int}>} A promise that resolves to the logs for the specified block run ID.
+   */
+
+	}, {
+		key: 'getBlockRunLog',
+		value: function getBlockRunLog(_ref110) {
+			var auth = _ref110.auth,
+			    org = _ref110.org,
+			    blockId = _ref110.blockId,
+			    runId = _ref110.runId,
+			    headers = _ref110.headers,
+			    context = _ref110.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/blocks/' + blockId + '/runs/' + runId + '/logs',
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Creates a new ledger definition in the specified organization.
+   *
+   * @param {Object} options         The options for creating the ledger definition.
+   * @param {Object} options.auth    Access token
+   * @param {string} options.org     The name of the organization.
+   * @param {Ledger}  options.definition   The ledger definition object.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {ledger: ResponseLedger}, statusCode: int}>} A promise that resolves to the created ledger definition data.
+   */
+
+	}, {
+		key: 'createLedger',
+		value: function createLedger(_ref111) {
+			var auth = _ref111.auth,
+			    org = _ref111.org,
+			    ledger = _ref111.ledger,
+			    headers = _ref111.headers,
+			    context = _ref111.context;
+
+			return this.post({
+				uri: '/v1/orgs/' + org + '/ledgers',
+				auth: auth,
+				data: { ledger: ledger },
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Get a ledger definition in the specified organization by ledger name.
+   *
+   * @param {Object} options         The options for the ledger definition.
+   * @param {Object} options.auth    Access token
+   * @param {string} options.org     The name of the organization.
+   * @param {string} options.ledgerName The ID of the ledger definition to retrieve.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {ledger: ResponseLedger}, statusCode: int}>} A promise that resolves to the specified ledger definition data.
+   */
+
+	}, {
+		key: 'getLedger',
+		value: function getLedger(_ref112) {
+			var auth = _ref112.auth,
+			    org = _ref112.org,
+			    ledgerName = _ref112.ledgerName,
+			    headers = _ref112.headers,
+			    context = _ref112.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/ledgers/' + ledgerName,
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Updates an existing ledger definition in the specified organization.
+   *
+   * @param {Object} options          The options for updating the ledger definition.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {string} options.ledgerName  Name of the ledger definition to update.
+   * @param {Ledger} options.ledger     The ledger definition object.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: {ledger: ResponseLedger}, statusCode: int}>} A promise that resolves to the updated ledger definition data.
+   */
+
+	}, {
+		key: 'updateLedger',
+		value: function updateLedger(_ref113) {
+			var auth = _ref113.auth,
+			    org = _ref113.org,
+			    ledgerName = _ref113.ledgerName,
+			    ledger = _ref113.ledger,
+			    headers = _ref113.headers,
+			    context = _ref113.context;
+
+			return this.put({
+				uri: '/v1/orgs/' + org + '/ledgers/' + ledgerName,
+				auth: auth,
+				data: { ledger: ledger },
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Archives a ledger definition in the specified organization by ledger name.
+   *
+   * @param {Object} options          The options for archiving the ledger definition.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {string} options.ledgerName  Name of the ledger definition to archive.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: undefined, statusCode: int}>} A promise that resolves to an object confirming the ledger definition was archived.
+   */
+
+	}, {
+		key: 'archiveLedger',
+		value: function archiveLedger(_ref114) {
+			var auth = _ref114.auth,
+			    org = _ref114.org,
+			    ledgerName = _ref114.ledgerName,
+			    headers = _ref114.headers,
+			    context = _ref114.context;
+
+			return this.delete({
+				uri: '/v1/orgs/' + org + '/ledgers/' + ledgerName,
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Lists all ledger definitions in the specified organization.
+   *
+   * @param {Object} options          The options for listing ledger definitions.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: {ledgers: ResponseLedger[]}, statusCode: int}>} A promise that resolves to an array of ledger definition data.
+   */
+
+	}, {
+		key: 'listLedgers',
+		value: function listLedgers(_ref115) {
+			var auth = _ref115.auth,
+			    org = _ref115.org,
+			    headers = _ref115.headers,
+			    context = _ref115.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/ledgers',
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Get ledger instance data.
+   *
+   * @param {Object} options         The options for the ledger instance.
+   * @param {Object} options.auth    Access token
+   * @param {string} options.org     The name of the organization.
+   * @param {string} options.ledgerName Ledger name.
+   * @param {string} options.scopeValue Scope value.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context
+   *
+   * @returns {Promise<{body: {instance: ResponseLedgerInstance}, statusCode: int}>} A promise that resolves to the specified ledger instance data.
+   */
+
+	}, {
+		key: 'getLedgerInstance',
+		value: function getLedgerInstance(_ref116) {
+			var auth = _ref116.auth,
+			    org = _ref116.org,
+			    ledgerName = _ref116.ledgerName,
+			    scopeValue = _ref116.scopeValue,
+			    headers = _ref116.headers,
+			    context = _ref116.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/ledgers/' + ledgerName + '/instances/' + scopeValue,
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Set ledger instance data.
+   *
+   * @param {Object} options          The options for updating the ledger instance.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {string} options.ledgerName Ledger name.
+   * @param {string} options.scopeValue Scope value.
+   * @param {LedgerInstance} options.instance     The ledger instance object.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: {instance: ResponseLedgerInstance}, statusCode: int}>} A promise that resolves to the updated ledger instance data.
+   */
+
+	}, {
+		key: 'setLedgerInstance',
+		value: function setLedgerInstance(_ref117) {
+			var auth = _ref117.auth,
+			    org = _ref117.org,
+			    ledgerName = _ref117.ledgerName,
+			    scopeValue = _ref117.scopeValue,
+			    data = _ref117.data,
+			    headers = _ref117.headers,
+			    context = _ref117.context;
+
+			return this.put({
+				uri: '/v1/orgs/' + org + '/ledgers/' + ledgerName + '/instances/' + scopeValue,
+				auth: auth,
+				data: { data: data },
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Delete a ledger instance in the specified organization by ledger name.
+   *
+   * @param {Object} options          The options for archiving the ledger instance.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {string} options.ledgerName  Name of the ledger instance to archive.
+   * @param {string} options.scopeValue Scope value.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: undefined, statusCode: int}>} A promise that resolves to an object confirming the ledger instance was deleted.
+   */
+
+	}, {
+		key: 'deleteLedgerInstance',
+		value: function deleteLedgerInstance(_ref118) {
+			var auth = _ref118.auth,
+			    org = _ref118.org,
+			    ledgerName = _ref118.ledgerName,
+			    scopeValue = _ref118.scopeValue,
+			    headers = _ref118.headers,
+			    context = _ref118.context;
+
+			return this.delete({
+				uri: '/v1/orgs/' + org + '/ledgers/' + ledgerName + '/instances/' + scopeValue,
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
+		/**
+   * Lists ledger instances.
+   *
+   * @param {Object} options          The options for listing ledger instances.
+   * @param {Object} options.auth     The authentication object with the API key.
+   * @param {string} options.org      The unique identifier of the organization.
+   * @param {string} options.ledgerName  Name of the ledger instance to archive.
+   * @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {Object} [options.context] Request context.
+   *
+   * @returns {Promise<{body: {instances: ResponseLedgerInstance[]}, statusCode: int}>} A promise that resolves to an array of ledger instance data.
+   */
+
+	}, {
+		key: 'listLedgerInstances',
+		value: function listLedgerInstances(_ref119) {
+			var auth = _ref119.auth,
+			    org = _ref119.org,
+			    ledgerName = _ref119.ledgerName,
+			    headers = _ref119.headers,
+			    context = _ref119.context;
+
+			return this.get({
+				uri: '/v1/orgs/' + org + '/ledgers/' + ledgerName + '/instances',
+				auth: auth,
+				headers: headers,
+				context: context
+			});
+		}
+
 		/**
    * Set default auth token that will be used in each method if `auth` is not provided
    * @param  {String} auth A Particle access token
@@ -3140,77 +3651,149 @@ var Particle = function () {
 
 	}, {
 		key: 'deviceUri',
-		value: function deviceUri(_ref103) {
-			var deviceId = _ref103.deviceId,
-			    product = _ref103.product;
+		value: function deviceUri(_ref120) {
+			var deviceId = _ref120.deviceId,
+			    product = _ref120.product;
 
 			return product ? '/v1/products/' + product + '/devices/' + deviceId : '/v1/devices/' + deviceId;
 		}
+
+		/**
+   * Make a GET request
+   * @param {string} uri		The URI to request
+   * @param {string} [auth]	Authorization token to use
+   * @param {object} [headers]	Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {string|object} [query] Key/VAlue pairs of query params or a correctly formatted string
+   * @param {object} [context[	The invocation context, describing the tool and project
+   * @returns {Promise<RequestResponse, RequestError>} A promise that resolves with either the requested data or an error object
+   */
+
 	}, {
 		key: 'get',
-		value: function get(_ref104) {
-			var uri = _ref104.uri,
-			    auth = _ref104.auth,
-			    headers = _ref104.headers,
-			    query = _ref104.query,
-			    context = _ref104.context;
+		value: function get(_ref121) {
+			var uri = _ref121.uri,
+			    auth = _ref121.auth,
+			    headers = _ref121.headers,
+			    query = _ref121.query,
+			    context = _ref121.context;
 
 			context = this._buildContext(context);
 			auth = this._getActiveAuthToken(auth);
 			return this.agent.get({ uri: uri, auth: auth, headers: headers, query: query, context: context });
 		}
+
+		/**
+   * Make a HEAD request
+   * @param {string} uri		The URI to request
+   * @param {string} [auth]	Authorization token to use
+   * @param {object} [headers]	Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {string|object} [query] Key/VAlue pairs of query params or a correctly formatted string
+   * @param {object} [context]	The invocation context, describing the tool and project
+   * @returns {Promise<RequestResponse, RequestError>} A promise that resolves with either the requested data or an error object
+   */
+
 	}, {
 		key: 'head',
-		value: function head(_ref105) {
-			var uri = _ref105.uri,
-			    auth = _ref105.auth,
-			    headers = _ref105.headers,
-			    query = _ref105.query,
-			    context = _ref105.context;
+		value: function head(_ref122) {
+			var uri = _ref122.uri,
+			    auth = _ref122.auth,
+			    headers = _ref122.headers,
+			    query = _ref122.query,
+			    context = _ref122.context;
 
 			context = this._buildContext(context);
 			auth = this._getActiveAuthToken(auth);
 			return this.agent.head({ uri: uri, auth: auth, headers: headers, query: query, context: context });
 		}
+
+		/**
+   * Make a POST request
+   * @param {string} uri		The URI to request
+   * @param {string} [auth]	Authorization token to use
+   * @param {object} [headers]	Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {string|object} [query] Key/VAlue pairs of query params or a correctly formatted string
+   * @param {object} [context]	The invocation context, describing the tool and project
+   * @returns {Promise<RequestResponse, RequestError>} A promise that resolves with either the requested data or an error object
+   */
+
 	}, {
 		key: 'post',
-		value: function post(_ref106) {
-			var uri = _ref106.uri,
-			    auth = _ref106.auth,
-			    headers = _ref106.headers,
-			    data = _ref106.data,
-			    context = _ref106.context;
+		value: function post(_ref123) {
+			var uri = _ref123.uri,
+			    auth = _ref123.auth,
+			    headers = _ref123.headers,
+			    data = _ref123.data,
+			    context = _ref123.context;
 
 			context = this._buildContext(context);
 			auth = this._getActiveAuthToken(auth);
 			return this.agent.post({ uri: uri, auth: auth, headers: headers, data: data, context: context });
 		}
+
+		/**
+   * Make a PUT request
+   * @param {string} uri		The URI to request
+   * @param {string} [auth]	Authorization token to use
+   * @param {object} [headers]	Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {string|object} [query] Key/VAlue pairs of query params or a correctly formatted string
+   * @param {object} [context]	The invocation context, describing the tool and project
+   * @returns {Promise<RequestResponse, RequestError>} A promise that resolves with either the requested data or an error object
+   */
+
 	}, {
 		key: 'put',
-		value: function put(_ref107) {
-			var uri = _ref107.uri,
-			    auth = _ref107.auth,
-			    headers = _ref107.headers,
-			    data = _ref107.data,
-			    context = _ref107.context;
+		value: function put(_ref124) {
+			var uri = _ref124.uri,
+			    auth = _ref124.auth,
+			    headers = _ref124.headers,
+			    data = _ref124.data,
+			    context = _ref124.context;
 
 			context = this._buildContext(context);
 			auth = this._getActiveAuthToken(auth);
 			return this.agent.put({ uri: uri, auth: auth, headers: headers, data: data, context: context });
 		}
+
+		/**
+   * Make a DELETE request
+   * @param {string} uri		The URI to request
+   * @param {string} [auth]	Authorization token to use
+   * @param {object} [headers]	Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {string|object} [query] Key/VAlue pairs of query params or a correctly formatted string
+   * @param {object} [context]	The invocation context, describing the tool and project
+   * @returns {Promise<RequestResponse, RequestError>} A promise that resolves with either the requested data or an error object
+   */
+
 	}, {
 		key: 'delete',
-		value: function _delete(_ref108) {
-			var uri = _ref108.uri,
-			    auth = _ref108.auth,
-			    headers = _ref108.headers,
-			    data = _ref108.data,
-			    context = _ref108.context;
+		value: function _delete(_ref125) {
+			var uri = _ref125.uri,
+			    auth = _ref125.auth,
+			    headers = _ref125.headers,
+			    data = _ref125.data,
+			    context = _ref125.context;
 
 			context = this._buildContext(context);
 			auth = this._getActiveAuthToken(auth);
 			return this.agent.delete({ uri: uri, auth: auth, headers: headers, data: data, context: context });
 		}
+
+		/**
+   *
+   * @param {Object} args			An obj with all the possible request configurations
+   * @param {String} args.uri		The URI to request
+   * @param {String} args.method		The method used to request the URI, should be in uppercase.
+   * @param {Object} args.headers		Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+   * @param {String} args.data		Arbitrary data to send as the body.
+   * @param {Object} args.auth		Authorization
+   * @param {String|Object} args.query	Query parameters
+   * @param {Object} args.form		Form fields
+   * @param {Object} args.files		Array of file names and file content
+   * @param {Object} args.context		The invocation context, describing the tool and project.
+   * @param {boolean} args.isBuffer	Indicate if the response should be treated as Buffer instead of JSON
+   * @returns {Promise<RequestResponse, RequestError>} A promise that resolves with either the requested data or an error object
+   */
+
 	}, {
 		key: 'request',
 		value: function request(args) {