@progress/sitefinity-webservices-sdk 0.2.72 → 1.0.0

package/src/Requests/BatchRequest.ts

@@ -1,261 +1,226 @@
 import { RequestFactory } from "./RequestFactory";
-import { RequestBase } from './Request';
 import { BlobBuilder } from '../BlobBuilder';
 import { utils } from '../utils';
-
-var headerNames = require("../Headers").headerNames;
-var httpMethods = require("../HttpMethods").default;
+import { HEADER_NAMES, HTTP_METHODS } from "../constants";
+import { ExecutableRequest } from "./ExecutableRequest";
+import { SDKOptions, Token, TypeOptions } from "../Sitefinity";
+import { RequestBase, RequestOptionsBaseExtended } from "./RequestBase";
+import { CreateRelatedRequestOptions, RequestOptionsBase, PropertyRequestOptions, SingleRelatedItemRequestOptions, CreateRequestOptions, UpdateRequestOptions } from "../Data";
+import { PostRequestOptionsExtended, PutRequestOptionsExtended, RelatedByIdRequestOptionsExtended, RelatedRequestOptionsExtended, UploadRequestOptionsExtended } from "./Request";
+import { Query } from "../Query";
 
 /**
- * @classdesc The transaction class is used to group operations that involve data manipulation together and execute them as a single atomic operation.
- * @class Transaction
- * @param {object} urlOptions - The url options that are passed to the {@link _factory} object.
- * @param {object} _factory - The factory object used for request generation.
+ * The transaction class is used to group operations that involve data manipulation together and execute them as a single atomic operation.
  */
