diff --git a/static/AppEnablementConnector.js b/static/AppEnablementConnector.js new file mode 100644 index 0000000..830fa07 --- /dev/null +++ b/static/AppEnablementConnector.js @@ -0,0 +1,242 @@ +var oAppEnablementConnectorInstance; + +// Shorthand syntax to check if the namespace already exists, if not create an empty Object. +var comGkSoftwareGkrAppEnablement = comGkSoftwareGkrAppEnablement || {}; + +/** + * @class + * @classdesc App Enablement Connector class for all general functionalities that should not + * be accessible via the API. These are only private helper functions. + * @author mluzius + * @since 2.0.0 + * @private + * @name com.gk_software.gkr.app_enablement.ConnectorPrivateClass + */ +comGkSoftwareGkrAppEnablement.ConnectorPrivateClass = ( function () { + "use strict"; + + /** + * @summary This function provides the value for a given URL parameter key. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.ConnectorPrivateClass._fnGetParameter + * @param {string} sParameterName + * Name of the URL parameter for which you want to get the value. + * @private + * @function + * @returns (string) Returns the value for the requested URL parameter key. + */ + var _fnGetParameter = function(sParameterName) { + var sResult = "", + aTmp = null, + aItems = window.location.search.substr(1).split("&"), + index = 0, + iItemsLength = (aItems) ? aItems.length : 0; + + for (index; index < iItemsLength; index++) { + aTmp = aItems[index].split("="); + if (aTmp[0] === sParameterName) { + sResult = decodeURIComponent(aTmp[1]); + } + } + + return sResult; + }; + + var _sAppToken = _fnGetParameter("appToken"); + var _sPosToken = _fnGetParameter("posToken"); + var _sPosOrigin = _fnGetParameter("posOrigin"); + + /** + * @summary This function validates the origins and tokens of the host and the app. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.ConnectorPrivateClass._fnValidateOrigin + * @param {Object} oEvent + * Object of the receiveMessage event with for example origin, token and event name. + * @private + * @function + * @returns (boolean) Returns true or false if the domain origins and tokens of host and app match. + */ + var _fnValidateOrigin = function(oEvent) { + return (oEvent.origin === _sPosOrigin && oEvent.token === _sPosToken); + }; + + /** + * @summary A function to process messages received by the global window via postMessage. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.ConnectorPrivateClass._fnReceiveMessage + * @param {Object} oEvent + * Object of the receiveMessage event with for example origin, token and event name. + * @private + * @function + */ + var _fnReceiveMessage = function (oEvent) { + + // Do we trust the sender of this message? + if (_fnValidateOrigin(oEvent)) { + return; + } + + if (oEvent && typeof oEvent !== "undefined" + && oEvent.data && typeof oEvent.data !== "undefined" + && oEvent.data.fnCall && typeof oEvent.data.fnCall !== "undefined" + && oEvent.data.fnData && typeof oEvent.data.fnData !== "undefined") { + + var fn = window[oEvent.data.fnCall](oEvent.data.fnData); + if (typeof fn === 'function') { + fn(); + } + + } + }; + + // Setup an event listener that calls _fnReceiveMessage() when the window + // receives a new MessageEvent. + window.addEventListener('message', _fnReceiveMessage); + + window._fnHandshakeWithConnectorSuccess = function (result) { + oAppEnablementConnectorInstance._connector = result; + }; + + /** + * @summary This function will do a handshake between host and client app to make sure that everything was + * initialized and to identify the host type (Java or JavaScript). This function will be + * executed automatically if the class is accessed. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.ConnectorPrivateClass._fnDoHandshake + * @private + * @function + */ + var _fnDoHandshake = function() { + if (_sPosOrigin && typeof _sPosOrigin !== "undefined" && _sPosOrigin !== null) { + var oMessage = {}; + + oMessage.origin = window.location.protocol + "//" + window.location.hostname + ":" + window.location.port; + oMessage.token = _sAppToken; + oMessage.version = "mobilePOS_5.5.1"; + + oMessage.onResult = "_fnHandshakeWithConnectorSuccess"; + oMessage.onError = ""; + + oMessage.fnCall = "handshake"; + oMessage.fnData = "app"; + + window.parent.postMessage(oMessage, _sPosOrigin); + } + }; + + _fnDoHandshake(); + + return { + /** + * @summary This function will provide the string for the app token. This value is read-only for users + * of the API. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.ConnectorPrivateClass.getAppToken + * @function + */ + getAppToken: function () { + return _sAppToken; + }, + + /** + * @summary This function will provide the string for the host domain origin. This value is read-only for users + * of the API. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.ConnectorPrivateClass.getPosOrigin + * @function + */ + getPosOrigin: function () { + return _sPosOrigin; + } + }; + +})(); + + +/** + * @class + * @classdesc App Enablement Connector class for all general functionalities related to API itself like using + * postMessage to enable communication between host and app. + * @author mluzius + * @since 2.0.0 + * @public + * @name com.gk_software.gkr.app_enablement.Connector + */ +comGkSoftwareGkrAppEnablement.Connector = function () { + "use strict"; + + // Empty is default. In that case the omniPOS is used instead of mobilePOS. + this._connector = ""; +}; + + +/** + * @summary This function will trigger events for the App Enablement API to exchange data between host and client + * app and also decides whether to use the JavaScript (postMessage) or Java (via own protocol for JX browser) logic. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.Connector.invokeMethod + * @param {string} sCall + * Event name that should be called. + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} sData + * Stringified Object that is passed to the event. + * @function + */ +comGkSoftwareGkrAppEnablement.Connector.prototype.invokeMethod = function (sCall, sResultFunction, sErrorFunction, sData) { + + if (this._connector === "mobilePOS") { + // The following lines are used by JavaScript hosts like mobilePOS. + var oMessage = {}; + + oMessage.origin = window.location.protocol + "//" + window.location.hostname + ":" + window.location.port; + oMessage.token = comGkSoftwareGkrAppEnablement.ConnectorPrivateClass.getAppToken(); + oMessage.version = "mobilePOS_5.5.1"; + oMessage.onResult = sResultFunction; + oMessage.onError = sErrorFunction; + oMessage.fnCall = sCall; + oMessage.fnData = sData; + + window.parent.postMessage(oMessage, comGkSoftwareGkrAppEnablement.ConnectorPrivateClass.getPosOrigin()); + + } else if (typeof injected_by_POS__postWebAppRequest !== "undefined" && typeof injected_by_POS__postWebAppRequest.invoke !== "undefined") { + // The following lines are used by the Java POS to send and execute specific events of App Enablement via an own + // protocol to the JX browser. + + var request = "jmc://" + sCall; + var sep = "?"; + + if (sResultFunction && typeof sResultFunction !== "undefined") { + request += sep + "onResult=" + sResultFunction; + sep = "&"; + } + + if (sErrorFunction && typeof sErrorFunction !== "undefined") { + request += sep + "onError=" + sErrorFunction; + } + + if (sData && typeof sData !== "undefined") { + request += sep + "0=" + encodeURIComponent(sData); + } + + injected_by_POS__postWebAppRequest.invoke(request); + } +}; + +oAppEnablementConnectorInstance = new comGkSoftwareGkrAppEnablement.Connector(); \ No newline at end of file diff --git a/static/api/Common.js b/static/api/Common.js new file mode 100644 index 0000000..5ef6c11 --- /dev/null +++ b/static/api/Common.js @@ -0,0 +1,178 @@ +// Shorthand syntax to check if the namespace already exists, if not create an empty Object. +var comGkSoftwareGkrAppEnablementApi = comGkSoftwareGkrAppEnablementApi || {}; + +/*global oAppEnablementConnectorInstance*/ +/** + * @class + * @classdesc App Enablement class for all common used functionalities like registering and unregistering to events + * and to get the session context. + * @author mluzius + * @since 2.0.0 + * @public + * @name com.gk_software.gkr.app_enablement.api.Common + */ +comGkSoftwareGkrAppEnablementApi.Common = function () { + "use strict"; + this._prefix = "comGkSoftwareGkrAppEnablementApi.Common/"; +}; + +/** + * The internally returned object looks like the following example: + * { + * businessUnitGroupID: "100000000000000001", + * businessUnitID: "9090", // Equivalent to store ID + * isoCurrencyCode: "USD", + * storeLanguage: "en_US", + * tenantID: "004", + * userLanguage: "zh_CN", + * workstationID: "107" + * } + * @summary This function will provide the session context. For example currency, language. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Common.getSessionContext + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.getSessionContext = function (sResultFunction, sErrorFunction) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getSessionContext", sResultFunction, sErrorFunction); +}; + + +/** + * @summary This function will create a request object for the function 'registerListener'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Common.createRegisterListenerRequest + * @param {string} sEventName + * Name of the event that should be registered. For example: 'EVENT_TRANSACTION_UPDATED'. + * @param {string} sEventListenerName + * Name of the event listener function that should be executed when the event is fired. + * @param {boolean} bPassData + * Flag to indicate if the event listener function receives a data parameter. For example needed for + * Scan events to provide the barcodeFormat and the rawScanData. + * @function + * @returns (String) Returns a stringified Object for the registerListener request. + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.createRegisterListenerRequest = function (sEventName, sEventListenerName, bPassData) { + return JSON.stringify({ + "event": sEventName, + "listener": sEventListenerName, + "passData": bPassData + }); +}; + +/** + * @summary This function will register a listener for the given event. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Common.registerListener + * @param {string} oRegisterListenerRequest + * Necessary request object to register event listeners. Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * "event": "EVENT_TRANSACTION_UPDATED", + "listener": "returnEventNotification", + "passData": false || true + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.registerListener = function (sRegisterListenerRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "registerListener", "", "", sRegisterListenerRequest); +}; + + +/** + * @summary This function will create a request object for the function 'unregisterListener'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Common.createUnregisterListenerRequest + * @param {string} sEventName + * Name of the event that should be unregistered. For example: 'EVENT_TRANSACTION_UPDATED'. + * @param {string} sEventListenerName + * Name of the event listener function that should be unregistered. + * @function + * @returns (String) Returns a stringified Object for the unregisterListener request. + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.createUnregisterListenerRequest = function (sEventName, sEventListenerName) { + return JSON.stringify({ + "event": sEventName, + "listener": sEventListenerName + }); +}; + + +/** + * @summary This function will unregister a listener for the given event. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Common.unregisterListener + * @param {string} sUnregisterListenerRequest + * Name of the event that should be unregistered so that it can't be fired any longer. + * Data type is string but internal data type is Object. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.unregisterListener = function (sUnregisterListenerRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "unregisterListener", "", "", sUnregisterListenerRequest); +}; + + +/** + * @summary This function will close the app + * + * @author nmankel (Last modified by: nmankel) + * @since 2.1.0 + * @name com.gk_software.gkr.app_enablement.api.Common.closeBrowser + * @function + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.closeBrowser = function () { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "closeBrowser", "", ""); +}; + + +/** + * @summary This function will hide the app + * + * @author nmankel (Last modified by: nmankel) + * @since 2.1.0 + * @name com.gk_software.gkr.app_enablement.api.Common.hideBrowser + * @function + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.hideBrowser = function () { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "hideBrowser", "", ""); +}; + + +/** + * The internally returned object looks like the following example: + * { + * operatorID: "1", + * workerID: "1", + * salutation: "Herr", + * firstName: "Max", + * lastName: "Mustermann", + * rightsSet: ["S.00000000001.00","S.00000000001.01"], + * } + * @summary This function will provide operator data. For example operatorID, name, rights. + * + * @author nmankel (Last modified by: nmankel) + * @since 2.1.0 + * @name com.gk_software.gkr.app_enablement.api.Common.getOperatorData + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Common.prototype.getOperatorData = function (sResultFunction, sErrorFunction) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getOperatorData", sResultFunction, sErrorFunction); +}; \ No newline at end of file diff --git a/static/api/ExternalMasterdata.js b/static/api/ExternalMasterdata.js new file mode 100644 index 0000000..87bbb17 --- /dev/null +++ b/static/api/ExternalMasterdata.js @@ -0,0 +1,200 @@ +/*global oAppEnablementConnectorInstance*/ + +// Shorthand syntax to check if the namespace already exists, if not create an empty Object. +var comGkSoftwareGkrAppEnablementApi = comGkSoftwareGkrAppEnablementApi || {}; + +/** + * @class + * @classdesc App Enablement class for all functionalities related to external masterdata like searching, + * registering external items and to grab the image url from external webshops. + * @author mluzius + * @since 2.0.0 + * @public + * @name com.gk_software.gkr.app_enablement.api.ExternalMasterdata + */ +comGkSoftwareGkrAppEnablementApi.ExternalMasterdata = function () { + "use strict"; + this._prefix = "comGkSoftwareGkrAppEnablementApi.ExternalMasterdata/"; +}; + +/** + * @summary This function will create a request object for the function 'getItemByCriteria'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.ExternalMasterdata.createGetItemByCriteriaRequest + * @param {string} sItemID + * Item ID to get the item information for external items. + * @param {string} oContext + * Provides the session context. For example currency, language. Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * businessUnitGroupID: "100000000000000001", + * businessUnitID: "9090", // Equivalent to store ID + * isoCurrencyCode: "USD", + * storeLanguage: "en_US", + * tenantID: "004", + * userLanguage: "zh_CN", + * workstationID: "107" + * } + * @function + * @returns (String) Returns a stringified Object for the getItemByCriteria request. + */ +comGkSoftwareGkrAppEnablementApi.ExternalMasterdata.prototype.createGetItemByCriteriaRequest = function (sItemID, oContext) { + return JSON.stringify({ + "itemID": sItemID, + "language": (oContext && oContext.userLanguage) ? oContext.userLanguage : null, + "isoCurrencyCode": (oContext && oContext.isoCurrencyCode) ? oContext.isoCurrencyCode : null + }); +}; + +/** + * @summary This function will provide external item information for a given item ID. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.ExternalMasterdata.getItemByCriteria + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oGetItemByCriteriaRequest + * Stringified Object from the createGetItemByCriteriaRequest. + * Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * itemID: "030039", + * language: "en_US", + * isoCurrencyCode: "USD" + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.ExternalMasterdata.prototype.getItemByCriteria = function (sResultFunction, sErrorFunction, oGetItemByCriteriaRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getItemByCriteria", sResultFunction, sErrorFunction, oGetItemByCriteriaRequest); +}; + + +/** + * @summary This function will create a request object for the function 'getItemListBySearchCriteria'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.ExternalMasterdata.createGetItemByCriteriaRequest + * @param {string} sSearchQuery + * The string that is used to search external items. + * @param {number} iRecordCount + * Determines the maximum count of items that should be displayed per page. + * @param {string} oContext + * Provides the session context. For example currency, language. Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * businessUnitGroupID: "100000000000000001", + * businessUnitID: "9090", // Equivalent to store ID + * isoCurrencyCode: "USD", + * storeLanguage: "en_US", + * tenantID: "004", + * userLanguage: "zh_CN", + * workstationID: "107" + * } + * @function + * @returns (String) Returns a stringified Object for the getItemListBySearchCriteria request. + */ +comGkSoftwareGkrAppEnablementApi.ExternalMasterdata.prototype.createGetItemListBySearchCriteriaRequest = function (sSearchQuery, iRecordCount, oContext) { + + return JSON.stringify({ + "query": (sSearchQuery && sSearchQuery !== "") ? sSearchQuery : "", + "language": (oContext && oContext.userLanguage) ? oContext.userLanguage : null, + "isoCurrencyCode": (oContext && oContext.isoCurrencyCode) ? oContext.isoCurrencyCode : null, + "recordCount": iRecordCount + }); +}; + +/** + * @summary This function will provide a list of external items that you searched for. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.ExternalMasterdata.getItemListBySearchCriteria + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oGetItemListBySearchCriteriaRequest + * Stringified Object from the createGetItemListBySearchCriteriaRequest. + * Data type is string but internal data type is Object. + * The internally used object should look like the following example: + * { + * query: "camera", + * language: "en_US", + * isoCurrencyCode: "USD", + * recordCount: 60 + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.ExternalMasterdata.prototype.getItemListBySearchCriteria = function (sResultFunction, sErrorFunction, oGetItemListBySearchCriteriaRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getItemListBySearchCriteria", sResultFunction, sErrorFunction, oGetItemListBySearchCriteriaRequest); +}; + + +/** + * @summary This function will create a request object for the function 'getImageUrl'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.ExternalMasterdata.createGetExternalImageUrlRequest + * @param {string} sItemID + * The string that is used to search external items. + * @param {string} oContext + * Provides the session context. For example currency, language. Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * businessUnitGroupID: "100000000000000001", + * businessUnitID: "9090", // Equivalent to store ID + * isoCurrencyCode: "USD", + * storeLanguage: "en_US", + * tenantID: "004", + * userLanguage: "zh_CN", + * workstationID: "107" + * } + * @function + * @returns (String) Returns a stringified Object for the getImageUrl request. + */ +comGkSoftwareGkrAppEnablementApi.ExternalMasterdata.prototype.createGetExternalImageUrlRequest = function (sItemID, oContext) { + + return JSON.stringify({ + "itemID": sItemID, + "type": "item", + "language": (oContext && oContext.userLanguage) ? oContext.userLanguage : null, + "isoCurrencyCode": (oContext && oContext.isoCurrencyCode) ? oContext.isoCurrencyCode : null + }); +}; + +/** + * @summary This function will provide an image URL for external items. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.ExternalMasterdata.getImageUrl + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oGetExternalImageUrlRequest + * Stringified Object from the createGetExternalImageUrlRequest. + * Data type is string but internal data type is Object. + * The internally used object should look like the following example: + * { + * itemID: "030039", + * type: "item", + * language: "en_US", + * isoCurrencyCode: "USD" + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.ExternalMasterdata.prototype.getImageUrl = function (sResultFunction, sErrorFunction, oGetExternalImageUrlRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getImageUrl", sResultFunction, sErrorFunction, oGetExternalImageUrlRequest); +}; diff --git a/static/api/Masterdata.js b/static/api/Masterdata.js new file mode 100644 index 0000000..6bd4632 --- /dev/null +++ b/static/api/Masterdata.js @@ -0,0 +1,145 @@ +/*global oAppEnablementConnectorInstance*/ + +// Shorthand syntax to check if the namespace already exists, if not create an empty Object. +var comGkSoftwareGkrAppEnablementApi = comGkSoftwareGkrAppEnablementApi || {}; + +/** + * @class + * @classdesc App Enablement class for all functionalities related to GK masterdata like getting single item + * information, get item list by id list and to grab the image url from Digital Signage Server. + * @author mluzius + * @since 2.0.0 + * @public + * @name com.gk_software.gkr.app_enablement.api.Masterdata + */ +comGkSoftwareGkrAppEnablementApi.Masterdata = function () { + "use strict"; + this._prefix = "comGkSoftwareGkrAppEnablementApi.Masterdata/"; +}; + +/** + * @summary This function will create a request object for the function 'getItemDataByID'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Masterdata.createGetItemDataByIDRequest + * @param {string} sItemID + * Item ID to get the item information for GK masterdata items. + * @function + * @returns (String) Returns a stringified Object for the getItemDataByID request. + */ +comGkSoftwareGkrAppEnablementApi.Masterdata.prototype.createGetItemDataByIDRequest = function (sItemID) { + return JSON.stringify({ + "itemID": sItemID + }); +}; + + +/** + * @summary This function will provide GK masterdata item information for a given item ID. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Masterdata.getItemDataByID + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oGetItemDataByIDRequest + * Stringified Object from the createGetItemDataByIDRequest. + * Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * itemID: "030039" + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.Masterdata.prototype.getItemDataByID = function (sResultFunction, sErrorFunction, oGetItemDataByIDRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getItemDataByID", sResultFunction, sErrorFunction, oGetItemDataByIDRequest); +}; + + +/** + * @summary This function will create a request object for the function 'getItemDataListByIDList'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Masterdata.createGetItemDataListByIDListRequest + * @param {Array} aItemIDList + * Array of item IDs to get the item information for GK masterdata items. + * @function + * @returns (String) Returns a stringified Object for the getItemDataListByIDList request. + */ +comGkSoftwareGkrAppEnablementApi.Masterdata.prototype.createGetItemDataListByIDListRequest = function (aItemIDList) { + return JSON.stringify({ + "itemIDList": aItemIDList + }); +}; + +/** + * @summary This function will provide an array of GK masterdata items with their information for a given item ID list. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Masterdata.getItemDataListByIDList + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oGetItemDataListByIDListRequest + * Stringified Object from the createGetItemDataListByIDListRequest. + * Data type is string but internal data type is Object. + * The internally used object should look like the following example: + * { + * itemIDList: ["03039", "65005", "65007"] + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.Masterdata.prototype.getItemDataListByIDList = function (sResultFunction, sErrorFunction, oGetItemDataListByIDListRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getItemDataListByIDList", sResultFunction, sErrorFunction, oGetItemDataListByIDListRequest); +}; + + +/** + * @summary This function will create a request object for the function 'getImageUrl'. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Masterdata.createGetImageUrlRequest + * @param {string} sItemID + * Item ID to get the item image url for a GK masterdata item. + * @function + * @returns (String) Returns a stringified Object for the getImageUrl request. + */ +comGkSoftwareGkrAppEnablementApi.Masterdata.prototype.createGetImageUrlRequest = function (sItemID) { + return JSON.stringify({ + "itemID": sItemID, + "type": "item" + }); +}; + +/** + * @summary This function will provide an image url via an item ID and the Digital Signage Server. + * + * @author mluzius (Last modified by: mluzius) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Masterdata.getImageUrl + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oCreateGetImageUrlRequest + * Stringified Object from the createGetImageUrlRequest. + * Data type is string but internal data type is Object. + * The internally used object should look like the following example: + * { + * itemID: "03039", + * type: "item" + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.Masterdata.prototype.getImageUrl = function (sResultFunction, sErrorFunction, oCreateGetImageUrlRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getImageUrl", sResultFunction, sErrorFunction, oCreateGetImageUrlRequest); +}; + diff --git a/static/api/Pos.js b/static/api/Pos.js new file mode 100644 index 0000000..a11bcc4 --- /dev/null +++ b/static/api/Pos.js @@ -0,0 +1,1061 @@ +// TODO Create object documentation. +// Working on Mobile POS, and Omni POS. + +/*global oAppEnablementConnectorInstance*/ + +// Shorthand syntax to check if the namespace already exists, if not create an empty Object. +var comGkSoftwareGkrAppEnablementApi = comGkSoftwareGkrAppEnablementApi || {}; + +/** + * @class + * @classdesc App Enablement class for all functionalities related to GK POS like getting single item + * information, registering items, getting the current transaction + * @author sschreiner + * @since 2.0.0 + * @public + * @name com.gk_software.gkr.app_enablement.api.Pos + */ +comGkSoftwareGkrAppEnablementApi.Pos = function () { + "use strict"; + this._prefix = "comGkSoftwareGkrAppEnablementApi.Pos/"; +}; + +/** + * @summary This function will create a request object for the function 'getPOSItemInformationByID'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createGetPOSItemInformationByIDRequest + * @param {string} sItemID + * Item ID to get the item information for GK POS items. + * @function + * @returns (String) Returns a stringifi+ed Object for the getPOSItemInformationByID request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createGetPOSItemInformationByIDRequest = function (sItemID) { + + return JSON.stringify({ + "itemID": sItemID + }); +}; + + +/** + * @summary This function will provide GK Pos item information for a given item ID. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.getPOSItemInformationByID + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oGetPOSItemInformationByIDRequest + * stringified object from the createGetPOSItemInformationByIDRequest. + * Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * itemID: "030039" + * } + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.getPOSItemInformationByID = function (sResultFunction, sErrorFunction, oGetPOSItemInformationByIDRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getPOSItemInformationByID", sResultFunction, sErrorFunction, oGetPOSItemInformationByIDRequest); +}; + +/** + * @summary *This function contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * This function will create a request object for the function 'registerLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createRegisterLineItemRequest + * @param {string} sItemID + * Item ID to get the item information for GK POS items. + * @param {string} oContext + * Provides the session context. For example currency, language. Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * businessUnitGroupID: "100000000000000001", + * businessUnitID: "9090", // Equivalent to store ID + * isoCurrencyCode: "USD", + * storeLanguage: "en_US", + * tenantID: "004", + * userLanguage: "zh_CN", + * workstationID: "107" + * } + * @param {integer} iQuantity + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {integer} iActualUnitPrice + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {string} sCustomerOrderID + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {string} sCustomerOrderSequenceNumber + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {string} sSalesOrderTypeCode + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {string} sSalesOrderDeliveryTypeCode + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {string} sRequestedDeliveryDate + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {string} sItemType + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {Object[]} aRetailPriceModifierList + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {Object[]} aLineItemExtensionList + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @param {Object[]} aPrintAdditionalLineItemTextLineList + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. + * @function + * @returns (String) Returns a stringified object for the registerLineItem request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createRegisterLineItemRequest = function (sItemID, oContext, iQuantity, iActualUnitPrice, + sCustomerOrderID, sCustomerOrderSequenceNumber, sSalesOrderTypeCode, + sSalesOrderDeliveryTypeCode, sRequestedDeliveryDate, sItemType, aRetailPriceModifierList, aLineItemExtensionList, aPrintAdditionalLineItemTextLineList) { + + return JSON.stringify({ + "itemID": sItemID, + "language": (oContext && oContext.userLanguage) ? oContext.userLanguage : null, + "isoCurrencyCode": (oContext && oContext.isoCurrencyCode) ? oContext.isoCurrencyCode : null, + "quantity": iQuantity, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "actualUnitPrice":iActualUnitPrice, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "customerOrderID": sCustomerOrderID, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "customerOrderSequenceNumber": sCustomerOrderSequenceNumber, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "salesOrderTypeCode": sSalesOrderTypeCode, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "salesOrderDeliveryTypeCode": sSalesOrderDeliveryTypeCode, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "requestedDeliveryDate": sRequestedDeliveryDate, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "itemType": sItemType, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "retailPriceModifierList": aRetailPriceModifierList, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "lineItemExtensionList": aLineItemExtensionList, // This parameter is a non-recommended interface and is potentially subject to change in future releases. + "printAdditionalLineItemTextLineList": aPrintAdditionalLineItemTextLineList // This parameter is a non-recommended interface and is potentially subject to change in future releases. + }); +}; + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerLineItem' and 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createPrintAdditionalLineItemTextLineObject + * @param {string} sText + * @param {string} sSortOrder + * @param {string} sStyleID + * @returns (String) Returns a stringified object of PrintAdditionalLineItemTextLine. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createPrintAdditionalLineItemTextLineObject = function (sText, sSortOrder, sStyleID) { + + return { + "text" : sText, + "sortOrder" : sSortOrder, + "styleID" : sStyleID + }; +}; + + + +/** + * @summary *This function contains parameters that are a non-recommended interface and is therefore potentially subject to change in future releases. + * This function will register a GK Pos item in the current transaction of the Pos + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.registerLineItem + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oRegisterLineItemRequest + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. stringified object from the createRegisterCustomerRequest. + * stringified object from the createRegisterLineItemRequest. + * Data type is string but internal + * data type is Object. + * The internally used object should look like the following example: + * { + * itemID: "030039", + * language: "en_US", + * isoCurrencyCode: "USD", + * quantity: 1 + * } + * + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.registerLineItem = function (sResultFunction, sErrorFunction, oRegisterLineItemRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "registerLineItem", sResultFunction, sErrorFunction, oRegisterLineItemRequest); +}; + + +/* + * + * + * + * + */ + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createRegisterExternalLineItemRequest + * @param {string} sPosItemIDsItemID + * @param {string} sPosDepartmentID + * @param {string} sUnitOfMeasureCode + * @param {string} sItemType + * @param {string} sRegularUnitPrice + * @param {string} sActualUnitPrice + * @param {integer} iQuantity + * @param {string} sUnits + * @param {string} sQuantityInputMethod + * @param {string} sLength + * @param {string} sWidth + * @param {string} sHeight + * @param {string} sReceiptText + * @param {string} sReceiptDescription + * @param {boolean} bWicFlag + * @param {boolean} bAllowFoodStampFlag + * @param {string} sRegistrationNumber + * @param {boolean} bDiscountFlag + * @param {boolean} bFrequentShopperPointsEligibilityFlag + * @param {string} sDiscountTypeCode + * @param {string} sPriceChangeTypeCode + * @param {string} sPriceTypeCode + * @param {boolean} bNotConsideredByLoyaltyEngineFlag + * @param {string} sMerchandiseHierarchyGroupName + * @param {string} sMerchandiseHierarchyGroupDescription + * @param {string} sItemClassCode + * @param {boolean} bProhibitTaxExemptFlag + * @param {boolean} bProhibitReturnFlag + * @param {string} sWarrantyDuration + * @param {string} sDepositTypeCode + * @param {string} sTaxExemptCode + * @param {string} sMainPOSItemID + * @param {string} sMainMerchandiseHierarchyGroupIDQualifier + * @param {string} sMainMerchandiseHierarchyGroupID + * @param {string} sTaxGroupID + * @param {string} sTareCount, + * @param {Object[]} aSaleReturnLineItemCharacteristicList + * @param {Object[]} aSaleReturnLineItemMerchandiseHierarchyGroupList + * @param {Object[]} aRetailTransactionLineItemI18NTextList + * @param {string} sSerialNumber, + * @param {object} oSaleReturnLineItemSalesOrderObject + * @param {string} sReasonCode + * @param {string} sReasonCodeGroupCode + * @param {string} sReasonDescription, + * @param {object} oRetailTransactionLineItemAdditionalParameterList + * @param {Object[]} aRetailPriceModifierList + * @param {Object[]} aLineItemExtensionList + * @param {Object[]} aPrintAdditionalLineItemTextLineList + * @returns (String) Returns a stringified object of RegisterExternalLineItemRequest. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createRegisterExternalLineItemRequest = function (sPosItemID, sItemID, sPosDepartmentID, sUnitOfMeasureCode, sItemType, sRegularUnitPrice, sActualUnitPrice, iQuantity, sUnits, sQuantityInputMethod, sLength, sWidth, sHeight, sReceiptText, sReceiptDescription, bWicFlag , bAllowFoodStampFlag , sRegistrationNumber, bDiscountFlag, bFrequentShopperPointsEligibilityFlag, sDiscountTypeCode, sPriceChangeTypeCode, sPriceTypeCode, bNotConsideredByLoyaltyEngineFlag, sMerchandiseHierarchyGroupName, sMerchandiseHierarchyGroupDescription, sItemClassCode , bProhibitTaxExemptFlag, bProhibitReturnFlag, sWarrantyDuration, sDepositTypeCode, sTaxExemptCode, sMainPOSItemID, sMainMerchandiseHierarchyGroupIDQualifier, sMainMerchandiseHierarchyGroupID, sTaxGroupID, sTareCount, + aSaleReturnLineItemCharacteristicList, aSaleReturnLineItemMerchandiseHierarchyGroupList, aRetailTransactionLineItemI18NTextList, sSerialNumber, + oSaleReturnLineItemSalesOrderObject, sReasonCode, sReasonCodeGroupCode, sReasonDescription, + oRetailTransactionLineItemAdditionalParameterList, aRetailPriceModifierList, aLineItemExtensionList, aPrintAdditionalLineItemTextLineList) { + return JSON.stringify({ + "posItemID": sPosItemID, + "itemID": sItemID, + "posDepartmentID": sPosDepartmentID, + "unitOfMeasureCode": sUnitOfMeasureCode, + "itemType": sItemType, + "regularUnitPrice": sRegularUnitPrice, + "actualUnitPrice": sActualUnitPrice, + "quantity": iQuantity, + "units": sUnits, + "quantityInputMethod": sQuantityInputMethod, + "length": sLength, + "width": sWidth, + "height": sHeight, + "receiptText": sReceiptText, + "receiptDescription": sReceiptDescription, + "wicFlag": bWicFlag, + "allowFoodStampFlag": bAllowFoodStampFlag, + "registrationNumber": sRegistrationNumber, + "discountFlag": bDiscountFlag, + "frequentShopperPointsEligibilityFlag": bFrequentShopperPointsEligibilityFlag, + "discountTypeCode": sDiscountTypeCode, + "priceChangeTypeCode": sPriceChangeTypeCode, + "priceTypeCode": sPriceTypeCode, + "notConsideredByLoyaltyEngineFlag": bNotConsideredByLoyaltyEngineFlag, + "merchandiseHierarchyGroupName": sMerchandiseHierarchyGroupName, + "merchandiseHierarchyGroupDescription": sMerchandiseHierarchyGroupDescription, + "itemClassCode": sItemClassCode , + "prohibitTaxExemptFlag": bProhibitTaxExemptFlag, + "prohibitReturnFlag": bProhibitReturnFlag, + "warrantyDuration": sWarrantyDuration, + "depositTypeCode": sDepositTypeCode, + "taxExemptCode": sTaxExemptCode, + "mainPOSItemID": sMainPOSItemID, + "mainMerchandiseHierarchyGroupIDQualifier": sMainMerchandiseHierarchyGroupIDQualifier, + "mainMerchandiseHierarchyGroupID": sMainMerchandiseHierarchyGroupID, + "taxGroupID": sTaxGroupID, + "tareCount": sTareCount, + + "saleReturnLineItemCharacteristicList": aSaleReturnLineItemCharacteristicList, + + "saleReturnLineItemMerchandiseHierarchyGroupList": aSaleReturnLineItemMerchandiseHierarchyGroupList, + + "retailTransactionLineItemI18NTextList": aRetailTransactionLineItemI18NTextList, + + + "serializedUnitModifer":{ + "serialNumber": sSerialNumber + }, + + "saleReturnLineItemSalesOrder": oSaleReturnLineItemSalesOrderObject, + + "reasonCode": sReasonCode, + "reasonCodeGroupCode": sReasonCodeGroupCode, + "reasonDescription": sReasonDescription, + + "retailTransactionLineItemAdditionalParameterList": oRetailTransactionLineItemAdditionalParameterList, + + "retailPriceModifierList": aRetailPriceModifierList, + + "lineItemExtensionList": aLineItemExtensionList, + + "printAdditionalLineItemTextLineList": aPrintAdditionalLineItemTextLineList + + }); +}; + + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createSaleReturnLineItemCharacteristicObject + * @param {string} sCharacteristicID + * @param {string} sCharacteristicValueID + * @param {string} sMerchandiseHierarchyGroupID + * @returns (String) Returns a stringified object of SaleReturnLineItemMerchandiseHierarchyGroup. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createSaleReturnLineItemCharacteristicObject = function (sCharacteristicID, sCharacteristicValueID, sCharacteristicValueName ){ + + return { + "characteristicID": sCharacteristicID, + "characteristicValueID": sCharacteristicValueID, + "characteristicValueName": sCharacteristicValueName + }; +}; + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createSaleReturnLineItemMerchandiseHierarchyGroupObject + * @param {string} sMerchandiseHierarchyGroupIDQualifier + * @param {string} sMerchandiseHierarchyGroupID + * @returns (String) Returns a stringified object of SaleReturnLineItemMerchandiseHierarchyGroup. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createSaleReturnLineItemMerchandiseHierarchyGroupObject = function (sMerchandiseHierarchyGroupIDQualifier, sMerchandiseHierarchyGroupID ){ + + return { + "merchandiseHierarchyGroupIDQualifier": sMerchandiseHierarchyGroupIDQualifier, + "merchandiseHierarchyGroupID": sMerchandiseHierarchyGroupID + } +}; + + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createRetailTransactionLineItemI18NTextObject + * @param {integer} iTextSequenceNumber + * @param {string} sLanguageID + * @param {string} sCategory + * @param {string} sText + * @param {boolean} bPictureFlag + * @returns (String) Returns a stringified object of RetailTransactionLineItemI18NText. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createRetailTransactionLineItemI18NTextObject = function (iTextSequenceNumber, sLanguageID, sCategory, sText, bPictureFlag){ + + return { + "textSequenceNumber": iTextSequenceNumber, + "languageID": sLanguageID, + "category": sCategory, + "text": sText, + "pictureFlag": bPictureFlag + }; +}; + + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createSaleReturnLineItemSalesOrderObject + * @param {string} sExternalCustomerOrderID + * @param {string} sCustomerOrderSequenceNumber + * @param {string} sSalesOrderTypeCode + * @param {string} sSalesOrderDeliveryTypeCode + * @param {string} sRequestedDeliveryDate + * @returns (String) Returns a stringified object of SaleReturnLineItemSalesOrder. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createSaleReturnLineItemSalesOrderObject = function ( sExternalCustomerOrderID,sCustomerOrderSequenceNumber, + sSalesOrderTypeCode, sSalesOrderDeliveryTypeCode,sRequestedDeliveryDate) { + + return { + "externalCustomerOrderID": sExternalCustomerOrderID, + "customerOrderSequenceNumber": sCustomerOrderSequenceNumber, + "salesOrderTypeCode": sSalesOrderTypeCode, + "salesOrderDeliveryTypeCode": sSalesOrderDeliveryTypeCode, + "requestedDeliveryDate": sRequestedDeliveryDate + }; +}; + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createRetailTransactionLineItemAdditionalParameterObject + * @param {string} sExternalParameterID + * @param {string} sParameterName + * @param {string} sParameterValue + * @returns (String) Returns a stringified object of RetailTransactionLineItemAdditionalParameter. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createRetailTransactionLineItemAdditionalParameterObject = function (sExternalParameterID, sParameterName, sParameterValue){ + + return { + "externalParameterID": sExternalParameterID, + "parameterName": sParameterName, + "parameterValue": sParameterValue + }; +}; + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createRetailPriceModifierObject + * @param {integer} iRetailPriceModifierSequenceNumber + * @param {string} sPercent + * @param {string} sAmount + * @param {string} sExtendedAmountBeforeModification + * @param {string} sExtendedAmountAfterModification + * @param {string} sAppliedQuantity + * @param {integer} iTriggerSequenceNumber + * @param {string} sExtraAmount + * @param {string} sRoundingAmount + * @param {string} sCalculationBaseAmount + * @param {object} oRetailTransactionPriceDerivationRule + * @param {Object[]} aSaleReturnLineItemPromotionTriggerList + * @returns (String) Returns a stringified object of RetailPriceModifier. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createRetailPriceModifierObject = function (iRetailPriceModifierSequenceNumber, sPercent, sAmount, sExtendedAmountBeforeModification, sExtendedAmountAfterModification, sAppliedQuantity, iTriggerSequenceNumber, sExtraAmount, sRoundingAmount, sCalculationBaseAmount, oRetailTransactionPriceDerivationRule, aSaleReturnLineItemPromotionTriggerList){ + + return { + "retailPriceModifierSequenceNumber": iRetailPriceModifierSequenceNumber, + "percent": sPercent, + "amount": sAmount, + "extendedAmountBeforeModification": sExtendedAmountBeforeModification, + "extendedAmountAfterModification": sExtendedAmountAfterModification, + "appliedQuantity": sAppliedQuantity, + "triggerSequenceNumber": iTriggerSequenceNumber, + "extraAmount": sExtraAmount, + "roundingAmount": sRoundingAmount, + "calculationBaseAmount": sCalculationBaseAmount, + "retailTransactionPriceDerivationRule": oRetailTransactionPriceDerivationRule, + "saleReturnLineItemPromotionTriggerList": aSaleReturnLineItemPromotionTriggerList + }; +}; + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createRetailTransactionPriceDerivationRuleObject + * @param {integer} iPromotionID + * @param {integer} iPriceDerivationRuleID + * @param {integer} iPriceDerivationRuleEligibilityID + * @param {string} sPromotionDescription + * @param {string} sReceiptPrinterName + * @param {integer} iPromotionPriceDerivationRuleSequence + * @param {integer} iPromotionPriceDerivationRuleResolution + * @param {string} sPromotionPriceDerivationRuleTypeCode + * @param {string} sPriceModificationMethodCode + * @param {string} sPriceDerivationRuleDescription + * @param {string} sPromotionOriginatorTypeCode + * @param {string} sExternalPromotionID + * @param {string} sExternalPriceDerivationRuleID + * @param {string} sTriggerQuantity + * @param {string} sGiftCertificateExpirationDate + * @param {string} sDiscountMethodCode + * @param {boolean} bProhibitPrintFlag + * @param {string} sTenderTypeCode + * @param {string} sPromotionTypeName + * @param {string} sCalculationBase + * @param {boolean} bNoEffectOnSubsequentPriceDerivationRulesFlag + * @param {boolean} bProhibitTransactionRelatedPriceDerivationRulesFlag + * @param {string} sCouponPrintoutID + * @param {string} sCouponPrintoutRule + * @param {string} sCouponPrintoutText + * @param {boolean} bExclusiveFlag + * @param {boolean} bConsiderPreviousPriceDerivationRulesFlag + * @param {string} sConcurrenceControlVector + * @param {integer} iAppliedCount + * @param {integer} iPrintoutValidityPeriod + * @returns (String) Returns a stringified object of RetailTransactionPriceDerivationRule. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createRetailTransactionPriceDerivationRuleObject = function (iPromotionID, iPriceDerivationRuleID, iPriceDerivationRuleEligibilityID, sPromotionDescription, sReceiptPrinterName, iPromotionPriceDerivationRuleSequence, iPromotionPriceDerivationRuleResolution, sPromotionPriceDerivationRuleTypeCode, sPriceModificationMethodCode, sPriceDerivationRuleDescription, sPromotionOriginatorTypeCode, sExternalPromotionID, sExternalPriceDerivationRuleID, sTriggerQuantity, sGiftCertificateExpirationDate, sDiscountMethodCode, bProhibitPrintFlag, sTenderTypeCode, sPromotionTypeName, sCalculationBase, bNoEffectOnSubsequentPriceDerivationRulesFlag, bProhibitTransactionRelatedPriceDerivationRulesFlag, sCouponPrintoutID, sCouponPrintoutRule, sCouponPrintoutText, bExclusiveFlag, bConsiderPreviousPriceDerivationRulesFlag, sConcurrenceControlVector, iAppliedCount, iPrintoutValidityPeriod){ + + return { + "promotionID": iPromotionID, + "priceDerivationRuleID": iPriceDerivationRuleID, + "priceDerivationRuleEligibilityID": iPriceDerivationRuleEligibilityID, + "promotionDescription": sPromotionDescription, + "receiptPrinterName": sReceiptPrinterName, + "promotionPriceDerivationRuleSequence": iPromotionPriceDerivationRuleSequence, + "promotionPriceDerivationRuleResolution": iPromotionPriceDerivationRuleResolution, + "promotionPriceDerivationRuleTypeCode": sPromotionPriceDerivationRuleTypeCode, + "priceModificationMethodCode": sPriceModificationMethodCode, + "priceDerivationRuleDescription": sPriceDerivationRuleDescription, + "promotionOriginatorTypeCode": sPromotionOriginatorTypeCode, + "externalPromotionID": sExternalPromotionID, + "externalPriceDerivationRuleID": sExternalPriceDerivationRuleID, + "triggerQuantity": sTriggerQuantity, + "giftCertificateExpirationDate": sGiftCertificateExpirationDate, + "discountMethodCode": sDiscountMethodCode, + "prohibitPrintFlag": bProhibitPrintFlag, + "tenderTypeCode": sTenderTypeCode, + "promotionTypeName": sPromotionTypeName, + "calculationBase": sCalculationBase, + "noEffectOnSubsequentPriceDerivationRulesFlag": bNoEffectOnSubsequentPriceDerivationRulesFlag, + "prohibitTransactionRelatedPriceDerivationRulesFlag": bProhibitTransactionRelatedPriceDerivationRulesFlag, + "couponPrintoutID": sCouponPrintoutID, + "couponPrintoutRule": sCouponPrintoutRule, + "couponPrintoutText": sCouponPrintoutText, + "exclusiveFlag": bExclusiveFlag, + "concurrenceControlVector": sConcurrenceControlVector, + "appliedCount": iAppliedCount, + "printoutValidityPeriod": iPrintoutValidityPeriod + }; +}; + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createSaleReturnLineItemPromotionTriggerObject + * @param {integer} iTriggerSequenceNumber + * @param {string} sTriggerType + * @param {string} sTriggerValue + * @param {string} sPrivilegeType + * @param {string} sPrivilegeValue + * @param {string} sReasonCode + * @param {string} sReasonDescription + * @param {integer} iTriggerSequenceAddend + * @returns (String) Returns a stringified object of SaleReturnLineItemPromotionTrigger. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createSaleReturnLineItemPromotionTriggerObject = function (iTriggerSequenceNumber, sTriggerType, sTriggerValue, sPrivilegeType, sPrivilegeValue, sReasonCode, sReasonDescription, iTriggerSequenceAddend){ + + return { + "triggerSequenceNumber": iTriggerSequenceNumber, + "triggerType": sTriggerType, + "triggerValue": sTriggerValue, + "privilegeType": sPrivilegeType, + "privilegeValue": sPrivilegeValue, + "reasonCode": sReasonCode, + "reasonDescription": sReasonDescription, + "triggerSequenceAddend": iTriggerSequenceAddend + }; +}; + + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a sub-request object for the function 'registerExternalLineItem'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createLineItemExtensionObject + * @param {string} iExtensionKey + * Key of the extension data + * @param {string} sExtensionValue + * Value of the extension data + * @returns (String) Returns a stringified object of LineItemExtension. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createLineItemExtensionObject = function (sExtensionKey, sExtensionValue){ + return { + "extensionKey": sExtensionKey, + "extensionValue": sExtensionValue + }; +}; + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. The function + * allows to propagate an ExternalRegisterLineItemRequest directly into POS, while specifying directly all relevant item data, + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.registerExternalLineItem + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oRegisterExternalLineItemRequest + * stringified object from the createRegisterExternalLineItemRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.registerExternalLineItem = function (sResultFunction, sErrorFunction, oRegisterExternalLineItemRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "registerExternalLineItem", sResultFunction, sErrorFunction, oRegisterExternalLineItemRequest); +}; + + + + +/* + * + * + */ + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a request object for the function 'setAdditionalTransactionReport' + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createAddAdditionalTransactionReportRequest + * @param {string} sReportIdentification + * @param {Object[]} aPrintAdditionalLineItemTextLineList + * @returns (String) Returns a stringified object of AddAdditionalTransactionReportRequest. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createAddAdditionalTransactionReportRequest = function (sReportIdentification, aPrintAdditionalLineItemTextLineList) { + + return JSON.stringify({ + "reportIdentification" :sReportIdentification, + "printAdditionalLineItemTextLineList" : aPrintAdditionalLineItemTextLineList + }); +}; + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. The function + * allows to set an additional report in the transaction for printing. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.addAdditionalTransactionReport + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oAdditionalTransactionReportRequest + * stringified object from the createAddAdditionalTransactionReportRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.addAdditionalTransactionReport = function (sResultFunction, sErrorFunction, oAdditionalTransactionReportRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "addAdditionalTransactionReport", sResultFunction, sErrorFunction, oAdditionalTransactionReportRequest); +}; + +/** + * @summary This function will return the current GK Pos transaction + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.getCurrentTransaction + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.getCurrentTransaction = function (sResultFunction, sErrorFunction) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getCurrentTransaction", sResultFunction, sErrorFunction); +}; + +/** + * @summary This function will return the last not voided transaction. + * + * @author mfedorenko (Last modified by: mfedorenko) + * @since 5.6.1 + * @name com.gk_software.gkr.app_enablement.api.Pos.getLastNotVoidedTransaction + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.getLastNotVoidedTransaction = function (sResultFunction, sErrorFunction) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getLastNotVoidedTransaction", sResultFunction, sErrorFunction); +}; + +/** + * @summary This function will print the given transaction. + * + * @author mfedorenko (Last modified by: mfedorenko) + * @since 5.6.1 + * @name com.gk_software.gkr.app_enablement.api.Pos.printReport + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {Object[]} the transaction to print + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.printReport = function(sResultFunction, sErrorFunction, oTransaction) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "printReport", sResultFunction, sErrorFunction, oTransaction); +}; + +/** + * @summary *This function contains parameters that are a non-recommended interface and is therefore potentially subject to change in future releases. + * This function will create a request object for the function 'cancelCurrentTransaction'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @deprecated since version 2.1.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createCancelCurrentTransactionRequest + * @param {boolean} bReasonCodeRequired + * *This parameter is a non-recommended interface and is potentially subject to change in future releases. Is a reason code required + * @param {string} sReasonCode + * *This parameter is a non-recommended interface and is potentially subject to change in future releases. The reason code + * @param {string} sReasonDescription + * *This parameter is a non-recommended interface and is potentially subject to change in future releases. The reason description + * @returns (String) Returns a stringified object for the cancelCurrentTransaction request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createCancelCurrentTransactionRequest = function (bReasonCodeRequired, sReasonCode, sReasonDescription) { + + return { + "reasonCode": sReasonCode, + "reasonDescription": sReasonDescription + }; +}; + +/** + * @summary *This function contains parameters that are a non-recommended interface and is therefore potentially subject to change in future releases. + * This function will create a request object for the function 'cancelCurrentTransaction'. + * + * @author mwessel (Last modified by: mwessel) + * @since 2.1.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createCancelCurrentTransactionRequest + * @param {string} sReasonCode + * *This parameter is a non-recommended interface and is potentially subject to change in future releases. The reason code + * @param {string} sReasonDescription + * *This parameter is a non-recommended interface and is potentially subject to change in future releases. The reason description + * @returns (String) Returns a stringified object for the cancelCurrentTransaction request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createCancelCurrentTransactionRequest = function (sReasonCode, sReasonDescription) { + + return { + "reasonCode": sReasonCode, + "reasonDescription": sReasonDescription + }; +}; + + +/** + * @summary *This function contains parameters that are a non-recommended interface and is therefore potentially subject to change in future releases. + * This function allows to cancel the current transaction in the POS. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.cancelCurrentTransaction + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oCancelCurrentTransactionRequest + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. stringified object from the createCancelCurrentTransactionRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.cancelCurrentTransaction = function (sResultFunction, sErrorFunction, oCancelCurrentTransactionRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "cancelCurrentTransaction", sResultFunction, sErrorFunction, oCancelCurrentTransactionRequest); +}; + +/* + * + * + * + * + */ + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a request object for the function 'addTransactionExtension'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createAddTransactionExtensionRequest + * @param {string} sExtensionKey + * @param {string} sExtensionValue + * @returns (String) Returns a stringified object for the addTransactionExtension request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createAddTransactionExtensionRequest = function (sExtensionKey, sExtensionValue) { + + return { + "extensionKey": sExtensionKey, + "extensionValue": sExtensionValue + }; +}; + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. The function + * allows to create extension data in the transaction of the POS, + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.addTransactionExtension + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oAddTransactionExtensionRequest + * stringified object from the createAddTransactionExtensionRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.addTransactionExtension = function (sResultFunction, sErrorFunction, oAddTransactionExtensionRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "addTransactionExtension", sResultFunction, sErrorFunction, oAddTransactionExtensionRequest); +}; + + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a request object for the function 'updateTransactionExtension'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createUpdateTransactionExtensionRequest + * @param {string} sExtensionKey + * @param {string} sExtensionValue + * @returns (String) Returns a stringified object for the updateTransactionExtension request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createUpdateTransactionExtensionRequest = function (sExtensionKey, sExtensionValue) { + + return { + "extensionKey": sExtensionKey, + "extensionValue": sExtensionValue + }; +}; + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. The function + * allows to update extension data in the transaction of the POS, + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.updateTransactionExtension + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oUpdateTransactionExtensionRequest + * stringified object from the createUpdateTransactionExtensionRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.updateTransactionExtension = function (sResultFunction, sErrorFunction, oUpdateTransactionExtensionRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "updateTransactionExtension", sResultFunction, sErrorFunction, oUpdateTransactionExtensionRequest); +}; + + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. + * This function will create a request object for the function 'deleteTransactionExtension'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createDeleteTransactionExtensionRequest + * @param {string} sExtensionKey + * @returns (String) Returns a stringified object for the deleteTransactionExtension request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createDeleteTransactionExtensionRequest = function (sExtensionKey) { + + return { + "extensionKey": sExtensionKey + }; +}; + + +/** + * @summary *This function is a non-recommended interface and is potentially subject to change in future releases. The function + * allows to delete extension data in the transaction of the POS, + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.deleteTransactionExtension + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oDeleteTransactionExtensionRequest + * stringified object from the createDeleteTransactionExtensionRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.deleteTransactionExtension = function (sResultFunction, sErrorFunction, oDeleteTransactionExtensionRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "deleteTransactionExtension", sResultFunction, sErrorFunction, oDeleteTransactionExtensionRequest); +}; + + +/* + * + * + */ + + + +/** + * @summary This function will return the current customer list of the current GK Pos transaction + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.getCurrentTransaction + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.getCurrentCustomerList = function (sResultFunction, sErrorFunction) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "getCurrentCustomerList", sResultFunction, sErrorFunction); +}; + + + +/** + * @summary *This function contains parameters that are a non-recommended interface and is therefore potentially subject to change in future releases. + * This function will create a request object for the function 'registerCustomer'. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createRegisterCustomerRequest + * @param {string} sCustomerId + * ID of the customer to register + * @param {string} sCustomerServiceTypeCode + * *This parameter is a non-recommended interface and is potentially subject to change in future releases. The customer service type code + * @param {string} sPreferredReceiptPrintoutTypeCode + * *This parameter is a non-recommended interface and is potentially subject to change in future releases. The preferred receipt printout type code. + * @returns (String) Returns a stringified object for the registerLineItem request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createRegisterCustomerRequest = function (sCustomerId, sCustomerServiceTypeCode, sPreferredReceiptPrintoutTypeCode) { + + return { + "customerId": sCustomerId, + "customerServiceTypeCode": sCustomerServiceTypeCode, // *This parameter is a non-recommended interface and is potentially subject to change in future releases. + "preferredReceiptPrintoutTypeCode": sPreferredReceiptPrintoutTypeCode // *This parameter is a non-recommended interface and is potentially subject to change in future releases. + + }; +}; + + + +/** + * @summary *This function contains parameters that are a non-recommended interface and is therefore potentially subject to change in future releases. + * This function allows to register a customer within the current transaction in the POS. + * + * @author sschreiner (Last modified by: sschreiner) + * @since 2.0.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.registerCustomer + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oRegisterCustomerRequest + * *This object parameter contains parameter that are a non-recommended interface and is therefore potentially subject to change in future releases. This object is a stringified object from the createRegisterCustomerRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.registerCustomer = function (sResultFunction, sErrorFunction, oRegisterCustomerRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "registerCustomer", sResultFunction, sErrorFunction, oRegisterCustomerRequest); +}; + + + +/** + * @summary This function signals the host implementation that LineItem registrations have been completed. + * + * @author jsaade (Last modified by: jsaade) + * @since 5.6.1 + * @name com.gk_software.gkr.app_enablement.api.Pos.onLineItemRegistrationFinished + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.onLineItemRegistrationFinished = function (sResultFunction, sErrorFunction) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "onLineItemRegistrationFinished", sResultFunction, sErrorFunction); +}; + + +/** + * @summary This function will create a request object for the function 'enterCoupon'. + * + * @author nmankel (Last modified by: nmankel) + * @since 2.1.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.createEnterCouponRequest + * @param {string} couponNumber + * number of the coupon to register + * @param {string} privilegeType + * The privilege type + * @param {double} privilegeValue + * The privilege Value. + * @returns (String) Returns a stringified object for the enterCoupon request. + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.createEnterCouponRequest = function (sCouponNumber, sPrivilegeType, dPrivilegeValue) { + + return { + "couponNumber": sCouponNumber, + "privilegeType": sPrivilegeType, + "privilegeValue": dPrivilegeValue, + }; +}; + + +/** + * @summary This function allows to enter a coupon within the current transaction in the POS. + * + * @author nmankel (Last modified by: nmankel) + * @since 2.1.0 + * @name com.gk_software.gkr.app_enablement.api.Pos.enterCoupon + * @param {string} sResultFunction + * Name of the success callback function. Data type is string but internal data type is function. + * @param {string} sErrorFunction + * Name of the error callback function. Data type is string but internal data type is function. + * @param {string} oEnterCouponRequest + * This object is a stringified object from the createEnterCouponRequest. + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos.prototype.enterCoupon = function (sResultFunction, sErrorFunction, oEnterCouponRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "enterCoupon", sResultFunction, sErrorFunction, oEnterCouponRequest); +}; \ No newline at end of file diff --git a/static/api/Pos_EXT.js b/static/api/Pos_EXT.js new file mode 100644 index 0000000..09c27ce --- /dev/null +++ b/static/api/Pos_EXT.js @@ -0,0 +1,61 @@ +// Shorthand syntax to check if the namespace already exists, if not create an empty Object. +var comGkSoftwareGkrAppEnablementApi = comGkSoftwareGkrAppEnablementApi || {}; + +comGkSoftwareGkrAppEnablementApi.Pos_EXT = function () { + "use strict"; + this._prefix = "comGkSoftwareGkrAppEnablementApi.Pos_EXT/"; +}; + +/** + * @summary This function sets the emailRequestedFlag, emailAddressLocalPart and emailAddressDomainPart + * of the current retailTransaction. + * + * @author jsousa + * @name com.gk_software.gkr.app_enablement.api.Pos_EXT.receiptAsEmail + * @function + */ +comGkSoftwareGkrAppEnablementApi.Pos_EXT.prototype.receiptAsEmail = function (sResultFunction, sErrorFunction, oReceiptAsEmailRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "receiptAsEmail", sResultFunction, sErrorFunction, oReceiptAsEmailRequest); +}; + + +/** + * @summary This function will create a sub-request object for the function 'receiptAsEmail'. + * + * @author jsousa + * @name com.gk_software.gkr.app_enablement.api.Pos_EXT.createReceiptAsEmailRequest + * @param {boolean} eReceiptFlag + * @param {string} emailAddress + + * @returns (String) Returns a stringified object of com.gk_software.cst.pos.ui.app_enablement.ReceiptAsEmailRequest. + */ +comGkSoftwareGkrAppEnablementApi.Pos_EXT.prototype.createReceiptAsEmailRequest = function (eReceiptFlag, emailAddress) { + return JSON.stringify({ + "ereceiptFlag": eReceiptFlag, + "emailAddress": emailAddress + }); +}; + +/** + * @summary This function will invoke function to register multiple external lineitems by one single call + * + * @author jdanisik + * + * @param {string} oRegisterExternalLineItemListRequest + + */ +comGkSoftwareGkrAppEnablementApi.Pos_EXT.prototype.registerExternalLineItemList = function (sResultFunction, sErrorFunction, oRegisterExternalLineItemListRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "registerExternalLineItemList", sResultFunction, sErrorFunction, oRegisterExternalLineItemListRequest); +}; + +/** + * @summary This function creates a transaction discount for Tommy 4 life + * + * @author mkuda + * + * @param {string} oTradeInRequest + + */ +comGkSoftwareGkrAppEnablementApi.Pos_EXT.prototype.createTradeVoucherRequest = function (sResultFunction, sErrorFunction, oTradeInRequest) { + oAppEnablementConnectorInstance.invokeMethod(this._prefix + "createTradeVoucherRequest", sResultFunction, sErrorFunction, oTradeInRequest); +}; \ No newline at end of file diff --git a/static/company_data.js b/static/company_data.js index 9f5fe59..d5527e0 100644 --- a/static/company_data.js +++ b/static/company_data.js @@ -1,3 +1,7 @@ +var oAppEnablementCommonInstance = new comGkSoftwareGkrAppEnablementApi.Common(); +var oAppEnablementPosInstance = new comGkSoftwareGkrAppEnablementApi.Pos(); +var oAppEnablementPosEXTInstance = new comGkSoftwareGkrAppEnablementApi.Pos_EXT(); + async function searchCompany() { const country = document.getElementById("country").value; const vatNumber = document.getElementById("vat_number").value.trim(); @@ -56,6 +60,14 @@ function saveData() { }; alert(JSON.stringify(payload, null, 2)); + + + var customer = { + "customerId":"17600703312990" + } + var oRegisterCustomerRequest = JSON.stringify(customer) + oAppEnablementPosInstance.registerCustomer('registerDataOk', 'registerDataFailed', oRegisterCustomerRequest); + } function clearForm() { @@ -81,5 +93,35 @@ function updateVatPlaceholder() { } } +function closeBrowser() { + oAppEnablementCommonInstance.closeBrowser(); +} + +// customer registration - uses standard Pos + +function registerLoyaltyCall(customerId) { + var request = JSON.stringify({ + "customerId": customerId, + "customerServiceTypeCode": null, + "preferredReceiptPrintoutTypeCode": null + }); + + oAppEnablementPosInstance.registerCustomer( + 'onSuccess', + 'onError', + request + ); +} + +// Callback functions +function onSuccess(result) { + document.getElementById("status").textContent = "Thank you."; + closeBrowser(); +} + +function onError(error) { + document.getElementById("status").textContent = "Company registration in receipt failed. Please try again."; +} + document.getElementById("country").addEventListener("change", updateVatPlaceholder); window.addEventListener("DOMContentLoaded", updateVatPlaceholder); diff --git a/templates/company_data.html b/templates/company_data.html index fb4b8fb..4cdcaa1 100644 --- a/templates/company_data.html +++ b/templates/company_data.html @@ -5,7 +5,10 @@ VAT Company Lookup - + + + +
@@ -18,23 +21,23 @@ - +
- +
- +
- +
@@ -49,7 +52,7 @@
- +
Ready.