@selfcommunity/api-services 0.1.6 → 0.1.7

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 (188) hide show
  1. package/lib/cjs/index.js +36 -0
  2. package/lib/cjs/services/category/index.js +168 -286
  3. package/lib/cjs/services/comment/index.js +107 -186
  4. package/lib/cjs/services/custom_adv/index.js +31 -51
  5. package/lib/cjs/services/custom_page/index.js +32 -52
  6. package/lib/cjs/services/data_portability/index.js +18 -43
  7. package/lib/cjs/services/embed/index.js +90 -151
  8. package/lib/cjs/services/feature/index.js +8 -16
  9. package/lib/cjs/services/feed/index.js +46 -81
  10. package/lib/cjs/services/feed_object/index.js +339 -505
  11. package/lib/cjs/services/incubator/index.js +64 -116
  12. package/lib/cjs/services/insight/index.js +51 -94
  13. package/lib/cjs/services/legal_page/index.js +60 -101
  14. package/lib/cjs/services/locality/index.js +14 -30
  15. package/lib/cjs/services/loyalty/index.js +92 -154
  16. package/lib/cjs/services/media/index.js +80 -122
  17. package/lib/cjs/services/moderation/index.js +65 -103
  18. package/lib/cjs/services/notification/index.js +67 -136
  19. package/lib/cjs/services/preference/index.js +25 -51
  20. package/lib/cjs/services/private_message/index.js +98 -177
  21. package/lib/cjs/services/score/index.js +22 -46
  22. package/lib/cjs/services/sso/index.js +17 -32
  23. package/lib/cjs/services/suggestion/index.js +23 -57
  24. package/lib/cjs/services/tag/index.js +72 -119
  25. package/lib/cjs/services/user/index.js +420 -767
  26. package/lib/cjs/services/webhook/index.js +4 -7
  27. package/lib/cjs/types/baseParams.js +3 -0
  28. package/lib/cjs/types/category.js +3 -0
  29. package/lib/cjs/types/comment.js +3 -0
  30. package/lib/cjs/types/customAdv.js +3 -0
  31. package/lib/cjs/types/customPage.js +3 -0
  32. package/lib/cjs/types/embed.js +3 -0
  33. package/lib/cjs/types/feed.js +3 -0
  34. package/lib/cjs/types/feedObject.js +3 -0
  35. package/lib/cjs/types/incubator.js +3 -0
  36. package/lib/cjs/types/index.js +91 -1
  37. package/lib/cjs/types/legalPage.js +3 -0
  38. package/lib/cjs/types/media.js +29 -0
  39. package/lib/cjs/types/moderation.js +3 -0
  40. package/lib/cjs/types/notification.js +3 -0
  41. package/lib/cjs/types/privateMessage.js +3 -0
  42. package/lib/cjs/types/prize.js +3 -0
  43. package/lib/cjs/types/sso.js +3 -0
  44. package/lib/cjs/types/tag.js +3 -0
  45. package/lib/cjs/types/user.js +3 -0
  46. package/lib/cjs/utils/apiRequest.js +2 -1
  47. package/lib/esm/index.js +36 -0
  48. package/lib/esm/services/category/index.js +168 -286
  49. package/lib/esm/services/comment/index.js +107 -186
  50. package/lib/esm/services/custom_adv/index.js +31 -51
  51. package/lib/esm/services/custom_page/index.js +32 -52
  52. package/lib/esm/services/data_portability/index.js +18 -43
  53. package/lib/esm/services/embed/index.js +90 -151
  54. package/lib/esm/services/feature/index.js +8 -16
  55. package/lib/esm/services/feed/index.js +46 -81
  56. package/lib/esm/services/feed_object/index.js +339 -505
  57. package/lib/esm/services/incubator/index.js +64 -116
  58. package/lib/esm/services/insight/index.js +51 -94
  59. package/lib/esm/services/legal_page/index.js +60 -101
  60. package/lib/esm/services/locality/index.js +14 -30
  61. package/lib/esm/services/loyalty/index.js +92 -154
  62. package/lib/esm/services/media/index.js +80 -122
  63. package/lib/esm/services/moderation/index.js +65 -103
  64. package/lib/esm/services/notification/index.js +67 -136
  65. package/lib/esm/services/preference/index.js +25 -51
  66. package/lib/esm/services/private_message/index.js +98 -177
  67. package/lib/esm/services/score/index.js +22 -46
  68. package/lib/esm/services/sso/index.js +17 -32
  69. package/lib/esm/services/suggestion/index.js +23 -57
  70. package/lib/esm/services/tag/index.js +72 -119
  71. package/lib/esm/services/user/index.js +420 -767
  72. package/lib/esm/services/webhook/index.js +4 -7
  73. package/lib/esm/types/baseParams.js +3 -0
  74. package/lib/esm/types/category.js +3 -0
  75. package/lib/esm/types/comment.js +3 -0
  76. package/lib/esm/types/customAdv.js +3 -0
  77. package/lib/esm/types/customPage.js +3 -0
  78. package/lib/esm/types/embed.js +3 -0
  79. package/lib/esm/types/feed.js +3 -0
  80. package/lib/esm/types/feedObject.js +3 -0
  81. package/lib/esm/types/incubator.js +3 -0
  82. package/lib/esm/types/index.js +91 -1
  83. package/lib/esm/types/legalPage.js +3 -0
  84. package/lib/esm/types/media.js +29 -0
  85. package/lib/esm/types/moderation.js +3 -0
  86. package/lib/esm/types/notification.js +3 -0
  87. package/lib/esm/types/privateMessage.js +3 -0
  88. package/lib/esm/types/prize.js +3 -0
  89. package/lib/esm/types/sso.js +3 -0
  90. package/lib/esm/types/tag.js +3 -0
  91. package/lib/esm/types/user.js +3 -0
  92. package/lib/esm/utils/apiRequest.js +2 -1
  93. package/lib/types/index.d.ts +2 -2
  94. package/lib/types/index.d.ts.map +1 -1
  95. package/lib/types/services/category/index.d.ts +114 -42
  96. package/lib/types/services/category/index.d.ts.map +1 -1
  97. package/lib/types/services/comment/index.d.ts +74 -23
  98. package/lib/types/services/comment/index.d.ts.map +1 -1
  99. package/lib/types/services/custom_adv/index.d.ts +26 -9
  100. package/lib/types/services/custom_adv/index.d.ts.map +1 -1
  101. package/lib/types/services/custom_page/index.d.ts +26 -9
  102. package/lib/types/services/custom_page/index.d.ts.map +1 -1
  103. package/lib/types/services/data_portability/index.d.ts +19 -6
  104. package/lib/types/services/data_portability/index.d.ts.map +1 -1
  105. package/lib/types/services/embed/index.d.ts +62 -24
  106. package/lib/types/services/embed/index.d.ts.map +1 -1
  107. package/lib/types/services/feature/index.d.ts +11 -3
  108. package/lib/types/services/feature/index.d.ts.map +1 -1
  109. package/lib/types/services/feed/index.d.ts +37 -15
  110. package/lib/types/services/feed/index.d.ts.map +1 -1
  111. package/lib/types/services/feed_object/index.d.ts +229 -81
  112. package/lib/types/services/feed_object/index.d.ts.map +1 -1
  113. package/lib/types/services/incubator/index.d.ts +51 -18
  114. package/lib/types/services/incubator/index.d.ts.map +1 -1
  115. package/lib/types/services/insight/index.d.ts +44 -18
  116. package/lib/types/services/insight/index.d.ts.map +1 -1
  117. package/lib/types/services/legal_page/index.d.ts +46 -18
  118. package/lib/types/services/legal_page/index.d.ts.map +1 -1
  119. package/lib/types/services/locality/index.d.ts +17 -6
  120. package/lib/types/services/locality/index.d.ts.map +1 -1
  121. package/lib/types/services/loyalty/index.d.ts +70 -27
  122. package/lib/types/services/loyalty/index.d.ts.map +1 -1
  123. package/lib/types/services/media/index.d.ts +55 -18
  124. package/lib/types/services/media/index.d.ts.map +1 -1
  125. package/lib/types/services/moderation/index.d.ts +51 -18
  126. package/lib/types/services/moderation/index.d.ts.map +1 -1
  127. package/lib/types/services/notification/index.d.ts +63 -27
  128. package/lib/types/services/notification/index.d.ts.map +1 -1
  129. package/lib/types/services/preference/index.d.ts +28 -9
  130. package/lib/types/services/preference/index.d.ts.map +1 -1
  131. package/lib/types/services/private_message/index.d.ts +68 -24
  132. package/lib/types/services/private_message/index.d.ts.map +1 -1
  133. package/lib/types/services/score/index.d.ts +24 -9
  134. package/lib/types/services/score/index.d.ts.map +1 -1
  135. package/lib/types/services/sso/index.d.ts +18 -6
  136. package/lib/types/services/sso/index.d.ts.map +1 -1
  137. package/lib/types/services/suggestion/index.d.ts +29 -12
  138. package/lib/types/services/suggestion/index.d.ts.map +1 -1
  139. package/lib/types/services/tag/index.d.ts +57 -21
  140. package/lib/types/services/tag/index.d.ts.map +1 -1
  141. package/lib/types/services/user/index.d.ts +313 -114
  142. package/lib/types/services/user/index.d.ts.map +1 -1
  143. package/lib/types/services/webhook/index.d.ts +3 -4
  144. package/lib/types/services/webhook/index.d.ts.map +1 -1
  145. package/lib/types/tsconfig.build.tsbuildinfo +1 -1
  146. package/lib/types/types/baseParams.d.ts +23 -0
  147. package/lib/types/types/baseParams.d.ts.map +1 -0
  148. package/lib/types/types/category.d.ts +15 -0
  149. package/lib/types/types/category.d.ts.map +1 -0
  150. package/lib/types/types/comment.d.ts +51 -0
  151. package/lib/types/types/comment.d.ts.map +1 -0
  152. package/lib/types/types/customAdv.d.ts +19 -0
  153. package/lib/types/types/customAdv.d.ts.map +1 -0
  154. package/lib/types/types/customPage.d.ts +24 -0
  155. package/lib/types/types/customPage.d.ts.map +1 -0
  156. package/lib/types/types/embed.d.ts +26 -0
  157. package/lib/types/types/embed.d.ts.map +1 -0
  158. package/lib/types/types/feed.d.ts +11 -0
  159. package/lib/types/types/feed.d.ts.map +1 -0
  160. package/lib/types/types/feedObject.d.ts +56 -0
  161. package/lib/types/types/feedObject.d.ts.map +1 -0
  162. package/lib/types/types/incubator.d.ts +33 -0
  163. package/lib/types/types/incubator.d.ts.map +1 -0
  164. package/lib/types/types/index.d.ts +19 -1
  165. package/lib/types/types/index.d.ts.map +1 -1
  166. package/lib/types/types/legalPage.d.ts +19 -0
  167. package/lib/types/types/legalPage.d.ts.map +1 -0
  168. package/lib/types/types/media.d.ts +80 -0
  169. package/lib/types/types/media.d.ts.map +1 -0
  170. package/lib/types/types/moderation.d.ts +23 -0
  171. package/lib/types/types/moderation.d.ts.map +1 -0
  172. package/lib/types/types/notification.d.ts +31 -0
  173. package/lib/types/types/notification.d.ts.map +1 -0
  174. package/lib/types/types/privateMessage.d.ts +176 -0
  175. package/lib/types/types/privateMessage.d.ts.map +1 -0
  176. package/lib/types/types/prize.d.ts +47 -0
  177. package/lib/types/types/prize.d.ts.map +1 -0
  178. package/lib/types/types/sso.d.ts +12 -0
  179. package/lib/types/types/sso.d.ts.map +1 -0
  180. package/lib/types/types/tag.d.ts +39 -0
  181. package/lib/types/types/tag.d.ts.map +1 -0
  182. package/lib/types/types/user.d.ts +105 -0
  183. package/lib/types/types/user.d.ts.map +1 -0
  184. package/lib/types/utils/apiRequest.d.ts +1 -1
  185. package/lib/types/utils/apiRequest.d.ts.map +1 -1
  186. package/lib/umd/api-services.js +1 -1
  187. package/lib/umd/api-services.js.map +1 -1
  188. package/package.json +4 -4
