@selfcommunity/api-services 0.1.6-alpha.0 → 0.1.6-alpha.1

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.
Files changed (62) hide show
  1. package/lib/cjs/constants/Endpoints.js +8 -16
  2. package/lib/cjs/index.js +0 -6
  3. package/lib/cjs/services/webhook/index.js +110 -27
  4. package/lib/cjs/services/webhook/types.js +3 -0
  5. package/lib/esm/api-services/src/constants/Endpoints.d.ts.map +1 -1
  6. package/lib/esm/api-services/src/index.d.ts +1 -2
  7. package/lib/esm/api-services/src/index.d.ts.map +1 -1
  8. package/lib/esm/api-services/src/services/webhook/index.d.ts +87 -30
  9. package/lib/esm/api-services/src/services/webhook/index.d.ts.map +1 -1
  10. package/lib/esm/api-services/src/services/webhook/types.d.ts +32 -0
  11. package/lib/esm/api-services/src/services/webhook/types.d.ts.map +1 -0
  12. package/lib/esm/constants/Endpoints.js +8 -16
  13. package/lib/esm/index.js +0 -6
  14. package/lib/esm/services/webhook/index.js +110 -27
  15. package/lib/esm/services/webhook/types.js +3 -0
  16. package/lib/esm/types/src/index.d.ts +9 -0
  17. package/lib/esm/types/src/index.d.ts.map +1 -0
  18. package/lib/esm/types/src/types/auth.d.ts +26 -0
  19. package/lib/esm/types/src/types/auth.d.ts.map +1 -0
  20. package/lib/esm/types/src/types/broadcastMessage.d.ts +73 -0
  21. package/lib/esm/types/src/types/broadcastMessage.d.ts.map +1 -0
  22. package/lib/esm/types/src/types/category.d.ts +100 -0
  23. package/lib/esm/types/src/types/category.d.ts.map +1 -0
  24. package/lib/esm/types/src/types/comment.d.ts +97 -0
  25. package/lib/esm/types/src/types/comment.d.ts.map +1 -0
  26. package/lib/esm/types/src/types/customAdv.d.ts +53 -0
  27. package/lib/esm/types/src/types/customAdv.d.ts.map +1 -0
  28. package/lib/esm/types/src/types/customNotification.d.ts +28 -0
  29. package/lib/esm/types/src/types/customNotification.d.ts.map +1 -0
  30. package/lib/esm/types/src/types/embed.d.ts +33 -0
  31. package/lib/esm/types/src/types/embed.d.ts.map +1 -0
  32. package/lib/esm/types/src/types/feed.d.ts +208 -0
  33. package/lib/esm/types/src/types/feed.d.ts.map +1 -0
  34. package/lib/esm/types/src/types/incubator.d.ts +53 -0
  35. package/lib/esm/types/src/types/incubator.d.ts.map +1 -0
  36. package/lib/esm/types/src/types/index.d.ts +23 -0
  37. package/lib/esm/types/src/types/index.d.ts.map +1 -0
  38. package/lib/esm/types/src/types/location.d.ts +61 -0
  39. package/lib/esm/types/src/types/location.d.ts.map +1 -0
  40. package/lib/esm/types/src/types/media.d.ts +52 -0
  41. package/lib/esm/types/src/types/media.d.ts.map +1 -0
  42. package/lib/esm/types/src/types/notification.d.ts +416 -0
  43. package/lib/esm/types/src/types/notification.d.ts.map +1 -0
  44. package/lib/esm/types/src/types/poll.d.ts +77 -0
  45. package/lib/esm/types/src/types/poll.d.ts.map +1 -0
  46. package/lib/esm/types/src/types/privateMessage.d.ts +109 -0
  47. package/lib/esm/types/src/types/privateMessage.d.ts.map +1 -0
  48. package/lib/esm/types/src/types/prize.d.ts +48 -0
  49. package/lib/esm/types/src/types/prize.d.ts.map +1 -0
  50. package/lib/esm/types/src/types/tag.d.ts +47 -0
  51. package/lib/esm/types/src/types/tag.d.ts.map +1 -0
  52. package/lib/esm/types/src/types/user.d.ts +231 -0
  53. package/lib/esm/types/src/types/user.d.ts.map +1 -0
  54. package/lib/esm/types/src/types/webhook.d.ts +91 -0
  55. package/lib/esm/types/src/types/webhook.d.ts.map +1 -0
  56. package/lib/umd/api-services.js +1 -1
  57. package/lib/umd/api-services.js.map +1 -1
  58. package/package.json +4 -4
  59. package/lib/cjs/services/dynamic_preference/index.js +0 -85
  60. package/lib/esm/api-services/src/services/dynamic_preference/index.d.ts +0 -16
  61. package/lib/esm/api-services/src/services/dynamic_preference/index.d.ts.map +0 -1
  62. package/lib/esm/services/dynamic_preference/index.js +0 -85
