@favish/staffbase-utils 0.16.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/types/groups/CreateGroupBody.d.ts +12 -0
- package/dist/src/types/groups/CreateGroupBody.d.ts.map +1 -0
- package/dist/src/types/groups/Group.d.ts +47 -0
- package/dist/src/types/groups/Group.d.ts.map +1 -0
- package/dist/src/types/groups/GroupAccessors.d.ts +13 -0
- package/dist/src/types/groups/GroupAccessors.d.ts.map +1 -0
- package/dist/src/types/groups/GroupAdminsWithGroups.d.ts +18 -0
- package/dist/src/types/groups/GroupAdminsWithGroups.d.ts.map +1 -0
- package/dist/src/types/groups/GroupBranch.d.ts +23 -0
- package/dist/src/types/groups/GroupBranch.d.ts.map +1 -0
- package/dist/src/types/groups/GroupConfig.d.ts +16 -0
- package/dist/src/types/groups/GroupConfig.d.ts.map +1 -0
- package/dist/src/types/groups/GroupConfigLocalization.d.ts +13 -0
- package/dist/src/types/groups/GroupConfigLocalization.d.ts.map +1 -0
- package/dist/src/types/groups/GroupUser.d.ts +51 -0
- package/dist/src/types/groups/GroupUser.d.ts.map +1 -0
- package/dist/src/types/groups/GroupUsers.d.ts +21 -0
- package/dist/src/types/groups/GroupUsers.d.ts.map +1 -0
- package/dist/src/types/groups/UpdateGroupBody.d.ts +12 -0
- package/dist/src/types/groups/UpdateGroupBody.d.ts.map +1 -0
- package/dist/src/types/groups/generated/groupsApi.d.ts +739 -0
- package/dist/src/types/groups/generated/groupsApi.d.ts.map +1 -0
- package/dist/src/types/groups/index.d.ts +11 -0
- package/dist/src/types/groups/index.d.ts.map +1 -0
- package/dist/src/types/news/CreatePostBody.d.ts +11 -0
- package/dist/src/types/news/CreatePostBody.d.ts.map +1 -0
- package/dist/src/types/news/Post.d.ts +73 -0
- package/dist/src/types/news/Post.d.ts.map +1 -0
- package/dist/src/types/news/PostAcknowledgements.d.ts +14 -0
- package/dist/src/types/news/PostAcknowledgements.d.ts.map +1 -0
- package/dist/src/types/news/PostAuthor.d.ts +16 -0
- package/dist/src/types/news/PostAuthor.d.ts.map +1 -0
- package/dist/src/types/news/PostAuthorAvatar.d.ts +17 -0
- package/dist/src/types/news/PostAuthorAvatar.d.ts.map +1 -0
- package/dist/src/types/news/PostComments.d.ts +11 -0
- package/dist/src/types/news/PostComments.d.ts.map +1 -0
- package/dist/src/types/news/PostLayout.d.ts +12 -0
- package/dist/src/types/news/PostLayout.d.ts.map +1 -0
- package/dist/src/types/news/PostLikes.d.ts +12 -0
- package/dist/src/types/news/PostLikes.d.ts.map +1 -0
- package/dist/src/types/news/PostSource.d.ts +11 -0
- package/dist/src/types/news/PostSource.d.ts.map +1 -0
- package/dist/src/types/news/UpdatePostBody.d.ts +10 -0
- package/dist/src/types/news/UpdatePostBody.d.ts.map +1 -0
- package/dist/src/types/news/generated/newsApi.d.ts +1433 -0
- package/dist/src/types/news/generated/newsApi.d.ts.map +1 -0
- package/dist/src/types/news/index.d.ts +11 -0
- package/dist/src/types/news/index.d.ts.map +1 -0
- package/dist/src/types/pages/CreatePagePayload.d.ts +12 -0
- package/dist/src/types/pages/CreatePagePayload.d.ts.map +1 -0
- package/dist/src/types/pages/Page.d.ts +51 -0
- package/dist/src/types/pages/Page.d.ts.map +1 -0
- package/dist/src/types/pages/PageAccess.d.ts +20 -0
- package/dist/src/types/pages/PageAccess.d.ts.map +1 -0
- package/dist/src/types/pages/PageContent.d.ts +18 -0
- package/dist/src/types/pages/PageContent.d.ts.map +1 -0
- package/dist/src/types/pages/UpdatePagePayload.d.ts +11 -0
- package/dist/src/types/pages/UpdatePagePayload.d.ts.map +1 -0
- package/dist/src/types/pages/generated/pagesApi.d.ts +418 -0
- package/dist/src/types/pages/generated/pagesApi.d.ts.map +1 -0
- package/dist/src/types/pages/index.d.ts +6 -0
- package/dist/src/types/pages/index.d.ts.map +1 -0
- package/dist/src/types/user/CreateUserBody.d.ts +11 -0
- package/dist/src/types/user/CreateUserBody.d.ts.map +1 -0
- package/dist/src/types/user/UpdateUserBody.d.ts +11 -0
- package/dist/src/types/user/UpdateUserBody.d.ts.map +1 -0
- package/dist/src/types/user/User.d.ts +65 -0
- package/dist/src/types/user/User.d.ts.map +1 -0
- package/dist/src/types/user/UserAvatar.d.ts +19 -0
- package/dist/src/types/user/UserAvatar.d.ts.map +1 -0
- package/dist/src/types/user/UserAvatarVariant.d.ts +23 -0
- package/dist/src/types/user/UserAvatarVariant.d.ts.map +1 -0
- package/dist/src/types/user/UserConfig.d.ts +11 -0
- package/dist/src/types/user/UserConfig.d.ts.map +1 -0
- package/dist/src/types/user/UserCreation.d.ts +16 -0
- package/dist/src/types/user/UserCreation.d.ts.map +1 -0
- package/dist/src/types/user/UserEmail.d.ts +15 -0
- package/dist/src/types/user/UserEmail.d.ts.map +1 -0
- package/dist/src/types/user/UserName.d.ts +13 -0
- package/dist/src/types/user/UserName.d.ts.map +1 -0
- package/dist/src/types/user/UserProfile.d.ts +28 -0
- package/dist/src/types/user/UserProfile.d.ts.map +1 -0
- package/dist/src/types/user/UserRecoveryCode.d.ts +17 -0
- package/dist/src/types/user/UserRecoveryCode.d.ts.map +1 -0
- package/dist/src/types/user/UserRole.d.ts +12 -0
- package/dist/src/types/user/UserRole.d.ts.map +1 -0
- package/dist/src/types/user/UserSecret.d.ts +20 -0
- package/dist/src/types/user/UserSecret.d.ts.map +1 -0
- package/dist/src/types/user/generated/userApi.d.ts +1525 -0
- package/dist/src/types/user/generated/userApi.d.ts.map +1 -0
- package/dist/src/types/user/index.d.ts +14 -0
- package/dist/src/types/user/index.d.ts.map +1 -0
- package/dist/types/groups.cjs.js +1 -0
- package/dist/types/groups.es.mjs +0 -0
- package/dist/types/news.cjs.js +1 -0
- package/dist/types/news.es.mjs +0 -0
- package/dist/types/pages.cjs.js +1 -0
- package/dist/types/pages.es.mjs +0 -0
- package/dist/types/user.cjs.js +1 -0
- package/dist/types/user.es.mjs +0 -0
- package/package.json +26 -1
|
@@ -0,0 +1,1433 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
export interface paths {
|
|
6
|
+
'/branch/channels': {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* List manageable news channels
|
|
15
|
+
* @description Fetch a list of all news channels that are manageable within the current accessor (API-token/user). The result includes news channels that are not published.
|
|
16
|
+
*/
|
|
17
|
+
get: operations['GetBranchChannels'];
|
|
18
|
+
put?: never;
|
|
19
|
+
post?: never;
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
'/channels': {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path?: never;
|
|
31
|
+
cookie?: never;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* List accessible news channels
|
|
35
|
+
* @description Fetch a list of all accessible channels for the current accessor (API-token/user).
|
|
36
|
+
*/
|
|
37
|
+
get: operations['GetChannels'];
|
|
38
|
+
put?: never;
|
|
39
|
+
post?: never;
|
|
40
|
+
delete?: never;
|
|
41
|
+
options?: never;
|
|
42
|
+
head?: never;
|
|
43
|
+
patch?: never;
|
|
44
|
+
trace?: never;
|
|
45
|
+
};
|
|
46
|
+
'/channels/{channelID}': {
|
|
47
|
+
parameters: {
|
|
48
|
+
query?: never;
|
|
49
|
+
header?: never;
|
|
50
|
+
path?: never;
|
|
51
|
+
cookie?: never;
|
|
52
|
+
};
|
|
53
|
+
/**
|
|
54
|
+
* Fetch a news channel
|
|
55
|
+
* @description Fetch an existing news channel by its ID
|
|
56
|
+
*/
|
|
57
|
+
get: operations['GetChannel'];
|
|
58
|
+
put?: never;
|
|
59
|
+
post?: never;
|
|
60
|
+
delete?: never;
|
|
61
|
+
options?: never;
|
|
62
|
+
head?: never;
|
|
63
|
+
patch?: never;
|
|
64
|
+
trace?: never;
|
|
65
|
+
};
|
|
66
|
+
'/channels/{channelID}/posts': {
|
|
67
|
+
parameters: {
|
|
68
|
+
query?: never;
|
|
69
|
+
header?: never;
|
|
70
|
+
path?: never;
|
|
71
|
+
cookie?: never;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* List posts of a news channel
|
|
75
|
+
* @description Fetch a list of news posts that belong to the news channel.
|
|
76
|
+
*/
|
|
77
|
+
get: operations['GetChannelPosts'];
|
|
78
|
+
put?: never;
|
|
79
|
+
/**
|
|
80
|
+
* Create a new post
|
|
81
|
+
* @description Creates a new post in the channel and returns the newly created post.<div class="sb-box sb-box--tip"> To assign the post to a campaign, use the <span class="mdx-code">campaignId</span> parameter in the [create campaign reference](/api/api-campaigns/#tag/campaignsreferences/operation/CreateCampaignReference) endpoint of the Campaigns API. </div>
|
|
82
|
+
*/
|
|
83
|
+
post: operations['CreateChannelPost'];
|
|
84
|
+
delete?: never;
|
|
85
|
+
options?: never;
|
|
86
|
+
head?: never;
|
|
87
|
+
patch?: never;
|
|
88
|
+
trace?: never;
|
|
89
|
+
};
|
|
90
|
+
'/posts': {
|
|
91
|
+
parameters: {
|
|
92
|
+
query?: never;
|
|
93
|
+
header?: never;
|
|
94
|
+
path?: never;
|
|
95
|
+
cookie?: never;
|
|
96
|
+
};
|
|
97
|
+
/**
|
|
98
|
+
* List all accessible news posts
|
|
99
|
+
* @description Fetch a list of all news posts that are accessible for the current accessor (API-token/user).
|
|
100
|
+
*/
|
|
101
|
+
get: operations['GetPosts'];
|
|
102
|
+
put?: never;
|
|
103
|
+
post?: never;
|
|
104
|
+
delete?: never;
|
|
105
|
+
options?: never;
|
|
106
|
+
head?: never;
|
|
107
|
+
patch?: never;
|
|
108
|
+
trace?: never;
|
|
109
|
+
};
|
|
110
|
+
'/posts/search': {
|
|
111
|
+
parameters: {
|
|
112
|
+
query?: never;
|
|
113
|
+
header?: never;
|
|
114
|
+
path?: never;
|
|
115
|
+
cookie?: never;
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Search news posts
|
|
119
|
+
* @description Fetch a list of news posts that match the search query in the content, hashtags, image description, teasers, or titles. <div class="sb-box sb-box--note"> This endpoint is in **Beta** and is available for early use and feedback. It may still undergo changes and improvements.</div>
|
|
120
|
+
*/
|
|
121
|
+
get: operations['SearchPosts'];
|
|
122
|
+
put?: never;
|
|
123
|
+
post?: never;
|
|
124
|
+
delete?: never;
|
|
125
|
+
options?: never;
|
|
126
|
+
head?: never;
|
|
127
|
+
patch?: never;
|
|
128
|
+
trace?: never;
|
|
129
|
+
};
|
|
130
|
+
'/posts/{postID}': {
|
|
131
|
+
parameters: {
|
|
132
|
+
query?: never;
|
|
133
|
+
header?: never;
|
|
134
|
+
path?: never;
|
|
135
|
+
cookie?: never;
|
|
136
|
+
};
|
|
137
|
+
/**
|
|
138
|
+
* Fetch a news post
|
|
139
|
+
* @description Fetch an existing news post by its Id.
|
|
140
|
+
*/
|
|
141
|
+
get: operations['GetPost'];
|
|
142
|
+
/**
|
|
143
|
+
* Update a news post
|
|
144
|
+
* @description Updates an existing news post with the data provided in the request and returns the updated object as a response. <div class="sb-box sb-box--tip"> To assign the post to a campaign, use the <span class="mdx-code">campaignId</span> parameter in the [create campaign reference](/api/api-campaigns/#tag/campaignsreferences/operation/CreateCampaignReference) endpoint of the Campaigns API. </div>
|
|
145
|
+
*/
|
|
146
|
+
put: operations['UpdatePost'];
|
|
147
|
+
post?: never;
|
|
148
|
+
/**
|
|
149
|
+
* Delete a news post
|
|
150
|
+
* @description Remove a news post from the system by deleting it or moving it to the trash if trash is active on your platform.
|
|
151
|
+
*/
|
|
152
|
+
delete: operations['DeletePost'];
|
|
153
|
+
options?: never;
|
|
154
|
+
head?: never;
|
|
155
|
+
patch?: never;
|
|
156
|
+
trace?: never;
|
|
157
|
+
};
|
|
158
|
+
'/posts/{postID}/notifications': {
|
|
159
|
+
parameters: {
|
|
160
|
+
query?: never;
|
|
161
|
+
header?: never;
|
|
162
|
+
path?: never;
|
|
163
|
+
cookie?: never;
|
|
164
|
+
};
|
|
165
|
+
get?: never;
|
|
166
|
+
put?: never;
|
|
167
|
+
/**
|
|
168
|
+
* Resend notifications
|
|
169
|
+
* @description Resend notifications for a news post.
|
|
170
|
+
*/
|
|
171
|
+
post: operations['ResendNotifications'];
|
|
172
|
+
delete?: never;
|
|
173
|
+
options?: never;
|
|
174
|
+
head?: never;
|
|
175
|
+
patch?: never;
|
|
176
|
+
trace?: never;
|
|
177
|
+
};
|
|
178
|
+
'/posts/{postID}/acknowledgements': {
|
|
179
|
+
parameters: {
|
|
180
|
+
query?: never;
|
|
181
|
+
header?: never;
|
|
182
|
+
path?: never;
|
|
183
|
+
cookie?: never;
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* Fetch acknowledgements
|
|
187
|
+
* @description Fetch the list of acknowledgements for a news post. The acknowledgements are sorted by the point in time when the user acknowledged the post in descending order.
|
|
188
|
+
*/
|
|
189
|
+
get: operations['FetchAcknowledgements'];
|
|
190
|
+
put?: never;
|
|
191
|
+
post?: never;
|
|
192
|
+
delete?: never;
|
|
193
|
+
options?: never;
|
|
194
|
+
head?: never;
|
|
195
|
+
patch?: never;
|
|
196
|
+
trace?: never;
|
|
197
|
+
};
|
|
198
|
+
'/client/channels/{channelID}/posts': {
|
|
199
|
+
parameters: {
|
|
200
|
+
query?: never;
|
|
201
|
+
header?: never;
|
|
202
|
+
path?: never;
|
|
203
|
+
cookie?: never;
|
|
204
|
+
};
|
|
205
|
+
/**
|
|
206
|
+
* List posts of a channel for the client view
|
|
207
|
+
* @description Fetch a list of news posts for the client view from a single news channel. The client view includes only news posts that are accessible with the current accessor (API-token/user). The posts are ordered by their published date in descending order.
|
|
208
|
+
*/
|
|
209
|
+
get: operations['GetClientChannelPosts'];
|
|
210
|
+
put?: never;
|
|
211
|
+
post?: never;
|
|
212
|
+
delete?: never;
|
|
213
|
+
options?: never;
|
|
214
|
+
head?: never;
|
|
215
|
+
patch?: never;
|
|
216
|
+
trace?: never;
|
|
217
|
+
};
|
|
218
|
+
'/client/newspages/{newsPageID}/posts': {
|
|
219
|
+
parameters: {
|
|
220
|
+
query?: never;
|
|
221
|
+
header?: never;
|
|
222
|
+
path?: never;
|
|
223
|
+
cookie?: never;
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* List posts of a news page for the client view
|
|
227
|
+
* @description Fetch a list of news posts for the client view from a news channel. The client view includes only news posts that are accessible with the current accessor (API-token/user). A news page can contain multiple news channels. The posts are ordered by publish date.
|
|
228
|
+
*/
|
|
229
|
+
get: operations['GetClientNewsPagePosts'];
|
|
230
|
+
put?: never;
|
|
231
|
+
post?: never;
|
|
232
|
+
delete?: never;
|
|
233
|
+
options?: never;
|
|
234
|
+
head?: never;
|
|
235
|
+
patch?: never;
|
|
236
|
+
trace?: never;
|
|
237
|
+
};
|
|
238
|
+
'/client/newspages/{newsPageID}/channels': {
|
|
239
|
+
parameters: {
|
|
240
|
+
query?: never;
|
|
241
|
+
header?: never;
|
|
242
|
+
path?: never;
|
|
243
|
+
cookie?: never;
|
|
244
|
+
};
|
|
245
|
+
/**
|
|
246
|
+
* List channels of a news page for the client view
|
|
247
|
+
* @description Fetch a list of channels in which the current accessor (API-token/user) is contributor and therefore allowed to create posts in these channels.
|
|
248
|
+
*/
|
|
249
|
+
get: operations['GetClientNewsPageChannels'];
|
|
250
|
+
put?: never;
|
|
251
|
+
post?: never;
|
|
252
|
+
delete?: never;
|
|
253
|
+
options?: never;
|
|
254
|
+
head?: never;
|
|
255
|
+
patch?: never;
|
|
256
|
+
trace?: never;
|
|
257
|
+
};
|
|
258
|
+
'/client/newspages/{newsPageID}/rights': {
|
|
259
|
+
parameters: {
|
|
260
|
+
query?: never;
|
|
261
|
+
header?: never;
|
|
262
|
+
path?: never;
|
|
263
|
+
cookie?: never;
|
|
264
|
+
};
|
|
265
|
+
/**
|
|
266
|
+
* Fetch the rights for a news page
|
|
267
|
+
* @description Fetch the rights the current accessor has on the news page. This information can be used to determine if the accessor (API-token/user) is allowed to contribute to any news channel assigned to the newspage.
|
|
268
|
+
*/
|
|
269
|
+
get: operations['GetClientNewsPageRights'];
|
|
270
|
+
put?: never;
|
|
271
|
+
post?: never;
|
|
272
|
+
delete?: never;
|
|
273
|
+
options?: never;
|
|
274
|
+
head?: never;
|
|
275
|
+
patch?: never;
|
|
276
|
+
trace?: never;
|
|
277
|
+
};
|
|
278
|
+
}
|
|
279
|
+
export type webhooks = Record<string, never>;
|
|
280
|
+
export interface components {
|
|
281
|
+
schemas: {
|
|
282
|
+
Acknowledgement: {
|
|
283
|
+
/** @description The Id of the post this acknowledgement refers to. */
|
|
284
|
+
parentID?: string;
|
|
285
|
+
/** @description The Id of the user who acknowledged the post. */
|
|
286
|
+
userID?: string;
|
|
287
|
+
/** @description The Id of the acknowledgement. */
|
|
288
|
+
id?: string;
|
|
289
|
+
/** @description The date and time when the acknowledgement was created. */
|
|
290
|
+
created?: string;
|
|
291
|
+
};
|
|
292
|
+
BasicPost: {
|
|
293
|
+
/** @description Optional external identifier to easily reference this entity later. Allowed characters for the externalID are a-z (lower case), 0-9, _ and -. */
|
|
294
|
+
externalID?: string;
|
|
295
|
+
/** @description Planned post at the given date and time. */
|
|
296
|
+
planned?: string | null;
|
|
297
|
+
/** @description Contains a set of locale based keys, like "en_US" or "de_DE" with content fields for this language. */
|
|
298
|
+
contents?: {
|
|
299
|
+
/** @description A locale name. */
|
|
300
|
+
en_US?: {
|
|
301
|
+
/** @description Title of the news post. */
|
|
302
|
+
title: string;
|
|
303
|
+
/** @description Teaser for this news post, which will be used in notifications and as teaser in the news feed, among other things. */
|
|
304
|
+
teaser?: string;
|
|
305
|
+
/** @description The main content of the news post. Can contain html. */
|
|
306
|
+
content?: string;
|
|
307
|
+
/** @description URL that refers to the image that will be used as primary media of the news post. Will be used notifications and as teaser in the news feed, among other things. */
|
|
308
|
+
image?: string;
|
|
309
|
+
};
|
|
310
|
+
};
|
|
311
|
+
};
|
|
312
|
+
CreatePost: components['schemas']['BasicPost'] & {
|
|
313
|
+
/** @description Date of the publication. */
|
|
314
|
+
published?: 'now' | string;
|
|
315
|
+
/** @description Notification settings of the news post. Only use this property when you want to send out notifications. Available options depend on the default settings of the news channel. <br/><strong>Attention:</strong> When updating the news post, it will trigger a re-send of the notifications if you don't remove the property beforehand. */
|
|
316
|
+
notificationChannels?: ('email' | 'push')[];
|
|
317
|
+
};
|
|
318
|
+
UpdatePost: components['schemas']['BasicPost'] & {
|
|
319
|
+
/** @description The identifier for this news post which was assigned at creation. */
|
|
320
|
+
id?: string;
|
|
321
|
+
/** @description Date of the publication. */
|
|
322
|
+
published?: 'now' | string | null;
|
|
323
|
+
};
|
|
324
|
+
ResendCreateNotification: {
|
|
325
|
+
/** @description Send emails for this notification. */
|
|
326
|
+
email: boolean;
|
|
327
|
+
/** @description Send push notifications for this notification. */
|
|
328
|
+
push: boolean;
|
|
329
|
+
/**
|
|
330
|
+
* @description Define the target audience for the notification.
|
|
331
|
+
* @enum {string}
|
|
332
|
+
*/
|
|
333
|
+
recipients: 'all' | 'unread' | 'acknowledged';
|
|
334
|
+
/** @description Optional custom notification text for each post localization. If left empty the post content is used. */
|
|
335
|
+
contents?: {
|
|
336
|
+
[key: string]: {
|
|
337
|
+
/** @description Custom notification text */
|
|
338
|
+
text?: string;
|
|
339
|
+
};
|
|
340
|
+
};
|
|
341
|
+
};
|
|
342
|
+
CampaignIdField: {
|
|
343
|
+
/**
|
|
344
|
+
* @deprecated
|
|
345
|
+
* @description This field is read-only and will be completely removed on November 1, 2025.
|
|
346
|
+
* To assign or unassign post from campaigns, use [campaign reference](https://developers.staffbase.com/api/api-campaigns/#tag/campaignsreferences) in Campaigns API.
|
|
347
|
+
*
|
|
348
|
+
* Indicates the identifier of the campaign to which the post is assigned. If `null`, the post is not assigned to any campaign.
|
|
349
|
+
*/
|
|
350
|
+
campaignId?: string;
|
|
351
|
+
};
|
|
352
|
+
PostSearchResult: {
|
|
353
|
+
/** @description The unique identifier of the user who created the post. */
|
|
354
|
+
authorID?: string;
|
|
355
|
+
/** @description The unique identifier of the branch the post belongs to. */
|
|
356
|
+
branchID?: string;
|
|
357
|
+
/** @description The unique identifier of the channel the post belongs to. */
|
|
358
|
+
channelID?: string;
|
|
359
|
+
/** @description The contents of the post in different languages. */
|
|
360
|
+
contents?: {
|
|
361
|
+
/** @description The contents of the post in English. */
|
|
362
|
+
en_US?: {
|
|
363
|
+
/** @description The title of the post in English. */
|
|
364
|
+
title?: string;
|
|
365
|
+
/** @description The content of the post in English. */
|
|
366
|
+
content?: string;
|
|
367
|
+
/** @description The image of the post in English. */
|
|
368
|
+
image?: {
|
|
369
|
+
/** @description The original image of the post in English. */
|
|
370
|
+
original?: {
|
|
371
|
+
/** @description The width of the image in pixels. */
|
|
372
|
+
width?: number;
|
|
373
|
+
/** @description The height of the image in pixels. */
|
|
374
|
+
height?: number;
|
|
375
|
+
/** @description The size of the image in bytes. */
|
|
376
|
+
size?: number;
|
|
377
|
+
/** @description The format of the image. */
|
|
378
|
+
format?: string;
|
|
379
|
+
/** @description The mime type of the image. */
|
|
380
|
+
mimeType?: string;
|
|
381
|
+
/** @description The URL of the image. */
|
|
382
|
+
url?: string;
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
/** @description The contents of the post in German. */
|
|
387
|
+
de_DE?: {
|
|
388
|
+
/** @description The title of the post in German. */
|
|
389
|
+
title?: string;
|
|
390
|
+
/** @description The content of the post in German. */
|
|
391
|
+
content?: string;
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
/** @description The notification channels the post is sent to. */
|
|
395
|
+
notificationChannels?: ('email' | 'push')[];
|
|
396
|
+
/** @description Whether the post is highlighted. */
|
|
397
|
+
highlighted?: boolean;
|
|
398
|
+
/** @description Whether highlighting is allowed. */
|
|
399
|
+
highlightingAllowed?: boolean;
|
|
400
|
+
/** @description The weight of the post. */
|
|
401
|
+
weight?: number;
|
|
402
|
+
/** @description The hashtags of the post. */
|
|
403
|
+
hashtags?: string[];
|
|
404
|
+
/**
|
|
405
|
+
* @description The content type of the post.
|
|
406
|
+
* @enum {string}
|
|
407
|
+
*/
|
|
408
|
+
contentType?: 'articles' | 'pictures' | 'updates';
|
|
409
|
+
/** @description Whether acknowledging is allowed. */
|
|
410
|
+
acknowledgingAllowed?: boolean;
|
|
411
|
+
/** @description Whether acknowledging is enabled. */
|
|
412
|
+
acknowledgingEnabled?: boolean;
|
|
413
|
+
/** @description Whether commenting is allowed. */
|
|
414
|
+
commentingAllowed?: boolean;
|
|
415
|
+
/** @description Whether commenting is enabled. */
|
|
416
|
+
commentingEnabled?: boolean;
|
|
417
|
+
/** @description The layout of the post. */
|
|
418
|
+
layout?: {
|
|
419
|
+
/** @description The primary media of the post. */
|
|
420
|
+
primaryMedia?: string;
|
|
421
|
+
};
|
|
422
|
+
/** @description Whether liking is allowed. */
|
|
423
|
+
likingAllowed?: boolean;
|
|
424
|
+
/** @description Whether liking is enabled. */
|
|
425
|
+
likingEnabled?: boolean;
|
|
426
|
+
/** @description Whether sharing is allowed. */
|
|
427
|
+
sharingAllowed?: boolean;
|
|
428
|
+
/** @description Whether sharing is enabled. */
|
|
429
|
+
sharingEnabled?: boolean;
|
|
430
|
+
/** @description Whether internal sharing is allowed. */
|
|
431
|
+
internalSharingAllowed?: boolean;
|
|
432
|
+
/** @description Whether internal sharing is enabled. */
|
|
433
|
+
internalSharingEnabled?: boolean;
|
|
434
|
+
/** @description Whether external sharing is allowed. */
|
|
435
|
+
externalSharingAllowed?: boolean;
|
|
436
|
+
/** @description Whether external sharing is enabled. */
|
|
437
|
+
externalSharingEnabled?: boolean;
|
|
438
|
+
/**
|
|
439
|
+
* Format: date-time
|
|
440
|
+
* @description The creation date of the post.
|
|
441
|
+
*/
|
|
442
|
+
created?: string;
|
|
443
|
+
/**
|
|
444
|
+
* Format: date-time
|
|
445
|
+
* @description The update date of the post.
|
|
446
|
+
*/
|
|
447
|
+
updated?: string;
|
|
448
|
+
/**
|
|
449
|
+
* Format: date-time
|
|
450
|
+
* @description The publication date of the post.
|
|
451
|
+
*/
|
|
452
|
+
published?: string;
|
|
453
|
+
};
|
|
454
|
+
};
|
|
455
|
+
responses: {
|
|
456
|
+
/** @description This occurs when a valid token is missing. */
|
|
457
|
+
NoToken: {
|
|
458
|
+
headers: {
|
|
459
|
+
[name: string]: unknown;
|
|
460
|
+
};
|
|
461
|
+
content: {
|
|
462
|
+
/**
|
|
463
|
+
* @example {
|
|
464
|
+
* "identifier": 40102,
|
|
465
|
+
* "statusCode": 401,
|
|
466
|
+
* "message": "This endpoint requires authentication.",
|
|
467
|
+
* "type": "NotLoggedInException"
|
|
468
|
+
* }
|
|
469
|
+
*/
|
|
470
|
+
'application/json': unknown;
|
|
471
|
+
};
|
|
472
|
+
};
|
|
473
|
+
/** @description This occurs when the used token has not the required permissions to perform this action. */
|
|
474
|
+
NoPermission: {
|
|
475
|
+
headers: {
|
|
476
|
+
[name: string]: unknown;
|
|
477
|
+
};
|
|
478
|
+
content: {
|
|
479
|
+
/**
|
|
480
|
+
* @example {
|
|
481
|
+
* "identifier": 40308,
|
|
482
|
+
* "statusCode": 403,
|
|
483
|
+
* "message": "Access to branch 'null' is restricted.",
|
|
484
|
+
* "type": "AccessDeniedException"
|
|
485
|
+
* }
|
|
486
|
+
*/
|
|
487
|
+
'application/json': unknown;
|
|
488
|
+
};
|
|
489
|
+
};
|
|
490
|
+
/** @description This occurs when the requested news post does not exist. */
|
|
491
|
+
PostNotFound: {
|
|
492
|
+
headers: {
|
|
493
|
+
[name: string]: unknown;
|
|
494
|
+
};
|
|
495
|
+
content: {
|
|
496
|
+
/**
|
|
497
|
+
* @example {
|
|
498
|
+
* "identifier": 40408,
|
|
499
|
+
* "statusCode": 404,
|
|
500
|
+
* "message": "Post '5791e3ffd4c61f21c3df8b9' could not be found.",
|
|
501
|
+
* "type": "NotFoundException"
|
|
502
|
+
* }
|
|
503
|
+
*/
|
|
504
|
+
'application/json': unknown;
|
|
505
|
+
};
|
|
506
|
+
};
|
|
507
|
+
/** @description This occurs when the requested news channel does not exist. */
|
|
508
|
+
ChannelNotFound: {
|
|
509
|
+
headers: {
|
|
510
|
+
[name: string]: unknown;
|
|
511
|
+
};
|
|
512
|
+
content: {
|
|
513
|
+
/**
|
|
514
|
+
* @example {
|
|
515
|
+
* "identifier": 40408,
|
|
516
|
+
* "statusCode": 404,
|
|
517
|
+
* "message": "Installation '5791e3ffd4c61f21c3df8b9' could not be found.",
|
|
518
|
+
* "type": "NotFoundException"
|
|
519
|
+
* }
|
|
520
|
+
*/
|
|
521
|
+
'application/json': unknown;
|
|
522
|
+
};
|
|
523
|
+
};
|
|
524
|
+
/** @description This occurs when the requested news page does not exist. */
|
|
525
|
+
NewsPageNotFound: {
|
|
526
|
+
headers: {
|
|
527
|
+
[name: string]: unknown;
|
|
528
|
+
};
|
|
529
|
+
content: {
|
|
530
|
+
/**
|
|
531
|
+
* @example {
|
|
532
|
+
* "identifier": 40408,
|
|
533
|
+
* "statusCode": 404,
|
|
534
|
+
* "message": "Newspage '5791e3ffd4c61f21c3df8b9' could not be found.",
|
|
535
|
+
* "type": "NotFoundException"
|
|
536
|
+
* }
|
|
537
|
+
*/
|
|
538
|
+
'application/json': unknown;
|
|
539
|
+
};
|
|
540
|
+
};
|
|
541
|
+
/** @description Returns the requested channel. */
|
|
542
|
+
ReturnChannel: {
|
|
543
|
+
headers: {
|
|
544
|
+
[name: string]: unknown;
|
|
545
|
+
};
|
|
546
|
+
content: {
|
|
547
|
+
/**
|
|
548
|
+
* @example {
|
|
549
|
+
* "id": "5791e3ffd4c61f21c3df8b92",
|
|
550
|
+
* "config": {
|
|
551
|
+
* "localization": {
|
|
552
|
+
* "de_DE": {
|
|
553
|
+
* "title": "Kickstart für Ihre Mitarbeiter-App"
|
|
554
|
+
* },
|
|
555
|
+
* "en_US": {
|
|
556
|
+
* "title": "Kickstart your Employee App"
|
|
557
|
+
* }
|
|
558
|
+
* }
|
|
559
|
+
* },
|
|
560
|
+
* "published": "2021-04-19T09:14:39.157Z",
|
|
561
|
+
* "created": "2021-04-19T09:14:39.157Z",
|
|
562
|
+
* "updated": "2021-04-19T09:14:39.157Z"
|
|
563
|
+
* }
|
|
564
|
+
*/
|
|
565
|
+
'application/json': unknown;
|
|
566
|
+
};
|
|
567
|
+
};
|
|
568
|
+
/** @description Returns all channels that are accessible in the current context. */
|
|
569
|
+
ReturnAccessibleChannels: {
|
|
570
|
+
headers: {
|
|
571
|
+
[name: string]: unknown;
|
|
572
|
+
};
|
|
573
|
+
content: {
|
|
574
|
+
/**
|
|
575
|
+
* @example {
|
|
576
|
+
* "total": 2,
|
|
577
|
+
* "limit": 100,
|
|
578
|
+
* "offset": 0,
|
|
579
|
+
* "data": [
|
|
580
|
+
* {
|
|
581
|
+
* "id": "5791e3ffd4c61f21c3df8b92",
|
|
582
|
+
* "config": {
|
|
583
|
+
* "localization": {
|
|
584
|
+
* "de_DE": {
|
|
585
|
+
* "title": "Kickstart für Ihre Mitarbeiter-App"
|
|
586
|
+
* },
|
|
587
|
+
* "en_US": {
|
|
588
|
+
* "title": "Kickstart your Employee App"
|
|
589
|
+
* }
|
|
590
|
+
* }
|
|
591
|
+
* },
|
|
592
|
+
* "created": "2016-12-02T09:31:39.775Z",
|
|
593
|
+
* "published": "2021-04-19T09:14:39.157Z",
|
|
594
|
+
* "updated": "2021-04-19T09:14:39.157Z"
|
|
595
|
+
* },
|
|
596
|
+
* {
|
|
597
|
+
* "id": "5791e3ffd4c61f21c3df8b96",
|
|
598
|
+
* "config": {
|
|
599
|
+
* "localization": {
|
|
600
|
+
* "de_DE": {
|
|
601
|
+
* "title": "Kurzmeldungen"
|
|
602
|
+
* },
|
|
603
|
+
* "en_US": {
|
|
604
|
+
* "title": "Short news"
|
|
605
|
+
* }
|
|
606
|
+
* }
|
|
607
|
+
* },
|
|
608
|
+
* "created": "2016-10-19T12:18:10.434Z",
|
|
609
|
+
* "updated": "2021-04-19T09:14:39.182Z",
|
|
610
|
+
* "published": "2021-04-19T09:14:39.182Z"
|
|
611
|
+
* }
|
|
612
|
+
* ]
|
|
613
|
+
* }
|
|
614
|
+
*/
|
|
615
|
+
'application/json': unknown;
|
|
616
|
+
};
|
|
617
|
+
};
|
|
618
|
+
/** @description Returns all channels that are manageable in the current context. */
|
|
619
|
+
ReturnManageableChannels: {
|
|
620
|
+
headers: {
|
|
621
|
+
[name: string]: unknown;
|
|
622
|
+
};
|
|
623
|
+
content: {
|
|
624
|
+
/**
|
|
625
|
+
* @example {
|
|
626
|
+
* "total": 2,
|
|
627
|
+
* "limit": 100,
|
|
628
|
+
* "cursor": "eyJzb3J0RmllbGRWYWx1ZSI6MTYxNDkzODU1OTc3NywibGFzdElkIjoiNjA0MjAxYmZhMTI1NzE0NTYyMDU4YWUxIn0=",
|
|
629
|
+
* "data": [
|
|
630
|
+
* {
|
|
631
|
+
* "id": "5791e3ffd4c61f21c3df8b92",
|
|
632
|
+
* "config": {
|
|
633
|
+
* "localization": {
|
|
634
|
+
* "de_DE": {
|
|
635
|
+
* "title": "Kickstart für Ihre Mitarbeiter-App"
|
|
636
|
+
* },
|
|
637
|
+
* "en_US": {
|
|
638
|
+
* "title": "Kickstart your Employee App"
|
|
639
|
+
* }
|
|
640
|
+
* }
|
|
641
|
+
* },
|
|
642
|
+
* "created": "2016-12-02T09:31:39.775Z",
|
|
643
|
+
* "published": "2021-04-19T09:14:39.157Z",
|
|
644
|
+
* "updated": "2021-04-19T09:14:39.157Z"
|
|
645
|
+
* },
|
|
646
|
+
* {
|
|
647
|
+
* "id": "5791e3ffd4c61f21c3df8b96",
|
|
648
|
+
* "config": {
|
|
649
|
+
* "localization": {
|
|
650
|
+
* "de_DE": {
|
|
651
|
+
* "title": "Kurzmeldungen"
|
|
652
|
+
* },
|
|
653
|
+
* "en_US": {
|
|
654
|
+
* "title": "Short news"
|
|
655
|
+
* }
|
|
656
|
+
* }
|
|
657
|
+
* },
|
|
658
|
+
* "created": "2016-10-19T12:18:10.434Z",
|
|
659
|
+
* "updated": "2021-04-19T09:14:39.182Z",
|
|
660
|
+
* "published": "2021-04-19T09:14:39.182Z"
|
|
661
|
+
* }
|
|
662
|
+
* ]
|
|
663
|
+
* }
|
|
664
|
+
*/
|
|
665
|
+
'application/json': unknown;
|
|
666
|
+
};
|
|
667
|
+
};
|
|
668
|
+
/** @description Returns a list of posts within the channel. */
|
|
669
|
+
ReturnPosts: {
|
|
670
|
+
headers: {
|
|
671
|
+
[name: string]: unknown;
|
|
672
|
+
};
|
|
673
|
+
content: {
|
|
674
|
+
/**
|
|
675
|
+
* @example {
|
|
676
|
+
* "total": 2,
|
|
677
|
+
* "limit": 10,
|
|
678
|
+
* "offset": 0,
|
|
679
|
+
* "data": [
|
|
680
|
+
* {
|
|
681
|
+
* "id": "5791e3ffd4c61f21c3df8b93",
|
|
682
|
+
* "channelID": "5791e3ffd4c61f21c3df8b92",
|
|
683
|
+
* "externalID": "your-unique-external-id",
|
|
684
|
+
* "contents": {
|
|
685
|
+
* "en_US": {
|
|
686
|
+
* "content": "<p>Content can contain HTML.</p>",
|
|
687
|
+
* "image": {
|
|
688
|
+
* "original": {
|
|
689
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
690
|
+
* "width": 1900,
|
|
691
|
+
* "height": 1069,
|
|
692
|
+
* "size": 753886
|
|
693
|
+
* }
|
|
694
|
+
* },
|
|
695
|
+
* "teaser": "Teaser is text only.",
|
|
696
|
+
* "title": "The Title"
|
|
697
|
+
* },
|
|
698
|
+
* "de_DE": {
|
|
699
|
+
* "content": "<p>Der Inhalt kann HTML enthalten.</p>",
|
|
700
|
+
* "image": {
|
|
701
|
+
* "original": {
|
|
702
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
703
|
+
* "width": 1900,
|
|
704
|
+
* "height": 1069,
|
|
705
|
+
* "size": 753886
|
|
706
|
+
* }
|
|
707
|
+
* },
|
|
708
|
+
* "teaser": "Der Teaser ist nur normaler Text",
|
|
709
|
+
* "title": "Ein Titel"
|
|
710
|
+
* }
|
|
711
|
+
* },
|
|
712
|
+
* "campaignId": "602bce34e11096566faf4263",
|
|
713
|
+
* "planned": "2021-04-19T09:14:39.171Z",
|
|
714
|
+
* "published": "2021-04-19T09:14:39.171Z",
|
|
715
|
+
* "created": "2021-04-19T09:14:39.171Z",
|
|
716
|
+
* "updated": "2021-04-19T09:14:39.171Z"
|
|
717
|
+
* },
|
|
718
|
+
* {
|
|
719
|
+
* "id": "5791e3ffd4c61f21c3df8b94",
|
|
720
|
+
* "channelID": "5791e3ffd4c61f21c3df8b92",
|
|
721
|
+
* "externalID": "your-unique-external-id2",
|
|
722
|
+
* "contents": {
|
|
723
|
+
* "en_US": {
|
|
724
|
+
* "content": "<p>This is another post with a <strong>strong-tag</strong></p>",
|
|
725
|
+
* "image": {
|
|
726
|
+
* "original": {
|
|
727
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
728
|
+
* "width": 1900,
|
|
729
|
+
* "height": 1069,
|
|
730
|
+
* "size": 1026588
|
|
731
|
+
* }
|
|
732
|
+
* },
|
|
733
|
+
* "teaser": "Post with strong-tag",
|
|
734
|
+
* "title": "Strong-Tag"
|
|
735
|
+
* },
|
|
736
|
+
* "de_DE": {
|
|
737
|
+
* "content": "<p>Dies ist ein weiterer Post mit <strong>Strong-Tag</strong>.</p>",
|
|
738
|
+
* "image": {
|
|
739
|
+
* "original": {
|
|
740
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
741
|
+
* "width": 1900,
|
|
742
|
+
* "height": 1069,
|
|
743
|
+
* "size": 1026588
|
|
744
|
+
* }
|
|
745
|
+
* },
|
|
746
|
+
* "teaser": "Post mit Strong-Tag",
|
|
747
|
+
* "title": "Strong-Tag"
|
|
748
|
+
* }
|
|
749
|
+
* },
|
|
750
|
+
* "campaignId": "602bce34e11096566faf4263",
|
|
751
|
+
* "planned": "2021-04-19T09:14:39.170Z",
|
|
752
|
+
* "published": "2021-04-19T09:14:39.170Z",
|
|
753
|
+
* "created": "2021-04-19T09:14:39.170Z",
|
|
754
|
+
* "updated": "2021-04-19T09:14:39.170Z"
|
|
755
|
+
* }
|
|
756
|
+
* ]
|
|
757
|
+
* }
|
|
758
|
+
*/
|
|
759
|
+
'application/json': unknown;
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
/** @description Returns a single news post. */
|
|
763
|
+
ReturnPost: {
|
|
764
|
+
headers: {
|
|
765
|
+
[name: string]: unknown;
|
|
766
|
+
};
|
|
767
|
+
content: {
|
|
768
|
+
'application/json': unknown;
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
/** @description Returns a list of posts that match the search parameters. */
|
|
772
|
+
PostSearchDTO: {
|
|
773
|
+
headers: {
|
|
774
|
+
[name: string]: unknown;
|
|
775
|
+
};
|
|
776
|
+
content: {
|
|
777
|
+
/**
|
|
778
|
+
* @example {
|
|
779
|
+
* "total": 1,
|
|
780
|
+
* "data": [
|
|
781
|
+
* {
|
|
782
|
+
* "id": "5afe82c7ea2d154b79aa2ff7",
|
|
783
|
+
* "authorID": "5afacbacea2d159e5243c2d1",
|
|
784
|
+
* "branchID": "5afac5790a09a2503e8c7103",
|
|
785
|
+
* "channelID": "5afbf0a50a09a25d685ba2b6",
|
|
786
|
+
* "contents": {
|
|
787
|
+
* "en_US": {
|
|
788
|
+
* "title": "Title of the post in English!",
|
|
789
|
+
* "content": "<p>Content of the post!</p>",
|
|
790
|
+
* "image": {
|
|
791
|
+
* "original": {
|
|
792
|
+
* "width": 7360,
|
|
793
|
+
* "height": 4912,
|
|
794
|
+
* "size": 6981561,
|
|
795
|
+
* "format": "jpeg",
|
|
796
|
+
* "mimeType": "image/jpeg",
|
|
797
|
+
* "url": "https:/imageurl/api/media/..."
|
|
798
|
+
* }
|
|
799
|
+
* }
|
|
800
|
+
* },
|
|
801
|
+
* "de_DE": {
|
|
802
|
+
* "title": "Title in German!",
|
|
803
|
+
* "content": "<p>Content of the post!</p>"
|
|
804
|
+
* }
|
|
805
|
+
* },
|
|
806
|
+
* "notificationChannels": [
|
|
807
|
+
* "email",
|
|
808
|
+
* "push"
|
|
809
|
+
* ],
|
|
810
|
+
* "highlighted": true,
|
|
811
|
+
* "highlightingAllowed": true,
|
|
812
|
+
* "weight": 1562749967798,
|
|
813
|
+
* "hashtags": [],
|
|
814
|
+
* "contentType": "articles",
|
|
815
|
+
* "acknowledgingAllowed": true,
|
|
816
|
+
* "acknowledgingEnabled": false,
|
|
817
|
+
* "commentingAllowed": true,
|
|
818
|
+
* "commentingEnabled": true,
|
|
819
|
+
* "layout": {
|
|
820
|
+
* "primaryMedia": "big-first"
|
|
821
|
+
* },
|
|
822
|
+
* "likingAllowed": true,
|
|
823
|
+
* "likingEnabled": true,
|
|
824
|
+
* "sharingAllowed": true,
|
|
825
|
+
* "sharingEnabled": false,
|
|
826
|
+
* "internalSharingAllowed": true,
|
|
827
|
+
* "internalSharingEnabled": false,
|
|
828
|
+
* "externalSharingAllowed": true,
|
|
829
|
+
* "externalSharingEnabled": false,
|
|
830
|
+
* "created": "2018-05-18T07:37:43.987Z",
|
|
831
|
+
* "updated": "2024-10-07T14:18:59.009Z",
|
|
832
|
+
* "published": "2019-07-10T09:12:47.798Z",
|
|
833
|
+
* "entityType": "post"
|
|
834
|
+
* }
|
|
835
|
+
* ]
|
|
836
|
+
* }
|
|
837
|
+
*/
|
|
838
|
+
'application/json': {
|
|
839
|
+
/** @description An array containing post data */
|
|
840
|
+
data?: components['schemas']['PostSearchResult'][];
|
|
841
|
+
/** @description The total number of posts that match the search query. */
|
|
842
|
+
total?: Record<string, never>;
|
|
843
|
+
};
|
|
844
|
+
};
|
|
845
|
+
};
|
|
846
|
+
/** @description The requested list of news information. */
|
|
847
|
+
ClientApiReturnPosts: {
|
|
848
|
+
headers: {
|
|
849
|
+
[name: string]: unknown;
|
|
850
|
+
};
|
|
851
|
+
content: {
|
|
852
|
+
'application/json': {
|
|
853
|
+
/** @description Array containing post data */
|
|
854
|
+
data?: (components['schemas']['BasicPost'] & components['schemas']['CampaignIdField'])[];
|
|
855
|
+
/** @description Hypermedia links object collection. */
|
|
856
|
+
links?: {
|
|
857
|
+
/** @description Hyperlink object for the next page results. */
|
|
858
|
+
next?: {
|
|
859
|
+
/** @description The next link cursor for pagination. */
|
|
860
|
+
href?: string;
|
|
861
|
+
method?: string;
|
|
862
|
+
};
|
|
863
|
+
};
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
/** @description The post has been successfully created. The response contains the newly created post. */
|
|
868
|
+
PostCreated: {
|
|
869
|
+
headers: {
|
|
870
|
+
[name: string]: unknown;
|
|
871
|
+
};
|
|
872
|
+
content: {
|
|
873
|
+
/**
|
|
874
|
+
* @example {
|
|
875
|
+
* "id": "5791e3ffd4c61f21c3df8b93",
|
|
876
|
+
* "channelID": "5791e3ffd4c61f21c3df8b92",
|
|
877
|
+
* "externalID": "your-unique-external-id",
|
|
878
|
+
* "contents": {
|
|
879
|
+
* "en_US": {
|
|
880
|
+
* "content": "<p>Here is HTML.</p>",
|
|
881
|
+
* "image": {
|
|
882
|
+
* "original": {
|
|
883
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
884
|
+
* "width": 1900,
|
|
885
|
+
* "height": 1069,
|
|
886
|
+
* "size": 753886
|
|
887
|
+
* }
|
|
888
|
+
* },
|
|
889
|
+
* "teaser": "Teaser is text only.",
|
|
890
|
+
* "title": "The Title"
|
|
891
|
+
* },
|
|
892
|
+
* "de_DE": {
|
|
893
|
+
* "content": "<p>Hier steht HTML.</p>",
|
|
894
|
+
* "image": {
|
|
895
|
+
* "original": {
|
|
896
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
897
|
+
* "width": 1900,
|
|
898
|
+
* "height": 1069,
|
|
899
|
+
* "size": 753886
|
|
900
|
+
* }
|
|
901
|
+
* },
|
|
902
|
+
* "teaser": "Teaser ist nur normaler Text",
|
|
903
|
+
* "title": "Ein Titel"
|
|
904
|
+
* }
|
|
905
|
+
* },
|
|
906
|
+
* "campaignId": "602bce34e11096566faf4263",
|
|
907
|
+
* "planned": "2021-04-19T09:14:39.171Z",
|
|
908
|
+
* "published": "2021-04-19T09:14:39.171Z",
|
|
909
|
+
* "created": "2021-04-19T09:14:39.171Z",
|
|
910
|
+
* "updated": "2021-04-19T09:14:39.171Z"
|
|
911
|
+
* }
|
|
912
|
+
*/
|
|
913
|
+
'application/json': unknown;
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
/** @description The post has been successfully removed from the system. */
|
|
917
|
+
NoContent: {
|
|
918
|
+
headers: {
|
|
919
|
+
[name: string]: unknown;
|
|
920
|
+
};
|
|
921
|
+
content?: never;
|
|
922
|
+
};
|
|
923
|
+
/** @description The post has been successfully updated. Returns the recently updated post. */
|
|
924
|
+
PostUpdated: {
|
|
925
|
+
headers: {
|
|
926
|
+
[name: string]: unknown;
|
|
927
|
+
};
|
|
928
|
+
content: {
|
|
929
|
+
/**
|
|
930
|
+
* @example {
|
|
931
|
+
* "id": "5791e3ffd4c61f21c3df8b93",
|
|
932
|
+
* "channelID": "5791e3ffd4c61f21c3df8b92",
|
|
933
|
+
* "externalID": "your-unique-external-id",
|
|
934
|
+
* "contents": {
|
|
935
|
+
* "en_US": {
|
|
936
|
+
* "content": "<p>Here is HTML.</p>",
|
|
937
|
+
* "image": {
|
|
938
|
+
* "original": {
|
|
939
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
940
|
+
* "width": 1900,
|
|
941
|
+
* "height": 1069,
|
|
942
|
+
* "size": 753886
|
|
943
|
+
* }
|
|
944
|
+
* },
|
|
945
|
+
* "teaser": "Teaser is text only.",
|
|
946
|
+
* "title": "The Title"
|
|
947
|
+
* },
|
|
948
|
+
* "de_DE": {
|
|
949
|
+
* "content": "<p>Hier steht HTML.</p>",
|
|
950
|
+
* "image": {
|
|
951
|
+
* "original": {
|
|
952
|
+
* "url": "https://cdn.eyo.net/production/image/upload/v1618901827/dw7RPe9RlHo9kbfLoZREiaq1L1po9LVJVSfMBf2Furaa2wLm0aySm0yXm0N2pQ7iYjUG5tLZRzXur48FL7NoYzFrB0I0WnEUfKdqe8RtastLOLFTBPwmDfHKgkmJhrzogWmcln7FDUZcTDZKHrmRjZFf4QKvURY7qZ7GBm3sDELVYHEdDt9mEnhfLdWwKBTh/ocean.jpeg",
|
|
953
|
+
* "width": 1900,
|
|
954
|
+
* "height": 1069,
|
|
955
|
+
* "size": 753886
|
|
956
|
+
* }
|
|
957
|
+
* },
|
|
958
|
+
* "teaser": "Teaser ist nur normaler Text",
|
|
959
|
+
* "title": "Ein Titel"
|
|
960
|
+
* }
|
|
961
|
+
* },
|
|
962
|
+
* "campaignId": "602bce34e11096566faf4263",
|
|
963
|
+
* "planned": "2021-04-19T09:14:39.171Z",
|
|
964
|
+
* "published": "2021-04-19T09:14:39.171Z",
|
|
965
|
+
* "created": "2021-04-19T09:14:39.171Z",
|
|
966
|
+
* "updated": "2021-04-19T09:14:39.171Z"
|
|
967
|
+
* }
|
|
968
|
+
*/
|
|
969
|
+
'application/json': unknown;
|
|
970
|
+
};
|
|
971
|
+
};
|
|
972
|
+
/** @description The notification was created successfully. */
|
|
973
|
+
ResendCreatedResponse: {
|
|
974
|
+
headers: {
|
|
975
|
+
[name: string]: unknown;
|
|
976
|
+
};
|
|
977
|
+
content: {
|
|
978
|
+
/**
|
|
979
|
+
* @example {
|
|
980
|
+
* "email": false,
|
|
981
|
+
* "push": true,
|
|
982
|
+
* "recipients": "ALL",
|
|
983
|
+
* "contents": {
|
|
984
|
+
* "en_US": {
|
|
985
|
+
* "text": "Custom notification text."
|
|
986
|
+
* },
|
|
987
|
+
* "de_DE": {
|
|
988
|
+
* "text": "Angepasster Benachrichtigungstext."
|
|
989
|
+
* }
|
|
990
|
+
* }
|
|
991
|
+
* }
|
|
992
|
+
*/
|
|
993
|
+
'application/json': unknown;
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
/** @description Returns a list of acknowledgements. */
|
|
997
|
+
AcknowledgementsResponse: {
|
|
998
|
+
headers: {
|
|
999
|
+
[name: string]: unknown;
|
|
1000
|
+
};
|
|
1001
|
+
content: {
|
|
1002
|
+
/**
|
|
1003
|
+
* @example {
|
|
1004
|
+
* "total": 42,
|
|
1005
|
+
* "limit": 1,
|
|
1006
|
+
* "data": [
|
|
1007
|
+
* {
|
|
1008
|
+
* "parentID": "6722478fe8edf20ffffba3b1",
|
|
1009
|
+
* "userID": "6622364fb6cddf3acf6d46da",
|
|
1010
|
+
* "id": "67852d5a99affd0e4a535c2c",
|
|
1011
|
+
* "created": "2025-01-01T12:00:00.000Z"
|
|
1012
|
+
* }
|
|
1013
|
+
* ],
|
|
1014
|
+
* "cursor": "MTczNjc4MTE0NjU2Mw==__dHJ1ZQ=="
|
|
1015
|
+
* }
|
|
1016
|
+
*/
|
|
1017
|
+
'application/json': {
|
|
1018
|
+
/** @description Array containing acknowledgement data */
|
|
1019
|
+
data?: components['schemas']['Acknowledgement'][];
|
|
1020
|
+
/** @description The total number of acknowledgements for this post. */
|
|
1021
|
+
total?: Record<string, never>;
|
|
1022
|
+
/** @description The amount of items that should be returned. */
|
|
1023
|
+
limit?: Record<string, never>;
|
|
1024
|
+
/** @description Paging cursor to load the next batch of items. */
|
|
1025
|
+
cursor?: Record<string, never>;
|
|
1026
|
+
};
|
|
1027
|
+
};
|
|
1028
|
+
};
|
|
1029
|
+
};
|
|
1030
|
+
parameters: {
|
|
1031
|
+
/** @description The ID of the news page. */
|
|
1032
|
+
newsPageID: string;
|
|
1033
|
+
/** @description The ID of the channel. */
|
|
1034
|
+
channelID: string;
|
|
1035
|
+
/** @description This can be either the ID of the post set by the system or the external ID if supplied on creation of the post. */
|
|
1036
|
+
postID: string;
|
|
1037
|
+
/** @description A string that can be used for searching the post content. */
|
|
1038
|
+
query: string;
|
|
1039
|
+
/** @description A string that can be used for searching the name of a channel. */
|
|
1040
|
+
channelQuery: string;
|
|
1041
|
+
/** @description The amount of items that should be returned. If set to 0 only meta information is returned. */
|
|
1042
|
+
limit: number;
|
|
1043
|
+
/** @description The amount of items that should be returned. */
|
|
1044
|
+
limit1_10: number;
|
|
1045
|
+
/** @description The amount of items that should be returned. If set to 0 only meta information is returned. */
|
|
1046
|
+
limit10: number;
|
|
1047
|
+
/**
|
|
1048
|
+
* @deprecated
|
|
1049
|
+
* @description Define an offset to skip this number of items in the response. Offset for this endpoint is deprecated and will be removed in February 2026. Use `cursor` instead to page through results.
|
|
1050
|
+
*/
|
|
1051
|
+
deprecatedOffset: number;
|
|
1052
|
+
/** @description Define an offset to skip this number of items in the response. */
|
|
1053
|
+
offset: number;
|
|
1054
|
+
/** @description Define an offset to skip this number of items in the response. */
|
|
1055
|
+
offsetMax20: number;
|
|
1056
|
+
/** @description Paging cursor to load the next batch of items. */
|
|
1057
|
+
cursor: string;
|
|
1058
|
+
/** @description Sort the result in descending order for the creation, publication or last updated date. */
|
|
1059
|
+
sort: 'created_DESC' | 'published_DESC' | 'updated_DESC';
|
|
1060
|
+
/** @description Sort the result in ascending order for channel priority or descending order for the creation, publication or last updated date. */
|
|
1061
|
+
sortWithPriority: 'created_DESC' | 'published_DESC' | 'updated_DESC' | 'priority_ASC';
|
|
1062
|
+
/** @description Set the access check to restrict the results to either accessible or manageable items. */
|
|
1063
|
+
postsManageable: boolean;
|
|
1064
|
+
/** @description Optional filter for the given post content types. Defaults to not filtering. */
|
|
1065
|
+
postsContentType: ('articles' | 'pictures' | 'updates')[];
|
|
1066
|
+
/** @description Optional filter for the given post content types. Defaults to not filtering. */
|
|
1067
|
+
postType: ('articles' | 'pictures' | 'updates')[];
|
|
1068
|
+
};
|
|
1069
|
+
requestBodies: never;
|
|
1070
|
+
headers: never;
|
|
1071
|
+
pathItems: never;
|
|
1072
|
+
}
|
|
1073
|
+
export type $defs = Record<string, never>;
|
|
1074
|
+
export interface operations {
|
|
1075
|
+
GetBranchChannels: {
|
|
1076
|
+
parameters: {
|
|
1077
|
+
query?: {
|
|
1078
|
+
/** @description A string that can be used for searching the name of a channel. */
|
|
1079
|
+
query?: components['parameters']['channelQuery'];
|
|
1080
|
+
/** @description The amount of items that should be returned. If set to 0 only meta information is returned. */
|
|
1081
|
+
limit?: components['parameters']['limit10'];
|
|
1082
|
+
/** @description Paging cursor to load the next batch of items. */
|
|
1083
|
+
cursor?: components['parameters']['cursor'];
|
|
1084
|
+
/**
|
|
1085
|
+
* @deprecated
|
|
1086
|
+
* @description Define an offset to skip this number of items in the response. Offset for this endpoint is deprecated and will be removed in February 2026. Use `cursor` instead to page through results.
|
|
1087
|
+
*/
|
|
1088
|
+
offset?: components['parameters']['deprecatedOffset'];
|
|
1089
|
+
/** @description Sort the result in ascending order for channel priority or descending order for the creation, publication or last updated date. */
|
|
1090
|
+
sort?: components['parameters']['sortWithPriority'];
|
|
1091
|
+
/** @description Optional filter for the given post content types. Defaults to not filtering. */
|
|
1092
|
+
contentType?: components['parameters']['postsContentType'];
|
|
1093
|
+
};
|
|
1094
|
+
header?: never;
|
|
1095
|
+
path?: never;
|
|
1096
|
+
cookie?: never;
|
|
1097
|
+
};
|
|
1098
|
+
requestBody?: never;
|
|
1099
|
+
responses: {
|
|
1100
|
+
200: components['responses']['ReturnManageableChannels'];
|
|
1101
|
+
401: components['responses']['NoToken'];
|
|
1102
|
+
};
|
|
1103
|
+
};
|
|
1104
|
+
GetChannels: {
|
|
1105
|
+
parameters: {
|
|
1106
|
+
query?: {
|
|
1107
|
+
/** @description A string that can be used for searching the name of a channel. */
|
|
1108
|
+
query?: components['parameters']['channelQuery'];
|
|
1109
|
+
/** @description The amount of items that should be returned. If set to 0 only meta information is returned. */
|
|
1110
|
+
limit?: components['parameters']['limit'];
|
|
1111
|
+
/** @description Define an offset to skip this number of items in the response. */
|
|
1112
|
+
offset?: components['parameters']['offset'];
|
|
1113
|
+
};
|
|
1114
|
+
header?: never;
|
|
1115
|
+
path?: never;
|
|
1116
|
+
cookie?: never;
|
|
1117
|
+
};
|
|
1118
|
+
requestBody?: never;
|
|
1119
|
+
responses: {
|
|
1120
|
+
200: components['responses']['ReturnAccessibleChannels'];
|
|
1121
|
+
401: components['responses']['NoToken'];
|
|
1122
|
+
};
|
|
1123
|
+
};
|
|
1124
|
+
GetChannel: {
|
|
1125
|
+
parameters: {
|
|
1126
|
+
query?: never;
|
|
1127
|
+
header?: never;
|
|
1128
|
+
path: {
|
|
1129
|
+
/** @description The ID of the channel. */
|
|
1130
|
+
channelID: components['parameters']['channelID'];
|
|
1131
|
+
};
|
|
1132
|
+
cookie?: never;
|
|
1133
|
+
};
|
|
1134
|
+
requestBody?: never;
|
|
1135
|
+
responses: {
|
|
1136
|
+
200: components['responses']['ReturnChannel'];
|
|
1137
|
+
401: components['responses']['NoToken'];
|
|
1138
|
+
404: components['responses']['ChannelNotFound'];
|
|
1139
|
+
};
|
|
1140
|
+
};
|
|
1141
|
+
GetChannelPosts: {
|
|
1142
|
+
parameters: {
|
|
1143
|
+
query?: {
|
|
1144
|
+
/** @description The amount of items that should be returned. If set to 0 only meta information is returned. */
|
|
1145
|
+
limit?: components['parameters']['limit10'];
|
|
1146
|
+
/** @description Define an offset to skip this number of items in the response. */
|
|
1147
|
+
offset?: components['parameters']['offset'];
|
|
1148
|
+
};
|
|
1149
|
+
header?: never;
|
|
1150
|
+
path: {
|
|
1151
|
+
/** @description The ID of the channel. */
|
|
1152
|
+
channelID: components['parameters']['channelID'];
|
|
1153
|
+
};
|
|
1154
|
+
cookie?: never;
|
|
1155
|
+
};
|
|
1156
|
+
requestBody?: never;
|
|
1157
|
+
responses: {
|
|
1158
|
+
200: components['responses']['ReturnPosts'];
|
|
1159
|
+
401: components['responses']['NoToken'];
|
|
1160
|
+
404: components['responses']['ChannelNotFound'];
|
|
1161
|
+
};
|
|
1162
|
+
};
|
|
1163
|
+
CreateChannelPost: {
|
|
1164
|
+
parameters: {
|
|
1165
|
+
query?: never;
|
|
1166
|
+
header?: never;
|
|
1167
|
+
path: {
|
|
1168
|
+
/** @description The ID of the channel. */
|
|
1169
|
+
channelID: components['parameters']['channelID'];
|
|
1170
|
+
};
|
|
1171
|
+
cookie?: never;
|
|
1172
|
+
};
|
|
1173
|
+
requestBody: {
|
|
1174
|
+
content: {
|
|
1175
|
+
'application/json': components['schemas']['CreatePost'];
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
responses: {
|
|
1179
|
+
201: components['responses']['PostCreated'];
|
|
1180
|
+
401: components['responses']['NoToken'];
|
|
1181
|
+
403: components['responses']['NoPermission'];
|
|
1182
|
+
404: components['responses']['ChannelNotFound'];
|
|
1183
|
+
};
|
|
1184
|
+
};
|
|
1185
|
+
GetPosts: {
|
|
1186
|
+
parameters: {
|
|
1187
|
+
query?: {
|
|
1188
|
+
/** @description A string that can be used for searching the post content. */
|
|
1189
|
+
query?: components['parameters']['query'];
|
|
1190
|
+
/** @description The amount of items that should be returned. If set to 0 only meta information is returned. */
|
|
1191
|
+
limit?: components['parameters']['limit'];
|
|
1192
|
+
/** @description Define an offset to skip this number of items in the response. */
|
|
1193
|
+
offset?: components['parameters']['offset'];
|
|
1194
|
+
/** @description Sort the result in descending order for the creation, publication or last updated date. */
|
|
1195
|
+
sort?: components['parameters']['sort'];
|
|
1196
|
+
/** @description Set the access check to restrict the results to either accessible or manageable items. */
|
|
1197
|
+
manageable?: components['parameters']['postsManageable'];
|
|
1198
|
+
/** @description Optional filter for the given post content types. Defaults to not filtering. */
|
|
1199
|
+
contentType?: components['parameters']['postsContentType'];
|
|
1200
|
+
};
|
|
1201
|
+
header?: never;
|
|
1202
|
+
path?: never;
|
|
1203
|
+
cookie?: never;
|
|
1204
|
+
};
|
|
1205
|
+
requestBody?: never;
|
|
1206
|
+
responses: {
|
|
1207
|
+
200: components['responses']['ReturnPosts'];
|
|
1208
|
+
401: components['responses']['NoToken'];
|
|
1209
|
+
};
|
|
1210
|
+
};
|
|
1211
|
+
SearchPosts: {
|
|
1212
|
+
parameters: {
|
|
1213
|
+
query?: {
|
|
1214
|
+
/** @description A string that can be used for searching the post content. */
|
|
1215
|
+
query?: components['parameters']['query'];
|
|
1216
|
+
/** @description The amount of items that should be returned. If set to 0 only meta information is returned. */
|
|
1217
|
+
limit?: components['parameters']['limit'];
|
|
1218
|
+
/** @description Sort the result in descending order for the creation, publication or last updated date. */
|
|
1219
|
+
sort?: components['parameters']['sort'];
|
|
1220
|
+
};
|
|
1221
|
+
header?: never;
|
|
1222
|
+
path?: never;
|
|
1223
|
+
cookie?: never;
|
|
1224
|
+
};
|
|
1225
|
+
requestBody?: never;
|
|
1226
|
+
responses: {
|
|
1227
|
+
/** @description __OK__ - The response contains a list of posts that match the search parameters. */
|
|
1228
|
+
200: components['responses']['PostSearchDTO'];
|
|
1229
|
+
401: components['responses']['NoToken'];
|
|
1230
|
+
403: components['responses']['NoPermission'];
|
|
1231
|
+
};
|
|
1232
|
+
};
|
|
1233
|
+
GetPost: {
|
|
1234
|
+
parameters: {
|
|
1235
|
+
query?: never;
|
|
1236
|
+
header?: never;
|
|
1237
|
+
path: {
|
|
1238
|
+
/** @description This can be either the ID of the post set by the system or the external ID if supplied on creation of the post. */
|
|
1239
|
+
postID: components['parameters']['postID'];
|
|
1240
|
+
};
|
|
1241
|
+
cookie?: never;
|
|
1242
|
+
};
|
|
1243
|
+
requestBody?: never;
|
|
1244
|
+
responses: {
|
|
1245
|
+
200: components['responses']['ReturnPost'];
|
|
1246
|
+
401: components['responses']['NoToken'];
|
|
1247
|
+
403: components['responses']['NoPermission'];
|
|
1248
|
+
404: components['responses']['PostNotFound'];
|
|
1249
|
+
};
|
|
1250
|
+
};
|
|
1251
|
+
UpdatePost: {
|
|
1252
|
+
parameters: {
|
|
1253
|
+
query?: never;
|
|
1254
|
+
header?: never;
|
|
1255
|
+
path: {
|
|
1256
|
+
/** @description This can be either the ID of the post set by the system or the external ID if supplied on creation of the post. */
|
|
1257
|
+
postID: components['parameters']['postID'];
|
|
1258
|
+
};
|
|
1259
|
+
cookie?: never;
|
|
1260
|
+
};
|
|
1261
|
+
requestBody?: {
|
|
1262
|
+
content: {
|
|
1263
|
+
'application/json': components['schemas']['UpdatePost'];
|
|
1264
|
+
};
|
|
1265
|
+
};
|
|
1266
|
+
responses: {
|
|
1267
|
+
200: components['responses']['PostUpdated'];
|
|
1268
|
+
401: components['responses']['NoToken'];
|
|
1269
|
+
403: components['responses']['NoPermission'];
|
|
1270
|
+
404: components['responses']['PostNotFound'];
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
DeletePost: {
|
|
1274
|
+
parameters: {
|
|
1275
|
+
query?: never;
|
|
1276
|
+
header?: never;
|
|
1277
|
+
path: {
|
|
1278
|
+
/** @description This can be either the ID of the post set by the system or the external ID if supplied on creation of the post. */
|
|
1279
|
+
postID: components['parameters']['postID'];
|
|
1280
|
+
};
|
|
1281
|
+
cookie?: never;
|
|
1282
|
+
};
|
|
1283
|
+
requestBody?: never;
|
|
1284
|
+
responses: {
|
|
1285
|
+
204: components['responses']['NoContent'];
|
|
1286
|
+
401: components['responses']['NoToken'];
|
|
1287
|
+
403: components['responses']['NoPermission'];
|
|
1288
|
+
404: components['responses']['PostNotFound'];
|
|
1289
|
+
};
|
|
1290
|
+
};
|
|
1291
|
+
ResendNotifications: {
|
|
1292
|
+
parameters: {
|
|
1293
|
+
query?: never;
|
|
1294
|
+
header?: never;
|
|
1295
|
+
path: {
|
|
1296
|
+
/** @description This can be either the ID of the post set by the system or the external ID if supplied on creation of the post. */
|
|
1297
|
+
postID: components['parameters']['postID'];
|
|
1298
|
+
};
|
|
1299
|
+
cookie?: never;
|
|
1300
|
+
};
|
|
1301
|
+
requestBody?: {
|
|
1302
|
+
content: {
|
|
1303
|
+
'application/json': components['schemas']['ResendCreateNotification'];
|
|
1304
|
+
};
|
|
1305
|
+
};
|
|
1306
|
+
responses: {
|
|
1307
|
+
201: components['responses']['ResendCreatedResponse'];
|
|
1308
|
+
401: components['responses']['NoToken'];
|
|
1309
|
+
404: components['responses']['PostNotFound'];
|
|
1310
|
+
};
|
|
1311
|
+
};
|
|
1312
|
+
FetchAcknowledgements: {
|
|
1313
|
+
parameters: {
|
|
1314
|
+
query?: {
|
|
1315
|
+
/** @description The amount of items that should be returned. */
|
|
1316
|
+
limit?: components['parameters']['limit1_10'];
|
|
1317
|
+
/** @description Paging cursor to load the next batch of items. */
|
|
1318
|
+
cursor?: components['parameters']['cursor'];
|
|
1319
|
+
};
|
|
1320
|
+
header?: never;
|
|
1321
|
+
path: {
|
|
1322
|
+
/** @description This can be either the ID of the post set by the system or the external ID if supplied on creation of the post. */
|
|
1323
|
+
postID: components['parameters']['postID'];
|
|
1324
|
+
};
|
|
1325
|
+
cookie?: never;
|
|
1326
|
+
};
|
|
1327
|
+
requestBody?: never;
|
|
1328
|
+
responses: {
|
|
1329
|
+
200: components['responses']['AcknowledgementsResponse'];
|
|
1330
|
+
401: components['responses']['NoToken'];
|
|
1331
|
+
404: components['responses']['PostNotFound'];
|
|
1332
|
+
};
|
|
1333
|
+
};
|
|
1334
|
+
GetClientChannelPosts: {
|
|
1335
|
+
parameters: {
|
|
1336
|
+
query?: {
|
|
1337
|
+
/** @description The amount of items that should be returned. */
|
|
1338
|
+
limit?: components['parameters']['limit1_10'];
|
|
1339
|
+
/** @description Define an offset to skip this number of items in the response. */
|
|
1340
|
+
offset?: components['parameters']['offsetMax20'];
|
|
1341
|
+
/** @description Paging cursor to load the next batch of items. */
|
|
1342
|
+
cursor?: components['parameters']['cursor'];
|
|
1343
|
+
};
|
|
1344
|
+
header?: never;
|
|
1345
|
+
path: {
|
|
1346
|
+
/** @description The ID of the channel. */
|
|
1347
|
+
channelID: components['parameters']['channelID'];
|
|
1348
|
+
};
|
|
1349
|
+
cookie?: never;
|
|
1350
|
+
};
|
|
1351
|
+
requestBody?: never;
|
|
1352
|
+
responses: {
|
|
1353
|
+
200: components['responses']['ClientApiReturnPosts'];
|
|
1354
|
+
404: components['responses']['ChannelNotFound'];
|
|
1355
|
+
};
|
|
1356
|
+
};
|
|
1357
|
+
GetClientNewsPagePosts: {
|
|
1358
|
+
parameters: {
|
|
1359
|
+
query?: {
|
|
1360
|
+
/** @description The amount of items that should be returned. */
|
|
1361
|
+
limit?: components['parameters']['limit1_10'];
|
|
1362
|
+
/** @description Define an offset to skip this number of items in the response. */
|
|
1363
|
+
offset?: components['parameters']['offsetMax20'];
|
|
1364
|
+
/** @description Paging cursor to load the next batch of items. */
|
|
1365
|
+
cursor?: components['parameters']['cursor'];
|
|
1366
|
+
/** @description Optional filter for the given post content types. Defaults to not filtering. */
|
|
1367
|
+
postType?: components['parameters']['postType'];
|
|
1368
|
+
};
|
|
1369
|
+
header?: never;
|
|
1370
|
+
path: {
|
|
1371
|
+
/** @description The ID of the news page. */
|
|
1372
|
+
newsPageID: components['parameters']['newsPageID'];
|
|
1373
|
+
};
|
|
1374
|
+
cookie?: never;
|
|
1375
|
+
};
|
|
1376
|
+
requestBody?: never;
|
|
1377
|
+
responses: {
|
|
1378
|
+
200: components['responses']['ClientApiReturnPosts'];
|
|
1379
|
+
404: components['responses']['NewsPageNotFound'];
|
|
1380
|
+
};
|
|
1381
|
+
};
|
|
1382
|
+
GetClientNewsPageChannels: {
|
|
1383
|
+
parameters: {
|
|
1384
|
+
query?: {
|
|
1385
|
+
/** @description The amount of items that should be returned. */
|
|
1386
|
+
limit?: components['parameters']['limit1_10'];
|
|
1387
|
+
/** @description Paging cursor to load the next batch of items. */
|
|
1388
|
+
cursor?: components['parameters']['cursor'];
|
|
1389
|
+
};
|
|
1390
|
+
header?: never;
|
|
1391
|
+
path: {
|
|
1392
|
+
/** @description The ID of the news page. */
|
|
1393
|
+
newsPageID: components['parameters']['newsPageID'];
|
|
1394
|
+
};
|
|
1395
|
+
cookie?: never;
|
|
1396
|
+
};
|
|
1397
|
+
requestBody?: never;
|
|
1398
|
+
responses: {
|
|
1399
|
+
200: components['responses']['ReturnAccessibleChannels'];
|
|
1400
|
+
404: components['responses']['NewsPageNotFound'];
|
|
1401
|
+
};
|
|
1402
|
+
};
|
|
1403
|
+
GetClientNewsPageRights: {
|
|
1404
|
+
parameters: {
|
|
1405
|
+
query?: never;
|
|
1406
|
+
header?: never;
|
|
1407
|
+
path: {
|
|
1408
|
+
/** @description The ID of the news page. */
|
|
1409
|
+
newsPageID: components['parameters']['newsPageID'];
|
|
1410
|
+
};
|
|
1411
|
+
cookie?: never;
|
|
1412
|
+
};
|
|
1413
|
+
requestBody?: never;
|
|
1414
|
+
responses: {
|
|
1415
|
+
/** @description If the user has contribution rights to this news page the result will contain the "CONTRIBUTE" string. */
|
|
1416
|
+
200: {
|
|
1417
|
+
headers: {
|
|
1418
|
+
[name: string]: unknown;
|
|
1419
|
+
};
|
|
1420
|
+
content: {
|
|
1421
|
+
/**
|
|
1422
|
+
* @example [
|
|
1423
|
+
* "CONTRIBUTE"
|
|
1424
|
+
* ]
|
|
1425
|
+
*/
|
|
1426
|
+
'application/json': 'CONTRIBUTE'[];
|
|
1427
|
+
};
|
|
1428
|
+
};
|
|
1429
|
+
404: components['responses']['NewsPageNotFound'];
|
|
1430
|
+
};
|
|
1431
|
+
};
|
|
1432
|
+
}
|
|
1433
|
+
//# sourceMappingURL=newsApi.d.ts.map
|