Skip to content

Commit 7635a2d

Browse files
James RobertsonJames Robertson
James Robertson
authored and
James Robertson
committed
Introduce announcement API + Introduce metadata API + Ensure all moderation paths are under Moderation API
1 parent 61b04c7 commit 7635a2d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+24577
-9938
lines changed

‎.openapi-generator/FILES

+28-18
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,32 @@
11
.gitignore
2-
AdvancedAnalyticsApi.md
3-
AnnouncementsApi.md
2+
AnnouncementApi.md
43
ApplicationApi.md
5-
BotInterfaceApi.md
4+
BotApi.md
65
DataExportApi.md
7-
DataPrivacyApi.md
8-
EmojisApi.md
96
GroupChannelApi.md
10-
MessagesApi.md
11-
MigrationApi.md
7+
MessageApi.md
8+
MetadataApi.md
9+
ModerationApi.md
1210
OpenChannelApi.md
11+
PrivacyApi.md
1312
README.md
14-
ReportContentSubjectApi.md
13+
ReportApi.md
14+
StatisticsApi.md
1515
UserApi.md
16-
UserChannelMetadataApi.md
1716
WebhooksApi.md
18-
apis/AdvancedAnalyticsApi.ts
19-
apis/AnnouncementsApi.ts
17+
apis/AnnouncementApi.ts
2018
apis/ApplicationApi.ts
21-
apis/BotInterfaceApi.ts
19+
apis/BotApi.ts
2220
apis/DataExportApi.ts
23-
apis/DataPrivacyApi.ts
24-
apis/EmojisApi.ts
2521
apis/GroupChannelApi.ts
26-
apis/MessagesApi.ts
27-
apis/MigrationApi.ts
22+
apis/MessageApi.ts
23+
apis/MetadataApi.ts
24+
apis/ModerationApi.ts
2825
apis/OpenChannelApi.ts
29-
apis/ReportContentSubjectApi.ts
26+
apis/PrivacyApi.ts
27+
apis/ReportApi.ts
28+
apis/StatisticsApi.ts
3029
apis/UserApi.ts
31-
apis/UserChannelMetadataApi.ts
3230
apis/WebhooksApi.ts
3331
apis/baseapi.ts
3432
apis/exception.ts
@@ -61,6 +59,7 @@ models/AddReactionToAMessageResponse.ts
6159
models/AddRegistrationOrDeviceTokenData.ts
6260
models/AddRegistrationOrDeviceTokenResponse.ts
6361
models/BanFromChannelsWithCustomChannelTypesData.ts
62+
models/BanUsersInChannelsWithCustomChannelTypeData.ts
6463
models/Blob.ts
6564
models/BlockUserData.ts
6665
models/BlockUserResponse.ts
@@ -77,6 +76,7 @@ models/CreateChannelMetadataResponse.ts
7776
models/CreateUserData.ts
7877
models/CreateUserMetadataData.ts
7978
models/CreateUserMetadataResponse.ts
79+
models/CustomTypeListBannedUsersResponse.ts
8080
models/DeleteAllowedIpsFromWhitelistResponse.ts
8181
models/DeleteApnsCertificateByIdResponse.ts
8282
models/EnableReactionsData.ts
@@ -123,6 +123,7 @@ models/GetStatisticsDailyResponseStatistics.ts
123123
models/GetStatisticsMonthlyResponse.ts
124124
models/GetStatisticsResponse.ts
125125
models/InlineResponse200.ts
126+
models/InlineResponse2001.ts
126127
models/JoinChannelsData.ts
127128
models/JoinChannelsResponse.ts
128129
models/LeaveMyGroupChannelsData.ts
@@ -169,6 +170,7 @@ models/ListUsersResponse.ts
169170
models/MarkAllMessagesAsReadData.ts
170171
models/ModelFile.ts
171172
models/MuteInChannelsWithCustomChannelTypesData.ts
173+
models/MuteUsersInChannelsWithCustomChannelTypeData.ts
172174
models/ObjectSerializer.ts
173175
models/OcBanUserData.ts
174176
models/OcBanUserResponse.ts
@@ -251,6 +253,7 @@ models/SendBirdUser.ts
251253
models/SendBirdUserMessageParams.ts
252254
models/SendBotSMessageData.ts
253255
models/SendMessageData.ts
256+
models/SetDomainFilterData.ts
254257
models/UpdateAnnouncementByIdData.ts
255258
models/UpdateAnnouncementByIdResponse.ts
256259
models/UpdateAnnouncementByIdResponseMessage.ts
@@ -287,6 +290,13 @@ models/UpdateUserMetadataData.ts
287290
models/UpdateUserMetadataResponse.ts
288291
models/UseDefaultEmojisData.ts
289292
models/UseDefaultEmojisResponse.ts
293+
models/V3ApplicationsSettingsByChannelCustomTypeCustomTypeBanBannedList.ts
294+
models/V3ApplicationsSettingsGlobalCustomTypeDomainFilter.ts
295+
models/V3ApplicationsSettingsGlobalCustomTypeImageModeration.ts
296+
models/V3ApplicationsSettingsGlobalCustomTypeImageModerationLimits.ts
297+
models/V3ApplicationsSettingsGlobalCustomTypeProfanityFilter.ts
298+
models/V3ApplicationsSettingsGlobalCustomTypeProfanityFilterRegexFilters.ts
299+
models/V3ApplicationsSettingsGlobalCustomTypeProfanityTriggeredModeration.ts
290300
models/ViewAnnouncementByIdResponse.ts
291301
models/ViewBotByIdResponse.ts
292302
models/ViewChannelInvitationPreferenceResponse.ts

