v1.0.11

Author: chrisallo

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Change Log
 
+### v1.0.11(Feb 6, 2020)
+
+- TypeScript d.ts interface fix.
+
 ### v1.0.10(Jan 3, 2020)
 
 - Added `setCustomFields(customFields, callback)` in `Ticket`.

README.md

@@ -1,27 +1,32 @@
-SendBird Desk SDK Integration Guide for JavaScript
-===========
+# SendBird Desk SDK Integration Guide for JavaScript
+
 SendBird Desk is a chat customer service platform built on SendBird SDK and API.
 
 Desk JavaScript SDK provides customer-side integration on your own application, so you can easily implement **ticketing system with chat inquiry**. Desk JavaScript SDK requires **SendBird JavaScript SDK 3.0.55 or higher**.
 
 ## Table of Contents
 
-  1. [Installation](#installation)
-  1. [Authentication](#authentication)
-  1. [Setting customer customFields](#setting-customer-customfields)
-  1. [Creating a new ticket](#creating-a-new-ticket)
-  1. [Count of opened tickets](#count-of-opened-tickets)
-  1. [Loading ticket list](#loading-ticket-list)
-  1. [Confirming end of chat](#confirming-end-of-chat)
-  1. [Ticket Feedback](#ticket-feedback)
-  1. [Handling ticket event](#handling-ticket-event)
-  1. [Rich messages](#rich-messages)
-  
+- [SendBird Desk SDK Integration Guide for JavaScript](#sendbird-desk-sdk-integration-guide-for-javascript)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Authentication](#authentication)
+  - [Setting customer customFields](#setting-customer-customfields)
+  - [Creating a new ticket](#creating-a-new-ticket)
+  - [Count of opened tickets](#count-of-opened-tickets)
+  - [Loading ticket list](#loading-ticket-list)
+  - [Handling ticket event](#handling-ticket-event)
+  - [Rich messages](#rich-messages)
+  - [Confirm end of chat](#confirm-end-of-chat)
+  - [Reopen a closed ticket](#reopen-a-closed-ticket)
+  - [Ticket Feedback](#ticket-feedback)
+  - [URL preview](#url-preview)
+
 ## Installation
 
 Before setup, you need to get SendBird App ID at [SendBird Dashboard](https://dashboard.sendbird.com). For using Desk solution, you may upgrade the plan. For more information, please contact [sales team](https://sendbird.com/contact-sales).
 
 Installing the Desk SDK is straightforward if you're familiar with npm. Run the following command at the project path.
+
 ```
 ~$ cd /path/to/your-project
 ~$ npm install --save sendbird-desk
@@ -31,39 +36,42 @@ Installing the Desk SDK is straightforward if you're familiar with npm. Run the
 
 > Basically SendBird Desk SDK is a plugin to handle tickets. You have to handle chat messages through SendBird SDK. Ticket is newly introduced in SendBird Desk SDK to support customer service ticketing system. Every ticket will be assigned to the appropriate agents and it will be mapped to a SendBird SDK channel, so you can implement real-time messaging on tickets with SendBird SDK.
 
-
 ## Authentication
 
 Connecting to SendBird platform via SendBird SDK is essential for real-time messaging. The official guide to SendBird SDK authentication is [here](https://docs.sendbird.com/android#authentication_2_authentication).
 Authentication in SendBird Desk is done by calling `SendBirdDesk.authenticate()`. The following is an example for SendBird SDK connection and SendBird Desk SDK authentication.
+
 ```js
-const sb = new SendBird({ appId : 'YOUR_APP_ID' });
+const sb = new SendBird({ appId: "YOUR_APP_ID" });
 sb.connect(userId, accessToken, (res, err) => {
-    if(err) throw err;
-    SendBirdDesk.init(SendBird);
-    SendBirdDesk.authenticate(userId, accessToken, (res, err) => {
-        if(err) throw err;    
-        // Now you can use Desk SDK later on
-    });
+  if (err) throw err;
+  SendBirdDesk.init(SendBird);
+  SendBirdDesk.authenticate(userId, accessToken, (res, err) => {
+    if (err) throw err;
+    // Now you can use Desk SDK later on
+  });
 });
 ```
-  
+
 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)
-        }
-    });
+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
@@ -82,57 +90,66 @@ Ticket.create(ticketTitle, userName, (ticket, err) =>
 `Ticket.create()` has 2 more parameters `groupKey` and `customFields`. The values could be evaluated when a ticket is created though it's used only in Dashboard currently. `groupKey` is the key of an agent group so that the ticket is assigned to the agents in that group. `customFields` holds customizable data for the individual ticket. The below is an example.
 
 ```js
-Ticket.create(ticketTitle, userName,
-    'cs-team-1', // groupKey
-    {
-        'text': 'hello',
-        'number': 14,
-        'select': 'option2'
-    }, // customFields
-    (ticket, err) => {
+Ticket.create(
+  ticketTitle,
+  userName,
+  "cs-team-1", // groupKey
+  {
+    text: "hello",
+    number: 14,
+    select: "option2"
+  }, // customFields
+  (ticket, err) => {
     // Ticket is created with groupKey 'cs-team-1' and customFields.
-});
+  }
+);
 ```
 
 > Note: each key in `customFields` should be preregistered in Dashboard. Otherwise, the key would be ignored.
 
 ## Count of opened tickets
+
 When you need to display opened ticket count in your application, use `Ticket.getOpenCount()`.
+
 ```js
 Ticket.getOpenCount((res, err) => {
-    const count = res;
-    // do something with the value
+  const count = res;
+  // do something with the value
 });
 ```
 
 ## Loading ticket list
+
 Retrieving ticket list is essential for inbox. SendBird Desk SDK provides `Ticket.getOpenedList()` and `Ticket.getClosedList()` to get the list of open/closed ticket. Open ticket list and closed ticket list can be loaded as below:
+
 ```js
 Ticket.getOpenedList(offset, (res, err) => {
-    const tickets = res;
-    // offset += tickets.length; for the next tickets.
-    // here is to display tickets on inbox.
+  const tickets = res;
+  // offset += tickets.length; for the next tickets.
+  // here is to display tickets on inbox.
 });
 ```
 
 ```js
 Ticket.getClosedList(offset, (res, err) => {
-    const tickets = res;
-    // offset += tickets.length; for the next tickets.
-    // here is to display tickets on inbox.
+  const tickets = res;
+  // offset += tickets.length; for the next tickets.
+  // here is to display tickets on inbox.
 });
 ```
 
 > Note: Once you set `customFields` to tickets, you can put `customFieldFilter` to `getOpenedList()` and `getClosedList()` in order to filter the tickets by `customFields` values.
 
 ## Handling ticket event
+
 SendBird Desk SDK uses predefined AdminMessage custom type which can be derived by calling `message.customType`. Custom type for Desk AdminMessage is set to `SENDBIRD_DESK_ADMIN_MESSAGE_CUSTOM_TYPE`. And there are sub-types which indicate ticket events: assign, transfer, and close. Each event type is located in `message.data` which looks like below.
 
 ```js
 {
     "type": "TICKET_ASSIGN" // "TICKET_TRANSFER", "TICKET_CLOSE"
 }
 ```
+
 You can check out these messages in `ChannelHandler.onMessageReceived()`.
 
 ## Rich messages
@@ -142,7 +159,7 @@ Rich message is a special message that holds custom content. You can distinguish
 - **`Confirm end of chat`** message notifies that the agent sent a confirm-end-of-chat request. When the user agrees with the closure, the ticket would be closed.
 - **`URL preview`** message contains web URL which is filled with image and description.
 
-### Confirm end of chat
+## Confirm end of chat
 
 Confirm end of chat message is initiated from the agent to inquire closure of ticket. The message has 3 states which are `WAITING`, `CONFIRMED`, `DECLIEND`. When agent sends confirm end of chat message, its state is set to `WAITING`. Customer can answer to the inquiry as `YES` or `NO` which leads to `CONFIRMED` state and `DECLINED` state accordingly. You can check the state by looking `message.data`. The format looks like below:
 
@@ -159,29 +176,39 @@ Once customer replies to the inquiry, the message would be updated. `SendBirdDes
 
 ```js
 channelHandler.onMessageUpdated = (channel, message) => {
-    SendBirdDesk.Ticket.getByChannelUrl(channel.url, (ticket, err) => {
-        if(err) throw err;
-        let data = JSON.parse(message.data);
-        const isClosureInquired = (data.type === SendBirdDesk.Message.DataType.TICKET_INQUIRE_CLOSURE);
-        if(isClosureInquired) {
-            const closureInquiry = data.body;
-            switch(closureInquiry.state) {
-                case SendBirdDesk.Message.ClosureState.WAITING:
-                    // do something on WAITING
-                    break;
-                case SendBirdDesk.Message.ClosureState.CONFIRMED:
-                    // do something on CONFIRMED
-                    break;
-                case SendBirdDesk.Message.ClosureState.DECLIND:
-                    // do something on DECLIND
-                    break;
-            }
-        }
-    });
-}
+  SendBirdDesk.Ticket.getByChannelUrl(channel.url, (ticket, err) => {
+    if (err) throw err;
+    let data = JSON.parse(message.data);
+    const isClosureInquired = data.type === SendBirdDesk.Message.DataType.TICKET_INQUIRE_CLOSURE;
+    if (isClosureInquired) {
+      const closureInquiry = data.body;
+      switch (closureInquiry.state) {
+        case SendBirdDesk.Message.ClosureState.WAITING:
+          // do something on WAITING
+          break;
+        case SendBirdDesk.Message.ClosureState.CONFIRMED:
+          // do something on CONFIRMED
+          break;
+        case SendBirdDesk.Message.ClosureState.DECLIND:
+          // do something on DECLIND
+          break;
+      }
+    }
+  });
+};
+```
+
+## Reopen a closed ticket
+
+The closed ticket could be reopened with `reopen()` function in `Ticket`.
+
+```js
+closedTicket.reopen((openTicket, err) => {
+  // update the ticket list here
+});
 ```
 
-### Ticket Feedback
+## 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.
 
@@ -200,26 +227,26 @@ Once the customer inputs the score and the comment, the data could be submitted
 
 ```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;
-            }
-        }
-    });
-}
+  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
+## 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:
 
@@ -237,4 +264,4 @@ To send URL preview message, you should send a text message with URL, extract pr
 }
 ```
 
-You may get the preview message in `ChannelHandler.onMessageUpdated()` or `channel.getPreviousMessagesByTimestamp()` for URL preview rendering.
+You may get the preview message in `ChannelHandler.onMessageUpdated()` or `channel.getPreviousMessagesByTimestamp()` for URL preview rendering.

SendBird.Desk.d.ts

@@ -1,9 +1,8 @@
 /**
- * Type Definitions for SendBird Desc SDK v1.0.10
+ * Type Definitions for SendBird Desc SDK v1.0.11
  * homepage: https://sendbird.com/
  */
-export = SendBirdDesk;
-export as namespace SendBirdDesk;
+export default SendBirdDeskStatic;
 
 interface SendBirdDeskStatic {
   version: string;
@@ -46,14 +45,7 @@ declare namespace SendBirdDesk {
     create(title: string, name: string, callback: TicketCallback): void;
     create(title: string, name: string, groupKey: string, callback: TicketCallback): void;
     create(title: string, name: string, groupKey: string, customFields: object, callback: TicketCallback): void;
-    create(
-      title: string,
-      name: string,
-      groupKey: string,
-      customFields: object,
-      priority: TicketPriority,
-      callback: TicketCallback
-    ): void;
+    create(title: string, name: string, groupKey: string, customFields: object, priority: TicketPriority, callback: TicketCallback): void;
     getOpenCount(callback: Callback): void;
     getByChannelUrl(channelUrl: string, callback: TicketCallback): void;
     getOpenedList(offset: number, callback: TicketArrayCallback): void;
@@ -66,18 +58,18 @@ declare namespace SendBirdDesk {
     new (json: object): TicketInstance;
   }
   enum TicketStatus {
-    INITIALIZED = 'INITIALIZED',
-    PROACTIVE = 'PROACTIVE',
-    UNASSIGNED = 'UNASSIGNED',
-    ASSIGNED = 'ASSIGNED',
-    OPEN = 'OPEN',
-    CLOSED = 'CLOSED'
+    INITIALIZED = "INITIALIZED",
+    PROACTIVE = "PROACTIVE",
+    UNASSIGNED = "UNASSIGNED",
+    ASSIGNED = "ASSIGNED",
+    OPEN = "OPEN",
+    CLOSED = "CLOSED"
   }
   enum TicketPriority {
-    URGENT = 'URGENT',
-    HIGH = 'HIGH',
-    MEDIUM = 'MEDIUM',
-    LOW = 'LOW'
+    URGENT = "URGENT",
+    HIGH = "HIGH",
+    MEDIUM = "MEDIUM",
+    LOW = "LOW"
   }
   interface TicketInstance {
     id: string;

SendBird.Desk.min.js

@@ -1,6 +1,6 @@
 {
   "name": "sendbird-desk",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "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": {