@selfcommunity/api-services 0.1.28-alpha.3 → 0.1.28

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 (211) hide show
  1. package/lib/cjs/services/category/index.d.ts +76 -49
  2. package/lib/cjs/services/category/index.d.ts.map +1 -1
  3. package/lib/cjs/services/category/index.js +91 -65
  4. package/lib/cjs/services/category/index.js.map +1 -1
  5. package/lib/cjs/services/comment/index.d.ts +55 -34
  6. package/lib/cjs/services/comment/index.d.ts.map +1 -1
  7. package/lib/cjs/services/comment/index.js +65 -45
  8. package/lib/cjs/services/comment/index.js.map +1 -1
  9. package/lib/cjs/services/custom_adv/index.d.ts +23 -10
  10. package/lib/cjs/services/custom_adv/index.d.ts.map +1 -1
  11. package/lib/cjs/services/custom_adv/index.js +25 -13
  12. package/lib/cjs/services/custom_adv/index.js.map +1 -1
  13. package/lib/cjs/services/custom_page/index.d.ts +23 -10
  14. package/lib/cjs/services/custom_page/index.d.ts.map +1 -1
  15. package/lib/cjs/services/custom_page/index.js +25 -13
  16. package/lib/cjs/services/custom_page/index.js.map +1 -1
  17. package/lib/cjs/services/data_portability/index.d.ts +22 -9
  18. package/lib/cjs/services/data_portability/index.d.ts.map +1 -1
  19. package/lib/cjs/services/data_portability/index.js +24 -12
  20. package/lib/cjs/services/data_portability/index.js.map +1 -1
  21. package/lib/cjs/services/embed/index.d.ts +43 -25
  22. package/lib/cjs/services/embed/index.d.ts.map +1 -1
  23. package/lib/cjs/services/embed/index.js +50 -33
  24. package/lib/cjs/services/embed/index.js.map +1 -1
  25. package/lib/cjs/services/feature/index.d.ts +14 -3
  26. package/lib/cjs/services/feature/index.d.ts.map +1 -1
  27. package/lib/cjs/services/feature/index.js +14 -4
  28. package/lib/cjs/services/feature/index.js.map +1 -1
  29. package/lib/cjs/services/feed/index.d.ts +32 -17
  30. package/lib/cjs/services/feed/index.d.ts.map +1 -1
  31. package/lib/cjs/services/feed/index.js +36 -22
  32. package/lib/cjs/services/feed/index.js.map +1 -1
  33. package/lib/cjs/services/feed_object/index.d.ts +118 -81
  34. package/lib/cjs/services/feed_object/index.d.ts.map +1 -1
  35. package/lib/cjs/services/feed_object/index.js +143 -107
  36. package/lib/cjs/services/feed_object/index.js.map +1 -1
  37. package/lib/cjs/services/incubator/index.d.ts +39 -22
  38. package/lib/cjs/services/incubator/index.d.ts.map +1 -1
  39. package/lib/cjs/services/incubator/index.js +45 -29
  40. package/lib/cjs/services/incubator/index.js.map +1 -1
  41. package/lib/cjs/services/insight/index.d.ts +35 -19
  42. package/lib/cjs/services/insight/index.d.ts.map +1 -1
  43. package/lib/cjs/services/insight/index.js +40 -25
  44. package/lib/cjs/services/insight/index.js.map +1 -1
  45. package/lib/cjs/services/legal_page/index.d.ts +35 -19
  46. package/lib/cjs/services/legal_page/index.d.ts.map +1 -1
  47. package/lib/cjs/services/legal_page/index.js +40 -25
  48. package/lib/cjs/services/legal_page/index.js.map +1 -1
  49. package/lib/cjs/services/locality/index.d.ts +18 -6
  50. package/lib/cjs/services/locality/index.d.ts.map +1 -1
  51. package/lib/cjs/services/locality/index.js +19 -8
  52. package/lib/cjs/services/locality/index.js.map +1 -1
  53. package/lib/cjs/services/loyalty/index.d.ts +48 -29
  54. package/lib/cjs/services/loyalty/index.d.ts.map +1 -1
  55. package/lib/cjs/services/loyalty/index.js +56 -38
  56. package/lib/cjs/services/loyalty/index.js.map +1 -1
  57. package/lib/cjs/services/media/index.d.ts +42 -22
  58. package/lib/cjs/services/media/index.d.ts.map +1 -1
  59. package/lib/cjs/services/media/index.js +48 -29
  60. package/lib/cjs/services/media/index.js.map +1 -1
  61. package/lib/cjs/services/moderation/index.d.ts +33 -19
  62. package/lib/cjs/services/moderation/index.d.ts.map +1 -1
  63. package/lib/cjs/services/moderation/index.js +40 -27
  64. package/lib/cjs/services/moderation/index.js.map +1 -1
  65. package/lib/cjs/services/notification/index.d.ts +47 -28
  66. package/lib/cjs/services/notification/index.d.ts.map +1 -1
  67. package/lib/cjs/services/notification/index.js +55 -37
  68. package/lib/cjs/services/notification/index.js.map +1 -1
  69. package/lib/cjs/services/preference/index.d.ts +23 -10
  70. package/lib/cjs/services/preference/index.d.ts.map +1 -1
  71. package/lib/cjs/services/preference/index.js +25 -13
  72. package/lib/cjs/services/preference/index.js.map +1 -1
  73. package/lib/cjs/services/private_message/index.d.ts +51 -31
  74. package/lib/cjs/services/private_message/index.d.ts.map +1 -1
  75. package/lib/cjs/services/private_message/index.js +60 -41
  76. package/lib/cjs/services/private_message/index.js.map +1 -1
  77. package/lib/cjs/services/score/index.d.ts +22 -9
  78. package/lib/cjs/services/score/index.d.ts.map +1 -1
  79. package/lib/cjs/services/score/index.js +24 -12
  80. package/lib/cjs/services/score/index.js.map +1 -1
  81. package/lib/cjs/services/sso/index.d.ts +18 -6
  82. package/lib/cjs/services/sso/index.d.ts.map +1 -1
  83. package/lib/cjs/services/sso/index.js +19 -8
  84. package/lib/cjs/services/sso/index.js.map +1 -1
  85. package/lib/cjs/services/suggestion/index.d.ts +26 -12
  86. package/lib/cjs/services/suggestion/index.d.ts.map +1 -1
  87. package/lib/cjs/services/suggestion/index.js +29 -16
  88. package/lib/cjs/services/suggestion/index.js.map +1 -1
  89. package/lib/cjs/services/tag/index.d.ts +39 -22
  90. package/lib/cjs/services/tag/index.d.ts.map +1 -1
  91. package/lib/cjs/services/tag/index.js +45 -29
  92. package/lib/cjs/services/tag/index.js.map +1 -1
  93. package/lib/cjs/services/user/index.d.ts +204 -145
  94. package/lib/cjs/services/user/index.d.ts.map +1 -1
  95. package/lib/cjs/services/user/index.js +259 -201
  96. package/lib/cjs/services/user/index.js.map +1 -1
  97. package/lib/cjs/services/webhook/index.d.ts +59 -37
  98. package/lib/cjs/services/webhook/index.d.ts.map +1 -1
  99. package/lib/cjs/services/webhook/index.js +70 -49
  100. package/lib/cjs/services/webhook/index.js.map +1 -1
  101. package/lib/cjs/utils/apiRequest.d.ts +2 -1
  102. package/lib/cjs/utils/apiRequest.d.ts.map +1 -1
  103. package/lib/cjs/utils/apiRequest.js +4 -8
  104. package/lib/cjs/utils/apiRequest.js.map +1 -1
  105. package/lib/esm/services/category/index.d.ts +76 -49
  106. package/lib/esm/services/category/index.d.ts.map +1 -1
  107. package/lib/esm/services/category/index.js +91 -65
  108. package/lib/esm/services/category/index.js.map +1 -1
  109. package/lib/esm/services/comment/index.d.ts +55 -34
  110. package/lib/esm/services/comment/index.d.ts.map +1 -1
  111. package/lib/esm/services/comment/index.js +65 -45
  112. package/lib/esm/services/comment/index.js.map +1 -1
  113. package/lib/esm/services/custom_adv/index.d.ts +23 -10
  114. package/lib/esm/services/custom_adv/index.d.ts.map +1 -1
  115. package/lib/esm/services/custom_adv/index.js +25 -13
  116. package/lib/esm/services/custom_adv/index.js.map +1 -1
  117. package/lib/esm/services/custom_page/index.d.ts +23 -10
  118. package/lib/esm/services/custom_page/index.d.ts.map +1 -1
  119. package/lib/esm/services/custom_page/index.js +25 -13
  120. package/lib/esm/services/custom_page/index.js.map +1 -1
  121. package/lib/esm/services/data_portability/index.d.ts +22 -9
  122. package/lib/esm/services/data_portability/index.d.ts.map +1 -1
  123. package/lib/esm/services/data_portability/index.js +24 -12
  124. package/lib/esm/services/data_portability/index.js.map +1 -1
  125. package/lib/esm/services/embed/index.d.ts +43 -25
  126. package/lib/esm/services/embed/index.d.ts.map +1 -1
  127. package/lib/esm/services/embed/index.js +50 -33
  128. package/lib/esm/services/embed/index.js.map +1 -1
  129. package/lib/esm/services/feature/index.d.ts +14 -3
  130. package/lib/esm/services/feature/index.d.ts.map +1 -1
  131. package/lib/esm/services/feature/index.js +14 -4
  132. package/lib/esm/services/feature/index.js.map +1 -1
  133. package/lib/esm/services/feed/index.d.ts +32 -17
  134. package/lib/esm/services/feed/index.d.ts.map +1 -1
  135. package/lib/esm/services/feed/index.js +36 -22
  136. package/lib/esm/services/feed/index.js.map +1 -1
  137. package/lib/esm/services/feed_object/index.d.ts +118 -81
  138. package/lib/esm/services/feed_object/index.d.ts.map +1 -1
  139. package/lib/esm/services/feed_object/index.js +143 -107
  140. package/lib/esm/services/feed_object/index.js.map +1 -1
  141. package/lib/esm/services/incubator/index.d.ts +39 -22
  142. package/lib/esm/services/incubator/index.d.ts.map +1 -1
  143. package/lib/esm/services/incubator/index.js +45 -29
  144. package/lib/esm/services/incubator/index.js.map +1 -1
  145. package/lib/esm/services/insight/index.d.ts +35 -19
  146. package/lib/esm/services/insight/index.d.ts.map +1 -1
  147. package/lib/esm/services/insight/index.js +40 -25
  148. package/lib/esm/services/insight/index.js.map +1 -1
  149. package/lib/esm/services/legal_page/index.d.ts +35 -19
  150. package/lib/esm/services/legal_page/index.d.ts.map +1 -1
  151. package/lib/esm/services/legal_page/index.js +40 -25
  152. package/lib/esm/services/legal_page/index.js.map +1 -1
  153. package/lib/esm/services/locality/index.d.ts +18 -6
  154. package/lib/esm/services/locality/index.d.ts.map +1 -1
  155. package/lib/esm/services/locality/index.js +19 -8
  156. package/lib/esm/services/locality/index.js.map +1 -1
  157. package/lib/esm/services/loyalty/index.d.ts +48 -29
  158. package/lib/esm/services/loyalty/index.d.ts.map +1 -1
  159. package/lib/esm/services/loyalty/index.js +56 -38
  160. package/lib/esm/services/loyalty/index.js.map +1 -1
  161. package/lib/esm/services/media/index.d.ts +42 -22
  162. package/lib/esm/services/media/index.d.ts.map +1 -1
  163. package/lib/esm/services/media/index.js +48 -29
  164. package/lib/esm/services/media/index.js.map +1 -1
  165. package/lib/esm/services/moderation/index.d.ts +33 -19
  166. package/lib/esm/services/moderation/index.d.ts.map +1 -1
  167. package/lib/esm/services/moderation/index.js +40 -27
  168. package/lib/esm/services/moderation/index.js.map +1 -1
  169. package/lib/esm/services/notification/index.d.ts +47 -28
  170. package/lib/esm/services/notification/index.d.ts.map +1 -1
  171. package/lib/esm/services/notification/index.js +55 -37
  172. package/lib/esm/services/notification/index.js.map +1 -1
  173. package/lib/esm/services/preference/index.d.ts +23 -10
  174. package/lib/esm/services/preference/index.d.ts.map +1 -1
  175. package/lib/esm/services/preference/index.js +25 -13
  176. package/lib/esm/services/preference/index.js.map +1 -1
  177. package/lib/esm/services/private_message/index.d.ts +51 -31
  178. package/lib/esm/services/private_message/index.d.ts.map +1 -1
  179. package/lib/esm/services/private_message/index.js +60 -41
  180. package/lib/esm/services/private_message/index.js.map +1 -1
  181. package/lib/esm/services/score/index.d.ts +22 -9
  182. package/lib/esm/services/score/index.d.ts.map +1 -1
  183. package/lib/esm/services/score/index.js +24 -12
  184. package/lib/esm/services/score/index.js.map +1 -1
  185. package/lib/esm/services/sso/index.d.ts +18 -6
  186. package/lib/esm/services/sso/index.d.ts.map +1 -1
  187. package/lib/esm/services/sso/index.js +19 -8
  188. package/lib/esm/services/sso/index.js.map +1 -1
  189. package/lib/esm/services/suggestion/index.d.ts +26 -12
  190. package/lib/esm/services/suggestion/index.d.ts.map +1 -1
  191. package/lib/esm/services/suggestion/index.js +29 -16
  192. package/lib/esm/services/suggestion/index.js.map +1 -1
  193. package/lib/esm/services/tag/index.d.ts +39 -22
  194. package/lib/esm/services/tag/index.d.ts.map +1 -1
  195. package/lib/esm/services/tag/index.js +45 -29
  196. package/lib/esm/services/tag/index.js.map +1 -1
  197. package/lib/esm/services/user/index.d.ts +204 -145
  198. package/lib/esm/services/user/index.d.ts.map +1 -1
  199. package/lib/esm/services/user/index.js +259 -201
  200. package/lib/esm/services/user/index.js.map +1 -1
  201. package/lib/esm/services/webhook/index.d.ts +59 -37
  202. package/lib/esm/services/webhook/index.d.ts.map +1 -1
  203. package/lib/esm/services/webhook/index.js +70 -49
  204. package/lib/esm/services/webhook/index.js.map +1 -1
  205. package/lib/esm/utils/apiRequest.d.ts +2 -1
  206. package/lib/esm/utils/apiRequest.d.ts.map +1 -1
  207. package/lib/esm/utils/apiRequest.js +4 -8
  208. package/lib/esm/utils/apiRequest.js.map +1 -1
  209. package/lib/umd/api-services.js +1 -1
  210. package/lib/umd/api-services.js.map +1 -1
  211. package/package.json +4 -4
