diff --git a/lib/Helper/Environment.php b/lib/Helper/Environment.php index 21d6aca093..436b8a7547 100644 --- a/lib/Helper/Environment.php +++ b/lib/Helper/Environment.php @@ -30,7 +30,7 @@ */ class Environment { - public static $WEBSITE_VERSION_NAME = '4.1.0-alpha'; + public static $WEBSITE_VERSION_NAME = '4.1.0-alpha2'; public static $XMDS_VERSION = '7'; public static $XLF_VERSION = 4; public static $VERSION_REQUIRED = '8.1.0'; diff --git a/web/swagger.json b/web/swagger.json index feb6431536..f04aa7eaf4 100755 --- a/web/swagger.json +++ b/web/swagger.json @@ -804,6 +804,13 @@ "description": "An array of Player types this Command is available on, empty for all.", "required": false, "type": "string" + }, + { + "name": "createAlertOn", + "in": "formData", + "description": "On command execution, when should a Display alert be created?\r\n * success, failure, always or never", + "required": false, + "type": "string" } ], "responses": { @@ -872,6 +879,13 @@ "description": "An array of Player types this Command is available on, empty for all.", "required": false, "type": "string" + }, + { + "name": "createAlertOn", + "in": "formData", + "description": "On command execution, when should a Display alert be created?\r\n * success, failure, always or never", + "required": false, + "type": "string" } ], "responses": { @@ -936,6 +950,13 @@ "required": false, "type": "string" }, + { + "name": "isRealTime", + "in": "query", + "description": "Filter by real time", + "required": false, + "type": "integer" + }, { "name": "userId", "in": "query", @@ -1006,6 +1027,13 @@ "required": true, "type": "integer" }, + { + "name": "isRealTime", + "in": "formData", + "description": "Is this a real time DataSet?", + "required": true, + "type": "integer" + }, { "name": "method", "in": "formData", @@ -1146,6 +1174,13 @@ "required": false, "type": "string" }, + { + "name": "dataConnectorScript", + "in": "formData", + "description": "If isRealTime then provide a script to connect to the data source", + "required": false, + "type": "string" + }, { "name": "folderId", "in": "formData", @@ -1214,6 +1249,13 @@ "required": true, "type": "integer" }, + { + "name": "isRealTime", + "in": "formData", + "description": "Is this a real time DataSet?", + "required": true, + "type": "integer" + }, { "name": "method", "in": "formData", @@ -1354,6 +1396,13 @@ "required": false, "type": "string" }, + { + "name": "dataConnectorScript", + "in": "formData", + "description": "If isRealTime then provide a script to connect to the data source", + "required": false, + "type": "string" + }, { "name": "folderId", "in": "formData", @@ -1394,6 +1443,40 @@ } } }, + "/dataset/dataConnector/{dataSetId}": { + "put": { + "tags": [ + "dataset" + ], + "summary": "Edit DataSet Data Connector", + "description": "Edit a DataSet Data Connector", + "operationId": "dataSetDataConnectorEdit", + "parameters": [ + { + "name": "dataSetId", + "in": "path", + "description": "The DataSet ID", + "required": true, + "type": "integer" + }, + { + "name": "dataConnectorScript", + "in": "formData", + "description": "If isRealTime then provide a script to connect to the data source", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/DataSet" + } + } + } + } + }, "/dataset/copy/{dataSetId}": { "post": { "tags": [ @@ -6960,6 +7043,13 @@ "description": "DataType to return templates for", "required": true, "type": "string" + }, + { + "name": "type", + "in": "query", + "description": "Type to return templates for", + "required": false, + "type": "string" } ], "responses": { @@ -7085,13 +7175,6 @@ "required": false, "type": "string" }, - { - "name": "isEmail", - "in": "formData", - "description": "Flag indicating whether this notification should be emailed.", - "required": true, - "type": "integer" - }, { "name": "isInterrupt", "in": "formData", @@ -7173,13 +7256,6 @@ "required": true, "type": "string" }, - { - "name": "isEmail", - "in": "formData", - "description": "Flag indicating whether this notification should be emailed.", - "required": true, - "type": "integer" - }, { "name": "isInterrupt", "in": "formData", @@ -7922,6 +7998,37 @@ } } }, + "/playlist/{id}/convert": { + "post": { + "tags": [ + "playlist" + ], + "summary": "Playlist Convert", + "description": "Create a global playlist from inline editor Playlist.\r\n * Assign created Playlist via sub-playlist Widget to region Playlist.", + "operationId": "convert", + "parameters": [ + { + "name": "playlistId", + "in": "path", + "description": "The Playlist ID", + "required": true, + "type": "integer" + }, + { + "name": "name", + "in": "formData", + "description": "Optional name for the global Playlist.", + "required": false, + "type": "string" + } + ], + "responses": { + "201": { + "description": "successful operation" + } + } + } + }, "/region/{id}": { "put": { "tags": [ @@ -8726,6 +8833,20 @@ "description": "For Action eventTypeId and navLayout actionType, the Layout Code identifier", "required": false, "type": "string" + }, + { + "name": "dataSetId", + "in": "formData", + "description": "For Data Connector eventTypeId, the DataSet ID", + "required": false, + "type": "integer" + }, + { + "name": "dataSetParams", + "in": "formData", + "description": "For Data Connector eventTypeId, the DataSet params", + "required": false, + "type": "string" } ], "responses": { @@ -8955,6 +9076,20 @@ "description": "For Action eventTypeId and navLayout actionType, the Layout Code identifier", "required": false, "type": "string" + }, + { + "name": "dataSetId", + "in": "formData", + "description": "For Data Connector eventTypeId, the DataSet ID", + "required": false, + "type": "integer" + }, + { + "name": "dataSetParams", + "in": "formData", + "description": "For Data Connector eventTypeId, the DataSet params", + "required": false, + "type": "string" } ], "responses": { @@ -9400,6 +9535,20 @@ "required": false, "type": "integer" }, + { + "name": "syncSwitchDelay", + "in": "formData", + "description": "The delay (in ms) when displaying the changes in content - default 750", + "required": false, + "type": "integer" + }, + { + "name": "syncVideoPauseDelay", + "in": "formData", + "description": "The delay (in ms) before unpausing the video on start - default 100", + "required": false, + "type": "integer" + }, { "name": "leadDisplayId", "in": "formData", @@ -10584,7 +10733,49 @@ { "name": "isDisplayNotification", "in": "formData", - "description": "Flag (0, 1), should members of this Group receive Display notifications for Displays they have permissions to see", + "description": "Flag (0, 1), should members of this Group receive Display notifications\r\n * for Displays they have permissions to see", + "required": false, + "type": "integer" + }, + { + "name": "isDataSetNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive DataSet notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isLayoutNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Layout notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isLibraryNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Library notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isReportNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Report notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isScheduleNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Schedule notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isCustomNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Custom notification emails?", "required": false, "type": "integer" }, @@ -10663,7 +10854,49 @@ { "name": "isDisplayNotification", "in": "formData", - "description": "Flag (0, 1), should members of this Group receive Display notifications for Displays they have permissions to see", + "description": "Flag (0, 1), should members of this Group receive Display notifications\r\n * for Displays they have permissions to see", + "required": false, + "type": "integer" + }, + { + "name": "isDataSetNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive DataSet notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isLayoutNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Layout notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isLibraryNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Library notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isReportNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Report notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isScheduleNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Schedule notification emails?", + "required": false, + "type": "integer" + }, + { + "name": "isCustomNotification", + "in": "formData", + "description": "Flag (0, 1), should members of this Group receive Custom notification emails?", "required": false, "type": "integer" }, @@ -11535,6 +11768,10 @@ "ipAddress": { "description": "The IP Address of the User that took this action", "type": "string" + }, + "sessionHistoryId": { + "description": "Session history id.", + "type": "integer" } } }, @@ -11697,6 +11934,13 @@ "description": "A comma separated list of player types this command is available on", "type": "string" }, + "createAlertOn": { + "description": "Define if execution of this command should create an alert on success, failure, always or never.", + "type": "string" + }, + "createAlertOnDisplayProfile": { + "description": "Create Alert On specific to the provided DisplayProfile." + }, "groupsWithPermissions": { "description": "A comma separated list of groups/users with permissions to this Command", "type": "string" @@ -11746,6 +11990,10 @@ "description": "Flag to indicate whether this DataSet is Remote", "type": "integer" }, + "isRealTime": { + "description": "Flag to indicate whether this DataSet is Real time", + "type": "integer" + }, "method": { "description": "Method to fetch the Data, can be GET or POST", "type": "string" @@ -12267,6 +12515,26 @@ "syncGroupId": { "description": "The Display Group ID this Display is synced to", "type": "integer" + }, + "osVersion": { + "description": "The OS version of the Display", + "type": "string" + }, + "osSdk": { + "description": "The SDK version of the Display", + "type": "string" + }, + "manufacturer": { + "description": "The manufacturer of the Display", + "type": "string" + }, + "brand": { + "description": "The brand of the Display", + "type": "string" + }, + "model": { + "description": "The model of the Display", + "type": "string" } } }, @@ -12688,6 +12956,14 @@ "display": { "description": "The display this message relates to or CMS for CMS.", "type": "string" + }, + "sessionHistoryId": { + "description": "Session history id.", + "type": "integer" + }, + "userId": { + "description": "User id.", + "type": "integer" } } }, @@ -13171,6 +13447,10 @@ "description": "Is Visible?", "type": "boolean" }, + "isEnabled": { + "description": "Is Enabled?", + "type": "boolean" + }, "propertyGroups": { "description": "An array of additional module specific group properties", "type": "array", @@ -13186,6 +13466,10 @@ "description": "", "type": "array", "items": {} + }, + "groupsWithPermissions": { + "description": "A comma separated list of groups/users with permissions to this template", + "type": "string" } } }, @@ -13207,14 +13491,14 @@ "description": "The subject line", "type": "string" }, + "type": { + "description": "The Notification type", + "type": "string" + }, "body": { "description": "The HTML body of the notification", "type": "string" }, - "isEmail": { - "description": "Should the notification be emailed", - "type": "integer" - }, "isInterrupt": { "description": "Should the notification interrupt the CMS UI on navigate/login", "type": "integer" @@ -13742,6 +14026,13 @@ "$ref": "#/definitions/ScheduleReminder" } }, + "criteria": { + "description": "Schedule Criteria assigned to this Scheduled Event.", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleCriteria" + } + }, "userId": { "description": "The userId that owns this event.", "type": "integer" @@ -13857,6 +14148,14 @@ "description": "For sync events, the id the the sync group", "type": "integer" }, + "dataSetId": { + "description": "For data connector events, the dataSetId", + "type": "integer" + }, + "dataSetParams": { + "description": "For data connector events, the data set parameters", + "type": "integer" + }, "modifiedBy": { "description": "The userId of the user that last modified this Schedule", "type": "integer" @@ -13875,6 +14174,7 @@ } } }, + "ScheduleCriteria": {}, "ScheduleExclusion": { "properties": { "scheduleExclusionId": { @@ -13975,7 +14275,7 @@ "type": "integer" }, "syncVideoPauseDelay": { - "description": "The delay (in ms) before unpausing the video on start", + "description": "The delay (in ms) before unpausing the video on start.", "type": "integer" }, "leadDisplayId": { @@ -14214,11 +14514,35 @@ } }, "isSystemNotification": { - "description": "Does this Group receive system notifications.", + "description": "Does this User receive system notifications.", "type": "integer" }, "isDisplayNotification": { - "description": "Does this Group receive system notifications.", + "description": "Does this User receive system notifications.", + "type": "integer" + }, + "isDataSetNotification": { + "description": "Does this User receive DataSet notifications.", + "type": "integer" + }, + "isLayoutNotification": { + "description": "Does this User receive Layout notifications.", + "type": "integer" + }, + "isLibraryNotification": { + "description": "Does this User receive Library notifications.", + "type": "integer" + }, + "isReportNotification": { + "description": "Does this User receive Report notifications.", + "type": "integer" + }, + "isScheduleNotification": { + "description": "Does this User receive Schedule notifications.", + "type": "integer" + }, + "isCustomNotification": { + "description": "Does this User receive Custom notifications.", "type": "integer" }, "twoFactorTypeId": { @@ -14272,6 +14596,30 @@ "description": "Does this Group receive display notifications.", "type": "integer" }, + "isDataSetNotification": { + "description": "Does this Group receive DataSet notifications.", + "type": "integer" + }, + "isLayoutNotification": { + "description": "Does this Group receive Layout notifications.", + "type": "integer" + }, + "isLibraryNotification": { + "description": "Does this Group receive Library notifications.", + "type": "integer" + }, + "isReportNotification": { + "description": "Does this Group receive Report notifications.", + "type": "integer" + }, + "isScheduleNotification": { + "description": "Does this Group receive Schedule notifications.", + "type": "integer" + }, + "isCustomNotification": { + "description": "Does this Group receive Custom notifications.", + "type": "integer" + }, "isShownForAddUser": { "description": "Is this Group shown in the list of choices when onboarding a new user", "type": "integer" @@ -14494,6 +14842,7 @@ } }, "Element": {}, + "ElementGroup": {}, "Extend": {}, "LegacyType": {}, "Option": { @@ -14545,7 +14894,17 @@ }, "PropertyGroup": {}, "Rule": {}, - "Stencil": {}, + "Stencil": { + "properties": { + "elementGroups": { + "description": "An array of element groups", + "type": "array", + "items": { + "$ref": "#/definitions/ElementGroup" + } + } + } + }, "Test": {} }, "parameters": {