add: createRequest function

Author: AleksandrRogov

lib/dynamics-web-api-callbacks.js

@@ -173,6 +173,51 @@ function DynamicsWebApi(config) {
         Request.makeRequest(method, request, functionName, _internalConfig, successCallback, errorCallback);
     };
 
+    /**
+     * Sends an asynchronous request to create a new record.
+     *
+     * @param {DWARequest} request - An object that represents all possible options for a current request.
+     * @param {Function} successCallback - The function that will be passed through and be called by a successful response.
+     * @param {Function} errorCallback - The function that will be passed through and be called by a failed response.
+     * @example
+        *var lead = {
+        *    subject: "Test WebAPI",
+        *    firstname: "Test",
+        *    lastname: "WebAPI",
+        *    jobtitle: "Title"
+        *};
+        *
+        *var request = {
+        *    entity: lead,
+        *    collection: "leads",
+        *    returnRepresentation: true
+        *}
+        *
+        *dynamicsWebApi.createRequest(request, function (response) {
+        *}, function (error) {
+        *});
+     */
+    this.createRequest = function (request, successCallback, errorCallback) {
+        ErrorHelper.parameterCheck(request, 'DynamicsWebApi.create', 'request');
+        ErrorHelper.callbackParameterCheck(successCallback, "DynamicsWebApi.create", "successCallback");
+        ErrorHelper.callbackParameterCheck(errorCallback, "DynamicsWebApi.create", "errorCallback");
+
+        var onSuccess = function (response) {
+            if (response.data) {
+                successCallback(response.data);
+            }
+            else {
+                var entityUrl = response.headers['OData-EntityId']
+                    ? response.headers['OData-EntityId']
+                    : response.headers['odata-entityid'];
+                var id = /[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}/i.exec(entityUrl)[0];
+                successCallback(id);
+            }
+        }
+
+        _makeRequest("POST", request, 'create', onSuccess, errorCallback);
+    };
+
     /**
      * Sends an asynchronous request to create a new record.
      *
@@ -198,8 +243,6 @@ function DynamicsWebApi(config) {
 
         ErrorHelper.parameterCheck(object, "DynamicsWebApi.create", "object");
         ErrorHelper.stringParameterCheck(collection, "DynamicsWebApi.create", "collection");
-        ErrorHelper.callbackParameterCheck(successCallback, "DynamicsWebApi.create", "successCallback");
-        ErrorHelper.callbackParameterCheck(errorCallback, "DynamicsWebApi.create", "errorCallback");
 
         if (prefer) {
             ErrorHelper.stringOrArrayParameterCheck(prefer, "DynamicsWebApi.create", "prefer");
@@ -216,22 +259,7 @@ function DynamicsWebApi(config) {
             entity: object
         };
 
-        var result = RequestConverter.convertRequest(request, "create", _internalConfig);
-
-        var onSuccess = function (response) {
-            if (response.data) {
-                successCallback(response.data);
-            }
-            else {
-                var entityUrl = response.headers['OData-EntityId']
-                    ? response.headers['OData-EntityId']
-                    : response.headers['odata-entityid'];
-                var id = /[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}/i.exec(entityUrl)[0];
-                successCallback(id);
-            }
-        }
-
-        _makeRequest("POST", request, 'create', onSuccess, errorCallback);
+        this.createRequest(request, successCallback, errorCallback);
     };
 
     /**

lib/dynamics-web-api.js

@@ -175,6 +175,46 @@ function DynamicsWebApi(config) {
         });
     };
 
+    /**
+     * Sends an asynchronous request to create a new record.
+     *
+     * @param {DWARequest} request - An object that represents all possible options for a current request.
+     * @returns {Promise}
+     * @example
+        *var lead = {
+        *    subject: "Test WebAPI",
+        *    firstname: "Test",
+        *    lastname: "WebAPI",
+        *    jobtitle: "Title"
+        *};
+        *
+        *var request = {
+        *    entity: lead,
+        *    collection: "leads",
+        *    returnRepresentation: true
+        *}
+        *
+        *dynamicsWebApi.createRequest(request).then(function (response) {
+        *}).catch(function (error) {
+        *});
+     */
+    this.createRequest = function (request) {
+        ErrorHelper.parameterCheck(request, 'DynamicsWebApi.create', 'request');
+
+        return _makeRequest('POST', request, 'create')
+            .then(function (response) {
+                if (response.data) {
+                    return response.data;
+                }
+
+                var entityUrl = response.headers['OData-EntityId']
+                    ? response.headers['OData-EntityId']
+                    : response.headers['odata-entityid'];
+                var id = /[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}/i.exec(entityUrl)[0];
+                return id;
+            });
+    };
+
     /**
      * Sends an asynchronous request to create a new record.
      *
@@ -214,25 +254,28 @@ function DynamicsWebApi(config) {
             entity: object
         };
 
-        return _makeRequest('POST', request, 'create')
-            .then(function (response) {
-                if (response.data) {
-                    return response.data;
-                }
-
-                var entityUrl = response.headers['OData-EntityId']
-                    ? response.headers['OData-EntityId']
-                    : response.headers['odata-entityid'];
-                var id = /[0-9A-F]{8}[-]?([0-9A-F]{4}[-]?){3}[0-9A-F]{12}/i.exec(entityUrl)[0];
-                return id;
-            });
+        return this.createRequest(request);
     };
 
     /**
      * Sends an asynchronous request to retrieve a record.
      *
      * @param {DWARequest} request - An object that represents all possible options for a current request.
      * @returns {Promise}
+     * @example
+        *var request = {
+        *    key: '7d577253-3ef0-4a0a-bb7f-8335c2596e70',
+        *    collection: "leads",
+        *    select: ["fullname", "subject"],
+        *    ifnonematch: 'W/"468026"',
+        *    includeAnnotations: "OData.Community.Display.V1.FormattedValue"
+        *};
+        *
+        *dynamicsWebApi.retrieveRequest(request).then(function (response) {
+        *
+        *}).catch(function (error) {
+        *
+        *});
      */
     this.retrieveRequest = function (request) {
         ErrorHelper.parameterCheck(request, 'DynamicsWebApi.retrieve', 'request');