@@ -22,55 +22,59 @@ class ModerationApiClient {
22
22
  /**
23
23
  * This endpoint retrieves all users for moderation purpose.
24
24
  */
25
- static getUsersForModeration() {
26
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.UsersForModeration.url({}), Endpoints_1.default.UsersForModeration.method);
25
+ static getUsersForModeration(config) {
26
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UsersForModeration.url({}), method: Endpoints_1.default.UsersForModeration.method }));
27
27
  }
28
28
  /**
29
29
  * This endpoint performs users moderation.
30
30
  * @param id
31
31
  * @param status
32
+ * @param config
32
33
  */
33
- static moderateASpecificUser(id, status) {
34
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.ModerateUser.url({ id }), Endpoints_1.default.ModerateUser.method, { status: status });
34
+ static moderateASpecificUser(id, status, config) {
35
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.ModerateUser.url({ id }), method: Endpoints_1.default.ModerateUser.method, data: { status: status } }));
35
36
  }
36
37
  /**
37
38
  * This endpoint retrieves all flagged contributions.
38
39
  */
39
- static getAllFlaggedContributions() {
40
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.FlaggedContributions.url({}), Endpoints_1.default.FlaggedContributions.method);
40
+ static getAllFlaggedContributions(config) {
41
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.FlaggedContributions.url({}), method: Endpoints_1.default.FlaggedContributions.method }));
41
42
  }
