add Version 1.14 notes to the changelog - new ticketAction delete

Author: Ross Curry

docs/changelog.md

@@ -6,6 +6,40 @@ sidebar_label: API Changelog
 
 ⚠ Consider subscribing to our [**API Newsletter**](http://eepurl.com/g2EiC1) to be notified about upcoming API changes in the future.
 
+## Version 1.14
+
+### Manifest API: New ticketAction type delete`
+
+A new `delete` ticketAction type has been introduced for the [Manifest API](general/manifest-api). This means that a dedicated delete button can be availble to tickets. The action type `delete` should be added to the ticketActions array when updating the channel using the [Manifest API](general/manifest-api). 
+
+The delete action type accepts one kind of config: `{ forceTagging: true }` . Any other action config given will throw an error.
+As with other ticketActions the delete type requires an `id` and `labels` for the 3 supported languages: 'en', 'de', 'fr'.
+
+- webhooks: If configured, the delete action will trigger webhooks. 
+- action reset: The delete action can be reset using the [Ticket API's error handling](inbox/ticket-api#error-handling) route where `:actionId` will be `delete`.
+
+Manifest API ticketAction example
+```json
+// ...
+"inbox": {
+    "ticketActions": [
+        {
+            "type": "delete",
+            "id": "delete-id",
+            "label": {
+                "en": "Delete",
+                "de": "löschen",
+                "fr": "Supprimer"
+            },
+            "config": {
+                "forceTagging": true //optional
+            }
+        }
+        // ...
+    ],
+// ...
+```
+
 ## Version 1.13
 
 The following changes to the API are scheduled to be deployed in **calendar week 11**. As all of these changes are **New** additions to existing behavior, there should be no action required by Developers. The impacted documentation pages and swagger specifications have already been updated accordingly.

docs/general/manifest-api.md

@@ -85,7 +85,7 @@ curl -X PATCH "https://api.socialhub.io/manifest?accesstoken=eyJhbGciOiJIUzI1NiI
 
 | Field           | Description                                               |
 |-----------------|-----------------------------------------------------------|
-| `type`          | Type of the Ticket Action. At the moment we support `reply`, `template_reply` and `button` actions. There may be multiple actions of the same type. |
+| `type`          | Type of the Ticket Action. At the moment we support `reply`, `template_reply`, `delete` and `button` actions. There may be multiple actions of the same type. |
 | `id`            | Identifier of the Action. Each Action within a manifest must have a different identifier. Pattern regular expression: `^[a-zA-Z0-9-_]{1,256}$` |
 | `label`         | Button labels for different locales. Locale is selected depending on user settings. |
 | `config`        | Configuration options for this Ticket Action. |
@@ -106,7 +106,7 @@ curl -X PATCH "https://api.socialhub.io/manifest?accesstoken=eyJhbGciOiJIUzI1NiI
 | `approvalProcess`  | Boolean (default is `true`) controlling whether the Approval Process feature should be applied for this Ticket Action. Only supported for `reply` and `template_reply` at this moment |
 | `templates.url`    | URL to fetch templates for the `template_reply` action from. Required for the `template_reply` action. |
 | `timeout`          | Action timeout configuration options. |
-| `forceTagging`     | Boolean (default is `true`) controlling whether the feature forcing the user to add tag(s) to the ticket should be applied for this Ticket Action. |
+| `forceTagging`     | Boolean (default is `true`) controlling whether the feature forcing the user to add tag(s) to the ticket should be applied for this Ticket Action. (The action of type: `delete` only accepts a config of `forceTagging` . Any other config for the type `delete` will throw an error.) |
 
 #### `inbox.ticketActions[].config.timeout`
 
@@ -134,6 +134,7 @@ curl -X PATCH "https://api.socialhub.io/manifest?accesstoken=eyJhbGciOiJIUzI1NiI
 |-----------------|-----------------------------------------------------------|
 | `en`            | Human-readable dropdown label for English locale. |
 | `de`            | Human-readable dropdown label for German locale. |
+| `fr`            | Human-readable dropdown label for french locale. |
 
 #### `inbox.rightSidebar[]`
 

docs/inbox/ticket-api.md

@@ -378,5 +378,5 @@ curl -X POST "https://api.socialhub.io/inbox/tickets/5cc1b08ad62ec72e8388cb47/re
 
 | Field           | Description                                               |
 |-----------------|-----------------------------------------------------------|
-| `followupId`    | The identifier of the Reply Followup that has failed to be processed. Only required for `reply` and `template_reply` actions. |
 | `reason`        | Optional human readable reason why the Ticket Action has failed. |
+| `followupId` (optional)    | The identifier of the Reply Followup that has failed to be processed. Only required for `reply` and `template_reply` actions. |

swagger.yaml

@@ -520,7 +520,7 @@ definitions:
                 type:
                   type: string
                   description: 'Type of the Ticket Action. There may be multiple actions of the same type.'
-                  enum: ['reply', 'template_reply', 'button']
+                  enum: ['reply', 'template_reply', 'button', 'delete']
                 id:
                   type: string
                   description: 'Identifier of the Action. Each Action within a manifest must have a different identifier.'
@@ -595,7 +595,7 @@ definitions:
                       label:
                         type: object
                         description: 'Human readable title of the option which will be shown to the user as button label.'
-                        required: [ 'en', 'de' ]
+                        required: [ 'en', 'de', 'fr' ]
                         properties:
                           en:
                             type: string
@@ -623,7 +623,7 @@ definitions:
                 label:
                   type: object
                   description: 'Human readable title of the option which will be shown to the user as Tab label.'
-                  required: [ 'en', 'de' ]
+                  required: [ 'en', 'de', 'fr' ]
                   properties:
                     en:
                       type: string