@@ -107,16 +107,13 @@ class WebhookApiClient {
107
107
  /**
108
108
  * This endpoint reveals the secret associated with this endpoint.
109
109
  * @param id
110
- * @param password
111
110
  */
112
111
 
113
112
 
114
- static revealWebhookSigningSecret(id, password) {
113
+ static revealWebhookSigningSecret(id) {
115
114
  return (0, _apiRequest.apiRequest)(_Endpoints.default.WebhookRevealSigningSecret.url({
116
115
  id
117
- }), _Endpoints.default.WebhookRevealSigningSecret.method, password ? {
118
- password: password
119
- } : null);
116
+ }), _Endpoints.default.WebhookRevealSigningSecret.method);
120
117
  }
121
118
  /**
122
119
  * This endpoint resends the event specified as parameter to the endpoint specified by the id parameter.
@@ -188,8 +185,8 @@ class WebhookService {
188
185
  return WebhookApiClient.expireWebhookSigningSecret(id);
189
186
  }
190
187
 
191
- static async revealWebhookSigningSecret(id, password) {
192
- return WebhookApiClient.revealWebhookSigningSecret(id, password);
188
+ static async revealWebhookSigningSecret(id) {
189
+ return WebhookApiClient.revealWebhookSigningSecret(id);
193
190
  }
194
191
 
195
192
  static async resendWebhookEndpointEvent(id, event) {
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -9,4 +9,94 @@ exports.SCPaginatedResponse = _paginatedResponse.SCPaginatedResponse;
9
9
  var _webhook = require("./webhook");
10
10
 
11
11
  exports.WebhookParamType = _webhook.WebhookParamType;
12
- exports.WebhookEventsType = _webhook.WebhookEventsType;
12
+ exports.WebhookEventsType = _webhook.WebhookEventsType;
13
+
14
+ var _sso = require("./sso");
15
+
16
+ exports.SSOSignUpParams = _sso.SSOSignUpParams;
17
+
18
+ var _comment = require("./comment");
19
+
20
+ exports.CommentListParams = _comment.CommentListParams;
21
+ exports.CommentCreateParams = _comment.CommentCreateParams;
22
+
23
+ var _incubator = require("./incubator");
24
+
25
+ exports.IncubatorCreateParams = _incubator.IncubatorCreateParams;
26
+ exports.IncubatorSearchParams = _incubator.IncubatorSearchParams;
27
+
28
+ var _prize = require("./prize");
29
+
30
+ exports.LoyaltyPrizeParams = _prize.LoyaltyPrizeParams;
31
+
32
+ var _moderation = require("./moderation");
33
+
34
+ exports.ModerateContributionParams = _moderation.ModerateContributionParams;
35
+
36
+ var _notification = require("./notification");
37
+
38
+ exports.CustomNotificationParams = _notification.CustomNotificationParams;
39
+
40
+ var _user = require("./user");
41
+
42
+ exports.UserAutocompleteParams = _user.UserAutocompleteParams;
43
+ exports.UserScoreParams = _user.UserScoreParams;
44
+ exports.UserSearchParams = _user.UserSearchParams;
45
+
46
+ var _tag = require("./tag");
47
+
48
+ exports.TagParams = _tag.TagParams;
49
+
50
+ var _media = require("./media");
51
+
52
+ exports.MediaCreateParams = _media.MediaCreateParams;
53
+ exports.MediaTypes = _media.MediaTypes;
54
+ exports.ChunkUploadParams = _media.ChunkUploadParams;
55
+ exports.ChunkUploadCompleteParams = _media.ChunkUploadCompleteParams;
56
+ exports.ChunkType = _media.ChunkType;
57
+
58
+ var _privateMessage = require("./privateMessage");
59
+
60
+ exports.ThreadParams = _privateMessage.ThreadParams;
61
+ exports.MessageCreateParams = _privateMessage.MessageCreateParams;
62
+ exports.MessageMediaUploadParams = _privateMessage.MessageMediaUploadParams;
63
+ exports.MessageThumbnailUploadParams = _privateMessage.MessageThumbnailUploadParams;
64
+ exports.MessageChunkUploadDoneParams = _privateMessage.MessageChunkUploadDoneParams;
65
+ exports.MessageMediaChunksParams = _privateMessage.MessageMediaChunksParams;
66
+
67
+ var _category = require("./category");
68
+
69
+ exports.CategoryParams = _category.CategoryParams;
70
+
71
+ var _customAdv = require("./customAdv");
72
+
73
+ exports.CustomAdvParams = _customAdv.CustomAdvParams;
74
+
75
+ var _customPage = require("./customPage");
76
+
77
+ exports.CustomPageParams = _customPage.CustomPageParams;
78
+ exports.CustomPageSearchParams = _customPage.CustomPageSearchParams;
79
+
80
+ var _embed = require("./embed");
81
+
82
+ exports.EmbedUpdateParams = _embed.EmbedUpdateParams;
83
+ exports.EmbedSearchParams = _embed.EmbedSearchParams;
84
+
85
+ var _baseParams = require("./baseParams");
86
+
87
+ exports.BaseGetParams = _baseParams.BaseGetParams;
88
+ exports.BaseSearchParams = _baseParams.BaseSearchParams;
89
+
90
+ var _feedObject = require("./feedObject");
91
+
92
+ exports.FeedObjGetParams = _feedObject.FeedObjGetParams;
93
+ exports.FeedObjCreateParams = _feedObject.FeedObjCreateParams;
94
+ exports.FeedObjectPollVotesSearch = _feedObject.FeedObjectPollVotesSearch;
95
+
96
+ var _feed = require("./feed");
97
+
98
+ exports.FeedParams = _feed.FeedParams;
99
+
100
+ var _legalPage = require("./legalPage");
101
+
102
+ exports.LegalPageFilterParams = _legalPage.LegalPageFilterParams;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
4
+ exports.MediaTypes = exports.ChunkType = void 0;
5
+
6
+ /**
7
+ * Interface MediaCreateParams
8
+ */
9
+ let MediaTypes;
10
+ /**
11
+ * Interface ChunkUploadParams
12
+ */
13
+
14
+ exports.MediaTypes = MediaTypes;
15
+
16
+ (function (MediaTypes) {
17
+ MediaTypes["URL"] = "url";
18
+ MediaTypes["SHARE"] = "share";
19
+ MediaTypes["EMBED"] = "embed";
20
+ })(MediaTypes || (exports.MediaTypes = MediaTypes = {}));
21
+
22
+ let ChunkType;
23
+ exports.ChunkType = ChunkType;
24
+
25
+ (function (ChunkType) {
26
+ ChunkType["IMAGE"] = "image";
27
+ ChunkType["DOC"] = "doc";
28
+ ChunkType["EIMAGE"] = "eimage";
29
+ })(ChunkType || (exports.ChunkType = ChunkType = {}));
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+
3
+ exports.__esModule = true;
@@ -7,10 +7,11 @@ var _client = _interopRequireDefault(require("../client"));
7
7
 
