-
Notifications
You must be signed in to change notification settings - Fork 180
/
conversation.ts
117 lines (101 loc) · 2.13 KB
/
conversation.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
import { AnyChannel } from './anyChannel';
import { ConversationCallback } from './conversationCallback';
import { ConversationState } from '../enums';
/**
* Represents a conversation
*/
export type Conversation = {
/**
* The unique identifier for this conversation.
* @readonly
*/
id?: string;
/**
* Your internal conversation name. Must be unique.
*/
name?: string;
/**
* The public-facing name of the conversation.
*/
displayName?: string;
/**
* An image URL associated with the conversation.
*/
imageUrl?: string;
/**
* The conversation's status.
*
* @readonly
*/
status?: ConversationState;
/**
* The last Event ID in this conversation.
*
* This ID can be used to retrieve a specific event.
* @readonly
*/
sequenceNumber?: number;
/**
* The conversation's state.
*/
state?: ConversationState;
/**
* The conversation's properties
*/
properties?: {
/**
* The conversation's time to leave.
*
* After how many seconds the conversation is deleted.
*/
ttl?: number;
/**
* The conversation's type.
*/
type: string;
/**
* The conversation's custom sort key.
*/
customSortKey: string;
/**
* Custom key-value pairs to be included with the conversation.
*/
customData: Record<string, unknown>;
},
/**
* Timestamps for when the conversation was created, updated, and destroyed.
*
* @readonly
*/
timestamp?: {
/**
* The time the conversation was created.
* @readonly
*/
created?: string;
/**
* The time the conversation was last updated.
* @readonly
*/
updated?: string;
/**
* The time the conversation was destroyed (if applicable).
* @readonly
*/
destroyed?: string;
};
/**
* Communication channels (optional).
*
* @remarks
* This is not set when fetching a converstion from the API.
*/
numbers?: Array<AnyChannel>;
/**
* Callback information (optional).
*
* @remarks
* This is not set when fetching a converstion from the API.
*/
callback?: ConversationCallback;
};