42
43
  /**
43
44
  * This endpoint retrieves all flags for a specific contribution.
44
45
  * @param id
45
46
  * @param contribution_type
46
47
  * @param flag_type
48
+ * @param config
47
49
  */
48
- static getAllFlagsForSpecificContribution(id, contribution_type, flag_type) {
49
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.FlagsForSpecificContribution.url({ id, contribution_type }), Endpoints_1.default.FlagsForSpecificContribution.method, {
50
- flag_type: flag_type !== null && flag_type !== void 0 ? flag_type : null
51
- });
50
+ static getAllFlagsForSpecificContribution(id, contribution_type, flag_type, config) {
51
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.FlagsForSpecificContribution.url({ id, contribution_type }), method: Endpoints_1.default.FlagsForSpecificContribution.method, data: {
52
+ flag_type: flag_type !== null && flag_type !== void 0 ? flag_type : null
53
+ } }));
52
54
  }
53
55
  /**
54
56
  * This endpoint provides actions for flagged contributions moderation.
55
57
  * @param id
56
58
  * @param data
59
+ * @param config
57
60
  */
58
- static moderateAContribution(id, data) {
59
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.ModerateContribution.url({ id }), Endpoints_1.default.ModerateContribution.method, data);
61
+ static moderateAContribution(id, data, config) {
62
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.ModerateContribution.url({ id }), method: Endpoints_1.default.ModerateContribution.method, data: data }));
60
63
  }
61
64
  /**
62
65
  * This endpoint retrieves moderation status for a specific contribution.
63
66
  * @param id
64
67
  * @param contribution_type
68
+ * @param config
65
69
  */
66
- static getContributionModerationStatus(id, contribution_type) {
67
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.ModerateContributionStatus.url({ id, contribution_type }), Endpoints_1.default.ModerateContributionStatus.method);
70
+ static getContributionModerationStatus(id, contribution_type, config) {
71
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.ModerateContributionStatus.url({ id, contribution_type }), method: Endpoints_1.default.ModerateContributionStatus.method }));
68
72
  }
69
73
  }
70
74
  exports.ModerationApiClient = ModerationApiClient;
71
75
  /**
72
76
  *
73
- :::tipModeration service can be used in the following ways:
77
+ :::tipModeration service can be used in the following way:
74
78
 
75
79
  ```jsx
76
80
  1. Import the service from our library:
@@ -92,37 +96,46 @@ exports.ModerationApiClient = ModerationApiClient;
92
96
  return await ModerationService.moderateASpecificUser(userId, userStatus);
93
97
  }
94
98
  ```
99
+ ```jsx
100
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
101
+
102
+ 1. Declare it(or declare them, it is possible to add multiple params)
103
+
104
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
105
+
106
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
107
+ ```
95
108
  :::
96
109
  */