-class Transaction {
-    private urlOptions: any;
-    private _factory: RequestFactory;
-    private _requests: any[];
-    public id: number;
-    public _counter: number;
-
-    constructor(urlOptions, _factory) {
+export class Transaction {
+    id: number;
+    counter: number;
+    requests: TransactionRequest[];
+    private urlOptions: TypeOptions;
+    private factory: RequestFactory;
+
+    constructor(urlOptions: TypeOptions, factory: RequestFactory) {
         this.urlOptions = urlOptions;
-        this._factory = _factory;
-        this._requests = [];
-        this._counter = 0;
+        this.factory = factory;
+        this.requests = [];
+        this.counter = 0;
     }
 
-    upload(parameters: any) {
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+    upload(parameters: any): number {
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: UploadRequestOptionsExtended = {
             urlOptions: urlOptions,
             data: parameters.data,
             contentType: parameters.contentType,
             fileName: parameters.fileName,
             key: parameters.key,
-            uploadProperties: JSON.stringify(parameters.uploadProperties)
+            uploadProperties: parameters.uploadProperties
         };
 
-        var request = this._factory.upload(options);
+        const request = this.factory.upload(options);
 
-        return this.addRequest(this, request);
+        return this.addRequest(request);
     }
 
     /**
     * Adds a POST request to create a single item.
-    * @memberOf Transaction
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {object} parameters.data - The payload of the request.
     */
-    create(parameters: any) {
+    create(parameters: BatchCreateRequestOptions) {
         if (!(parameters || parameters.entitySet))
             throw "entitySet is required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: PostRequestOptionsExtended = {
             key: parameters.key,
             action: parameters.action,
             urlOptions: urlOptions,
-            data: JSON.stringify(parameters.data)
+            data: parameters.data
         };
 
-        var request = this._factory.create(options);
+        const request = this.factory.create(options);
 
-        return this.addRequest(this, request);
+        return this.addRequest(request);
     }
 
     /**
     * Adds a POST request to execute an operation on single item.
-    * @memberOf Transaction
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item to be updated.
-    * @param {object} parameters.data - The payload of the request.
     */
-    operation(parameters: any) {
+    // TODO: Remove
+    operation(parameters: BatchCreateRequestOptions) {
         if (!(parameters || parameters.entitySet || parameters.key || parameters.data))
             throw "parameters: entitySet, key and data are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: PostRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
             action: 'operation',
-            data: JSON.stringify(parameters.data)
+            data: parameters.data
         };
 
-        var request = this._factory.create(options);
+        const request = this.factory.create(options);
 
-        this._overrideUrlGeneration(request, parameters.key, 'operation', options.urlOptions);
-        this.addRequest(this, request);
+        this.overrideUrlGeneration(request, parameters.key, 'operation', options.urlOptions, options.query);
+        this.addRequest(request);
     }
 
     /**
     * Adds a PATCH request to update a single item.
-    * @memberOf Transaction
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {bool} parameters.saveTemp - A flag indicating whether to save in temp.
-    * @param {string} parameters.key - The identifier of the item to be updated.
-    * @param {object} parameters.data - The payload of the request.
     */
-    update(parameters: any) {
+    update(parameters: BatchUpdateRequestOptions) {
         if (!(parameters || parameters.entitySet || parameters.key || parameters.data))
             throw "parameters: entitySet, key and data are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: PutRequestOptionsExtended = {
             urlOptions: urlOptions,
             saveTemp: parameters.saveTemp,
             key: parameters.key,
-            data: JSON.stringify(parameters.data)
+            data: parameters.data
         };
 
-        var request = this._factory.update(options);
+        const request = this.factory.update(options);
 
-        this._overrideUrlGeneration(request, parameters.key, undefined, options.urlOptions);
-        this.addRequest(this, request);
+        this.overrideUrlGeneration(request, parameters.key, undefined, options.urlOptions, options.query);
+        this.addRequest(request);
     }
 
     /**
     * Adds a DELETE request to delete a single item.
-    * @memberOf Transaction
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item to be deleted.
     */
-    destroy(parameters: any) {
+    destroy(parameters: BatchSingleItemRequestOptions) {
         if (!(parameters || parameters.entitySet || parameters.key))
             throw "parameters: entitySet and key are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: RequestOptionsBaseExtended = {
             urlOptions: urlOptions,
             key: parameters.key
         };
 
-        var request = this._factory.destroy(options);
+        const request = this.factory.destroy(options);
 
-        this._overrideUrlGeneration(request, parameters.key, undefined, options.urlOptions);
+        this.overrideUrlGeneration(request, parameters.key, undefined, options.urlOptions, options.query);
 
-        this.addRequest(this, request);
+        this.addRequest(request);
     }
 
     /**
-    * Adds a DELETE request to retrieve the delete all of the associated members in the relation property.
-    * @memberOf Transaction
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property.
+    * Adds a DELETE request to delete all of the associated members in the relation property.
     */
-    destroyRelated(parameters: any) {
+    destroyRelated(parameters: BatchPropertyRequestOptions) {
         if (!(parameters || parameters.entitySet || parameters.key))
             throw "parameters: entitySet and key are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: RelatedRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.navigationProperty
+            property: parameters.property
         };
 
-        var request = this._factory.destroyRelated(options);
+        const request = this.factory.destroyRelated(options);
 
-        var navigationPropertyURL = (request as any).navigationProperty + '/$ref';
-        this._overrideUrlGeneration(request, parameters.key, navigationPropertyURL, options.urlOptions);
+        const propertyURL = (request as any).property + '/$ref';
+        this.overrideUrlGeneration(request, parameters.key, propertyURL, options.urlOptions, options.query);
 
-        this.addRequest(this, request);
+        this.addRequest(request);
     }
 
     /**
     * Adds a DELETE request to retrieve the a single entry of the associated members in the relation property.
-    * @memberOf Transaction
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property.
-    * @param {string} parameters.relatedKey - The identifier of the related item.
     */
-    destroyRelatedById(parameters: any) {
-        if (!(parameters || parameters.entitySet || parameters.key || parameters.relatedKey || parameters.navigationProperty))
-            throw "parameters: entitySet, key, relatedKey and navigationProperty are required!";
+    destroyRelatedById(parameters: BatchSingleRelatedItemRequestOptions) {
+        if (!(parameters || parameters.entitySet || parameters.key || parameters.relatedId || parameters.property))
+            throw "parameters: entitySet, key, relatedId and property are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: RelatedByIdRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
-            relatedKey: parameters.relatedKey,
-            navigationProperty: parameters.navigationProperty
+            relatedId: parameters.relatedId,
+            property: parameters.property
         };
 
-        var request = this._factory.destroyRelatedById(options);
+        const request = this.factory.destroyRelatedById(options);
 
-        this.addRequest(this, request);
+        this.addRequest(request);
     }
 
     /**
     * Adds a POST request to add a related item to the property collection.
-    * @memberOf Transaction
-    * @instance
-    * @see {@link Data.createRelated}
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property
     */
-    createRelated(parameters: any) {
-        if (!(parameters || parameters.entitySet || parameters.key || parameters.link || parameters.navigationProperty))
-            throw "parameters: entitySet, key, link and navigationProperty are required!";
+    createRelated(parameters: BatchCreateRelatedRequestOptions) {
+        if (!(parameters || parameters.entitySet || parameters.key || parameters.link || parameters.property))
+            throw "parameters: entitySet, key, link and property are required!";
 
         // TODO: rethink about the urls
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        for (var index = 0; index < this._requests.length; index += 1) {
-            if (this._requests[index].id == parameters.link) {
-                parameters.link = "$" + this._requests[index].id;
+        for (let index = 0; index < this.requests.length; index += 1) {
+            if (this.requests[index].id == parameters.link) {
+                parameters.link = "$" + this.requests[index].id;
             }
         }
 
-        var data = {
+        const data = {
             '@odata.id': parameters.link
         }
 
-        var options = {
+        const options: RelatedRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.navigationProperty,
-            data: JSON.stringify(data)
+            property: parameters.property,
+            data: data
         };
 
-        var request = this._factory.createRelated(options);
-        var navigationPropertyURL = (request as any).navigationProperty + '/$ref';
-        this._overrideUrlGeneration(request, parameters.key, navigationPropertyURL, options.urlOptions);
+        const request = this.factory.createRelated(options);
+        const propertyURL = (request as any).property + '/$ref';
+        this.overrideUrlGeneration(request, parameters.key, propertyURL, options.urlOptions, options.query);
 
-        return this.addRequest(this, request);
+        return this.addRequest(request);
     }
 
-    _overrideUrlGeneration(request: any, key: string, additionalPropertyURL: string, sfParams: any) {
+    private overrideUrlGeneration(request: RequestBase, key: number | string, additionalPropertyURL: string, urlOptions?: TypeOptions, query?: Query) {
         // TODO: match requests with Content-ID's!
-        // Content-ID's are the same as id's in _requests.
-        for (var index = 0; index < this._requests.length; index += 1) {
-            if (this._requests[index].id == key) {
-                request._buildUrl = function () {
-                    var uri = "$" + key;
+        // Content-ID's are the same as id's in requests.
+        for (let index = 0; index < this.requests.length; index += 1) {
+            if (this.requests[index].id == key) {
+                request.buildUrl = function () {
+                    let uri = "$" + key;
                     if (additionalPropertyURL !== undefined) {
                         uri = uri + '/' + additionalPropertyURL;
                     }
 
-                    if (sfParams) {
-                        var queryString = request._getQueryString(sfParams);
+                    if (urlOptions) {
+                        const queryString = request.getQueryString(urlOptions, query);
                         if (queryString) {
                             uri = uri + queryString;
                         }
@@ -267,13 +232,13 @@ class Transaction {
         }
     }
 
-    addRequest(that: any, request) {
-        that._requests.push({ "id": that._counter, "request": request });
-        return that._counter++;
+    private addRequest(request: RequestBase) {
+        this.requests.push({ id: this.counter, request: request });
+        return this.counter++;
     }
 
-    urlParametersClone(entitySet: string) {
-        var options = utils.clone(this.urlOptions);
+    private urlParametersClone(entitySet: string) {
+        const options = utils.clone(this.urlOptions);
         options.entitySet = entitySet;
 
         return options;
@@ -281,205 +246,173 @@ class Transaction {
 }
 
 /**
- * @classdesc The batch request class is used for grouping requests into a single batch request to execute on the server.
- * @class BatchRequest
+ * The batch request class is used for grouping requests into a single batch request to execute on the server.
  */
-class BatchRequest extends RequestBase {
-    private _factory: RequestFactory;
-    private _requests: any[];
-    private _counter: number;
-    private boundary: any;
+export class BatchRequest extends ExecutableRequest {
+    counter: number;
+    requests: BatchInnerRequest[];
+    private factory: RequestFactory;
+    private boundary: string;
     private responseHeaderRegex: RegExp;
     private responseStatusRegex: RegExp;
+
+
     public static constants = {
         newLine: '\r\n'
     };
 
-    constructor(options) {
-        super(options);
-        this._factory = options._factory;
-        this._requests = [];
-        this._counter = 0;
-        this.boundary = this._createBoundary("sf_batch_");
+    constructor(requestOptions: BatchRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
+        super(requestOptions, token, sdkOptions);
+        this.factory = requestOptions.factory;
+        this.requests = [];
+        this.counter = 0;
+        this.boundary = this.createBoundary("sf_batch_");
         this.responseHeaderRegex = /^([^()<>@,;:\\"\/[\]?={} \t]+)\s?:\s?(.*)/;
         this.responseStatusRegex = /^HTTP\/1\.\d (\d{3}) (.*)$/i;
     }
 
     /**
     * Adds a GET request to retrieve a collection of items.
-    * @memberOf BatchRequest
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {object} parameters.query - The {@link WhereQuery} with which to filter the items
     */
-    get(parameters: any) {
+    get(parameters: BatchRequestOptionsBase) {
         if (!(parameters || parameters.entitySet))
             throw "entitySet is required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
-        if (parameters && parameters.query)
-            urlOptions.ODataParams = parameters.query;
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: RequestOptionsBaseExtended = {
             urlOptions: urlOptions,
             action: parameters.action,
-            fallbackProperties: parameters.fallbackPropertyNames
+            query: parameters.query,
+            fallbackProperties: parameters.fallbackProperties
         };
 
-        var request = this._factory.get(options);
+        const request = this.factory.get(options);
 
         this.addRequest(request);
     }
 
     /**
     * Adds a GET request for the retrieval of a single item.
-    * @memberOf BatchRequest
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {object} parameters.query - The {@link QueryBase} object containing the OData query options that should be sent to the server.
-    * @param {string} parameters.key - The identifier of the item to be retrieved.
     */
-    getSingle(parameters: any) {
+    getSingle(parameters: BatchSingleItemRequestOptions) {
         if (!(parameters || parameters.entitySet || parameters.key))
             throw "parameters: entitySet and key are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options: any = {
+        const options: RequestOptionsBaseExtended = {
             urlOptions: urlOptions,
             action: parameters.action,
-            key: parameters.key
+            key: parameters.key,
+            query: parameters.query
         };
 
-        if (parameters.query)
-            options.ODataParams = parameters.query;
-
-        var request = this._factory.getSingle(options);
+        const request = this.factory.getSingle(options);
 
         this.addRequest(request);
     }
 
     /**
     * Adds a GET request to get the property of a single item.
-    * @memberOf BatchRequest
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.property - The name of the property to be retrieved.
     */
-    getProperty(parameters: any) {
+    getProperty(parameters: BatchPropertyRequestOptions) {
         if (!(parameters || parameters.entitySet || parameters.key, parameters.property))
             throw "parameters: entitySet, key and property are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: RelatedRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.property
+            property: parameters.property
         };
 
-        var request = this._factory.getProperty(options);
+        const request = this.factory.getProperty(options);
 
         this.addRequest(request);
     }
 
     /**
     * Adds a GET request to get the related property value of a single item.
-    * @memberOf BatchRequest
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property to be retrieved.
     */
-    getRelated(parameters: any) {
-        if (!(parameters || parameters.entitySet || parameters.key || parameters.navigationProperty))
-            throw "parameters: entitySet, key and navigationProperty are required!";
+    getRelated(parameters: BatchPropertyRequestOptions) {
+        if (!(parameters || parameters.entitySet || parameters.key || parameters.property))
+            throw "parameters: entitySet, key and property are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: RelatedRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.navigationProperty
+            property: parameters.property
         };
 
-        var request = this._factory.getRelated(options);
+        const request = this.factory.getRelated(options);
 
         this.addRequest(request);
     }
 
     /**
     * Adds a GET request to retrieve the related property value of a single item by the id of the related item.
-    * @memberOf BatchRequest
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property to be retrieved.
-    * @param {string} parameters.relatedKey - The identifier of the related item.
     */
-    getRelatedById(parameters: any) {
-        if (!(parameters || parameters.entitySet || parameters.key || parameters.relatedKey || parameters.navigationProperty))
-            throw "parameters: entitySet, key, relatedKey and navigationProperty are required!";
+    getRelatedById(parameters: BatchSingleRelatedItemRequestOptions) {
+        if (!(parameters || parameters.entitySet || parameters.key || parameters.relatedId || parameters.property))
+            throw "parameters: entitySet, key, relatedId and property are required!";
 
-        var urlOptions = this.urlParametersClone(parameters.entitySet);
+        const urlOptions = this.urlParametersClone(parameters.entitySet);
 
-        var options = {
+        const options: RelatedByIdRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
-            relatedKey: parameters.relatedKey,
-            navigationProperty: parameters.navigationProperty
+            relatedId: parameters.relatedId,
+            property: parameters.property
         };
 
-        var request = this._factory.getRelatedById(options);
+        const request = this.factory.getRelatedById(options);
 
         this.addRequest(request);
     }
 
     /**
     * Begins a transaction.
-    * @memberOf BatchRequest
-    * @instance
-    * @returns {@link Transaction}
     */
-    beginTransaction() {
-        var option = utils.clone(this.urlOptions);
-        const newTransaction = new Transaction(option, this._factory);
-        newTransaction.id = ++this._counter;
+    beginTransaction(): Transaction {
+        const option = utils.clone(this.urlOptions);
+        const newTransaction = new Transaction(option, this.factory);
+        newTransaction.id = ++this.counter;
         return newTransaction;
     }
 
     /**
     * Ends a transaction.
-    * @memberOf BatchRequest
-    * @instance
     */
-    endTransaction(transaction: any) {
-        this._requests.push({
+    endTransaction(transaction: Transaction) {
+        this.requests.push({
             id: transaction.id,
             request: transaction
         });
     }
 
-    _getBody() {
-        return this._buildRequestBody();
+    getBody(): object {
+        return this.buildRequestBody();
     }
 
-    _getMethod() {
-        return httpMethods.Post;
+    getMethod(): string {
+        return HTTP_METHODS.post;
     }
 
-    _getHeaders() {
-        var contentType = "multipart/mixed; boundary=" + this.boundary;
-        var headers = { };
-        headers[headerNames.contentType] = contentType;
+    getHeaders(): { [key: string]: string } {
+        const contentType = "multipart/mixed; boundary=" + this.boundary;
+        const headers = { };
+        headers[HEADER_NAMES.contentType] = contentType;
 
         return headers;
     }
 
-    _buildUrl() {
-        var url = this.urlOptions.baseUrl + "$batch";
-        var queryString = this._getQueryString(this.urlOptions);
+    buildUrl(): string {
+        let url = this.urlOptions.baseUrl + "$batch";
+        const queryString = this.getQueryString(this.urlOptions, this.query);
 
         if (queryString) {
             url += queryString
@@ -488,53 +421,53 @@ class BatchRequest extends RequestBase {
         return url;
     }
 
-    _parseResponse(http) {
-        var context = {
+    protected parseResponse(http: XMLHttpRequest): any {
+        const context = {
             position: 0,
             boundaries: []
         };
 
-        var pos = context.position;
-        var partHeaders = this._readHeaders(http.getAllResponseHeaders(), context);
-        var partContentType = this._contentType(partHeaders["content-type"]);
+        const pos = context.position;
+        const partHeaders = this.readHeaders(http.getAllResponseHeaders(), context);
+        const partContentType = this.contentType(partHeaders["content-type"]);
         if (partContentType && partContentType.mediaType == "multipart/mixed") {
             context.boundaries.push((partContentType.properties as any).boundary);
         }
 
         context.position = pos;
 
-        var batchResponse = this._parseBatchResponse(http.responseText, context);
-        var responseParsed = [];
-        for (var i = 0; i < batchResponse.length; i++) {
+        const batchResponse = this.parseBatchResponse(http.responseText, context);
+        const responseParsed = [];
+        for (let i = 0; i < batchResponse.length; i++) {
             try {
-                const currentRequest = this._requests[i];
-                var finalResult = null;
-                var key = null;
+                const currentRequest = this.requests[i];
+                let finalResult = null;
+                let key = null;
 
-                var singleResponse = batchResponse[i];
-                var changesets = singleResponse.__changeResponses;
+                const singleResponse = batchResponse[i];
+                const changesets = singleResponse.__changeResponses;
                 if (changesets) {
                     finalResult = [];
-                    const currentRequests = currentRequest ? currentRequest.request._requests : [];
+                    const currentRequests = currentRequest ? (currentRequest.request as Transaction).requests : [];
 
-                    for (var j = 0; j < changesets.length; j++) {
-                        key = currentRequests[j] ? currentRequests[j].request.request.key : null;
-                        var changeset = changesets[j];
-                        var response = changeset.response;
-                        var responseResult = this._getResponseResult(response, key);
+                    for (let j = 0; j < changesets.length; j++) {
+                        key = currentRequests[j] ? currentRequests[j].request.key : null;
+                        const changeset = changesets[j];
+                        const response = changeset.response;
+                        const responseResult = this.getResponseResult(response, key);
                         finalResult.push(responseResult);
                     }
                 } else {
-                    key = currentRequest ? currentRequest.request.key : null;
-                    var response = singleResponse.response;
-                    finalResult = this._getResponseResult(response, key);
+                    key = currentRequest ? (currentRequest.request as any).key : null;
+                    const response = singleResponse.response;
+                    finalResult = this.getResponseResult(response, key);
                 }
 
-                var statusCodeCheck = function (r) {
+                const statusCodeCheck = function (r) {
                     return r.statusCode >= 400;
                 };
 
-                var responseCheck = function (r) {
+                const responseCheck = function (r) {
                     let success = true;
                     if (r.data && r.data.hasOwnProperty("Success")) {
                         success = r.data.Success
@@ -543,7 +476,7 @@ class BatchRequest extends RequestBase {
                     return success;
                 };
 
-                var isSuccessful = Array.isArray(finalResult) ?
+                const isSuccessful = Array.isArray(finalResult) ?
                     finalResult.filter(statusCodeCheck).length === 0 && finalResult.filter(responseCheck).length === finalResult.length :
                     !statusCodeCheck(finalResult) && responseCheck(finalResult);
 
@@ -555,47 +488,47 @@ class BatchRequest extends RequestBase {
             }
         }
 
-        var isSuccessfulCheck = (r) => {
+        const isSuccessfulCheck = (r) => {
             return !r.isSuccessful;
         };
 
-        var batchIsSuccessful = responseParsed.filter(isSuccessfulCheck).length === 0;
+        const batchIsSuccessful = responseParsed.filter(isSuccessfulCheck).length === 0;
         return { data: responseParsed, isSuccessful: batchIsSuccessful };
     }
 
-    _parseBatchResponse(text, context) {
+    private parseBatchResponse(text, context) {
         // get boundary from response
-        var delimiter = "--" + this._currentBoundary(context);
-        this._readTo(text, delimiter, context);
-        this._readLine(text, context);
+        const delimiter = "--" + this.currentBoundary(context);
+        this.readTo(text, delimiter, context);
+        this.readLine(text, context);
 
-        var responses = [];
-        var partEnd;
+        const responses = [];
+        let partEnd;
         while (partEnd !== "--" && context.position < text.length) {
-            var partHeaders = this._readHeaders(text, context);
-            var partContentType = this._contentType(partHeaders["content-type"]);
-            var changeResponses;
+            const partHeaders = this.readHeaders(text, context);
+            const partContentType = this.contentType(partHeaders["content-type"]);
+            let changeResponses;
             if (partContentType && partContentType.mediaType === "multipart/mixed") {
                 context.boundaries.push((partContentType.properties as any).boundary);
 
                 try {
-                    changeResponses = this._parseBatchResponse(text, context);
+                    changeResponses = this.parseBatchResponse(text, context);
                 } catch (e) {
-                    e.response = this._readResponse(text, context, delimiter);
+                    e.response = this.readResponse(text, context, delimiter);
                     changeResponses = [e];
                 }
                 responses.push({ __changeResponses: changeResponses });
                 context.boundaries.pop();
-                this._readTo(text, "--" + this._currentBoundary(context), context);
+                this.readTo(text, "--" + this.currentBoundary(context), context);
             } else {
                 if (!partContentType || partContentType.mediaType !== "application/http") {
                     throw { message: "invalid MIME part type " };
                 }
                 // Skip empty line
-                this._readLine(text, context);
+                this.readLine(text, context);
 
                 // Read the response
-                var response: any = this._readResponse(text, context, delimiter);
+                let response: any = this.readResponse(text, context, delimiter);
 
                 try {
                     if (response.statusCode >= 200 && response.statusCode <= 299) {
@@ -614,15 +547,15 @@ class BatchRequest extends RequestBase {
             partEnd = text.substr(context.position, 2);
 
             // Ignore the incoming line.
-            this._readLine(text, context);
+            this.readLine(text, context);
         }
 
         return responses;
     }
 
-    _getResponseResult(response, key) {
-        var responseBody = response.body;
-        var data = utils.parseStringToJson(responseBody);
+    private getResponseResult(response, key) {
+        const responseBody = response.body;
+        const data = utils.parseStringToJson(responseBody);
 
         return {
             key: key,
@@ -632,32 +565,32 @@ class BatchRequest extends RequestBase {
         };
     }
 
-    _currentBoundary(context) {
-        var boundaries = context.boundaries;
+    private currentBoundary(context) {
+        const boundaries = context.boundaries;
         return boundaries[boundaries.length - 1];
     }
 
-    _contentType(str) {
+    private contentType(str) {
 
         if (!str) {
             return null;
         }
 
-        var contentTypeParts = str.split(";");
-        var properties = {};
+        const contentTypeParts = str.split(";");
+        const properties = {};
 
-        var i, len;
+        let i, len;
         for (i = 1, len = contentTypeParts.length; i < len; i++) {
-            var contentTypeParams = contentTypeParts[i].split("=");
+            const contentTypeParams = contentTypeParts[i].split("=");
             properties[contentTypeParams[0].replace(/^\s+|\s+$/g, '')] = contentTypeParams[1];
         }
 
         return { mediaType: contentTypeParts[0].replace(/^\s+|\s+$/g, ''), properties: properties };
     }
 
-    _readTo(text, str, context) {
-        var start = context.position || 0;
-        var end = text.length;
+    private readTo(text, str, context) {
+        const start = context.position || 0;
+        let end = text.length;
         if (str) {
             end = text.indexOf(str, start);
             if (end === -1) {
@@ -671,19 +604,19 @@ class BatchRequest extends RequestBase {
         return text.substring(start, end);
     }
 
-    _readLine(text, context) {
-        return this._readTo(text, BatchRequest.constants.newLine, context);
+    private readLine(text, context) {
+        return this.readTo(text, BatchRequest.constants.newLine, context);
     }
 
-    _readHeaders(text, context) {
-        var headers = {};
-        var parts;
-        var line;
-        var pos;
+    private readHeaders(text, context) {
+        const headers = {};
+        let parts;
+        let line;
+        let pos;
 
         do {
             pos = context.position;
-            line = this._readLine(text, context);
+            line = this.readLine(text, context);
             parts = this.responseHeaderRegex.exec(line);
             if (parts !== null) {
                 headers[parts[1].toLowerCase()] = parts[2];
@@ -696,20 +629,20 @@ class BatchRequest extends RequestBase {
         return headers;
     }
 
-    _readResponse(text, context, delimiter) {
+    private readResponse(text, context, delimiter) {
         // Read the status line.
-        var pos = context.position;
-        var match = this.responseStatusRegex.exec(this._readLine(text, context));
+        const pos = context.position;
+        const match = this.responseStatusRegex.exec(this.readLine(text, context));
 
-        var statusCode;
-        var statusText;
-        var headers;
+        let statusCode;
+        let statusText;
+        let headers;
 
         if (match) {
             statusCode = match[1];
             statusText = match[2];
-            headers = this._readHeaders(text, context);
-            this._readLine(text, context);
+            headers = this.readHeaders(text, context);
+            this.readLine(text, context);
         } else {
             context.position = pos;
         }
@@ -718,90 +651,90 @@ class BatchRequest extends RequestBase {
             statusCode: statusCode,
             statusText: statusText,
             headers: headers,
-            body: this._readTo(text, BatchRequest.constants.newLine + delimiter, context)
+            body: this.readTo(text, BatchRequest.constants.newLine + delimiter, context)
         };
     }
 
-    _buildRequestBody() {
-        var builder = new BlobBuilder();
+    private buildRequestBody() {
+        const builder = new BlobBuilder();
         builder.append('');
 
-        for (var index = 0; index < this._requests.length; index += 1) {
+        for (let index = 0; index < this.requests.length; index += 1) {
 
-            var request = this._requests[index].request;
+            const request = this.requests[index].request;
             if (index != 0)
                 builder.append(BatchRequest.constants.newLine + BatchRequest.constants.newLine);
 
             builder.append("--" + this.boundary);
 
             if (request instanceof Transaction) {
-                builder.append(this._buildTransaction(request));
+                builder.append(this.buildTransaction(request));
             }
             else {
-                builder.append(this._buildRequest(request));
+                builder.append(this.buildRequest(request));
             }
         }
 
-        builder.append(this._createDelimeter(this.boundary, true));
+        builder.append(this.createDelimeter(this.boundary, true));
         return builder.build();
     }
 
-    _buildRequest(request) {
-        var builder = new BlobBuilder();
+    private buildRequest(request: RequestBase): Blob {
+        const builder = new BlobBuilder();
         builder.append(BatchRequest.constants.newLine + 'Content-Type: application/http' +
                     BatchRequest.constants.newLine + 'Content-Transfer-Encoding: binary' +
                     BatchRequest.constants.newLine +
                     BatchRequest.constants.newLine +
-                    request._getMethod() +
-                    ' ' + request._buildUrl() + ' HTTP/1.1');
+                    request.getMethod() +
+                    ' ' + request.buildUrl() + ' HTTP/1.1');
 
         return builder.build();
     }
 
-    _buildTransaction(transaction) {
-        if (transaction._requests.length == 0)
+    private buildTransaction(transaction: Transaction) {
+        if (transaction.requests.length == 0)
             return;
 
-        var builder = new BlobBuilder();
+        const builder = new BlobBuilder();
         builder.append(BatchRequest.constants.newLine);
 
-        var changeset = this._createBoundary("sf_changeset_");
+        const changeset = this.createBoundary("sf_changeset_");
         builder.append('Content-Type: multipart/mixed; boundary=' + changeset);
 
-        var changesetRequests = transaction._requests;
-        for (var index = 0; index < changesetRequests.length; index += 1) {
-            var currentRequest = changesetRequests[index].request;
+        const changesetRequests = transaction.requests;
+        for (let index = 0; index < changesetRequests.length; index += 1) {
+            const currentRequest = changesetRequests[index].request;
 
             // we shouldn't add new lines after blob content. Otherwise they are added to the blob and corrupt it
-            const shouldAddNewLine = index === 0 || !utils.isBlob(changesetRequests[index - 1].request._getBody());
-            builder.append(this._createDelimeter(changeset, false, shouldAddNewLine) +
+            const shouldAddNewLine = index === 0 || !utils.isBlob(changesetRequests[index - 1].request.getBody());
+            builder.append(this.createDelimeter(changeset, false, shouldAddNewLine) +
                         BatchRequest.constants.newLine + 'Content-Type: application/http' +
                         BatchRequest.constants.newLine + 'Content-Transfer-Encoding: binary' +
                         BatchRequest.constants.newLine + 'Content-ID: ' + changesetRequests[index].id);
 
-            var requestUrl = currentRequest._buildUrl();
-            builder.append(BatchRequest.constants.newLine + BatchRequest.constants.newLine + currentRequest._getMethod() + ' ' + requestUrl + ' HTTP/1.1');
+            const requestUrl = currentRequest.buildUrl();
+            builder.append(BatchRequest.constants.newLine + BatchRequest.constants.newLine + currentRequest.getMethod() + ' ' + requestUrl + ' HTTP/1.1');
 
-            var headers = currentRequest._getHeaders();
-            var headerNames = Object.keys(headers);
-            for (var i = 0; i < headerNames.length; i++) {
-                var headerName = headerNames[i];
+            const headers = currentRequest.getHeaders();
+            const headerNames = Object.keys(headers);
+            for (let i = 0; i < headerNames.length; i++) {
+                const headerName = headerNames[i];
                 builder.append(BatchRequest.constants.newLine + headerName + ": " + headers[headerName]);
             }
 
-            var body = currentRequest._getBody();
+            const body = utils.serializeToJSON(currentRequest.getBody());
             if (body) {
                 builder.append(BatchRequest.constants.newLine + BatchRequest.constants.newLine);
                 builder.append(body);
             }
         }
 
-        builder.append(this._createDelimeter(changeset, true));
+        builder.append(this.createDelimeter(changeset, true));
 
         return builder.build();
     }
 
-    _createDelimeter(boundary, close, shouldAddNewLine: boolean = true) {
+    private createDelimeter(boundary, close, shouldAddNewLine = true) {
         let result = "";
         if (shouldAddNewLine) {
             result = BatchRequest.constants.newLine + BatchRequest.constants.newLine;
@@ -815,17 +748,61 @@ class BatchRequest extends RequestBase {
         return result;
     }
 
-    _createBoundary(prefix) {
+    private createBoundary(prefix) {
         return prefix + utils.hex16() + '-' + utils.hex16() + '-' + utils.hex16();
     }
 
-    addRequest(request) {
-        return Transaction.prototype.addRequest(this, request);
+    private addRequest(request: RequestBase) {
+        this.requests.push({ id: this.counter, request: request });
+        return this.counter++;
     }
 
-    urlParametersClone(entitySet) {
-        return Transaction.prototype.urlParametersClone.call(this, entitySet);
+    private urlParametersClone(entitySet: string): TypeOptions {
+        const options = utils.clone(this.urlOptions);
+        options.entitySet = entitySet;
+
+        return options;
     }
+}
+
+interface TransactionRequest {
+    id: number,
+    request: RequestBase;
+}
+
+interface BatchInnerRequest {
+    id: number,
+    request: RequestBase | Transaction;
+}
+
+export interface BatchRequestOptionsExtended extends RequestOptionsBaseExtended {
+    factory: RequestFactory;
+}
+
+export interface BatchRequestOptionsBase extends RequestOptionsBase {
+    entitySet: string;
+}
+
+export interface BatchCreateRequestOptions extends CreateRequestOptions {
+    entitySet: string;
+}
+
+export interface BatchUpdateRequestOptions extends UpdateRequestOptions {
+    entitySet: string;
+}
+
+export interface BatchSingleItemRequestOptions extends RequestOptionsBase {
+    entitySet: string;
+}
+
+export interface BatchPropertyRequestOptions extends PropertyRequestOptions {
+    entitySet: string;
+}
+
+export interface BatchSingleRelatedItemRequestOptions extends SingleRelatedItemRequestOptions {
+    entitySet: string;
+}
 
+export interface BatchCreateRelatedRequestOptions extends CreateRelatedRequestOptions {
+    entitySet: string;
 }
-module.exports = BatchRequest;