‎AnnouncementApi.md

+260
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,260 @@
1+
# .AnnouncementApi
2+
3+
All URIs are relative to *https://api-APP_ID.sendbird.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getDetailedOpenRateOfAnnouncementById**](AnnouncementApi.md#getDetailedOpenRateOfAnnouncementById) | **GET** /v3/announcement_open_rate/{unique_id} | Get detailed open rate of an announcement
8+
[**getDetailedOpenRateOfAnnouncementGroup**](AnnouncementApi.md#getDetailedOpenRateOfAnnouncementGroup) | **GET** /v3/announcement_open_rate_by_group/{announcement_group} | Get detailed open rate of an announcement group
9+
[**getDetailedOpenStatusOfAnnouncementById**](AnnouncementApi.md#getDetailedOpenStatusOfAnnouncementById) | **GET** /v3/announcement_open_status/{unique_id} | Get detailed open status of an announcement
10+
[**viewAnnouncementById**](AnnouncementApi.md#viewAnnouncementById) | **GET** /v3/announcements/{unique_id} | View an announcement
11+
12+
13+
# **getDetailedOpenRateOfAnnouncementById**
14+
> GetDetailedOpenRateOfAnnouncementByIdResponse getDetailedOpenRateOfAnnouncementById()
15+
16+
## Get detailed open rate of an announcement Retrieves the detailed open rate information of an announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-rate-of-an-announcement ---------------------------- `unique_id` Type: string Description: Specifies the unique ID of the announcement to get its open rate.
17+
18+
### Example
19+
20+
21+
```typescript
22+
import { } from '';
23+
import * as fs from 'fs';
24+
25+
const configuration = .createConfiguration();
26+
const apiInstance = new .AnnouncementApi(configuration);
27+
28+
let body:.AnnouncementApiGetDetailedOpenRateOfAnnouncementByIdRequest = {
29+
// string
30+
apiToken: "{{API_TOKEN}}",
31+
// string
32+
uniqueId: "unique_id_example",
33+
};
34+
35+
apiInstance.getDetailedOpenRateOfAnnouncementById(body).then((data:any) => {
36+
console.log('API called successfully. Returned data: ' + data);
37+
}).catch((error:any) => console.error(error));
38+
```
39+
40+
41+
### Parameters
42+
43+
Name | Type | Description | Notes
44+
------------- | ------------- | ------------- | -------------
45+
**apiToken** | [**string**] | | defaults to undefined
46+
**uniqueId** | [**string**] | | defaults to undefined
47+
48+
49+
### Return type
50+
51+
**GetDetailedOpenRateOfAnnouncementByIdResponse**
52+
53+
### Authorization
54+
55+
No authorization required
56+
57+
### HTTP request headers
58+
59+
- **Content-Type**: Not defined
60+
- **Accept**: application/json
61+
62+
63+
### HTTP response details
64+
| Status code | Description | Response headers |
65+
|-------------|-------------|------------------|
66+
**200** | Successful response | - |
67+
68+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
69+
70+
# **getDetailedOpenRateOfAnnouncementGroup**
71+
> GetDetailedOpenRateOfAnnouncementGroupResponse getDetailedOpenRateOfAnnouncementGroup()
72+
73+
## Get detailed open rate of an announcement group Retrieves the detailed open rate information of an announcement group. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-rate-of-an-announcement-group ----------------------------
74+
75+
### Example
76+
77+
78+
```typescript
79+
import { } from '';
80+
import * as fs from 'fs';
81+
82+
const configuration = .createConfiguration();
83+
const apiInstance = new .AnnouncementApi(configuration);
84+
85+
let body:.AnnouncementApiGetDetailedOpenRateOfAnnouncementGroupRequest = {
86+
// string
87+
apiToken: "{{API_TOKEN}}",
88+
// string
89+
announcementGroup: "announcement_group_example",
90+
};
91+
92+
apiInstance.getDetailedOpenRateOfAnnouncementGroup(body).then((data:any) => {
93+
console.log('API called successfully. Returned data: ' + data);
94+
}).catch((error:any) => console.error(error));
95+
```
96+
97+
98+
### Parameters
99+
100+
Name | Type | Description | Notes
101+
------------- | ------------- | ------------- | -------------
102+
**apiToken** | [**string**] | | defaults to undefined
103+
**announcementGroup** | [**string**] | | defaults to undefined
104+
105+
106+
### Return type
107+
108+
**GetDetailedOpenRateOfAnnouncementGroupResponse**
109+
110+
### Authorization
111+
112+
No authorization required
113+
114+
### HTTP request headers
115+
116+
- **Content-Type**: Not defined
117+
- **Accept**: application/json
118+
119+
120+
### HTTP response details
121+
| Status code | Description | Response headers |
122+
|-------------|-------------|------------------|
123+
**200** | Successful response | - |
124+
125+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
126+
127+
# **getDetailedOpenStatusOfAnnouncementById**
128+
> GetDetailedOpenStatusOfAnnouncementByIdResponse getDetailedOpenStatusOfAnnouncementById()
129+
130+
## Get detailed open status of an announcement Retrieves the detailed open status information of a specific announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-get-detailed-open-status-of-an-announcement ----------------------------
131+
132+
### Example
133+
134+
135+
```typescript
136+
import { } from '';
137+
import * as fs from 'fs';
138+
139+
const configuration = .createConfiguration();
140+
const apiInstance = new .AnnouncementApi(configuration);
141+
142+
let body:.AnnouncementApiGetDetailedOpenStatusOfAnnouncementByIdRequest = {
143+
// string
144+
apiToken: "{{API_TOKEN}}",
145+
// string
146+
uniqueId: "unique_id_example",
147+
// number (optional)
148+
limit: 1,
149+
// string (optional)
150+
next: "next_example",
151+
// Array<string> (optional)
152+
uniqueIds: [
153+
"unique_ids_example",
154+
],
155+
// Array<string> (optional)
156+
channelUrls: [
157+
"channel_urls_example",
158+
],
159+
// boolean (optional)
160+
hasOpened: true,
161+
};
162+
163+
apiInstance.getDetailedOpenStatusOfAnnouncementById(body).then((data:any) => {
164+
console.log('API called successfully. Returned data: ' + data);
165+
}).catch((error:any) => console.error(error));
166+
```
167+
168+
169+
### Parameters
170+
171+
Name | Type | Description | Notes
172+
------------- | ------------- | ------------- | -------------
173+
**apiToken** | [**string**] | | defaults to undefined
174+
**uniqueId** | [**string**] | | defaults to undefined
175+
**limit** | [**number**] | | (optional) defaults to undefined
176+
**next** | [**string**] | | (optional) defaults to undefined
177+
**uniqueIds** | **Array&lt;string&gt;** | | (optional) defaults to undefined
178+
**channelUrls** | **Array&lt;string&gt;** | | (optional) defaults to undefined
179+
**hasOpened** | [**boolean**] | | (optional) defaults to undefined
180+
181+
182+
### Return type
183+
184+
**GetDetailedOpenStatusOfAnnouncementByIdResponse**
185+
186+
### Authorization
187+
188+
No authorization required
189+
190+
### HTTP request headers
191+
192+
- **Content-Type**: Not defined
193+
- **Accept**: application/json
194+
195+
196+
### HTTP response details
197+
| Status code | Description | Response headers |
198+
|-------------|-------------|------------------|
199+
**200** | Successful response | - |
200+
201+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
202+
203+
# **viewAnnouncementById**
204+
> ViewAnnouncementByIdResponse viewAnnouncementById()
205+
206+
## View an announcement Retrieves information on a specific announcement. https://sendbird.com/docs/chat/v3/platform-api/guides/announcements#2-view-an-announcement ----------------------------
207+
208+
### Example
209+
210+
211+
```typescript
212+
import { } from '';
213+
import * as fs from 'fs';
214+
215+
const configuration = .createConfiguration();
216+
const apiInstance = new .AnnouncementApi(configuration);
217+
218+
let body:.AnnouncementApiViewAnnouncementByIdRequest = {
219+
// string
220+
apiToken: "{{API_TOKEN}}",
221+
// string
222+
uniqueId: "unique_id_example",
223+
};
224+
225+
apiInstance.viewAnnouncementById(body).then((data:any) => {
226+
console.log('API called successfully. Returned data: ' + data);
227+
}).catch((error:any) => console.error(error));
228+
```
229+
230+
231+
### Parameters
232+
233+
Name | Type | Description | Notes
234+
------------- | ------------- | ------------- | -------------
235+
**apiToken** | [**string**] | | defaults to undefined
236+
**uniqueId** | [**string**] | | defaults to undefined
237+
238+
239+
### Return type
240+
241+
**ViewAnnouncementByIdResponse**
242+
243+
### Authorization
244+
245+
No authorization required
246+
247+
### HTTP request headers
248+
249+
- **Content-Type**: Not defined
250+
- **Accept**: application/json
251+
252+
253+
### HTTP response details
254+
| Status code | Description | Response headers |
255+
|-------------|-------------|------------------|
256+
**200** | Successful response | - |
257+
258+
[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)
259+
260+

0 commit comments

Comments
 (0)