|
1 | | -# [Conversations API] |
| 1 | +# V 3.0.0 |
2 | 2 |
|
3 | | -## Added |
| 3 | +## [Conversations API] |
| 4 | + |
| 5 | +### Added |
4 | 6 |
|
5 | 7 | 1. Method to create Conversation `conversation.create({userId, body})` |
6 | 8 | 2. New param to find Conversation – `display_as` –> `conversation.find({id, inPlainText})` |
|
16 | 18 | 10. Method to search Conversation using nested/flat filters `conversation.search({data})` |
17 | 19 | 11. Method to redact Conversation's part `conversation.redactConversationPart({conversationId, conversationPartId, sourceId, type})` |
18 | 20 |
|
19 | | -## Changed |
| 21 | +### Changed |
20 | 22 |
|
21 | 23 | 1. Method to reply to conversation is now split to two different ones: |
22 | 24 | 1.1. Reply by ID: |
|
36 | 38 | } |
37 | 39 | ``` |
38 | 40 |
|
39 | | -# [Contacts API] |
| 41 | +## [Contacts API] |
40 | 42 |
|
41 | | -## Added |
| 43 | +### Added |
42 | 44 |
|
43 | 45 | 1. Method to archive Contact -> `contacts.archive({id})` |
44 | 46 | 2. Method to unarchive Contact -> `contacts.unarchive({id})` |
|
48 | 50 | 6. Method to list attached email subscriptions -> `contacts.listAttachedEmailSubscriptions({id})` |
49 | 51 | 7. Method to search Contact by filters `contacts.search({data})` |
50 | 52 |
|
51 | | -## Changed |
| 53 | +### Changed |
52 | 54 |
|
53 | 55 | 1. Methods to create Contact: |
54 | 56 | 1.1. Create User -> `contacts.createUser({externalId phone, name, avatar, signedUpAt, lastSeenAt, ownerId, isUnsubscribedFromEmails, customAttributes})` |
|
58 | 60 | 4. Removed `listBy` method |
59 | 61 | 5. Removed `convert` method |
60 | 62 |
|
61 | | -# [Tags API] |
| 63 | +## [Tags API] |
62 | 64 |
|
63 | | -## Added |
| 65 | +### Added |
64 | 66 |
|
65 | 67 | 1. Method to tag Contact -> `tags.tagContact({contactId, tagId})` |
66 | 68 | 2. Method to untag Contact -> `tags.untagContact({contactId, tagId})` |
|
69 | 71 | 5. Method to tag Companies -> `tags.tagCompanies({companiesIds, tagName})` |
70 | 72 | 6. Method to untag Companies -> `tags.untagCompanies({companiesIds, tagName})` |
71 | 73 |
|
72 | | -## Changed |
| 74 | +### Changed |
73 | 75 |
|
74 | 76 | 1. Methods to Create/Update Tag: |
75 | 77 | 1.1. Create -> `tags.create({name})` |
76 | 78 | 1.2. Update -> `tags.update({id, name})` |
77 | 79 |
|
78 | | -# [Teams API] |
| 80 | +## [Teams API] |
79 | 81 |
|
80 | | -## Added |
| 82 | +### Added |
81 | 83 |
|
82 | 84 | 1. Method to find Team by id -> `teams.find({id})` |
83 | 85 | 2. Method to list Teams -> `teams.list()` |
84 | 86 |
|
85 | | -# [Admin API] |
| 87 | +## [Admin API] |
86 | 88 |
|
87 | | -## Added |
| 89 | +### Added |
88 | 90 |
|
89 | 91 | 1. List all activities logs `admin.listAllActivities` |
90 | 92 |
|
91 | | -## Changed |
| 93 | +### Changed |
92 | 94 |
|
93 | 95 | 1. Params for `admin.away` method -> `admin.away({adminId, enableAwayMode, enableReassignMode})` |
94 | 96 |
|
95 | | -## Removed |
| 97 | +### Removed |
96 | 98 |
|
97 | 99 | 1. `admin.me` method. |
98 | 100 |
|
99 | | -# [Companies API] |
| 101 | +## [Companies API] |
100 | 102 |
|
101 | | -## Added |
| 103 | +### Added |
102 | 104 |
|
103 | 105 | 1. Method to delete Company `companies.delete({ id })` |
104 | 106 | 2. Method to attach Contact to Company `companies.attachContact({ companyId, contactId })` |
105 | 107 | 3. Method to detach Contact from Company `companies.detachContact({ companyId, contactId })` |
106 | 108 | 4. Method to list attached Contacts for Company `companies.listAttachedContacts({ companyId, page, perPage })` |
107 | 109 | 5. Method to list attached Segments for Company `companies.listAttachedSegments({ companyId })` |
108 | 110 |
|
109 | | -## Changed |
| 111 | +### Changed |
110 | 112 |
|
111 | 113 | 1. Method to create Companies `companies.create({createdAt, companyId, name, monthlySpend, plan, size, website, industry, customAttributes})` |
112 | 114 | 2. Method to update Companies `companies.update({createdAt, name, monthlySpend, plan, size, website, industry, customAttributes})` |
113 | 115 | 3. Method to find Company `companies.find({ name, companyId })` |
114 | 116 | 4. Method to list Companies `companies.list({tagId, segmentId, page, perPage, order})` |
115 | 117 | 5. Method to infinitely scroll (till the last Company) Companies `companies.scroll.each({scrollParam})` |
116 | | -6. # Method to manually scroll Companies `companies.scroll.next({scrollParam})` |
| 118 | +6. ## Method to manually scroll Companies `companies.scroll.next({scrollParam})` |
117 | 119 |
|
118 | | -# [Events API] |
| 120 | +## [Events API] |
119 | 121 |
|
120 | | -## Changed |
| 122 | +### Changed |
121 | 123 |
|
122 | 124 | 1. Params for `event.create` method -> `event.create({ eventName, createdAt, userId, id, email, metadata })` |
123 | 125 | 2. Params for `event.listBy` method -> `event.listBy({ userId, email, intercomUserId, perPage, summary })` |
124 | 126 |
|
125 | | -## Removed |
| 127 | +### Removed |
126 | 128 |
|
127 | 129 | 1. `event.bulk` method. |
128 | 130 |
|
129 | | -# [Segment API] |
| 131 | +## [Segment API] |
130 | 132 |
|
131 | | -## No changes |
| 133 | +### No changes |
132 | 134 |
|
133 | | -# [Data Attribute API] |
| 135 | +## [Data Attribute API] |
134 | 136 |
|
135 | | -## Added |
| 137 | +### Added |
136 | 138 |
|
137 | 139 | 1. Method to create Data Attribute `dataAttribute.create({ name, model, dataType, description, options,})` |
138 | 140 | 2. Method to update Data Attribute `dataAttribute.update({id, archived, description, options,})` |
|
0 commit comments