v1.0.6

Author: chrisallo

CHANGELOG.md

@@ -1,23 +1,28 @@
 ## Change Log
 
+### v1.0.6(May 13, 2019)
+* Added `reopen()` in `Ticket`
+* Added `groupKey` and `customField` parameters to `Ticket.create()`.
+* Added `customFieldFilter` parameter to `getOpenedList()` and `getClosedList()` in `Ticket`.
+
 ### v1.0.5(Nov 23, 2018)
-* added SendBird parameter to SendBirdDesk.init().
-* bug-fix in 'SendBird missing' error at init().
+* Added SendBird parameter to SendBirdDesk.init().
+* Bug-fix in 'SendBird missing' error at init().
 
 ### v1.0.4(July 18, 2018)
-* added setApiHost to customize host.
+* Added setApiHost to customize host.
 
 ### v1.0.3(July 4, 2018)
-* corrected package.json to fix library path.
+* Corrected package.json to fix library path.
 
 ### v1.0.2(May 21, 2018)
-* applied ticket assignment update.
+* Applied ticket assignment update.
 
 ### v1.0.1(Mar 30, 2018)
-* added SendBirdDesk.init().
-* added SendBirdDesk.isDeskChannel(channel).
-* added TypeScript interface - SendBird.Desk.d.ts.
-* added console logger in debug mode.
+* Added SendBirdDesk.init().
+* Added SendBirdDesk.isDeskChannel(channel).
+* Added TypeScript interface - SendBird.Desk.d.ts.
+* Added console logger in debug mode.
 
 ### v1.0.0-zendesk(Mar 16, 2018)
 * Zendesk-integrated version release.

README.md

@@ -52,7 +52,7 @@ Now your customers are ready to create tickets and start inquiry with your agent
 
 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).
 
-> Notice that the ticket could be assigned to the agents only when customer sends at least one message to the ticket. Otherwise, agent cannot see the ticket.
+> Note: Notice that the ticket could be assigned to the agents only when customer sends at least one message to the ticket. Otherwise, agent cannot see the ticket.
 
 ```js
 Ticket.create(ticketTitle, userName, (ticket, err) =>
@@ -61,6 +61,8 @@ Ticket.create(ticketTitle, userName, (ticket, err) =>
 });
 ```
 
+> Note: `Ticket.create()` has 2 more parameters `groupKey` and `customField`. 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. `customField` holds customizable data for the individual ticket.
+
 ## Count of opened tickets
 When you need to display opened ticket count in your application, use `Ticket.getOpenCount()`.
 ```js
@@ -88,6 +90,8 @@ Ticket.getClosedList(offset, (res, err) => {
 });
 ```
 
+> Note: Once you set `customField` to tickets, you can put `customFieldFilter` to `getOpenedList()` and `getClosedList()` in order to filter the tickets by `customField` 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.
 

SendBird.Desk.d.ts

@@ -1,93 +1,104 @@
 /**
- * Type Definitions for SendBird Desc SDK v1.0.5
+ * Type Definitions for SendBird Desc SDK v1.0.6
  * homepage: https://sendbird.com/
  */
-declare const SendBirdDesk: SendBirdDeskStatic;
 export = SendBirdDesk;
+export as namespace SendBirdDesk;
 
-interface GroupChannel {
-  url: String;
-  name: String;
-  customType: String;
-}
-type Callback = (res: Object, error: Error) => void;
-type TicketCallback = (ticket: TicketInstance, error: Error) => void;
-type TicketArrayCallback = (list: Array<TicketInstance>, error: Error) => void;
+declare const SendBirdDesk: SendBirdDeskStatic;
 
 interface SendBirdDeskStatic {
   version: String;
-  Agent: AgentStatic;
-  Ticket: TicketStatic;
-  Message: MessageStatic;
-  Error: SendBirdDeskErrorStatic;
+  Agent: SendBirdDesk.AgentStatic;
+  Ticket: SendBirdDesk.TicketStatic;
+  Message: SendBirdDesk.MessageStatic;
+  Error: SendBirdDesk.SendBirdDeskErrorStatic;
 
-  init(SendBird: Object);
-  authenticate(userId: String, callback: Callback);
-  authenticate(userId: String, accessToken: String, callback: Callback);
-  isDeskChannel(channel: GroupChannel): Boolean;
-  setDebugMode();
-}
-interface AgentStatic {
-  new (json: Object): AgentInstance;
-}
-interface AgentInstance {
-  userId: String;
-  name: String;
-  profileUrl: String;
-  fetchFromJSON(json: Object);
-}
-interface TicketStatic {
-  Status: TicketStatus;
-  isStatus(val: String): Boolean;
-  clearCache(channelUrl: String);
-  create(title: String, name: String, callback: TicketCallback);
-  getOpenCount(callback: Callback);
-  getByChannelUrl(channelUrl: String, callback: TicketCallback);
-  getOpenedList(offset: Number, callback: TicketArrayCallback);
-  getClosedList(offset: Number, callback: TicketArrayCallback);
-  getUrlPreview(url: String, callback: Callback);
-  confirmEndOfChat(message: Object, confirmYN: String, callback: Callback);
-  new (json: Object): TicketInstance;
-}
-type TicketStatus = {
-  INITIALIZED: String;
-  UNASSIGNED: String;
-  ASSIGNED: String;
-  OPEN: String;
-  CLOSED: String;
+  init(SendBird: Object): void;
+  authenticate(userId: String, callback: SendBirdDesk.Callback): void;
+  authenticate(userId: String, accessToken: String, callback: SendBirdDesk.Callback): void;
+  isDeskChannel(channel: SendBirdDesk.GroupChannel): Boolean;
+  setDebugMode(): void;
 }
