Skip to content

Commit cfc7694

Browse files
VoloVolo
authored andcommitted
Update Changelog
1 parent 6128908 commit cfc7694

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

CHANGELOG.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# [Conversations API]
1+
# V 3.0.0
22

3-
## Added
3+
## [Conversations API]
4+
5+
### Added
46

57
1. Method to create Conversation `conversation.create({userId, body})`
68
2. New param to find Conversation – `display_as` –> `conversation.find({id, inPlainText})`
@@ -16,7 +18,7 @@
1618
10. Method to search Conversation using nested/flat filters `conversation.search({data})`
1719
11. Method to redact Conversation's part `conversation.redactConversationPart({conversationId, conversationPartId, sourceId, type})`
1820

19-
## Changed
21+
### Changed
2022

2123
1. Method to reply to conversation is now split to two different ones:
2224
1.1. Reply by ID:
@@ -36,9 +38,9 @@
3638
}
3739
```
3840

39-
# [Contacts API]
41+
## [Contacts API]
4042

41-
## Added
43+
### Added
4244

4345
1. Method to archive Contact -> `contacts.archive({id})`
4446
2. Method to unarchive Contact -> `contacts.unarchive({id})`
@@ -48,7 +50,7 @@
4850
6. Method to list attached email subscriptions -> `contacts.listAttachedEmailSubscriptions({id})`
4951
7. Method to search Contact by filters `contacts.search({data})`
5052

51-
## Changed
53+
### Changed
5254

5355
1. Methods to create Contact:
5456
1.1. Create User -> `contacts.createUser({externalId phone, name, avatar, signedUpAt, lastSeenAt, ownerId, isUnsubscribedFromEmails, customAttributes})`
@@ -58,9 +60,9 @@
5860
4. Removed `listBy` method
5961
5. Removed `convert` method
6062

61-
# [Tags API]
63+
## [Tags API]
6264

63-
## Added
65+
### Added
6466

6567
1. Method to tag Contact -> `tags.tagContact({contactId, tagId})`
6668
2. Method to untag Contact -> `tags.untagContact({contactId, tagId})`
@@ -69,70 +71,70 @@
6971
5. Method to tag Companies -> `tags.tagCompanies({companiesIds, tagName})`
7072
6. Method to untag Companies -> `tags.untagCompanies({companiesIds, tagName})`
7173

72-
## Changed
74+
### Changed
7375

7476
1. Methods to Create/Update Tag:
7577
1.1. Create -> `tags.create({name})`
7678
1.2. Update -> `tags.update({id, name})`
7779

78-
# [Teams API]
80+
## [Teams API]
7981

80-
## Added
82+
### Added
8183

8284
1. Method to find Team by id -> `teams.find({id})`
8385
2. Method to list Teams -> `teams.list()`
8486

85-
# [Admin API]
87+
## [Admin API]
8688

87-
## Added
89+
### Added
8890

8991
1. List all activities logs `admin.listAllActivities`
9092

91-
## Changed
93+
### Changed
9294

9395
1. Params for `admin.away` method -> `admin.away({adminId, enableAwayMode, enableReassignMode})`
9496

95-
## Removed
97+
### Removed
9698

9799
1. `admin.me` method.
98100

99-
# [Companies API]
101+
## [Companies API]
100102

101-
## Added
103+
### Added
102104

103105
1. Method to delete Company `companies.delete({ id })`
104106
2. Method to attach Contact to Company `companies.attachContact({ companyId, contactId })`
105107
3. Method to detach Contact from Company `companies.detachContact({ companyId, contactId })`
106108
4. Method to list attached Contacts for Company `companies.listAttachedContacts({ companyId, page, perPage })`
107109
5. Method to list attached Segments for Company `companies.listAttachedSegments({ companyId })`
108110

109-
## Changed
111+
### Changed
110112

111113
1. Method to create Companies `companies.create({createdAt, companyId, name, monthlySpend, plan, size, website, industry, customAttributes})`
112114
2. Method to update Companies `companies.update({createdAt, name, monthlySpend, plan, size, website, industry, customAttributes})`
113115
3. Method to find Company `companies.find({ name, companyId })`
114116
4. Method to list Companies `companies.list({tagId, segmentId, page, perPage, order})`
115117
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})`
117119

118-
# [Events API]
120+
## [Events API]
119121

120-
## Changed
122+
### Changed
121123

122124
1. Params for `event.create` method -> `event.create({ eventName, createdAt, userId, id, email, metadata })`
123125
2. Params for `event.listBy` method -> `event.listBy({ userId, email, intercomUserId, perPage, summary })`
124126

125-
## Removed
127+
### Removed
126128

127129
1. `event.bulk` method.
128130

129-
# [Segment API]
131+
## [Segment API]
130132

131-
## No changes
133+
### No changes
132134

133-
# [Data Attribute API]
135+
## [Data Attribute API]
134136

135-
## Added
137+
### Added
136138

137139
1. Method to create Data Attribute `dataAttribute.create({ name, model, dataType, description, options,})`
138140
2. Method to update Data Attribute `dataAttribute.update({id, archived, description, options,})`

0 commit comments

Comments
 (0)