@eway-crm/connector 1.0.66 → 1.0.70

package/lib/ApiConnection.d.ts

@@ -1,3 +1,4 @@
+import { AxiosRequestConfig } from 'axios';
 import { IApiResult } from './data/IApiResult';
 import { ISessionHandler } from './ISessionHandler';
 import { HttpMethod } from './HttpMethod';
@@ -18,6 +19,26 @@ export declare class ApiConnection {
     static createUsingOAuth(apiServiceUri: string, username: string, clientId: string, clientSecret: string, refreshToken: string, accessToken: string, appVersion: string, errorCallback?: (error: TUnionError) => void, refreshTokenCallback?: (tokenData: ITokenData) => void, supportGetItemPreviewMethod?: boolean): ApiConnection;
     get wsUrl(): string;
     readonly createOpenLink: (folderName: TFolderName, guid?: string | undefined, fileAs?: string | undefined) => string;
+    /**
+     * Creates a promise for async file upload using binary stream
+     * @param itemGuid Item identificator. Ex. '9ac561be-9b7d-4938-8e55-4cce97142483'.
+     * @param fileName File name, ex. 'picture.img'.
+     * @param data Single file to be uploaded.
+     * @param config Optional. Additional config for the request.
+     * @param catchGlobally Optional. If true, raises this the global error handler each time the promise is rejected.
+     */
+    readonly askUploadMethod: (itemGuid: string, fileName: string, data: File, config?: AxiosRequestConfig | undefined, catchGlobally?: boolean | undefined) => Promise<IApiResult>;
+    /**
+     * Asynchronously uploads file using binary stream
+     * @param itemGuid Item identificator. Ex. '9ac561be-9b7d-4938-8e55-4cce97142483'.
+     * @param fileName File name, ex. 'picture.img'.
+     * @param data Single file to be uploaded.
+     * @param successCallback Handler callback when the method executes well. Gets the whole response JSON object as the only argument.
+     * @param unsuccessCallback Optional. Handler callback for eWay-API app level failures. Gets the whole response JSON object as the only argument. If not supplied, the global error handler is used.
+     * @param errorCallback Optional. Handler callback for any other failures. If not supplied, the global error handler is used.
+     * @param config Optional. Additional config for the request.
+     */
+    readonly callUploadMethod: (itemGuid: string, fileName: string, data: File, successCallback: (res: IApiResult) => void, unsuccessCallback?: ((e: IApiResult) => void) | undefined, errorCallback?: ((e: TUnionError) => void) | undefined, config?: AxiosRequestConfig | undefined) => void;
     /**
      * Creates a promise for async API method call.
      * @param methodName API method name. Ex. 'GetUsers'.

package/lib/ApiConnection.js

@@ -26,6 +26,85 @@ var ApiConnection = /** @class */ (function () {
             }
             return url;
         };
+        /**
+         * Creates a promise for async file upload using binary stream
+         * @param itemGuid Item identificator. Ex. '9ac561be-9b7d-4938-8e55-4cce97142483'.
+         * @param fileName File name, ex. 'picture.img'.
+         * @param data Single file to be uploaded.
+         * @param config Optional. Additional config for the request.
+         * @param catchGlobally Optional. If true, raises this the global error handler each time the promise is rejected.
+         */
+        this.askUploadMethod = function (itemGuid, fileName, data, config, catchGlobally) {
+            return new Promise(function (resolve, reject) {
+                var errClb = catchGlobally
+                    ? function (e) {
+                        reject(e);
+                        throw e;
+                    }
+                    : reject;
+                _this.callUploadMethod(itemGuid, fileName, data, resolve, errClb, errClb, config);
+            });
+        };
+        /**
+         * Asynchronously uploads file using binary stream
+         * @param itemGuid Item identificator. Ex. '9ac561be-9b7d-4938-8e55-4cce97142483'.
+         * @param fileName File name, ex. 'picture.img'.
+         * @param data Single file to be uploaded.
+         * @param successCallback Handler callback when the method executes well. Gets the whole response JSON object as the only argument.
+         * @param unsuccessCallback Optional. Handler callback for eWay-API app level failures. Gets the whole response JSON object as the only argument. If not supplied, the global error handler is used.
+         * @param errorCallback Optional. Handler callback for any other failures. If not supplied, the global error handler is used.
+         * @param config Optional. Additional config for the request.
+         */
+        this.callUploadMethod = function (itemGuid, fileName, data, successCallback, unsuccessCallback, errorCallback, config) {
+            var noSessionCallback = function () {
+                _this.sessionHandler.getSessionId(_this, function (newSessionId) {
+                    _this.sessionId = newSessionId;
+                    _this.callUploadMethod(itemGuid, fileName, data, successCallback, unsuccessCallback, errorCallback, config);
+                });
+            };
+            var sessionId = _this.sessionId;
+            if (!sessionId) {
+                noSessionCallback();
+                return;
+            }
+            var unsuccessClb = function (result) {
+                if (result.ReturnCode === ReturnCodes_1.ReturnCodes.rcBadSession) {
+                    _this.sessionId = null;
+                    _this.sessionHandler.invalidateSessionId(sessionId, noSessionCallback);
+                    return;
+                }
+                if (unsuccessCallback) {
+                    unsuccessCallback(result);
+                }
+                else {
+                    var error = new Error('Unhandled connection return code ' + result.ReturnCode + ': ' + result.Description);
+                    if (_this.errorCallback) {
+                        _this.errorCallback(error);
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            };
+            var errorClb = function (error) {
+                var err = new Error('Unhandled connection error when calling ' + methodUrl + ': ' + JSON.stringify(error));
+                if ('statusCode' in error && error.statusCode === 413) {
+                    err = new Error('The file has exceeded the maximum allowed file size for uploading. You can contact eWay-CRM support if you wish to increase the limit.');
+                }
+                if (errorCallback) {
+                    errorCallback(err);
+                }
+                else if (_this.errorCallback) {
+                    _this.errorCallback(err);
+                }
+                else {
+                    throw err;
+                }
+            };
+            var methodUrl = _this.svcUri + "/SaveBinaryAttachment?sessionId=" + _this.sessionId + "&itemGuid=" + itemGuid + "&fileName=" + fileName;
+            var promise = axios_1.default.post(methodUrl, data, config);
+            ApiConnection.handleCallPromise(promise, successCallback, unsuccessClb, errorClb);
+        };
         /**
          * Creates a promise for async API method call.
          * @param methodName API method name. Ex. 'GetUsers'.

package/lib/constants/FieldNames.d.ts

@@ -156,7 +156,6 @@ export default class FieldNames {
         readonly EstimatedRevenueDefaultCurrency: "EstimatedRevenueDefaultCurrency";
     };
     static readonly Documents: {
-        readonly File: "File";
         readonly FileAs: "FileAs";
         readonly DocName: "DocName";
         readonly Preview: "Preview";

package/lib/constants/FieldNames.js

@@ -160,7 +160,6 @@ var FieldNames = /** @class */ (function () {
         EstimatedRevenueDefaultCurrency: 'EstimatedRevenueDefaultCurrency'
     };
     FieldNames.Documents = {
-        File: 'File',
         FileAs: 'FileAs',
         DocName: 'DocName',
         Preview: 'Preview',

package/lib/constants/GlobalSettingsNames.d.ts

@@ -20,6 +20,7 @@ declare class GlobalSettingsNames {
     static exchangeRatesAdminGroupName: string;
     static forcedEmailTrackingGroups: string;
     static groupsForAllUnpaidInvoicesNotification: string;
+    static itemPreviewMaxHeight: string;
     static lastActivityAttributes: string;
     static leadsCompletedState: string;
     static leadDeadlineAlertGroups: string;

package/lib/constants/GlobalSettingsNames.js

@@ -24,6 +24,7 @@ var GlobalSettingsNames = /** @class */ (function () {
     GlobalSettingsNames.exchangeRatesAdminGroupName = 'ExchangeRatesAdminGroupName';
     GlobalSettingsNames.forcedEmailTrackingGroups = 'ForcedEmailTrackingGroups';
     GlobalSettingsNames.groupsForAllUnpaidInvoicesNotification = 'GroupsForAllUnpaidInvoicesNotification';
+    GlobalSettingsNames.itemPreviewMaxHeight = 'ItemPreviewMaxHeight';
     GlobalSettingsNames.lastActivityAttributes = 'LastActivityAttributes';
     GlobalSettingsNames.leadsCompletedState = 'LeadsCompletedState';
     GlobalSettingsNames.leadDeadlineAlertGroups = 'LeadDeadlineAlertGroups';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eway-crm/connector",
-  "version": "1.0.66",
+  "version": "1.0.70",
   "description": "eWay-CRM API JavaScript connector library.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",