97
110
  class ModerationService {
98
- static getUsersForModeration() {
111
+ static getUsersForModeration(config) {
99
112
  return __awaiter(this, void 0, void 0, function* () {
100
- return ModerationApiClient.getUsersForModeration();
113
+ return ModerationApiClient.getUsersForModeration(config);
101
114
  });
102
115
  }
103
- static moderateASpecificUser(id, status) {
116
+ static moderateASpecificUser(id, status, config) {
104
117
  return __awaiter(this, void 0, void 0, function* () {
105
- return ModerationApiClient.moderateASpecificUser(id, status);
118
+ return ModerationApiClient.moderateASpecificUser(id, status, config);
106
119
  });
107
120
  }
108
- static getAllFlaggedContributions() {
121
+ static getAllFlaggedContributions(config) {
109
122
  return __awaiter(this, void 0, void 0, function* () {
110
- return ModerationApiClient.getAllFlaggedContributions();
123
+ return ModerationApiClient.getAllFlaggedContributions(config);
111
124
  });
112
125
  }
113
- static getAllFlagsForSpecificContribution(id, contribution_type, flag_type) {
126
+ static getAllFlagsForSpecificContribution(id, contribution_type, flag_type, config) {
114
127
  return __awaiter(this, void 0, void 0, function* () {
115
- return ModerationApiClient.getAllFlagsForSpecificContribution(id, contribution_type, flag_type);
128
+ return ModerationApiClient.getAllFlagsForSpecificContribution(id, contribution_type, flag_type, config);
116
129
  });
117
130
  }
118
- static moderateAContribution(id, data) {
131
+ static moderateAContribution(id, data, config) {
119
132
  return __awaiter(this, void 0, void 0, function* () {
120
- return ModerationApiClient.moderateAContribution(id, data);
133
+ return ModerationApiClient.moderateAContribution(id, data, config);
121
134
  });
122
135
  }
123
- static getContributionModerationStatus(id, contribution_type) {
136
+ static getContributionModerationStatus(id, contribution_type, config) {
124
137
  return __awaiter(this, void 0, void 0, function* () {
125
- return ModerationApiClient.getContributionModerationStatus(id, contribution_type);
138
+ return ModerationApiClient.getContributionModerationStatus(id, contribution_type, config);
126
139
  });
127
140
  }
128
141
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAiBlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,MAAoB;QAC3D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,YAAY,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,YAAY,CAAC,MAAM,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IACvG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,0BAA0B;QAC/B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAU,EACV,iBAAqC,EACrC,SAA0B;QAE1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,EAAE;YACpI,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI;SAC7B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,IAAgC;QACvE,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3G,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,+BAA+B,CAAC,EAAU,EAAE,iBAAqC;QACtF,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EAAE,mBAAS,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACpI,CAAC;CACF;AAzDD,kDAyDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAqB,iBAAiB;IACpC,MAAM,CAAO,qBAAqB;;YAChC,OAAO,mBAAmB,CAAC,qBAAqB,EAAE,CAAC;QACrD,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,MAAoB;;YACjE,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;IACD,MAAM,CAAO,0BAA0B;;YACrC,OAAO,mBAAmB,CAAC,0BAA0B,EAAE,CAAC;QAC1D,CAAC;KAAA;IACD,MAAM,CAAO,kCAAkC,CAC7C,EAAU,EACV,iBAAqC,EACrC,SAA0B;;YAE1B,OAAO,mBAAmB,CAAC,kCAAkC,CAAC,EAAE,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;QAClG,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,IAAgC;;YAC7E,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7D,CAAC;KAAA;IACD,MAAM,CAAO,+BAA+B,CAAC,EAAU,EAAE,iBAAqC;;YAC5F,OAAO,mBAAmB,CAAC,+BAA+B,CAAC,EAAE,EAAE,iBAAiB,CAAC,CAAC;QACpF,CAAC;KAAA;CACF;AAvBD,oCAuBC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAmBlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB,CAAC,MAA2B;QACtD,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,IAAE,CAAC;IACzH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,MAAoB,EAAE,MAA2B;QACxF,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,YAAY,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,IAAE,CAAC;IACvI,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,0BAA0B,CAAC,MAA2B;QAC3D,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,IAAE,CAAC;IAC7H,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAU,EACV,iBAAqC,EACrC,SAA0B,EAC1B,MAA2B;QAE3B,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EACxE,MAAM,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,EACrD,IAAI,EAAE;gBACJ,SAAS,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI;aAC7B,IACD,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,IAAgC,EAAE,MAA2B;QACpG,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IAC3I,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,+BAA+B,CACpC,EAAU,EACV,iBAAqC,EACrC,MAA2B;QAE3B,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAC,EAAE,EAAE,iBAAiB,EAAC,CAAC,EACtE,MAAM,EAAE,mBAAS,CAAC,0BAA0B,CAAC,MAAM,IACnD,CAAC;IACL,CAAC;CACF;AA3ED,kDA2EC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAqB,iBAAiB;IACpC,MAAM,CAAO,qBAAqB,CAAC,MAA2B;;YAC5D,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,MAAoB,EAAE,MAA2B;;YAC9F,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QACvE,CAAC;KAAA;IACD,MAAM,CAAO,0BAA0B,CAAC,MAA2B;;YACjE,OAAO,mBAAmB,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAChE,CAAC;KAAA;IACD,MAAM,CAAO,kCAAkC,CAC7C,EAAU,EACV,iBAAqC,EACrC,SAA0B,EAC1B,MAA2B;;YAE3B,OAAO,mBAAmB,CAAC,kCAAkC,CAAC,EAAE,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC1G,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,IAAgC,EAAE,MAA2B;;YAC1G,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACrE,CAAC;KAAA;IACD,MAAM,CAAO,+BAA+B,CAC1C,EAAU,EACV,iBAAqC,EACrC,MAA2B;;YAE3B,OAAO,mBAAmB,CAAC,+BAA+B,CAAC,EAAE,EAAE,iBAAiB,EAAE,MAAM,CAAC,CAAC;QAC5F,CAAC;KAAA;CACF;AA5BD,oCA4BC"}
@@ -1,15 +1,16 @@
1
1
  import { SCBroadcastMessageType, SCNotificationAggregatedType, SCNotificationUnseenCountType } from '@selfcommunity/types';
2
2
  import { CustomNotificationParams, SCPaginatedResponse } from '../../types';
3
+ import { AxiosRequestConfig } from 'axios';
3
4
  export interface NotificationApiClientInterface {
4
- listUserNotification(): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>;
5
- markReadNotification(sids: string[]): Promise<any>;
6
- getUnseenNotification(): Promise<SCNotificationUnseenCountType>;
7
- createCustomNotification(data: CustomNotificationParams): Promise<any>;
8
- listBroadcastMessages(): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
9
- listBroadcastMessagesUnseenCount(): Promise<SCNotificationUnseenCountType>;
10
- listBroadcastMessagesUndisposedCount(): Promise<SCNotificationUnseenCountType>;
11
- markReadBroadcastMessages(banner_ids: number[]): Promise<any>;
12
- disposeBroadcastMessages(banner_ids: number[]): Promise<any>;
5
+ listUserNotification(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>;
6
+ markReadNotification(sids: string[], config?: AxiosRequestConfig): Promise<any>;
7
+ getUnseenNotification(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
8
+ createCustomNotification(data: CustomNotificationParams, config?: AxiosRequestConfig): Promise<any>;
9
+ listBroadcastMessages(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
10
+ listBroadcastMessagesUnseenCount(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
11
+ listBroadcastMessagesUndisposedCount(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
12
+ markReadBroadcastMessages(banner_ids: number[], config?: AxiosRequestConfig): Promise<any>;
13
+ disposeBroadcastMessages(banner_ids: number[], config?: AxiosRequestConfig): Promise<any>;
13
14
  }
14
15
  /**
15
16
  * Contains all the endpoints needed to manage notifications.
@@ -17,48 +18,57 @@ export interface NotificationApiClientInterface {
17
18
  export declare class NotificationApiClient {
18
19
  /**
19
20
  * List all user notifications (in aggregate form) related to the community.
21
+ * @param config
20
22
  */
21
- static listUserNotification(): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>;
23
+ static listUserNotification(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>;
22
24
  /**
23
25
  * This endpoint marks as read a list of notifications identified by serialization_ids (sids).
24
26
  * @param sids
27
+ * @param config
25
28
  */
26
- static markReadNotification(sids: string[]): Promise<any>;
29
+ static markReadNotification(sids: string[], config?: AxiosRequestConfig): Promise<any>;
27
30
  /**
28
31
  * This endpoint retrieves the number of unseen/unread notifications.
32
+ * @param config
29
33
  */
30
- static getUnseenNotification(): Promise<SCNotificationUnseenCountType>;
34
+ static getUnseenNotification(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
31
35
  /**
32
36
  * This endpoint generates a custom notification starting from the user. The recipients of the notification can be the user's friends/followers or the user himself (based on recipients_type value). Es. connections -> "user" added an item to the wishlist.
33
37
  * @param data
38
+ * @param config
34
39
  */
35
- static createCustomNotification(data: CustomNotificationParams): Promise<any>;
40
+ static createCustomNotification(data: CustomNotificationParams, config?: AxiosRequestConfig): Promise<any>;
36
41
  /**
37
42
  * This endpoint lists all broadcast messages. Broadcast Message is a feature which allows a specific user to send messages and announcements to a larger group of users at once.
43
+ * @param config
38
44
  */
39
- static listBroadcastMessages(): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
45
+ static listBroadcastMessages(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
40
46
  /**
41
47
  * This endpoint retrieves the total number of broadcast messages not yet seen by the user.
48
+ * @param config
42
49
  */
43
- static listBroadcastMessagesUnseenCount(): Promise<SCNotificationUnseenCountType>;
50
+ static listBroadcastMessagesUnseenCount(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
44
51
  /**
45
52
  * This endpoint retrieves the total number of broadcast messages not yet disposed by the user.
53
+ * @param config
46
54
  */
47
- static listBroadcastMessagesUndisposedCount(): Promise<SCNotificationUnseenCountType>;
55
+ static listBroadcastMessagesUndisposedCount(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
48
56
  /**
49
57
  * This endpoint marks as viewed/read a broadcast message for a user.
50
58
  * @param banner_ids
59
+ * @param config
51
60
  */
52
- static markReadBroadcastMessages(banner_ids: number[]): Promise<any>;
61
+ static markReadBroadcastMessages(banner_ids: number[], config?: AxiosRequestConfig): Promise<any>;
53
62
  /**
54
63
  * This endpoint disposes a broadcast message for a user.
55
64
  * @param banner_ids
65
+ * @param config
56
66
  */
57
- static disposeBroadcastMessages(banner_ids: number[]): Promise<any>;
67
+ static disposeBroadcastMessages(banner_ids: number[], config?: AxiosRequestConfig): Promise<any>;
58
68
  }
59
69
  /**
60
70
  *
61
- :::tipNotification service can be used in the following ways:
71
+ :::tipNotification service can be used in the following way:
62
72
 
63
73
  ```jsx
64
74
  1. Import the service from our library:
@@ -80,17 +90,26 @@ export declare class NotificationApiClient {
80
90
  return await NotificationService.disposeBroadcastMessages(banner_ids);
81
91
  }
82
92
  ```
93
+ ```jsx
94
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
95
+
96
+ 1. Declare it(or declare them, it is possible to add multiple params)
97
+
98
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
99
+
100
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
101
+ ```
83
102
  :::
84
103
  */
85
104
  export default class NotificationService {
86
- static listUserNotification(): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>;
87
- static markReadNotification(sids: string[]): Promise<any>;
88
- static getUnseenNotification(): Promise<SCNotificationUnseenCountType>;
89
- static createCustomNotification(data: CustomNotificationParams): Promise<any>;
90
- static listBroadcastMessages(): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
91
- static listBroadcastMessagesUnseenCount(): Promise<SCNotificationUnseenCountType>;
92
- static listBroadcastMessagesUndisposedCount(): Promise<SCNotificationUnseenCountType>;
93
- static disposeBroadcastMessages(banner_ids: number[]): Promise<any>;
94
- static markReadBroadcastMessages(banner_ids: number[]): Promise<any>;
105
+ static listUserNotification(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCNotificationAggregatedType>>;
106
+ static markReadNotification(sids: string[], config?: AxiosRequestConfig): Promise<any>;
107
+ static getUnseenNotification(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
108
+ static createCustomNotification(data: CustomNotificationParams, config?: AxiosRequestConfig): Promise<any>;
109
+ static listBroadcastMessages(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCBroadcastMessageType>>;
110
+ static listBroadcastMessagesUnseenCount(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
111
+ static listBroadcastMessagesUndisposedCount(config?: AxiosRequestConfig): Promise<SCNotificationUnseenCountType>;
112
+ static disposeBroadcastMessages(banner_ids: number[], config?: AxiosRequestConfig): Promise<any>;
113
+ static markReadBroadcastMessages(banner_ids: number[], config?: AxiosRequestConfig): Promise<any>;
95
114
  }
96
115
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,sBAAsB,EAAE,4BAA4B,EAAE,6BAA6B,EAAC,MAAM,sBAAsB,CAAC;AACzH,OAAO,EAAC,wBAAwB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAE1E,MAAM,WAAW,8BAA8B;IAC7C,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC,CAAC;IACnF,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAChE,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACvE,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC9E,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC3E,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC/E,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9D,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC9D;AACD;;GAEG;AAEH,qBAAa,qBAAqB;IAChC;;OAEG;IACH,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;IAIzF;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzD;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAItE;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7E;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;IAIpF;;OAEG;IACH,MAAM,CAAC,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAIjF;;OAEG;IACH,MAAM,CAAC,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC;IAIrF;;;OAGG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAGpE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;WACzB,oBAAoB,IAAI,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;WAGlF,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAGlD,qBAAqB,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG/D,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGtE,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;WAG7E,gCAAgC,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG1E,oCAAoC,IAAI,OAAO,CAAC,6BAA6B,CAAC;WAG9E,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;WAG5D,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAG3E"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,sBAAsB,EAAE,4BAA4B,EAAE,6BAA6B,EAAC,MAAM,sBAAsB,CAAC;AACzH,OAAO,EAAC,wBAAwB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,8BAA8B;IAC7C,oBAAoB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAC9G,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAChF,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC3F,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACpG,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC,CAAC;IACzG,gCAAgC,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IACtG,oCAAoC,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1G,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC3F,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CAC3F;AACD;;GAEG;AAEH,qBAAa,qBAAqB;IAChC;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;IAIpH;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAStF;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAIjG;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI1G;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;IAI/G;;;OAGG;IACH,MAAM,CAAC,gCAAgC,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAI5G;;;OAGG;IACH,MAAM,CAAC,oCAAoC,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAQhH;;;;OAIG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IASjG;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;CAQjG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAmB;WACzB,oBAAoB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,4BAA4B,CAAC,CAAC;WAG7G,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAG/E,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC;WAG1F,wBAAwB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGnG,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;WAGxG,gCAAgC,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC;WAGrG,oCAAoC,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,6BAA6B,CAAC;WAGzG,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGzF,yBAAyB,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;CAGxG"}
@@ -21,67 +21,76 @@ const Endpoints_1 = __importDefault(require("../../constants/Endpoints"));
21
21
  class NotificationApiClient {
22
22
  /**
23
23
  * List all user notifications (in aggregate form) related to the community.
24
+ * @param config
24
25
  */
25
- static listUserNotification() {
26
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.UserNotificationList.url({}), Endpoints_1.default.UserNotificationList.method);
26
+ static listUserNotification(config) {
27
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserNotificationList.url({}), method: Endpoints_1.default.UserNotificationList.method }));
27
28
  }
28
29
  /**
29
30
  * This endpoint marks as read a list of notifications identified by serialization_ids (sids).
30
31
  * @param sids
32
+ * @param config
31
33
  */
32
- static markReadNotification(sids) {
33
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.UserMarkReadNotification.url({}), Endpoints_1.default.UserMarkReadNotification.method, { sids: sids });
34
+ static markReadNotification(sids, config) {
35
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserMarkReadNotification.url({}), method: Endpoints_1.default.UserMarkReadNotification.method, data: { sids: sids } }));
34
36
  }
35
37
  /**
36
38
  * This endpoint retrieves the number of unseen/unread notifications.
39
+ * @param config
37
40
  */
38
- static getUnseenNotification() {
39
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.UserUnseenNotificationCount.url({}), Endpoints_1.default.UserUnseenNotificationCount.method);
41
+ static getUnseenNotification(config) {
42
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserUnseenNotificationCount.url({}), method: Endpoints_1.default.UserUnseenNotificationCount.method }));
40
43
  }
41
44
  /**
42
45
  * This endpoint generates a custom notification starting from the user. The recipients of the notification can be the user's friends/followers or the user himself (based on recipients_type value). Es. connections -> "user" added an item to the wishlist.
43
46
  * @param data
47
+ * @param config
44
48
  */
45
- static createCustomNotification(data) {
46
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.CreateCustomNotification.url({}), Endpoints_1.default.CreateCustomNotification.method, data);
49
+ static createCustomNotification(data, config) {
50
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreateCustomNotification.url({}), method: Endpoints_1.default.CreateCustomNotification.method, data: data }));
47
51
  }
48
52
  /**
49
53
  * This endpoint lists all broadcast messages. Broadcast Message is a feature which allows a specific user to send messages and announcements to a larger group of users at once.
54
+ * @param config
50
55
  */
51
- static listBroadcastMessages() {
52
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.BroadcastMessagesList.url({}), Endpoints_1.default.BroadcastMessagesList.method);
56
+ static listBroadcastMessages(config) {
57
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.BroadcastMessagesList.url({}), method: Endpoints_1.default.BroadcastMessagesList.method }));
53
58
  }
54
59
  /**
55
60
  * This endpoint retrieves the total number of broadcast messages not yet seen by the user.
61
+ * @param config
56
62
  */
57
- static listBroadcastMessagesUnseenCount() {
58
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.BroadcastMessagesUnseenCount.url({}), Endpoints_1.default.BroadcastMessagesUnseenCount.method);
63
+ static listBroadcastMessagesUnseenCount(config) {
64
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.BroadcastMessagesUnseenCount.url({}), method: Endpoints_1.default.BroadcastMessagesUnseenCount.method }));
59
65
  }
60
66
  /**
61
67
  * This endpoint retrieves the total number of broadcast messages not yet disposed by the user.
68
+ * @param config
62
69
  */
63
- static listBroadcastMessagesUndisposedCount() {
64
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.BroadcastMessagesUndisposedCount.url({}), Endpoints_1.default.BroadcastMessagesUndisposedCount.method);
70
+ static listBroadcastMessagesUndisposedCount(config) {
71
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.BroadcastMessagesUndisposedCount.url({}), method: Endpoints_1.default.BroadcastMessagesUndisposedCount.method }));
65
72
  }