8
8
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
9
9
 
10
- function apiRequest(url, method, data) {
10
+ function apiRequest(url, method, headers, data) {
11
11
  return _client.default.request({
12
12
  url,
13
13
  method,
14
+ headers,
14
15
  data: data != null ? data : null
15
16
  }).then(res => {
16
17
  if (res.status >= 300) {
@@ -43,9 +43,9 @@ import WebhookService, { WebhookApiClient, WebhookApiClientInterface } from './s
43
43
  /**
44
44
  * Types
45
45
  */
46
- import { SCPaginatedResponse, WebhookParamType, WebhookEventsType } from './types';
46
+ import { SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, MediaCreateParams, MediaTypes, ChunkType, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams } from './types';
47
47
  /**
48
48
  * Export all
49
49
  */
50
- export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, generateJWTToken, parseJwt, Endpoints, EndpointType, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType };
50
+ export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, generateJWTToken, parseJwt, Endpoints, EndpointType, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ChunkType, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams };
51
51
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,IAAI,EAAE,EAAC,YAAY,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAExD;;GAEG;AACH,OAAO,SAAS,EAAE,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAE9D;;GAEG;AACH,OAAO,EAAC,eAAe,EAAC,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AACzD,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAE9C;;GAEG;AACH,OAAO,eAAe,EAAE,EAAC,iBAAiB,EAAE,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,gBAAgB,EAAE,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AACxG,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,wBAAwB,CAAC;AAC5G,OAAO,sBAAsB,EAAE,EAAC,wBAAwB,EAAE,iCAAiC,EAAC,MAAM,6BAA6B,CAAC;AAChI,OAAO,YAAY,EAAE,EAAC,cAAc,EAAE,uBAAuB,EAAC,MAAM,kBAAkB,CAAC;AACvF,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,WAAW,EAAE,EAAC,aAAa,EAAE,sBAAsB,EAAC,MAAM,iBAAiB,CAAC;AACnF,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,wBAAwB,CAAC;AAC5G,OAAO,gBAAgB,EAAE,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,sBAAsB,CAAC;AACvG,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,gBAAgB,EAAE,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AACxG,OAAO,eAAe,EAAE,EAAC,iBAAiB,EAAE,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,YAAY,EAAE,EAAC,cAAc,EAAE,uBAAuB,EAAC,MAAM,kBAAkB,CAAC;AACvF,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,uBAAuB,CAAC;AAC3G,OAAO,mBAAmB,EAAE,EAAC,qBAAqB,EAAE,8BAA8B,EAAC,MAAM,yBAAyB,CAAC;AACnH,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,uBAAuB,CAAC;AAC3G,OAAO,qBAAqB,EAAE,EAAC,uBAAuB,EAAE,gCAAgC,EAAC,MAAM,4BAA4B,CAAC;AAC5H,OAAO,YAAY,EAAE,EAAC,cAAc,EAAE,uBAAuB,EAAC,MAAM,kBAAkB,CAAC;AACvF,OAAO,UAAU,EAAE,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,gBAAgB,CAAC;AAC/E,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,uBAAuB,CAAC;AAC3G,OAAO,UAAU,EAAE,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,gBAAgB,CAAC;AAC/E,OAAO,WAAW,EAAE,EAAC,aAAa,EAAE,sBAAsB,EAAC,MAAM,iBAAiB,CAAC;AACnF,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAE/F;;GAEG;AACH,OAAO,EAAC,mBAAmB,EAAE,gBAAgB,EAAE,iBAAiB,EAAC,MAAM,SAAS,CAAC;AAEjF;;GAEG;AACH,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,UAAU,EACV,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,WAAW,EACX,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,eAAe,EACf,iBAAiB,EACjB,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,iCAAiC,EACjC,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,WAAW,EACX,aAAa,EACb,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,eAAe,EACf,iBAAiB,EACjB,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,EAC9B,qBAAqB,EACrB,uBAAuB,EACvB,gCAAgC,EAChC,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,UAAU,EACV,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,UAAU,EACV,YAAY,EACZ,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EAClB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,IAAI,EAAE,EAAC,YAAY,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAExD;;GAEG;AACH,OAAO,SAAS,EAAE,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAE9D;;GAEG;AACH,OAAO,EAAC,eAAe,EAAC,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAC,gBAAgB,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAC;AACzD,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAE9C;;GAEG;AACH,OAAO,eAAe,EAAE,EAAC,iBAAiB,EAAE,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,gBAAgB,EAAE,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AACxG,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,wBAAwB,CAAC;AAC5G,OAAO,sBAAsB,EAAE,EAAC,wBAAwB,EAAE,iCAAiC,EAAC,MAAM,6BAA6B,CAAC;AAChI,OAAO,YAAY,EAAE,EAAC,cAAc,EAAE,uBAAuB,EAAC,MAAM,kBAAkB,CAAC;AACvF,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,WAAW,EAAE,EAAC,aAAa,EAAE,sBAAsB,EAAC,MAAM,iBAAiB,CAAC;AACnF,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,wBAAwB,CAAC;AAC5G,OAAO,gBAAgB,EAAE,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,sBAAsB,CAAC;AACvG,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,gBAAgB,EAAE,EAAC,kBAAkB,EAAE,2BAA2B,EAAC,MAAM,uBAAuB,CAAC;AACxG,OAAO,eAAe,EAAE,EAAC,iBAAiB,EAAE,0BAA0B,EAAC,MAAM,qBAAqB,CAAC;AACnG,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAC/F,OAAO,YAAY,EAAE,EAAC,cAAc,EAAE,uBAAuB,EAAC,MAAM,kBAAkB,CAAC;AACvF,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,uBAAuB,CAAC;AAC3G,OAAO,mBAAmB,EAAE,EAAC,qBAAqB,EAAE,8BAA8B,EAAC,MAAM,yBAAyB,CAAC;AACnH,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,uBAAuB,CAAC;AAC3G,OAAO,qBAAqB,EAAE,EAAC,uBAAuB,EAAE,gCAAgC,EAAC,MAAM,4BAA4B,CAAC;AAC5H,OAAO,YAAY,EAAE,EAAC,cAAc,EAAE,uBAAuB,EAAC,MAAM,kBAAkB,CAAC;AACvF,OAAO,UAAU,EAAE,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,gBAAgB,CAAC;AAC/E,OAAO,iBAAiB,EAAE,EAAC,mBAAmB,EAAE,4BAA4B,EAAC,MAAM,uBAAuB,CAAC;AAC3G,OAAO,UAAU,EAAE,EAAC,YAAY,EAAE,qBAAqB,EAAC,MAAM,gBAAgB,CAAC;AAC/E,OAAO,WAAW,EAAE,EAAC,aAAa,EAAE,sBAAsB,EAAC,MAAM,iBAAiB,CAAC;AACnF,OAAO,cAAc,EAAE,EAAC,gBAAgB,EAAE,yBAAyB,EAAC,MAAM,oBAAoB,CAAC;AAE/F;;GAEG;AACH,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,EAC1B,wBAAwB,EACxB,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,SAAS,EACT,iBAAiB,EACjB,yBAAyB,EACzB,YAAY,EACZ,mBAAmB,EACnB,wBAAwB,EACxB,4BAA4B,EAC5B,4BAA4B,EAC5B,wBAAwB,EACxB,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,UAAU,EACV,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,UAAU,EACV,UAAU,EACV,eAAe,EACf,gBAAgB,EAChB,QAAQ,EACR,SAAS,EACT,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,WAAW,EACX,aAAa,EACb,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,eAAe,EACf,iBAAiB,EACjB,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,iCAAiC,EACjC,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,WAAW,EACX,aAAa,EACb,sBAAsB,EACtB,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,eAAe,EACf,iBAAiB,EACjB,0BAA0B,EAC1B,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,EACrB,8BAA8B,EAC9B,qBAAqB,EACrB,uBAAuB,EACvB,gCAAgC,EAChC,YAAY,EACZ,cAAc,EACd,uBAAuB,EACvB,UAAU,EACV,YAAY,EACZ,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,4BAA4B,EAC5B,UAAU,EACV,YAAY,EACZ,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EAChB,yBAAyB,EACzB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,wBAAwB,EACxB,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAChB,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,yBAAyB,EACzB,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,wBAAwB,EACxB,4BAA4B,EAC5B,4BAA4B,EAC5B,wBAAwB,EACxB,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,yBAAyB,EACzB,UAAU,EACV,qBAAqB,EACtB,CAAC"}
@@ -1,55 +1,127 @@
1
+ import { SCCategoryType, SCCategoryAudienceType, SCUserType, SCFeedUnitType, SCCategoryFollowedStatusType } from '@selfcommunity/types';
2
+ import { BaseGetParams, CategoryParams, SCPaginatedResponse } from '../../types';
1
3
  export interface CategoryApiClientInterface {
2
- getAllCategories(): Promise<any>;
3
- searchCategory(): Promise<any>;
4
- createCategory(): Promise<any>;
5
- getSpecificCategory(id: number): Promise<any>;
6
- updateASpecificCategory(id: number): Promise<any>;
7
- patchASpecificCategory(id: number): Promise<any>;
4
+ getAllCategories(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
5
+ searchCategory(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
6
+ createCategory(data: SCCategoryType): Promise<SCCategoryType>;
7
+ getSpecificCategory(id: number): Promise<SCCategoryType>;
8
+ updateASpecificCategory(id: number, data: SCCategoryType): Promise<SCCategoryType>;
9
+ patchASpecificCategory(id: number, data: SCCategoryType): Promise<SCCategoryType>;
8
10
  deleteASpecificCategory(id: number): Promise<any>;
9
- getCategoryAudience(id: number): Promise<any>;
10
- getCategoryFollowers(id: number): Promise<any>;
11
- getCategoryFeed(id: number): Promise<any>;
12
- getCategoryTrendingFeed(id: number): Promise<any>;
13
- getCategoryTrendingFollowers(id: number): Promise<any>;
11
+ getCategoryAudience(id: number): Promise<SCCategoryAudienceType>;
12
+ getCategoryFollowers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
13
+ getCategoryFeed(id: number): Promise<SCPaginatedResponse<SCFeedUnitType>>;
14
+ getCategoryTrendingFeed(id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
15
+ getCategoryTrendingFollowers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
14
16
  followCategory(id: number): Promise<any>;
15
- checkCategoryIsFollowed(id: number): Promise<any>;
16
- getFollowedCategories(): Promise<any>;
17
- getPopularCategories(): Promise<any>;
17
+ checkCategoryIsFollowed(id: number): Promise<SCCategoryFollowedStatusType>;
18
+ getFollowedCategories(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
19
+ getPopularCategories(params?: BaseGetParams): Promise<SCPaginatedResponse<SCCategoryType>>;
18
20
  }
21
+ /**
22
+ * Contains all the endpoints needed to manage categories.
23
+ */
19
24
  export declare class CategoryApiClient {
20
- static getAllCategories(): Promise<any>;
21
- static searchCategory(): Promise<any>;
22
- static createCategory(): Promise<any>;
23
- static getSpecificCategory(id: number): Promise<any>;
24
- static updateASpecificCategory(id: number): Promise<any>;
25
- static patchASpecificCategory(id: number): Promise<any>;
25
+ /**
26
+ * This endpoint retrieves all categories.
27
+ * @param params
28
+ */
29
+ static getAllCategories(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
30
+ /**
31
+ * This endpoint performs category search.
32
+ * @param params
33
+ */
34
+ static searchCategory(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
35
+ /**
36
+ * This endpoint creates a category.
37
+ * @param data
38
+ */
39
+ static createCategory(data: SCCategoryType): Promise<SCCategoryType>;
40
+ /**
41
+ * This endpoint retrieves a specific category.
42
+ * @param id
43
+ */
44
+ static getSpecificCategory(id: number): Promise<SCCategoryType>;
45
+ /**
46
+ * This endpoint updates a specific category.
47
+ * @param id
48
+ * @param data
49
+ */
50
+ static updateASpecificCategory(id: number, data: SCCategoryType): Promise<SCCategoryType>;
51
+ /**
52
+ * This endpoint patches a specific category.
53
+ * @param id
54
+ * @param data
55
+ */
56
+ static patchASpecificCategory(id: number, data: SCCategoryType): Promise<SCCategoryType>;
57
+ /**
58
+ * This endpoint deletes a specific category identified by {id}.
59
+ * @param id
60
+ */
26
61
  static deleteASpecificCategory(id: number): Promise<any>;
27
- static getCategoryAudience(id: number): Promise<any>;
28
- static getCategoryFollowers(id: number): Promise<any>;
29
- static getCategoryFeed(id: number): Promise<any>;
30
- static getCategoryTrendingFeed(id: number): Promise<any>;
31
- static getCategoryTrendingFollowers(id: number): Promise<any>;
62
+ /**
63
+ * This endpoint returns the audience of a specific category.
64
+ * @param id
65
+ */
66
+ static getCategoryAudience(id: number): Promise<SCCategoryAudienceType>;
67
+ /**
68
+ * This endpoint returns all followers of a specific category.
69
+ * @param id
70
+ */
71
+ static getCategoryFollowers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
72
+ /**
73
+ * This endpoint retrieves the category feed.
74
+ * @param id
75
+ */
76
+ static getCategoryFeed(id: number): Promise<SCPaginatedResponse<SCFeedUnitType>>;
77
+ /**
78
+ * This endpoint retrieves the category trending feed.
79
+ * @param id
80
+ * @param params
81
+ */
82
+ static getCategoryTrendingFeed(id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
83
+ /**
84
+ * This endpoint returns all trending followers of a specific category during last n days (default 90) .
85
+ * @param id
86
+ */
87
+ static getCategoryTrendingFollowers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
88
+ /**
89
+ * This endpoint follows a category.
90
+ * @param id
91
+ */
32
92
  static followCategory(id: number): Promise<any>;
33
- static checkCategoryIsFollowed(id: number): Promise<any>;
34
- static getFollowedCategories(): Promise<any>;
35
- static getPopularCategories(): Promise<any>;
93
+ /**
94
+ * This endpoint returns is_followed = true if the category (identified in path) is followed by the authenticated user.
95
+ * @param id
96
+ */
97
+ static checkCategoryIsFollowed(id: number): Promise<SCCategoryFollowedStatusType>;
98
+ /**
99
+ * This endpoint retrieves all followed categories by the user.
100
+ * @param params
101
+ */
102
+ static getFollowedCategories(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
103
+ /**
104
+ * This endpoint retrieves all categories ordered by the number of followers (in descending order).
105
+ * @param params
106
+ */
107
+ static getPopularCategories(params?: BaseGetParams): Promise<SCPaginatedResponse<SCCategoryType>>;
36
108
  }
37
109
  export default class CategoryService {
38
- static getAllCategories(): Promise<any>;
39
- static searchCategory(): Promise<any>;
40
- static createCategory(): Promise<any>;
41
- static getSpecificCategory(id: number): Promise<any>;
42
- static updateASpecificCategory(id: number): Promise<any>;
43
- static patchASpecificCategory(id: number): Promise<any>;
110
+ static getAllCategories(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
111
+ static searchCategory(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
112
+ static createCategory(data: SCCategoryType): Promise<SCCategoryType>;
113
+ static getSpecificCategory(id: number): Promise<SCCategoryType>;
114
+ static updateASpecificCategory(id: number, data: SCCategoryType): Promise<SCCategoryType>;
115
+ static patchASpecificCategory(id: number, data: SCCategoryType): Promise<SCCategoryType>;
44
116
  static deleteASpecificCategory(id: number): Promise<any>;
45
- static getCategoryAudience(id: number): Promise<any>;
46
- static getCategoryFollowers(id: number): Promise<any>;
47
- static getCategoryFeed(id: number): Promise<any>;
48
- static getCategoryTrendingFeed(id: number): Promise<any>;
49
- static getCategoryTrendingFollowers(id: number): Promise<any>;
117
+ static getCategoryAudience(id: number): Promise<SCCategoryAudienceType>;
118
+ static getCategoryFollowers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
119
+ static getCategoryFeed(id: number): Promise<SCPaginatedResponse<SCFeedUnitType>>;
120
+ static getCategoryTrendingFeed(id: number, params?: BaseGetParams): Promise<SCPaginatedResponse<SCFeedUnitType>>;
121
+ static getCategoryTrendingFollowers(id: number): Promise<SCPaginatedResponse<SCUserType>>;
50
122
  static followCategory(id: number): Promise<any>;
51
- static checkCategoryIsFollowed(id: number): Promise<any>;
52
- static getFollowedCategories(): Promise<any>;
53
- static getPopularCategories(): Promise<any>;
123
+ static checkCategoryIsFollowed(id: number): Promise<SCCategoryFollowedStatusType>;
124
+ static getFollowedCategories(params?: CategoryParams): Promise<SCPaginatedResponse<SCCategoryType>>;
125
+ static getPopularCategories(params?: BaseGetParams): Promise<SCPaginatedResponse<SCCategoryType>>;
54
126
  }
55
127
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/category/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,0BAA0B;IACzC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACjC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9C,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9C,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/C,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC1C,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACvD,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;CACtC;AAED,qBAAa,iBAAiB;IAC5B,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBvC,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBrC,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBrC,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBpD,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBxD,MAAM,CAAC,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAkBvD,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBxD,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBpD,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBrD,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBhD,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBxD,MAAM,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB7D,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB/C,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBxD,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;IAmB5C,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;CAkB5C;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;WACrB,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIhC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;WAI9B,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;WAI9B,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI7C,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIhD,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI7C,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAI9C,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIzC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAItD,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIxC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,qBAAqB,IAAI,OAAO,CAAC,GAAG,CAAC;WAIrC,oBAAoB,IAAI,OAAO,CAAC,GAAG,CAAC;CAGlD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/category/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,cAAc,EAAE,sBAAsB,EAAE,UAAU,EAAE,cAAc,EAAE,4BAA4B,EAAC,MAAM,sBAAsB,CAAC;AACtI,OAAO,EAAC,aAAa,EAAE,cAAc,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAG/E,MAAM,WAAW,0BAA0B;IACzC,gBAAgB,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IACxF,cAAc,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IACtF,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9D,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACzD,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACnF,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAClF,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACjE,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3E,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAC1E,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAC1G,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IACnF,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAC3E,qBAAqB,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IAC7F,oBAAoB,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;CAC5F;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAK9F;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAK5F;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAIpE;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAI/D;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzF;;;;OAIG;IACH,MAAM,CAAC,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAIxF;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIvE;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAIjF;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAIhF;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAKhH;;;OAGG;IACH,MAAM,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAIzF;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAIjF;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAKnG;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAIlG;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;WACrB,gBAAgB,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAIvF,cAAc,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAIrF,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;WAI7D,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;WAIxD,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;WAIlF,sBAAsB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;WAIjF,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;WAIhE,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAI1E,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAIzE,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAIzG,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAIlF,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIxC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,4BAA4B,CAAC;WAI1E,qBAAqB,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAI5F,oBAAoB,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAGxG"}
@@ -1,40 +1,91 @@
1
+ import { SCCommentType, SCFlagType, SCFlagTypeEnum, SCVoteType } from '@selfcommunity/types';
2
+ import { CommentCreateParams, CommentListParams, SCPaginatedResponse } from '../../types';
1
3
  export interface CommentApiClientInterface {
2
- getAllComments(): Promise<any>;
3
- createComment(): Promise<any>;
4
- getASpecificComment(id: number): Promise<any>;
5
- updateComment(id: number): Promise<any>;
4
+ getAllComments(params: CommentListParams): Promise<SCPaginatedResponse<SCCommentType>>;
5
+ createComment(data: CommentCreateParams): Promise<SCCommentType>;
6
+ getASpecificComment(id: number): Promise<SCCommentType>;
7
+ updateComment(id: number, text: string): Promise<SCCommentType>;
6
8
  deleteComment(id: number): Promise<any>;
7
9
  restoreComment(id: number): Promise<any>;
8
- getSpecificCommentVotesList(id: number): Promise<any>;
10
+ getSpecificCommentVotesList(id: number): Promise<SCPaginatedResponse<SCVoteType>>;
9
11
  upvoteComment(id: number): Promise<any>;
10
- getSpecificCommentFlags(id: number): Promise<any>;
12
+ getSpecificCommentFlags(id: number): Promise<SCPaginatedResponse<SCFlagType>>;
11
13
  flagComment(id: number): Promise<any>;
12
- getSpecificCommentFlagStatus(id: number): Promise<any>;
14
+ getSpecificCommentFlagStatus(id: number): Promise<SCFlagType>;
13
15
  }
16
+ /**
17
+ * Contains all the endpoints needed to manage comments.
18
+ */
14
19
  export declare class CommentApiClient {
15
- static getAllComments(): Promise<any>;
16
- static createComment(): Promise<any>;
17
- static getASpecificComment(id: number): Promise<any>;
18
- static updateComment(id: number): Promise<any>;
20
+ /**
21
+ * This endpoint retrieves all comments.
22
+ * @param params
23
+ */
24
+ static getAllComments(params: CommentListParams): Promise<SCPaginatedResponse<SCCommentType>>;
25
+ /**
26
+ * This endpoint creates a comment.
27
+ * @param data
28
+ */
29
+ static createComment(data: CommentCreateParams): Promise<SCCommentType>;
30
+ /**
31
+ * This endpoint retrieves a specific comment using ID.
32
+ * @param id
33
+ */
34
+ static getASpecificComment(id: number): Promise<SCCommentType>;
35
+ /**
36
+ * This endpoint updates a specific comment.
37
+ * @param id
38
+ * @param text
39
+ */
40
+ static updateComment(id: number, text: string): Promise<SCCommentType>;
41
+ /**
42
+ * This endpoint deletes a specific comment using ID.
43
+ * @param id
44
+ */
19
45
  static deleteComment(id: number): Promise<any>;
46
+ /**
47
+ * This endpoint restores a specific comment using ID.
48
+ * @param id
49
+ */
20
50
  static restoreComment(id: number): Promise<any>;
21
- static getSpecificCommentVotesList(id: number): Promise<any>;
51
+ /**
52
+ * This endpoint retrieves all votes for a specific comment.
53
+ * @param id
54
+ */
55
+ static getSpecificCommentVotesList(id: number): Promise<SCPaginatedResponse<SCVoteType>>;
56
+ /**
57
+ * This endpoint upvotes a specific comment.
58
+ * @param id
59
+ */
22
60
  static upvoteComment(id: number): Promise<any>;
23
- static getSpecificCommentFlags(id: number): Promise<any>;
24
- static flagComment(id: number): Promise<any>;
25
- static getSpecificCommentFlagStatus(id: number): Promise<any>;
61
+ /**
62
+ * This endpoint retrieves a List of Flags for a Specific Comment.
63
+ * @param id
64
+ */
65
+ static getSpecificCommentFlags(id: number): Promise<SCPaginatedResponse<SCFlagType>>;
66
+ /**
67
+ * This endpoint flags a specific comment.
68
+ * @param id
69
+ * @param flagType
70
+ */
71
+ static flagComment(id: number, flagType: SCFlagTypeEnum): Promise<any>;
72
+ /**
73
+ * This endpoint retrieves, if exists, a flag for this contribute created by the user logged.
74
+ * @param id
75
+ */
76
+ static getSpecificCommentFlagStatus(id: number): Promise<SCFlagType>;
26
77
  }
27
78
  export default class CommentService {
28
- static getAllComments(): Promise<any>;
29
- static createComment(): Promise<any>;
30
- static getASpecificComment(id: number): Promise<any>;
31
- static updateComment(id: number): Promise<any>;
79
+ static getAllComments(params: CommentListParams): Promise<SCPaginatedResponse<SCCommentType>>;
80
+ static createComment(data: CommentCreateParams): Promise<SCCommentType>;
81
+ static getASpecificComment(id: number): Promise<SCCommentType>;
82
+ static updateComment(id: number, text: string): Promise<SCCommentType>;
32
83
  static deleteComment(id: number): Promise<any>;
33
84
  static restoreComment(id: number): Promise<any>;
34
- static getSpecificCommentVotesList(id: number): Promise<any>;
85
+ static getSpecificCommentVotesList(id: number): Promise<SCPaginatedResponse<SCVoteType>>;
35
86
  static upvoteComment(id: number): Promise<any>;
36
- static getSpecificCommentFlags(id: number): Promise<any>;
37
- static flagComment(id: number): Promise<any>;
38
- static getSpecificCommentFlagStatus(id: number): Promise<any>;
87
+ static getSpecificCommentFlags(id: number): Promise<SCPaginatedResponse<SCFlagType>>;
88
+ static flagComment(id: number, flagType: SCFlagTypeEnum): Promise<any>;
89
+ static getSpecificCommentFlagStatus(id: number): Promise<SCFlagType>;
39
90
  }
40
91
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/comment/index.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,yBAAyB;IACxC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9C,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,2BAA2B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtD,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACxD;AAED,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBrC,MAAM,CAAC,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAmBpC,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBpD,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB9C,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB9C,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB/C,MAAM,CAAC,2BAA2B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB5D,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB9C,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmBxD,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB5C,MAAM,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAkB9D;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC;WAG9B,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;WAG7B,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAG7C,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGxC,2BAA2B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGrD,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGjD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGrC,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGpE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/comment/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAC3F,OAAO,EAAC,mBAAmB,EAAE,iBAAiB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAExF,MAAM,WAAW,yBAAyB;IACxC,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;IACvF,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACjE,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACxD,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAChE,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,2BAA2B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAClF,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9E,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC/D;AAED;;GAEG;AAEH,qBAAa,gBAAgB;IAC3B;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAK7F;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIvE;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAI9D;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAItE;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,2BAA2B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAIxF;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAIpF;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;IAItE;;;OAGG;IACH,MAAM,CAAC,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAGrE;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;WAGtF,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAC;WAGhE,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;WAGvD,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;WAG/D,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGxC,2BAA2B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAGjF,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAG7E,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;WAG/D,4BAA4B,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAG3E"}