v1.0.8

Author: chrisallo

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Change Log
 
+### v1.0.8(Aug 23, 2019)
+* Added `setCustomerCustomFields()` in `SendBirdDesk`.
+* Added `submitFeedback()` in `Ticket`.
+
 ### v1.0.7(Jul 12, 2019)
 * Added `customFields` property to `Ticket`.
 

README.md

@@ -48,6 +48,22 @@ sb.connect(userId, accessToken, (res, err) => {
 
 Now your customers are ready to create tickets and start inquiry with your agents!
 
+## Setting customer customFields
+
+Customer information could be kept in `customFields`. `setCustomerCustomFields()` in `SendBirdDesk` lets the SDK set the `customFields` of the current customer. The `customFields` columns should be defined in SendBird Dashboard beforehand. Otherwise, the setting would be ignored.
+```js
+SendBirdDesk.setCustomerCustomFields({
+        gender: 'male',
+        age: 20
+    },
+    err => {
+        if (!err) {
+            // customer's customFields is rightly set
+            // (or a certain key could get ignored if the key is not defined yet)
+        }
+    });
+```
+
 ## Creating a new ticket
 
 Creating a new ticket is as simple as calling `Ticket.create()`. Once you create the ticket, you can access to created ticket and channel in callback. Channel object can be found at `ticket.channel` so that you can send messages to the channel. For more information in sending messages to channel, see [SendBird SDK guide docs](https://docs.sendbird.com/android#group_channel_3_sending_messages).
@@ -163,6 +179,44 @@ channelHandler.onMessageUpdated = (channel, message) => {
 }
 ```
 
+### Ticket Feedback
+
+If Desk satisfaction feature is on, a message would come after closing the ticket. The message is for getting customer feedback including score and comment. The data of satisfaction form message looks like below.
+
+```js
+{
+    "type": "SENDBIRD_DESK_CUSTOMER_SATISFACTION",
+    "body": {
+        "state": "WAITING" // also can have "CONFIRMED",
+        "customerSatisfactionScore": null, // or a number ranged in [1, 5]
+        "customerSatisfactionComment": null // or a string (optional)
+    }
+}
+```
+
+Once the customer inputs the score and the comment, the data could be submitted by calling `SendBirdDesk.Ticket.submitFeedback(message, score, comment, callback)`. Then updated message is going to be sent in `channelHandler.onMessageUpdate(channel, message)`.
+
+```js
+channelHandler.onMessageUpdated = (channel, message) => {
+    SendBirdDesk.Ticket.getByChannelUrl(channel.url, (ticket, err) => {
+        if(err) throw err;
+        let data = JSON.parse(message.data);
+        const isFeedbackMessage = (data.type === SendBirdDesk.Message.DataType.TICKET_FEEDBACK);
+        if(isFeedbackMessage) {
+            const feedback = data.body;
+            switch(feedback.state) {
+                case SendBirdDesk.Message.FeedbacState.WAITING:
+                    // do something on WAITING
+                    break;
+                case SendBirdDesk.Message.FeedbacState.CONFIRMED:
+                    // do something on CONFIRMED
+                    break;
+            }
+        }
+    });
+}
+```
+
 ### URL preview
 
 To send URL preview message, you should send a text message with URL, extract preview data, and update it with the preview data. Use `channel.updateUserMessage(messageId, text, messageData, customType, callback)` for the update operation. The format of `messageData` looks like below:

SendBird.Desk.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type Definitions for SendBird Desc SDK v1.0.7
+ * Type Definitions for SendBird Desc SDK v1.0.8
  * homepage: https://sendbird.com/
  */
 export = SendBirdDesk;
@@ -19,6 +19,7 @@ interface SendBirdDeskStatic {
   authenticate(userId: String, accessToken: String, callback: SendBirdDesk.Callback): void;
   isDeskChannel(channel: SendBirdDesk.GroupChannel): Boolean;
   setDebugMode(): void;
+  setCustomerCustomFields(customFields: Object, callback: SendBirdDesk.Callback): void;
 }
 
 declare namespace SendBirdDesk {
@@ -54,6 +55,7 @@ declare namespace SendBirdDesk {
     getClosedList(offset: Number, customFieldFilter: Object, callback: TicketArrayCallback): void;
     getUrlPreview(url: String, callback: Callback): void;
     confirmEndOfChat(message: Object, confirmYN: String, callback: Callback): void;
+    submitFeedback(message: Object, score: Number, comment: String, callback: Callback): void;
     new (json: Object): TicketInstance;
   }
   type TicketStatus = {
@@ -82,6 +84,7 @@ declare namespace SendBirdDesk {
     CustomType: MessageCustomType;
     DataType: MessageDataType;
     ClosureState: MessageClosureState;
+    FeedbackState: MessageFeedbackState;
   };
   type MessageCustomType = {
     RICH_MESSAGE: String;
@@ -92,12 +95,17 @@ declare namespace SendBirdDesk {
     TICKET_ASSIGN: String;
     TICKET_TRANSFER: String;
     TICKET_CLOSE: String;
+    TICKET_FEEDBACK: String;
     URL_PREVIEW: String;
   };
   type MessageClosureState = {
     WAITING: String;
     CONFIRMED: String;
     DECLINED: String;
   };
+  type MessageFeedbackState = {
+    WAITING: String;
+    CONFIRMED: String;
+  };
   interface SendBirdDeskErrorStatic {}
 }

SendBird.Desk.min.js

@@ -1,6 +1,6 @@
 {
   "name": "sendbird-desk",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "SendBird Desk SDK Integration Guide for JavaScript =========== SendBird Desk is a chat customer service platform built on SendBird SDK and API.",
   "main": "SendBird.Desk.min.js",
   "scripts": {
@@ -24,7 +24,7 @@
   },
   "homepage": "https://sendbird.com",
   "dependencies": {
-    "sendbird": "^3.0.55"
+    "sendbird": "^3.0.106"
   },
   "typings": "SendBird.Desk.d.ts"
 }