Skip to content

Commit 9e9037a

Browse files
chrisallochrisallo
committed
v1.0.13
1 parent 978d002 commit 9e9037a

File tree

4 files changed

+97
-79
lines changed

4 files changed

+97
-79
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
## Change Log
22

3+
### v1.0.13(Feb 21, 2020)
4+
5+
- TypeScript d.ts interface refactoring.
6+
37
### v1.0.12(Feb 14, 2020)
48

59
- TypeScript d.ts interface fix.

‎SendBird.Desk.d.ts‎

Lines changed: 89 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,111 @@
11
/**
2-
* Type Definitions for SendBird Desc SDK v1.0.12
2+
* Type Definitions for SendBird Desc SDK v1.0.13
33
* homepage: https://sendbird.com/
44
*/
5-
export default SendBirdDesk;
5+
import SendBird from 'sendbird';
6+
7+
export as namespace SendBirdDesk;
8+
export = SendBirdDesk;
69

710
declare const SendBirdDesk: SendBirdDeskStatic;
811

912
interface SendBirdDeskStatic {
1013
version: string;
11-
Agent: SendBirdDeskInstance.AgentStatic;
12-
Ticket: SendBirdDeskInstance.TicketStatic;
13-
Message: SendBirdDeskInstance.MessageStatic;
14-
Error: SendBirdDeskInstance.SendBirdDeskErrorStatic;
14+
Ticket: SendBirdDesk.TicketStatic;
15+
Agent: SendBirdDesk.AgentStatic;
16+
Message: SendBirdDesk.MessageStatic;
17+
Error: SendBirdDesk.SendBirdDeskErrorStatic;
1518

1619
init(SendBird: object): void;
17-
authenticate(userId: string, callback: SendBirdDeskInstance.Callback): void;
18-
authenticate(userId: string, accessToken: string, callback: SendBirdDeskInstance.Callback): void;
19-
isDeskChannel(channel: SendBirdDeskInstance.GroupChannel): boolean;
20+
authenticate(userId: string, callback: SendBirdDesk.CommonCallback): void;
21+
authenticate(userId: string, accessToken: string, callback: SendBirdDesk.CommonCallback): void;
22+
isDeskChannel(channel: SendBird.GroupChannel): boolean;
2023
setDebugMode(): void;
21-
setCustomerCustomFields(customFields: object, callback: SendBirdDeskInstance.Callback): void;
24+
setCustomerCustomFields(customFields: object, callback: SendBirdDesk.CommonCallback): void;
2225
}
2326

