- Fix error handling in authentication

- Readme changes
- ObjectApi - change getSesionId signature

Author: gregra81

README.md

@@ -32,7 +32,7 @@ and 3-legged tokens for calling different Data Management endpoints.
 #### 2-Legged Token
 
 This type of token is given directly to the application.
-To get a 2-legged token run the following code:
+To get a 2-legged token run the following code.  Note that you need to replace `your-client-id` and `your-client-secret` with your [app](https://developer.autodesk.com/myapps)'s client ID and client secret.
 
 ``` JavaScript
 var ForgeSDK = require('forge-apis');
@@ -59,11 +59,15 @@ oAuth2TwoLegged.authenticate().then(function(credentials){
 ##### Generate an Authentication URL
 
 To ask for permissions from a user to retrieve an access token, you
-redirect the user to a consent page. Run this code to create a consent page URL:
+redirect the user to a consent page.
+
+Replace `your-client-id`, `your-client-secret`, and `your-redirect-url` with your [app](https://developer.autodesk.com/myapps)'s client ID, client secret, and redirect URL, and run the code to create a consent page URL.
+
+Note that the redirect URL must match the pattern of the callback URL field of the app’s registration in the My Apps section. The pattern may include wildcards after the hostname, allowing different redirect URL values to be specified in different parts of your app.
 
 ``` JavaScript
 var ForgeSDK = require('forge-apis');
-var CLIENT_ID = '' , CLIENT_SECRET = '', REDIRECT_URL = '';
+var CLIENT_ID = '<your-client-id>', CLIENT_SECRET = '<your-client-secret>', REDIRECT_URL = '<your-redirect-url>';
 
 // Initialize the 3-legged OAuth2 client, set specific scopes and optionally set the `autoRefresh` parameter to true
 // if you want the token to auto refresh
@@ -198,8 +202,8 @@ Class | Method | HTTP request | Description
 *ForgeSdk.ObjectsApi* | [**getObject**](docs/ObjectsApi.md#getObject) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName} | 
 *ForgeSdk.ObjectsApi* | [**getObjectDetails**](docs/ObjectsApi.md#getObjectDetails) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/details | 
 *ForgeSdk.ObjectsApi* | [**getObjects**](docs/ObjectsApi.md#getObjects) | **GET** /oss/v2/buckets/{bucketKey}/objects | 
-*ForgeSdk.ObjectsApi* | [**getSessionid**](docs/ObjectsApi.md#getSessionid) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId} | 
 *ForgeSdk.ObjectsApi* | [**getSignedResource**](docs/ObjectsApi.md#getSignedResource) | **GET** /oss/v2/signedresources/{id} | 
+*ForgeSdk.ObjectsApi* | [**getStatusBySessionId**](docs/ObjectsApi.md#getStatusBySessionId) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId} | 
 *ForgeSdk.ObjectsApi* | [**uploadChunk**](docs/ObjectsApi.md#uploadChunk) | **PUT** /oss/v2/buckets/{bucketKey}/objects/{objectName}/resumable | 
 *ForgeSdk.ObjectsApi* | [**uploadObject**](docs/ObjectsApi.md#uploadObject) | **PUT** /oss/v2/buckets/{bucketKey}/objects/{objectName} | 
 *ForgeSdk.ObjectsApi* | [**uploadSignedResource**](docs/ObjectsApi.md#uploadSignedResource) | **PUT** /oss/v2/signedresources/{id} | 

docs/DerivativesApi.md

@@ -39,7 +39,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
+ - **Content-Type**: application/x-www-form-urlencoded
  - **Accept**: application/vnd.api+json, application/json
 
 <a name="getDerivativeManifest"></a>

docs/MetadataObject.md

@@ -5,6 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **objectid** | **Integer** | Unique ID for the object | 
 **name** | **String** | Name of the object | 
-**objects** | **[String]** | Optional collection of “children” objects within the hierarchy | [optional] 
+**objects** | [**[MetadataObject]**](MetadataObject.md) | Optional collection of “children” objects within the hierarchy | [optional] 
 
 

docs/ObjectsApi.md

@@ -11,8 +11,8 @@ Method | HTTP request | Description
 [**getObject**](ObjectsApi.md#getObject) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName} | 
 [**getObjectDetails**](ObjectsApi.md#getObjectDetails) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/details | 
 [**getObjects**](ObjectsApi.md#getObjects) | **GET** /oss/v2/buckets/{bucketKey}/objects | 
-[**getSessionid**](ObjectsApi.md#getSessionid) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId} | 
 [**getSignedResource**](ObjectsApi.md#getSignedResource) | **GET** /oss/v2/signedresources/{id} | 
+[**getStatusBySessionId**](ObjectsApi.md#getStatusBySessionId) | **GET** /oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId} | 
 [**uploadChunk**](ObjectsApi.md#uploadChunk) | **PUT** /oss/v2/buckets/{bucketKey}/objects/{objectName}/resumable | 
 [**uploadObject**](ObjectsApi.md#uploadObject) | **PUT** /oss/v2/buckets/{bucketKey}/objects/{objectName} | 
 [**uploadSignedResource**](ObjectsApi.md#uploadSignedResource) | **PUT** /oss/v2/signedresources/{id} | 
@@ -226,25 +226,28 @@ Name | Type | Description  | Notes
  - **Content-Type**: application/json
  - **Accept**: application/vnd.api+json, application/json
 
-<a name="getSessionid"></a>
-# **getSessionid**
-> Result getSessionid(bucketKey, objectName, sessionId, oauth2client, credentials)
+<a name="getSignedResource"></a>
+# **getSignedResource**
+> Object getSignedResource(id, opts, oauth2client, credentials)
 
 
 
-This endpoint returns status information about a resumable upload.
+Download an object using a signed URL.
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **bucketKey** | **String**| URL-encoded bucket key | 
- **objectName** | **String**| URL-encoded object name | 
- **sessionId** | **String**| Unique identifier of a session of a file being uploaded | 
+ **id** | **String**| Id of signed resource | 
+ **range** | **String**| A range of bytes to download from the specified object. | [optional] 
+ **ifNoneMatch** | **String**| The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included. | [optional] 
+ **ifModifiedSince** | **Date**| If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body.  | [optional] 
+ **acceptEncoding** | **String**| When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used.  | [optional] 
+ **region** | **String**| The region where the bucket resides Acceptable values: &#x60;US&#x60;, &#x60;EMEA&#x60; Default is &#x60;US&#x60;  | [optional] [default to US]
 
 ### Return type
 
-[**Result**](Result.md)
+**Object**
 
 ### Authorization
 
@@ -253,30 +256,27 @@ Name | Type | Description  | Notes
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: application/vnd.api+json, application/json
+ - **Accept**: application/octet-stream
 
-<a name="getSignedResource"></a>
-# **getSignedResource**
-> Object getSignedResource(id, opts, oauth2client, credentials)
+<a name="getStatusBySessionId"></a>
+# **getStatusBySessionId**
+> getStatusBySessionId(bucketKey, objectName, sessionId, oauth2client, credentials)
 
 
 
-Download an object using a signed URL.
+This endpoint returns status information about a resumable upload.
 
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| Id of signed resource | 
- **range** | **String**| A range of bytes to download from the specified object. | [optional] 
- **ifNoneMatch** | **String**| The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included. | [optional] 
- **ifModifiedSince** | **Date**| If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body.  | [optional] 
- **acceptEncoding** | **String**| When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used.  | [optional] 
- **region** | **String**| The region where the bucket resides Acceptable values: &#x60;US&#x60;, &#x60;EMEA&#x60; Default is &#x60;US&#x60;  | [optional] [default to US]
+ **bucketKey** | **String**| URL-encoded bucket key | 
+ **objectName** | **String**| URL-encoded object name | 
+ **sessionId** | **String**| Unique identifier of a session of a file being uploaded | 
 
 ### Return type
 
-**Object**
+null (empty response body)
 
 ### Authorization
 
@@ -285,7 +285,7 @@ Name | Type | Description  | Notes
 ### HTTP request headers
 
  - **Content-Type**: application/json
- - **Accept**: application/octet-stream
+ - **Accept**: application/vnd.api+json, application/json
 
 <a name="uploadChunk"></a>
 # **uploadChunk**

docs/PostObjectSigned.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **signedUrl** | **String** | URL created for downloading the object | 
-**expiration** | **Date** | Value for expiration in minutes | 
+**expiration** | **Integer** | Value for expiration in minutes | 
 
 

src/api/DerivativesApi.js

@@ -79,7 +79,7 @@ module.exports = (function() {
       var formParams = {
       };
 
-      var contentTypes = [];
+      var contentTypes = ['application/x-www-form-urlencoded'];
       var accepts = ['application/vnd.api+json', 'application/json'];
       var returnType = Result;
 

src/api/ObjectsApi.js

@@ -398,101 +398,100 @@ module.exports = (function() {
 
 
     /**
-     * This endpoint returns status information about a resumable upload.
-     * @param {String} bucketKey URL-encoded bucket key
-     * @param {String} objectName URL-encoded object name
-     * @param {String} sessionId Unique identifier of a session of a file being uploaded
-     * data is of type: {module:model/Result}
+     * Download an object using a signed URL.
+     * @param {String} id Id of signed resource
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.range A range of bytes to download from the specified object.
+     * @param {String} opts.ifNoneMatch The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included.
+     * @param {Date} opts.ifModifiedSince If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body. 
+     * @param {String} opts.acceptEncoding When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used. 
+     * @param {module:model/String} opts.region The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`  (default to US)
+     * data is of type: {Object}
      * @param {Object} oauth2client oauth2client for the call
      * @param {Object} credentials credentials for the call
      */
-    this.getSessionid = function(bucketKey, objectName, sessionId, oauth2client, credentials) {
+    this.getSignedResource = function(id, opts, oauth2client, credentials) {
+      opts = opts || {};
       var postBody = null;
 
-      // verify the required parameter 'bucketKey' is set
-      if (bucketKey == undefined || bucketKey == null) {
-        return Promise.reject("Missing the required parameter 'bucketKey' when calling getSessionid");
-      }
-
-      // verify the required parameter 'objectName' is set
-      if (objectName == undefined || objectName == null) {
-        return Promise.reject("Missing the required parameter 'objectName' when calling getSessionid");
-      }
-
-      // verify the required parameter 'sessionId' is set
-      if (sessionId == undefined || sessionId == null) {
-        return Promise.reject("Missing the required parameter 'sessionId' when calling getSessionid");
+      // verify the required parameter 'id' is set
+      if (id == undefined || id == null) {
+        return Promise.reject("Missing the required parameter 'id' when calling getSignedResource");
       }
 
 
       var pathParams = {
-        'bucketKey': bucketKey,
-        'objectName': objectName,
-        'sessionId': sessionId
+        'id': id
       };
       var queryParams = {
+        'region': opts['region']
       };
       var headerParams = {
+        'Range': opts['range'],
+        'If-None-Match': opts['ifNoneMatch'],
+        'If-Modified-Since': opts['ifModifiedSince'],
+        'Accept-Encoding': opts['acceptEncoding']
       };
       var formParams = {
       };
 
       var contentTypes = ['application/json'];
-      var accepts = ['application/vnd.api+json', 'application/json'];
-      var returnType = Result;
+      var accepts = ['application/octet-stream'];
+      var returnType = Object;
 
       return this.apiClient.callApi(
-        '/oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId}', 'GET',
+        '/oss/v2/signedresources/{id}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
         contentTypes, accepts, returnType, oauth2client, credentials
       );
     };
 
 
     /**
-     * Download an object using a signed URL.
-     * @param {String} id Id of signed resource
-     * @param {Object} opts Optional parameters
-     * @param {String} opts.range A range of bytes to download from the specified object.
-     * @param {String} opts.ifNoneMatch The value of this header is compared to the ETAG of the object. If they match, the body will not be included in the response. Only the object information will be included.
-     * @param {Date} opts.ifModifiedSince If the requested object has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message body. 
-     * @param {String} opts.acceptEncoding When gzip is specified, a gzip compressed stream of the object’s bytes will be returned in the response. Cannot use “Accept-Encoding:gzip” with Range header containing an end byte range. End byte range will not be honored if “Accept-Encoding: gzip” header is used. 
-     * @param {module:model/String} opts.region The region where the bucket resides Acceptable values: `US`, `EMEA` Default is `US`  (default to US)
-     * data is of type: {Object}
+     * This endpoint returns status information about a resumable upload.
+     * @param {String} bucketKey URL-encoded bucket key
+     * @param {String} objectName URL-encoded object name
+     * @param {String} sessionId Unique identifier of a session of a file being uploaded
      * @param {Object} oauth2client oauth2client for the call
      * @param {Object} credentials credentials for the call
      */
-    this.getSignedResource = function(id, opts, oauth2client, credentials) {
-      opts = opts || {};
+    this.getStatusBySessionId = function(bucketKey, objectName, sessionId, oauth2client, credentials) {
       var postBody = null;
 
-      // verify the required parameter 'id' is set
-      if (id == undefined || id == null) {
-        return Promise.reject("Missing the required parameter 'id' when calling getSignedResource");
+      // verify the required parameter 'bucketKey' is set
+      if (bucketKey == undefined || bucketKey == null) {
+        return Promise.reject("Missing the required parameter 'bucketKey' when calling getStatusBySessionId");
+      }
+
+      // verify the required parameter 'objectName' is set
+      if (objectName == undefined || objectName == null) {
+        return Promise.reject("Missing the required parameter 'objectName' when calling getStatusBySessionId");
+      }
+
+      // verify the required parameter 'sessionId' is set
+      if (sessionId == undefined || sessionId == null) {
+        return Promise.reject("Missing the required parameter 'sessionId' when calling getStatusBySessionId");
       }
 
 
       var pathParams = {
-        'id': id
+        'bucketKey': bucketKey,
+        'objectName': objectName,
+        'sessionId': sessionId
       };
       var queryParams = {
-        'region': opts['region']
       };
       var headerParams = {
-        'Range': opts['range'],
-        'If-None-Match': opts['ifNoneMatch'],
-        'If-Modified-Since': opts['ifModifiedSince'],
-        'Accept-Encoding': opts['acceptEncoding']
       };
       var formParams = {
       };
 
       var contentTypes = ['application/json'];
-      var accepts = ['application/octet-stream'];
-      var returnType = Object;
+      var accepts = ['application/vnd.api+json', 'application/json'];
+      var returnType = null;
 
       return this.apiClient.callApi(
-        '/oss/v2/signedresources/{id}', 'GET',
+        '/oss/v2/buckets/{bucketKey}/objects/{objectName}/status/{sessionId}', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
         contentTypes, accepts, returnType, oauth2client, credentials
       );

src/auth/OAuth2ThreeLegged.js

@@ -25,7 +25,7 @@
 module.exports = (function () {
     'use strict';
 
-    var OAuth2 = require('./OAuth2');
+    var OAuth2 = require('./OAuth2'),
     var ApiClient = require('../ApiClient').instance;
 
     /**
@@ -123,6 +123,7 @@ module.exports = (function () {
                     reject(errResponse);
                 });
             } else {
+                ApiClient.debug('tokenUrl is not defined in the authentication object');
                 reject(new Error('tokenUrl is not defined in the authentication object'));
             }
         });
@@ -155,14 +156,15 @@ module.exports = (function () {
                                 {expires_at: new Date(Date.now() + response.expires_in * 1000)});
                             resolve(credentials);
                         } else {
+                            ApiClient.debug('refreshToken error', response);
                             reject(response);
                         }
                     }, function(errResponse){
                         ApiClient.debug('refreshToken error', errResponse);
                         reject(errResponse);
                     });
                 } else {
-                    ApiClient.debug('refreshToken error', errResponse);
+                    ApiClient.debug('No refresh token present');
                     reject(new Error('No refresh token present'));
                 }
             } else {

src/model/MetadataObject.js

@@ -25,7 +25,8 @@
 module.exports = (function() {
   'use strict';
 
-  var ApiClient = require('../ApiClient');
+  var ApiClient = require('../ApiClient'),
+      MetadataObject = require('./MetadataObject');
 
 
 
@@ -53,7 +54,7 @@ module.exports = (function() {
         obj['name'] = ApiClient.convertToType(data['name'], 'String');
       }
       if (data.hasOwnProperty('objects')) {
-        obj['objects'] = ApiClient.convertToType(data['objects'], ['String']);
+        obj['objects'] = ApiClient.convertToType(data['objects'], [MetadataObject]);
       }
     }
     return obj;
@@ -100,7 +101,7 @@ module.exports = (function() {
   exports.prototype['name'] = undefined;
   /**
    * Optional collection of “children” objects within the hierarchy
-   * @member {Array.<String>} objects
+   * @member {Array.<module:model/MetadataObject>} objects
    */
   exports.prototype['objects'] = undefined;