@@ -9,7 +9,13 @@ var _Endpoints = _interopRequireDefault(require("../../constants/Endpoints"));
9
9
 
10
10
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
11
11
 
12
+ /**
13
+ * Contains all the endpoints needed to manage webhooks.
14
+ */
12
15
  class WebhookApiClient {
16
+ /**
17
+ * This endpoint retrieves all webhook endpoints
18
+ */
13
19
  static getAllWebhookEndpoints() {
14
20
  return _client.default.request({
15
21
  url: _Endpoints.default.WebhookEndpointsList.url({}),
@@ -26,6 +32,10 @@ class WebhookApiClient {
26
32
  return Promise.reject(error);
27
33
  });
28
34
  }
35
+ /**
36
+ * This endpoint retrieves webhook events that can be enabled in the endpoint.
37
+ */
38
+
29
39
 
30
40
  static getAllWebhookEvents() {
31
41
  return _client.default.request({
@@ -43,11 +53,19 @@ class WebhookApiClient {
43
53
  return Promise.reject(error);
44
54
  });
45
55
  }
56
+ /**
57
+ * This endpoint creates a webhook endpoint and connects it to the given webhook events.
58
+ * @param params
59
+ */
60
+
46
61
 
47
- static createWebhookEndpoint() {
62
+ static createWebhookEndpoint(params) {
48
63
  return _client.default.request({
49
64
  url: _Endpoints.default.WebhookCreate.url({}),
50
- method: _Endpoints.default.WebhookCreate.method
65
+ method: _Endpoints.default.WebhookCreate.method,
66
+ data: {
67
+ params
68
+ }
51
69
  }).then(res => {
52
70
  if (res.status >= 300) {
53
71
  console.log(`Unable to perform action (Response code: ${res.status}).`);
@@ -60,6 +78,11 @@ class WebhookApiClient {
60
78
  return Promise.reject(error);
61
79
  });
62
80
  }
81
+ /**
82
+ * This endpoint retrieves a specific webhook endpoint using ID.
83
+ * @param id
84
+ */
85
+
63
86
 
64
87
  static getASpecificWebhookEndpoint(id) {
65
88
  return _client.default.request({
@@ -79,13 +102,22 @@ class WebhookApiClient {
79
102
  return Promise.reject(error);
80
103
  });
81
104
  }
105
+ /**
106
+ * This endpoint updates a specific webhook endpoint.
107
+ * @param id
108
+ * @param params
109
+ */
110
+
82
111
 
83
- static updateASpecificWebhookEndpoint(id) {
112
+ static updateASpecificWebhookEndpoint(id, params) {
84
113
  return _client.default.request({
85
114
  url: _Endpoints.default.WebhookUpdate.url({
86
115
  id
87
116
  }),
88
- method: _Endpoints.default.WebhookUpdate.method
117
+ method: _Endpoints.default.WebhookUpdate.method,
118
+ data: {
119
+ params
120
+ }
89
121
  }).then(res => {
90
122
  if (res.status >= 300) {
91
123
  console.log(`Unable to perform action (Response code: ${res.status}).`);
@@ -98,13 +130,22 @@ class WebhookApiClient {
98
130
  return Promise.reject(error);
99
131
  });
100
132
  }
133
+ /**
134
+ * This endpoint updates a specific field for a specific webhook endpoint.
135
+ * @param id
136
+ * @param params
137
+ */
101
138
 
102
- static updateASingleWebhookEndpointField(id) {
139
+
140
+ static updateASingleWebhookEndpointField(id, params) {
103
141
  return _client.default.request({
104
142
  url: _Endpoints.default.WebhookPatch.url({
105
143
  id
106
144
  }),
107
- method: _Endpoints.default.WebhookPatch.method
145
+ method: _Endpoints.default.WebhookPatch.method,
146
+ data: {
147
+ params
148
+ }
108
149
  }).then(res => {
109
150
  if (res.status >= 300) {
110
151
  console.log(`Unable to perform action (Response code: ${res.status}).`);
@@ -117,6 +158,11 @@ class WebhookApiClient {
117
158
  return Promise.reject(error);
118
159
  });
119
160
  }
161
+ /**
162
+ * This endpoint deletes a Webhook Endpoint.
163
+ * @param id
164
+ */
165
+
120
166
 
121
167
  static deleteWebhookEndpoint(id) {
122
168
  return _client.default.request({
@@ -130,12 +176,17 @@ class WebhookApiClient {
130
176
  return Promise.reject(res);
131
177
  }
132
178
 
133
- return Promise.resolve(res.data);
179
+ return Promise.resolve(res);
134
180
  }).catch(error => {
135
181
  console.log('Unable to perform action.');
136
182
  return Promise.reject(error);
137
183
  });
138
184
  }
185
+ /**
186
+ * This endpoint retrieves the attempts related to this endpoint.
187
+ * @param id
188
+ */
189
+
139
190
 
140
191
  static getAllWebhookEndpointAttempts(id) {
141
192
  return _client.default.request({
@@ -155,6 +206,11 @@ class WebhookApiClient {
155
206
  return Promise.reject(error);
156
207
  });
157
208
  }
209
+ /**
210
+ * This endpoint expires the secret associated with this endpoint.
211
+ * @param id
212
+ */
213
+
158
214
 
159
215
  static expireWebhookSigningSecret(id) {
160
216
  return _client.default.request({
@@ -174,13 +230,22 @@ class WebhookApiClient {
174
230
  return Promise.reject(error);
175
231
  });
176
232
  }
233
+ /**
234
+ * This endpoint reveals the secret associated with this endpoint.
235
+ * @param id
236
+ * @param password
237
+ */
238
+
177
239
 
178
- static revealWebhookSigningSecret(id) {
240
+ static revealWebhookSigningSecret(id, password) {
179
241
  return _client.default.request({
180
242
  url: _Endpoints.default.WebhookRevealSigningSecret.url({
181
243
  id
182
244
  }),
183
- method: _Endpoints.default.WebhookRevealSigningSecret.method
245
+ method: _Endpoints.default.WebhookRevealSigningSecret.method,
246
+ data: {
247
+ password: password != null ? password : null
248
+ }
184
249
  }).then(res => {
185
250
  if (res.status >= 300) {
186
251
  console.log(`Unable to perform action(Response code: ${res.status}).`);
@@ -193,39 +258,57 @@ class WebhookApiClient {
193
258
  return Promise.reject(error);
194
259
  });
195
260
  }
261
+ /**
262
+ * This endpoint resends the event specified as parameter to the endpoint specified by the id parameter.
263
+ * @param id
264
+ * @param event
265
+ */
196
266
 
197
- static resendWebhookEndpointEvent(id) {
267
+
268
+ static resendWebhookEndpointEvent(id, event) {
198
269
  return _client.default.request({
199
270
  url: _Endpoints.default.WebhookResendEndpointEvent.url({
200
271
  id
201
272
  }),
202
- method: _Endpoints.default.WebhookResendEndpointEvent.method
273
+ method: _Endpoints.default.WebhookResendEndpointEvent.method,
274
+ data: {
275
+ event: event
276
+ }
203
277
  }).then(res => {
204
278
  if (res.status >= 300) {
205
279
  console.log(`Unable to perform action (Response code: ${res.status}).`);
206
280
  return Promise.reject(res);
207
281
  }
208
282
 
209
- return Promise.resolve(res.data);
283
+ return Promise.resolve(res);
210
284
  }).catch(error => {
211
285
  console.log('Unable to perform action.');
212
286
  return Promise.reject(error);
213
287
  });
214
288
  }
289
+ /**
290
+ * This endpoint resends the events specified as parameters to the endpoint specified by the id parameter.
291
+ * @param id
292
+ * @param event
293
+ */
294
+
215
295
 
216
- static resendMultipleWebhookEndpointEvent(id) {
296
+ static resendMultipleWebhookEndpointEvent(id, event) {
217
297
  return _client.default.request({
218
298
  url: _Endpoints.default.WebhookResendMultipleEndpointEvent.url({
219
299
  id
220
300
  }),
221
- method: _Endpoints.default.WebhookResendMultipleEndpointEvent.method
301
+ method: _Endpoints.default.WebhookResendMultipleEndpointEvent.method,
302
+ data: {
303
+ event: event
304
+ }
222
305
  }).then(res => {
223
306
  if (res.status >= 300) {
224
307
  console.log(`Unable to perform action (Response code: ${res.status}).`);
225
308
  return Promise.reject(res);
226
309
  }
227
310
 
228
- return Promise.resolve(res.data);
311
+ return Promise.resolve(res);
229
312
  }).catch(error => {
230
313
  console.log('Unable to perform action.');
231
314
  return Promise.reject(error);
@@ -245,20 +328,20 @@ class WebhookService {
245
328
  return WebhookApiClient.getAllWebhookEvents();
246
329
  }
247
330
 
248
- static async createWebhookEndpoint() {
249
- return WebhookApiClient.createWebhookEndpoint();
331
+ static async createWebhookEndpoint(params) {
332
+ return WebhookApiClient.createWebhookEndpoint(params);
250
333
  }
251
334
 
252
335
  static async getASpecificWebhookEndpoint(id) {
253
336
  return WebhookApiClient.getASpecificWebhookEndpoint(id);
254
337
  }
255
338
 
256
- static async updateASpecificWebhookEndpoint(id) {
257
- return WebhookApiClient.updateASpecificWebhookEndpoint(id);
339
+ static async updateASpecificWebhookEndpoint(id, params) {
340
+ return WebhookApiClient.updateASpecificWebhookEndpoint(id, params);
258
341
  }
259
342
 
260
- static async updateASingleWebhookEndpointField(id) {
261
- return WebhookApiClient.updateASingleWebhookEndpointField(id);
343
+ static async updateASingleWebhookEndpointField(id, params) {
344
+ return WebhookApiClient.updateASingleWebhookEndpointField(id, params);
262
345
  }
263
346
 
264
347
  static async deleteWebhookEndpoint(id) {
@@ -273,16 +356,16 @@ class WebhookService {
273
356
  return WebhookApiClient.expireWebhookSigningSecret(id);
274
357
  }
275
358
 
276
- static async revealWebhookSigningSecret(id) {
277
- return WebhookApiClient.revealWebhookSigningSecret(id);
359
+ static async revealWebhookSigningSecret(id, password) {
360
+ return WebhookApiClient.revealWebhookSigningSecret(id, password);
278
361
  }
279
362
 
280
- static async resendWebhookEndpointEvent(id) {
281
- return WebhookApiClient.resendWebhookEndpointEvent(id);
363
+ static async resendWebhookEndpointEvent(id, event) {
364
+ return WebhookApiClient.resendWebhookEndpointEvent(id, event);
282
365
  }
283
366
 
284
- static async resendMultipleWebhookEndpointEvent(id) {
285
- return WebhookApiClient.resendMultipleWebhookEndpointEvent(id);
367
+ static async resendMultipleWebhookEndpointEvent(id, event) {
368
+ return WebhookApiClient.resendMultipleWebhookEndpointEvent(id, event);
286
369
  }
287
370
 
288
371
  }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Types
3
+ */
4
+ import { SCBroadcastMessageBannerType, SCBannerType, SCBroadcastMessageType, SCAuthTokenType, SCCustomAdvPosition, SCCustomAdvType, SCUserFields, SCUserType, SCUserSettingsType, SCUserStatus, SCUserBlockedSettingsType, SCTagType, SCCategoryType, SCEmbedType, SCMediaType, SCContributionLocation, SCLocalityType, SCPollChoiceType, SCPollType, SCFeedUnitType, SCFeedUnitActivityType, SCFeedObjectType, SCFeedPostType, SCFeedDiscussionType, SCFeedStatusType, SCFeedObjectTypologyType, SCFeedUnitActivityTypologyType, SCFeedTypologyType, SCCommentTypologyType, SCCommentsOrderBy, SCCommentType, SCPrivateMessageType, SCPrivateMessageStatusType, SCPrivateMessageFileType, SCMessageFileType, SCNotificationTypologyType, SCNotificationAggregatedType, SCNotificationCommentType, SCNotificationConnectionAcceptType, SCNotificationConnectionRequestType, SCNotificationPrivateMessageType, SCNotificationMentionType, SCNotificationType, SCNotificationBlockedUserType, SCNotificationCollapsedForType, SCNotificationCustomNotificationType, SCNotificationDeletedForType, SCNotificationFollowType, SCNotificationKindlyNoticeType, SCNotificationUnBlockedUserType, SCNotificationUnDeletedForType, SCNotificationUserFollowType, SCNotificationVoteUpType, SCCustomNotificationType, SCIncubatorType, SCNotificationIncubatorType, SCNotificationTopicType, SCPrizeType, SCWebhookEndpointType, SCWebhookEndpointAttemptType, SCWebhookEndpointSecretType, SCWebhookEventsType } from './types';
5
+ /**
6
+ * List all exports
7
+ */
8
+ export { SCBroadcastMessageBannerType, SCBannerType, SCBroadcastMessageType, SCCustomAdvPosition, SCCustomAdvType, SCAuthTokenType, SCUserFields, SCUserType, SCUserSettingsType, SCUserStatus, SCUserBlockedSettingsType, SCTagType, SCCategoryType, SCEmbedType, SCMediaType, SCContributionLocation, SCLocalityType, SCPollChoiceType, SCPollType, SCFeedUnitType, SCFeedUnitActivityType, SCFeedObjectType, SCFeedPostType, SCFeedDiscussionType, SCFeedStatusType, SCFeedObjectTypologyType, SCFeedUnitActivityTypologyType, SCFeedTypologyType, SCCommentTypologyType, SCCommentsOrderBy, SCCommentType, SCPrivateMessageType, SCPrivateMessageStatusType, SCPrivateMessageFileType, SCMessageFileType, SCNotificationTypologyType, SCNotificationAggregatedType, SCNotificationCommentType, SCNotificationConnectionAcceptType, SCNotificationConnectionRequestType, SCNotificationPrivateMessageType, SCNotificationMentionType, SCNotificationType, SCNotificationBlockedUserType, SCNotificationCollapsedForType, SCNotificationCustomNotificationType, SCNotificationDeletedForType, SCNotificationFollowType, SCNotificationKindlyNoticeType, SCNotificationUnBlockedUserType, SCNotificationUnDeletedForType, SCNotificationUserFollowType, SCNotificationVoteUpType, SCCustomNotificationType, SCNotificationTopicType, SCIncubatorType, SCNotificationIncubatorType, SCPrizeType, SCWebhookEndpointType, SCWebhookEndpointAttemptType, SCWebhookEndpointSecretType, SCWebhookEventsType };
9
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../types/src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EACL,4BAA4B,EAC5B,YAAY,EACZ,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,yBAAyB,EACzB,SAAS,EACT,cAAc,EACd,WAAW,EACX,WAAW,EACX,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,EAC9B,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,0BAA0B,EAC1B,4BAA4B,EAC5B,yBAAyB,EACzB,kCAAkC,EAClC,mCAAmC,EACnC,gCAAgC,EAChC,yBAAyB,EACzB,kBAAkB,EAClB,6BAA6B,EAC7B,8BAA8B,EAC9B,oCAAoC,EACpC,4BAA4B,EAC5B,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC9B,4BAA4B,EAC5B,wBAAwB,EACxB,wBAAwB,EACxB,eAAe,EACf,2BAA2B,EAC3B,uBAAuB,EACvB,WAAW,EACX,qBAAqB,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,OAAO,EACL,4BAA4B,EAC5B,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,YAAY,EACZ,yBAAyB,EACzB,SAAS,EACT,cAAc,EACd,WAAW,EACX,WAAW,EACX,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,EAC9B,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,EACxB,iBAAiB,EACjB,0BAA0B,EAC1B,4BAA4B,EAC5B,yBAAyB,EACzB,kCAAkC,EAClC,mCAAmC,EACnC,gCAAgC,EAChC,yBAAyB,EACzB,kBAAkB,EAClB,6BAA6B,EAC7B,8BAA8B,EAC9B,oCAAoC,EACpC,4BAA4B,EAC5B,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,8BAA8B,EAC9B,4BAA4B,EAC5B,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACvB,eAAe,EACf,2BAA2B,EAC3B,WAAW,EACX,qBAAqB,EACrB,4BAA4B,EAC5B,2BAA2B,EAC3B,mBAAmB,EACpB,CAAC"}
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Interface SCAuthTokenType
3
+ */
4
+ export interface SCAuthTokenType {
5
+ /**
6
+ * Access token.
7
+ */
8
+ accessToken: string;
9
+ /**
10
+ * Refresh token.
11
+ */
12
+ refreshToken?: string;
13
+ /**
14
+ * Token Type.
15
+ */
16
+ tokenType?: string;
17
+ /**
18
+ * Expire in.
19
+ */
20
+ expiresIn?: number;
21
+ /**
22
+ * Token scopes;
23
+ */
24
+ scope?: Array<string>;
25
+ }
26
+ //# sourceMappingURL=auth.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/auth.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACvB"}
@@ -0,0 +1,73 @@
1
+ /**
2
+ * Define the various types of banners
3
+ */
4
+ export declare enum SCBroadcastMessageBannerType {
5
+ HTML = "html_banner",
6
+ NOTIFICATION = "notification_banner"
7
+ }
8
+ export interface SCBannerType {
9
+ /**
10
+ * The type of the banner, based on it the behaviour of the render component must be different
11
+ */
12
+ type_banner: SCBroadcastMessageBannerType;
13
+ /**
14
+ * The html to insert into the DOM
15
+ * This field is used when type_banner is html_banner
16
+ */
17
+ html?: string;
18
+ /**
19
+ * The title of the banner
20
+ */
21
+ title?: string;
22
+ /**
23
+ * The text of the banner
24
+ */
25
+ body_text?: string;
26
+ /**
27
+ * The text of the link associated to the banner
28
+ */
29
+ link_text?: string;
30
+ /**
31
+ * The action link of the banner
32
+ */
33
+ link?: string;
34
+ /**
35
+ * The image url to insert into the banner
36
+ */
37
+ image?: string;
38
+ /**
39
+ * The date the Banner was created
40
+ */
41
+ added_at: Date;
42
+ /**
43
+ * If true tell to open the banner in new tab
44
+ */
45
+ open_in_new_tab: boolean;
46
+ }
47
+ /**
48
+ * Interface SCBroadcastMessageType.
49
+ * Broadcast Message object
50
+ */
51
+ export interface SCBroadcastMessageType {
52
+ /**
53
+ * The ID of the category.
54
+ */
55
+ id: number;
56
+ /**
57
+ * The Banner associated to the Broadcast messages
58
+ */
59
+ banner: SCBannerType;
60
+ /**
61
+ * The date the BroadcastMessage was added
62
+ */
63
+ added_at: Date;
64
+ /**
65
+ * The date the BroadcastMessage was disposed
66
+ */
67
+ disposed_at: Date | null;
68
+ /**
69
+ * The date the BroadcastMessage was viewed the first time
70
+ */
71
+ viewed_at: Date | null;
72
+ }
73
+ //# sourceMappingURL=broadcastMessage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"broadcastMessage.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/broadcastMessage.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,4BAA4B;IACtC,IAAI,gBAAgB;IACpB,YAAY,wBAAwB;CACrC;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,WAAW,EAAE,4BAA4B,CAAC;IAE1C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC;IACf;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;CACxB"}
@@ -0,0 +1,100 @@
1
+ import { SCTagType } from './tag';
2
+ /**
3
+ * Interface SCCategoryType.
4
+ * Category Schema.
5
+ */
6
+ export interface SCCategoryType {
7
+ /**
8
+ * The ID of the category.
9
+ */
10
+ id: number;
11
+ /**
12
+ * The manual ordering number of the category.
13
+ */
14
+ order?: number;
15
+ /**
16
+ * The name of the category.
17
+ */
18
+ name: string;
19
+ /**
20
+ * The synonyms/aliases of the category.
21
+ */
22
+ name_synonyms?: string;
23
+ /**
24
+ * The slug of the category.
25
+ */
26
+ slug?: string;
27
+ /**
28
+ * The slogan of the category.
29
+ */
30
+ slogan?: string;
31
+ /**
32
+ * The category's html text.
33
+ */
34
+ html_info?: string;
35
+ /**
36
+ * The category's html meta tag.
37
+ */
38
+ seo_title?: string;
39
+ /**
40
+ * The description for category's html meta tag.
41
+ */
42
+ seo_description?: string;
43
+ /**
44
+ * The category's auto follow behaviour.
45
+ */
46
+ auto_follow?: string;
47
+ /**
48
+ * The category status.
49
+ */
50
+ active?: boolean;
51
+ /**
52
+ * The category status.
53
+ */
54
+ deleted?: boolean;
55
+ /**
56
+ * The category's image with min size.
57
+ */
58
+ image_original?: string;
59
+ /**
60
+ * The category's auto generated bigger size.
61
+ */
62
+ image_bigger?: string;
63
+ /**
64
+ * The category's auto generated big size.
65
+ */
66
+ image_big?: string;
67
+ /**
68
+ * The category's auto generated medium size.
69
+ */
70
+ image_medium?: string;
71
+ /**
72
+ * The category's auto generated small size.
73
+ */
74
+ image_small?: string;
75
+ /**
76
+ * The landscape format image for category hub.
77
+ */
78
+ emotional_image_original?: string;
79
+ /**
80
+ * The css background-position.
81
+ */
82
+ emotional_image_position?: number;
83
+ /**
84
+ * The last modify (datetime)
85
+ */
86
+ lastmod_datetime?: string;
87
+ /**
88
+ * The order of the category feed.
89
+ */
90
+ stream_order_by?: string;
91
+ /**
92
+ * The category's tags.
93
+ */
94
+ tags?: Array<SCTagType>;
95
+ /**
96
+ * Followers counter for the category.
97
+ */
98
+ followers_counter?: number;
99
+ }
100
+ //# sourceMappingURL=category.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/category.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,OAAO,CAAC;AAEhC;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IACxB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B"}
@@ -0,0 +1,97 @@
1
+ import { SCUserType } from './index';
2
+ /**
3
+ * Typology Comment
4
+ */
5
+ export declare const SCCommentTypologyType = "comment";
6
+ /**
7
+ * Interface SCCommentType.
8
+ * Comment Schema.
9
+ */
10
+ export interface SCCommentType {
11
+ /**
12
+ * Id of the comment
13
+ */
14
+ id: number;
15
+ /**
16
+ * Id of the Discussion object
17
+ */
18
+ discussion?: number;
19
+ /**
20
+ * Id of the Post object
21
+ */
22
+ post?: number;
23
+ /**
24
+ * Id of the Status object
25
+ */
26
+ status?: number;
27
+ /**
28
+ * User who commented
29
+ */
30
+ author?: SCUserType;
31
+ /**
32
+ * Added at
33
+ */
34
+ added_at: Date;
35
+ /**
36
+ * Html of the comment
37
+ */
38
+ html: string;
39
+ /**
40
+ * Summary
41
+ */
42
+ summary: string;
43
+ /**
44
+ * If the comments is deleted
45
+ */
46
+ deleted: boolean;
47
+ /**
48
+ * If the comments is hidden
49
+ */
50
+ collapsed: boolean;
51
+ /**
52
+ * Id of the parent
53
+ */
54
+ parent: number;
55
+ /**
56
+ * Id of the reply Comment, it must have the same parent
57
+ */
58
+ in_reply_to?: number;
59
+ /**
60
+ * Number of votes
61
+ */
62
+ vote_count: number;
63
+ /**
64
+ * True if the logged user has already voted the comment
65
+ */
66
+ voted: boolean;
67
+ /**
68
+ * Number of flags
69
+ */
70
+ flag_count: number;
71
+ /**
72
+ * Number of comments
73
+ */
74
+ comment_count: number;
75
+ /**
76
+ * Text of the comment
77
+ */
78
+ text: string;
79
+ /**
80
+ * Comments childs
81
+ */
82
+ latest_comments?: SCCommentType[];
83
+ /**
84
+ * Type: comment
85
+ */
86
+ type: string;
87
+ }
88
+ /**
89
+ * Type of comments ordering
90
+ */
91
+ export declare enum SCCommentsOrderBy {
92
+ ADDED_AT_DESC = "-added_at",
93
+ ADDED_AT_ASC = "added_at",
94
+ CONNECTION_DESC = "-connection",
95
+ CONNECTION_ASC = "connection"
96
+ }
97
+ //# sourceMappingURL=comment.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/comment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,MAAM,SAAS,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,qBAAqB,YAAY,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,EAAE,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,oBAAY,iBAAiB;IAC3B,aAAa,cAAc;IAC3B,YAAY,aAAa;IACzB,eAAe,gBAAgB;IAC/B,cAAc,eAAe;CAC9B"}
@@ -0,0 +1,53 @@
1
+ export declare enum SCCustomAdvPosition {
2
+ POSITION_BELOW_TOPBAR = "BELOW_TOPBAR",
3
+ POSITION_BELOW_FEED_OBJECT = "BELOW_THE_POST",
4
+ POSITION_ABOVE_FOOTER_BAR = "ABOVE_FOOTER_BAR",
5
+ POSITION_FOOTER_STICKY = "FOOTER_STICKY",
6
+ POSITION_IN_COMMENTS = "IN_POST_COMMENTS",
7
+ POSITION_RELATED_POSTS_COLUMN = "RELATED_POSTS_COLUMN",
8
+ POSITION_FEED_SIDEBAR = "TOOLS_COLUMN",
9
+ POSITION_FEED = "IN_STREAM"
10
+ }
11
+ export interface SCCustomAdvType {
12
+ /**
13
+ * Unique integer value identifying this adv
14
+ */
15
+ id: number;
16
+ /**
17
+ * A string code representing the display position of the adv
18
+ */
19
+ position: SCCustomAdvPosition;
20
+ /**
21
+ * The title of the adv
22
+ */
23
+ title: string | null;
24
+ /**
25
+ * The link/url of the adv
26
+ */
27
+ link: string | null;
28
+ /**
29
+ * An image banner for the adv
30
+ */
31
+ image: string | null;
32
+ /**
33
+ * Html/js embeddable code
34
+ */
35
+ embed_code: string | null;
36
+ /**
37
+ * A flag to activate or deactivate this adv
38
+ */
39
+ active: boolean;
40
+ /**
41
+ * datetime of creation
42
+ */
43
+ created_at: string;
44
+ /**
45
+ * last modify datetime
46
+ */
47
+ lastmod_datetime: string;
48
+ /**
49
+ * The id of the category connected to this adv
50
+ */
51
+ category: number | null;
52
+ }
53
+ //# sourceMappingURL=customAdv.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"customAdv.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/customAdv.ts"],"names":[],"mappings":"AAAA,oBAAY,mBAAmB;IAC7B,qBAAqB,iBAAiB;IACtC,0BAA0B,mBAAmB;IAC7C,yBAAyB,qBAAqB;IAC9C,sBAAsB,kBAAkB;IACxC,oBAAoB,qBAAqB;IACzC,6BAA6B,yBAAyB;IACtD,qBAAqB,iBAAiB;IACtC,aAAa,cAAc;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,mBAAmB,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB"}