66
73
  /**
67
74
  * This endpoint marks as viewed/read a broadcast message for a user.
68
75
  * @param banner_ids
76
+ * @param config
69
77
  */
70
- static markReadBroadcastMessages(banner_ids) {
71
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.BroadcastMessagesMarkRead.url({}), Endpoints_1.default.BroadcastMessagesMarkRead.method, { banner_ids: banner_ids });
78
+ static markReadBroadcastMessages(banner_ids, config) {
79
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.BroadcastMessagesMarkRead.url({}), method: Endpoints_1.default.BroadcastMessagesMarkRead.method, data: { banner_ids: banner_ids } }));
72
80
  }
73
81
  /**
74
82
  * This endpoint disposes a broadcast message for a user.
75
83
  * @param banner_ids
84
+ * @param config
76
85
  */
77
- static disposeBroadcastMessages(banner_ids) {
78
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.BroadcastMessagesDispose.url({}), Endpoints_1.default.BroadcastMessagesDispose.method, { banner_ids: banner_ids });
86
+ static disposeBroadcastMessages(banner_ids, config) {
87
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.BroadcastMessagesDispose.url({}), method: Endpoints_1.default.BroadcastMessagesDispose.method, data: { banner_ids: banner_ids } }));
79
88
  }
80
89
  }