-interface TicketInstance {
-  id: String;
-  title: String;
-  status: TicketStatus;
-  info: Object;
-  agent: AgentInstance;
-  customer: Object;
-  channel: Object;
-  channelUrl: String;
-  updatedAt: Number;
-  fetchFromJSON(json: Object);
-  refresh(callback: TicketCallback);
-}
-type MessageStatic = {
-  CustomType: MessageCustomType;
-  DataType: MessageDataType;
-  ClosureState : MessageClosureState;
-}
-type MessageCustomType = {
-  RICH_MESSAGE: String;
-  ADMIN_MESSAGE: String;
-}
-type MessageDataType = {
-  TICKET_INQUIRE_CLOSURE: String;
-  TICKET_ASSIGN: String;
-  TICKET_TRANSFER: String;
-  TICKET_CLOSE: String;
-  URL_PREVIEW: String;
-}
-type MessageClosureState = {
-  WAITING: String;
-  CONFIRMED: String;
-  DECLINED: String;
+
+declare namespace SendBirdDesk {
+  interface GroupChannel {
+    url: String;
+    name: String;
+    customType: String;
+  }
+  type Callback = (res: Object, error: Error) => void;
+  type TicketCallback = (ticket: TicketInstance, error: Error) => void;
+  type TicketArrayCallback = (list: Array<TicketInstance>, error: Error) => void;
+  
+  
+  interface AgentStatic {
+    new (json: Object): AgentInstance;
+  }
+  interface AgentInstance {
+    userId: String;
+    name: String;
+    profileUrl: String;
+    fetchFromJSON(json: Object): void;
+  }
+  interface TicketStatic {
+    Status: TicketStatus;
+    isStatus(val: String): Boolean;
+    clearCache(channelUrl: String): void;
+    create(title: String, name: String, callback: TicketCallback): void;
+    create(title: String, name: String, groupKey: String, customField: Object, callback: TicketCallback): void;
+    getOpenCount(callback: Callback): void;
+    getByChannelUrl(channelUrl: String, callback: TicketCallback): void;
+    getOpenedList(offset: Number, callback: TicketArrayCallback): void;
+    getOpenedList(offset: Number, customFieldFilter: Object, callback: TicketArrayCallback): void;
+    getClosedList(offset: Number, callback: TicketArrayCallback): void;
+    getClosedList(offset: Number, customFieldFilter: Object, callback: TicketArrayCallback): void;
+    getUrlPreview(url: String, callback: Callback): void;
+    confirmEndOfChat(message: Object, confirmYN: String, callback: Callback): void;
+    new (json: Object): TicketInstance;
+  }
+  type TicketStatus = {
+    INITIALIZED: String;
+    UNASSIGNED: String;
+    ASSIGNED: String;
+    OPEN: String;
+    CLOSED: String;
+  }
+  interface TicketInstance {
+    id: String;
+    title: String;
+    status: TicketStatus;
+    info: Object;
+    agent: AgentInstance;
+    customer: Object;
+    channel: Object;
+    channelUrl: String;
+    updatedAt: Number;
+    fetchFromJSON(json: Object): void;
+    refresh(callback: TicketCallback): void;
+    reopen(callback: TicketCallback): void;
+  }
+  type MessageStatic = {
+    CustomType: MessageCustomType;
+    DataType: MessageDataType;
+    ClosureState : MessageClosureState;
+  }
+  type MessageCustomType = {
+    RICH_MESSAGE: String;
+    ADMIN_MESSAGE: String;
+  }
+  type MessageDataType = {
+    TICKET_INQUIRE_CLOSURE: String;
+    TICKET_ASSIGN: String;
+    TICKET_TRANSFER: String;
+    TICKET_CLOSE: String;
+    URL_PREVIEW: String;
+  }
+  type MessageClosureState = {
+    WAITING: String;
+    CONFIRMED: String;
+    DECLINED: String;
+  }
+  interface SendBirdDeskErrorStatic {}
 }
-interface SendBirdDeskErrorStatic {}
+

SendBird.Desk.min.js

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