24-
declare namespace SendBirdDeskInstance {
25-
interface GroupChannel {
26-
url: string;
27-
name: string;
28-
customType: string;
29-
}
30-
type Callback = (res: object, error: Error) => void;
31-
type TicketCallback = (ticket: TicketInstance, error: Error) => void;
32-
type TicketArrayCallback = (list: Array<TicketInstance>, error: Error) => void;
27+
declare namespace SendBirdDesk {
28+
type TicketStatus = {
29+
INITIALIZED: string;
30+
PROACTIVE: string;
31+
UNASSIGNED: string;
32+
ASSIGNED: string;
33+
OPEN: string;
34+
CLOSED: string;
35+
};
36+
type TicketPriority = {
37+
URGENT: string;
38+
HIGH: string;
39+
MEDIUM: string;
40+
LOW: string;
41+
};
42+
type MessageCustomType = {
43+
RICH_MESSAGE: string;
44+
ADMIN_MESSAGE: string;
45+
};
46+
type MessageDataType = {
47+
TICKET_INQUIRE_CLOSURE: string;
48+
TICKET_ASSIGN: string;
49+
TICKET_TRANSFER: string;
50+
TICKET_CLOSE: string;
51+
TICKET_FEEDBACK: string;
52+
URL_PREVIEW: string;
53+
};
54+
type MessageClosureState = {
55+
WAITING: string;
56+
CONFIRMED: string;
57+
DECLINED: string;
58+
};
59+
type MessageFeedbackState = {
60+
WAITING: string;
61+
CONFIRMED: string;
62+
};
63+
type CommonCallback = (res: object, error: Error) => void;
64+
type TicketCallback = (ticket: Ticket, error: Error) => void;
65+
type TicketArrayCallback = (list: Array<Ticket>, error: Error) => void;
3366

34-
interface AgentStatic {
35-
new (json: object): AgentInstance;
36-
}
37-
interface AgentInstance {
38-
userId: string;
39-
name: string;
40-
profileUrl: string;
41-
fetchFromJSON(json: object): void;
42-
}
4367
interface TicketStatic {
4468
Status: TicketStatus;
4569
isStatus(val: string): boolean;
4670
clearCache(channelUrl: string): void;
4771
create(title: string, name: string, callback: TicketCallback): void;
4872
create(title: string, name: string, groupKey: string, callback: TicketCallback): void;
4973
create(title: string, name: string, groupKey: string, customFields: object, callback: TicketCallback): void;
50-
create(title: string, name: string, groupKey: string, customFields: object, priority: TicketPriority, callback: TicketCallback): void;
51-
getOpenCount(callback: Callback): void;
74+
create(
75+
title: string,
76+
name: string,
77+
groupKey: string,
78+
customFields: object,
79+
priority: TicketPriority,
80+
callback: TicketCallback
81+
): void;
82+
getOpenCount(callback: CommonCallback): void;
5283
getByChannelUrl(channelUrl: string, callback: TicketCallback): void;
5384
getOpenedList(offset: number, callback: TicketArrayCallback): void;
5485
getOpenedList(offset: number, customFieldFilter: object, callback: TicketArrayCallback): void;
5586
getClosedList(offset: number, callback: TicketArrayCallback): void;
5687
getClosedList(offset: number, customFieldFilter: object, callback: TicketArrayCallback): void;
57-
getUrlPreview(url: string, callback: Callback): void;
58-
confirmEndOfChat(message: object, confirmYN: string, callback: Callback): void;
59-
submitFeedback(message: object, score: number, comment: string, callback: Callback): void;
60-
new (json: object): TicketInstance;
88+
getUrlPreview(url: string, callback: CommonCallback): void;
89+
confirmEndOfChat(
90+
message: SendBird.UserMessage | SendBird.FileMessage | SendBird.AdminMessage,
91+
confirmYN: string,
92+
callback: CommonCallback
93+
): void;
94+
submitFeedback(
95+
message: SendBird.UserMessage | SendBird.FileMessage | SendBird.AdminMessage,
96+
score: number,
97+
comment: string,
98+
callback: CommonCallback
99+
): void;
100+
new (json: object): Ticket;
61101
}
62-
enum TicketStatus {
63-
INITIALIZED = "INITIALIZED",
64-
PROACTIVE = "PROACTIVE",
65-
UNASSIGNED = "UNASSIGNED",
66-
ASSIGNED = "ASSIGNED",
67-
OPEN = "OPEN",
68-
CLOSED = "CLOSED"
69-
}
70-
enum TicketPriority {
71-
URGENT = "URGENT",
72-
HIGH = "HIGH",
73-
MEDIUM = "MEDIUM",
74-
LOW = "LOW"
75-
}
76-
interface TicketInstance {
102+
interface Ticket {
77103
id: string;
78104
title: string;
79105
status: TicketStatus;
80106
info: object;
81107
priority: TicketPriority;
82-
agent: AgentInstance;
108+
agent: Agent;
83109
customer: object;
84110
channel: object;
85111
channelUrl: string;
@@ -88,35 +114,23 @@ declare namespace SendBirdDeskInstance {
88114
fetchFromJSON(json: object): void;
89115
refresh(callback: TicketCallback): void;
90116
reopen(callback: TicketCallback): void;
91-
setPriority(priority: TicketPriority, callback: SendBirdDeskInstance.Callback): void;
92-
setCustomFields(customFields: object, callback: SendBirdDeskInstance.Callback): void;
117+
setPriority(priority: TicketPriority, callback: CommonCallback): void;
118+
setCustomFields(customFields: object, callback: CommonCallback): void;
119+
}
120+
interface AgentStatic {
121+
new (json: object): Agent;
122+
}
123+
interface Agent {
124+
userId: string;
125+
name: string;
126+
profileUrl: string;
127+
fetchFromJSON(json: object): void;
93128
}
94-
type MessageStatic = {
129+
interface MessageStatic {
95130
CustomType: MessageCustomType;
96131
DataType: MessageDataType;
97132
ClosureState: MessageClosureState;
98133
FeedbackState: MessageFeedbackState;
99-
};
100-
type MessageCustomType = {
101-
RICH_MESSAGE: string;
102-
ADMIN_MESSAGE: string;
103-
};
104-
type MessageDataType = {
105-
TICKET_INQUIRE_CLOSURE: string;
106-
TICKET_ASSIGN: string;
107-
TICKET_TRANSFER: string;
108-
TICKET_CLOSE: string;
109-
TICKET_FEEDBACK: string;
110-
URL_PREVIEW: string;
111-
};
112-
type MessageClosureState = {
113-
WAITING: string;
114-
CONFIRMED: string;
115-
DECLINED: string;
116-
};
117-
type MessageFeedbackState = {
118-
WAITING: string;
119-
CONFIRMED: string;
120-
};
134+
}
121135
interface SendBirdDeskErrorStatic {}
122136
}

‎SendBird.Desk.min.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sendbird-desk",
3-
"version": "1.0.12",
3+
"version": "1.0.13",
44
"description": "SendBird Desk SDK Integration Guide for JavaScript =========== SendBird Desk is a chat customer service platform built on SendBird SDK and API.",
55
"main": "SendBird.Desk.min.js",
66
"scripts": {
@@ -24,7 +24,7 @@
2424
},
2525
"homepage": "https://sendbird.com",
2626
"dependencies": {
27-
"sendbird": "^3.0.113"
27+
"sendbird": "^3.0.117"
2828
},
2929
"typings": "SendBird.Desk.d.ts"
3030
}

0 commit comments

Comments
 (0)