81
90
  exports.NotificationApiClient = NotificationApiClient;
82
91
  /**
83
92
  *
84
- :::tipNotification service can be used in the following ways:
93
+ :::tipNotification service can be used in the following way:
85
94
 
86
95
  ```jsx
87
96
  1. Import the service from our library:
@@ -103,52 +112,61 @@ exports.NotificationApiClient = NotificationApiClient;
103
112
  return await NotificationService.disposeBroadcastMessages(banner_ids);
104
113
  }
105
114
  ```
115
+ ```jsx
116
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
117
+
118
+ 1. Declare it(or declare them, it is possible to add multiple params)
119
+
120
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
121
+
122
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
123
+ ```
106
124
  :::
107
125
  */
108
126
  class NotificationService {
109
- static listUserNotification() {
127
+ static listUserNotification(config) {
110
128
  return __awaiter(this, void 0, void 0, function* () {
111
- return NotificationApiClient.listUserNotification();
129
+ return NotificationApiClient.listUserNotification(config);
112
130
  });
113
131
  }
114
- static markReadNotification(sids) {
132
+ static markReadNotification(sids, config) {
115
133
  return __awaiter(this, void 0, void 0, function* () {
116
- return NotificationApiClient.markReadNotification(sids);
134
+ return NotificationApiClient.markReadNotification(sids, config);
117
135
  });
118
136
  }
119
- static getUnseenNotification() {
137
+ static getUnseenNotification(config) {
120
138
  return __awaiter(this, void 0, void 0, function* () {
121
- return NotificationApiClient.getUnseenNotification();
139
+ return NotificationApiClient.getUnseenNotification(config);
122
140
  });
123
141
  }
124
- static createCustomNotification(data) {
142
+ static createCustomNotification(data, config) {
125
143
  return __awaiter(this, void 0, void 0, function* () {
126
- return NotificationApiClient.createCustomNotification(data);
144
+ return NotificationApiClient.createCustomNotification(data, config);
127
145
  });
128
146
  }
129
- static listBroadcastMessages() {
147
+ static listBroadcastMessages(config) {
130
148
  return __awaiter(this, void 0, void 0, function* () {
131
- return NotificationApiClient.listBroadcastMessages();
149
+ return NotificationApiClient.listBroadcastMessages(config);
132
150
  });
133
151
  }
134
- static listBroadcastMessagesUnseenCount() {
152
+ static listBroadcastMessagesUnseenCount(config) {
135
153
  return __awaiter(this, void 0, void 0, function* () {
136
- return NotificationApiClient.listBroadcastMessagesUnseenCount();
154
+ return NotificationApiClient.listBroadcastMessagesUnseenCount(config);
137
155
  });
138
156
  }
139
- static listBroadcastMessagesUndisposedCount() {
157
+ static listBroadcastMessagesUndisposedCount(config) {
140
158
  return __awaiter(this, void 0, void 0, function* () {
141
- return NotificationApiClient.listBroadcastMessagesUndisposedCount();
159
+ return NotificationApiClient.listBroadcastMessagesUndisposedCount(config);
142
160
  });
143
161
  }
144
- static disposeBroadcastMessages(banner_ids) {
162
+ static disposeBroadcastMessages(banner_ids, config) {
145
163
  return __awaiter(this, void 0, void 0, function* () {
146
- return NotificationApiClient.disposeBroadcastMessages(banner_ids);
164
+ return NotificationApiClient.disposeBroadcastMessages(banner_ids, config);
147
165
  });
148
166
  }
149
- static markReadBroadcastMessages(banner_ids) {
167
+ static markReadBroadcastMessages(banner_ids, config) {
150
168
  return __awaiter(this, void 0, void 0, function* () {
151
- return NotificationApiClient.markReadBroadcastMessages(banner_ids);
169
+ return NotificationApiClient.markReadBroadcastMessages(banner_ids, config);
152
170
  });
153
171
  }
154
172
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAelD;;GAEG;AAEH,MAAa,qBAAqB;IAChC;;OAEG;IACH,MAAM,CAAC,oBAAoB;QACzB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAc;QACxC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;IACzH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA8B;QAC5D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,qBAAqB;QAC1B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACrG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gCAAgC;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;IACnH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,oCAAoC;QACzC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;IAC3H,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAoB;QACnD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC,CAAC;IACvI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAoB;QAClD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,CAAC,CAAC;IACrI,CAAC;CACF;AAnED,sDAmEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAqB,mBAAmB;IACtC,MAAM,CAAO,oBAAoB;;YAC/B,OAAO,qBAAqB,CAAC,oBAAoB,EAAE,CAAC;QACtD,CAAC;KAAA;IACD,MAAM,CAAO,oBAAoB,CAAC,IAAc;;YAC9C,OAAO,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC1D,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB;;YAChC,OAAO,qBAAqB,CAAC,qBAAqB,EAAE,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,IAA8B;;YAClE,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAC9D,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB;;YAChC,OAAO,qBAAqB,CAAC,qBAAqB,EAAE,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,gCAAgC;;YAC3C,OAAO,qBAAqB,CAAC,gCAAgC,EAAE,CAAC;QAClE,CAAC;KAAA;IACD,MAAM,CAAO,oCAAoC;;YAC/C,OAAO,qBAAqB,CAAC,oCAAoC,EAAE,CAAC;QACtE,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,UAAoB;;YACxD,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QACpE,CAAC;KAAA;IACD,MAAM,CAAO,yBAAyB,CAAC,UAAoB;;YACzD,OAAO,qBAAqB,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;QACrE,CAAC;KAAA;CACF;AA5BD,sCA4BC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/notification/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAgBlD;;GAEG;AAEH,MAAa,qBAAqB;IAChC;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAA2B;QACrD,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,IAAE,CAAC;IAC7H,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,IAAc,EAAE,MAA2B;QACrE,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAC/C,MAAM,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EACjD,IAAI,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,IAClB,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,MAA2B;QACtD,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,2BAA2B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,2BAA2B,CAAC,MAAM,IAAE,CAAC;IAC3I,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA8B,EAAE,MAA2B;QACzF,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACjJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,MAA2B;QACtD,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,qBAAqB,CAAC,MAAM,IAAE,CAAC;IAC/H,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gCAAgC,CAAC,MAA2B;QACjE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,4BAA4B,CAAC,MAAM,IAAE,CAAC;IAC7I,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oCAAoC,CAAC,MAA2B;QACrE,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EACvD,MAAM,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,IACzD,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,yBAAyB,CAAC,UAAoB,EAAE,MAA2B;QAChF,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAChD,MAAM,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAClD,IAAI,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,IAC9B,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,UAAoB,EAAE,MAA2B;QAC/E,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC,EAC/C,MAAM,EAAE,mBAAS,CAAC,wBAAwB,CAAC,MAAM,EACjD,IAAI,EAAE,EAAC,UAAU,EAAE,UAAU,EAAC,IAC9B,CAAC;IACL,CAAC;CACF;AA/FD,sDA+FC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAqB,mBAAmB;IACtC,MAAM,CAAO,oBAAoB,CAAC,MAA2B;;YAC3D,OAAO,qBAAqB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QAC5D,CAAC;KAAA;IACD,MAAM,CAAO,oBAAoB,CAAC,IAAc,EAAE,MAA2B;;YAC3E,OAAO,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,MAA2B;;YAC5D,OAAO,qBAAqB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC7D,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,IAA8B,EAAE,MAA2B;;YAC/F,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtE,CAAC;KAAA;IACD,MAAM,CAAO,qBAAqB,CAAC,MAA2B;;YAC5D,OAAO,qBAAqB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC7D,CAAC;KAAA;IACD,MAAM,CAAO,gCAAgC,CAAC,MAA2B;;YACvE,OAAO,qBAAqB,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC;QACxE,CAAC;KAAA;IACD,MAAM,CAAO,oCAAoC,CAAC,MAA2B;;YAC3E,OAAO,qBAAqB,CAAC,oCAAoC,CAAC,MAAM,CAAC,CAAC;QAC5E,CAAC;KAAA;IACD,MAAM,CAAO,wBAAwB,CAAC,UAAoB,EAAE,MAA2B;;YACrF,OAAO,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;KAAA;IACD,MAAM,CAAO,yBAAyB,CAAC,UAAoB,EAAE,MAA2B;;YACtF,OAAO,qBAAqB,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC7E,CAAC;KAAA;CACF;AA5BD,sCA4BC"}
@@ -1,9 +1,10 @@
1
1
  import { SCPreferenceType } from '@selfcommunity/types/src/types';
2
2
  import { SCPaginatedResponse } from '../../types';
3
+ import { AxiosRequestConfig } from 'axios';
3
4
  export interface PreferenceApiClientInterface {
4
- getAllPreferences(): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
5
- searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
6
- getSpecificPreference(id: number): Promise<SCPreferenceType>;
5
+ getAllPreferences(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
6
+ searchPreferences(search?: string, section?: string, keys?: string, ordering?: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
7
+ getSpecificPreference(id: number, config?: AxiosRequestConfig): Promise<SCPreferenceType>;
7
8
  }
8
9
  /**
9
10
  * Contains all the endpoints needed to manage dynamic preferences.
@@ -11,25 +12,28 @@ export interface PreferenceApiClientInterface {
11
12
  export declare class PreferenceApiClient {
12
13
  /**
13
14
  * This endpoint retrieves all available dynamic preferences.
15
+ * @param config
14
16
  */
15
- static getAllPreferences(): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
17
+ static getAllPreferences(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
16
18
  /**
17
19
  * This endpoint searches dynamic preferences.
18
20
  * @param search
19
21
  * @param section
20
22
  * @param keys
21
23
  * @param ordering
24
+ * @param config
22
25
  */
23
- static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
26
+ static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
24
27
  /**
25
28
  * This endpoint retrieves a specific dynamic preference.
26
29
  * @param id
30
+ * @param config
27
31
  */
28
- static getSpecificPreference(id: number): Promise<SCPreferenceType>;
32
+ static getSpecificPreference(id: number, config?: AxiosRequestConfig): Promise<SCPreferenceType>;
29
33
  }
30
34
  /**
31
35
  *
32
- :::tipPreference service can be used in the following ways:
36
+ :::tipPreference service can be used in the following way:
33
37
 
34
38
  ```jsx
35
39
  1. Import the service from our library:
@@ -51,11 +55,20 @@ export declare class PreferenceApiClient {
51
55
  return await PreferenceService.getSpecificPreference(preferenceId);
52
56
  }
53
57
  ```
58
+ ```jsx
59
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
60
+
61
+ 1. Declare it(or declare them, it is possible to add multiple params)
62
+
63
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
64
+
65
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
66
+ ```
54
67
  :::
55
68
  */
56
69
  export default class PreferenceService {
57
- static getAllPreferences(): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
58
- static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
59
- static getSpecificPreference(id: number): Promise<SCPreferenceType>;
70
+ static getAllPreferences(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
71
+ static searchPreferences(search?: string, section?: string, keys?: string, ordering?: string, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPreferenceType[]>>;
72
+ static getSpecificPreference(id: number, config?: AxiosRequestConfig): Promise<SCPreferenceType>;
60
73
  }
61
74
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAC,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEhD,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACtE,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACzI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC9D;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAI5E;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAU/I;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGpE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,iBAAiB,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAIrE,iBAAiB,CAC5B,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAItC,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAG1E"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAC,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAChD,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACjG,iBAAiB,CACf,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACpD,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC3F;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAIvG;;;;;;;OAOG;IACH,MAAM,CAAC,iBAAiB,CACtB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAUnD;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGjG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,iBAAiB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAIhG,iBAAiB,CAC5B,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,CAAC,CAAC;WAItC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGvG"}