@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
@@ -21,9 +21,10 @@ const Endpoints_1 = __importDefault(require("../../constants/Endpoints"));
21
21
  class PreferenceApiClient {
22
22
  /**
23
23
  * This endpoint retrieves all available dynamic preferences.
24
+ * @param config
24
25
  */
25
- static getAllPreferences() {
26
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.Preferences.url({}), Endpoints_1.default.Preferences.method);
26
+ static getAllPreferences(config) {
27
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.Preferences.url({}), method: Endpoints_1.default.Preferences.method }));
27
28
  }
28
29
  /**
29
30
  * This endpoint searches dynamic preferences.
@@ -31,23 +32,25 @@ class PreferenceApiClient {
31
32
  * @param section
32
33
  * @param keys
33
34
  * @param ordering
35
+ * @param config
34
36
  */
35
- static searchPreferences(search, section, keys, ordering) {
37
+ static searchPreferences(search, section, keys, ordering, config) {
36
38
  const params = new URLSearchParams(Object.assign(Object.assign(Object.assign(Object.assign({}, (search && { search: search })), (section && { section: section })), (keys && { keys: keys })), (ordering && { ordering: ordering })));
37
- return (0, apiRequest_1.apiRequest)(`${Endpoints_1.default.Preferences.url({})}?${params.toString()}`, Endpoints_1.default.Preferences.method);
39
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.Preferences.url({})}?${params.toString()}`, method: Endpoints_1.default.Preferences.method }));
38
40
  }
39
41
  /**
40
42
  * This endpoint retrieves a specific dynamic preference.
41
43
  * @param id
44
+ * @param config
42
45
  */
43
- static getSpecificPreference(id) {
44
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetPreference.url({ id }), Endpoints_1.default.Preferences.method);
46
+ static getSpecificPreference(id, config) {
47
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetPreference.url({ id }), method: Endpoints_1.default.Preferences.method }));
45
48
  }
46
49
  }
47
50
  exports.PreferenceApiClient = PreferenceApiClient;
48
51
  /**
49
52
  *
50
- :::tipPreference service can be used in the following ways:
53
+ :::tipPreference service can be used in the following way:
51
54
 
52
55
  ```jsx
53
56
  1. Import the service from our library:
@@ -69,22 +72,31 @@ exports.PreferenceApiClient = PreferenceApiClient;
69
72
  return await PreferenceService.getSpecificPreference(preferenceId);
70
73
  }
71
74
  ```
75
+ ```jsx
76
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
77
+
78
+ 1. Declare it(or declare them, it is possible to add multiple params)
79
+
80
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
81
+
82
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
83
+ ```
72
84
  :::
73
85
  */
74
86
  class PreferenceService {
75
- static getAllPreferences() {
87
+ static getAllPreferences(config) {
76
88
  return __awaiter(this, void 0, void 0, function* () {
77
- return PreferenceApiClient.getAllPreferences();
89
+ return PreferenceApiClient.getAllPreferences(config);
78
90
  });
79
91
  }
80
- static searchPreferences(search, section, keys, ordering) {
92
+ static searchPreferences(search, section, keys, ordering, config) {
81
93
  return __awaiter(this, void 0, void 0, function* () {
82
- return PreferenceApiClient.searchPreferences(search, section, keys, ordering);
94
+ return PreferenceApiClient.searchPreferences(search, section, keys, ordering, config);
83
95
  });
84
96
  }
85
- static getSpecificPreference(id) {
97
+ static getSpecificPreference(id, config) {
86
98
  return __awaiter(this, void 0, void 0, function* () {
87
- return PreferenceApiClient.getSpecificPreference(id);
99
+ return PreferenceApiClient.getSpecificPreference(id, config);
88
100
  });
89
101
  }
90
102
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AASlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,iBAAiB;QACtB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAe,EAAE,OAAgB,EAAE,IAAa,EAAE,QAAiB;QAC1F,MAAM,MAAM,GAAG,IAAI,eAAe,6DAC7B,CAAC,MAAM,IAAI,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,GAC5B,CAAC,OAAO,IAAI,EAAC,OAAO,EAAE,OAAO,EAAC,CAAC,GAC/B,CAAC,IAAI,IAAI,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,GACtB,CAAC,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,EACrC,CAAC;QACH,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACrF,CAAC;CACF;AAhCD,kDAgCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAqB,iBAAiB;IACpC,MAAM,CAAO,iBAAiB;;YAC5B,OAAO,mBAAmB,CAAC,iBAAiB,EAAE,CAAC;QACjD,CAAC;KAAA;IAED,MAAM,CAAO,iBAAiB,CAC5B,MAAe,EACf,OAAgB,EAChB,IAAa,EACb,QAAiB;;YAEjB,OAAO,mBAAmB,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChF,CAAC;KAAA;IAED,MAAM,CAAO,qBAAqB,CAAC,EAAU;;YAC3C,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;KAAA;CACF;AAjBD,oCAiBC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/preference/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAgBlD;;GAEG;AAEH,MAAa,mBAAmB;IAC9B;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAA2B;QAClD,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,IAAE,CAAC;IAC3G,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,iBAAiB,CACtB,MAAe,EACf,OAAgB,EAChB,IAAa,EACb,QAAiB,EACjB,MAA2B;QAE3B,MAAM,MAAM,GAAG,IAAI,eAAe,6DAC7B,CAAC,MAAM,IAAI,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,GAC5B,CAAC,OAAO,IAAI,EAAC,OAAO,EAAE,OAAO,EAAC,CAAC,GAC/B,CAAC,IAAI,IAAI,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,GACtB,CAAC,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC,CAAC,EACrC,CAAC;QACH,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,IAAE,CAAC;IACrI,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAU,EAAE,MAA2B;QAClE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,IAAE,CAAC;IAC/G,CAAC;CACF;AAzCD,kDAyCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAqB,iBAAiB;IACpC,MAAM,CAAO,iBAAiB,CAAC,MAA2B;;YACxD,OAAO,mBAAmB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC;KAAA;IAED,MAAM,CAAO,iBAAiB,CAC5B,MAAe,EACf,OAAgB,EAChB,IAAa,EACb,QAAiB,EACjB,MAA2B;;YAE3B,OAAO,mBAAmB,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxF,CAAC;KAAA;IAED,MAAM,CAAO,qBAAqB,CAAC,EAAU,EAAE,MAA2B;;YACxE,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;CACF;AAlBD,oCAkBC"}
@@ -1,16 +1,17 @@
1
1
  import { MessageChunkUploadDoneParams, MessageCreateParams, MessageMediaChunksParams, MessageMediaUploadParams, MessageThumbnailUploadParams, SCPaginatedResponse, ThreadParams } from '../../types';
2
2
  import { SCPrivateMessageType, SCPrivateMessageUploadMediaChunkType, SCPrivateMessageUploadMediaType, SCPrivateMessageUploadThumbnailType } from '@selfcommunity/types';
3
+ import { AxiosRequestConfig } from 'axios';
3
4
  export interface PrivateMessageApiClientInterface {
4
- getAllSnippets(): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
5
- getAThread(data: ThreadParams): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
6
- getASingleMessage(id: number): Promise<SCPrivateMessageType>;
7
- sendAMessage(data: MessageCreateParams): Promise<SCPrivateMessageType>;
8
- deleteAMessage(id: number): Promise<any>;
9
- deleteAThread(id: number): Promise<any>;
10
- uploadMedia(data: MessageMediaUploadParams): Promise<SCPrivateMessageUploadMediaType>;
11
- uploadThumbnail(data: MessageThumbnailUploadParams): Promise<SCPrivateMessageUploadThumbnailType>;
12
- uploadMediaInChunks(data: MessageMediaChunksParams): Promise<SCPrivateMessageUploadMediaChunkType>;
13
- chunkUploadDone(data: MessageChunkUploadDoneParams): Promise<SCPrivateMessageUploadMediaType>;
5
+ getAllSnippets(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
6
+ getAThread(data: ThreadParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
7
+ getASingleMessage(id: number, config?: AxiosRequestConfig): Promise<SCPrivateMessageType>;
8
+ sendAMessage(data: MessageCreateParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageType>;
9
+ deleteAMessage(id: number, config?: AxiosRequestConfig): Promise<any>;
10
+ deleteAThread(id: number, config?: AxiosRequestConfig): Promise<any>;
11
+ uploadMedia(data: MessageMediaUploadParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaType>;
12
+ uploadThumbnail(data: MessageThumbnailUploadParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadThumbnailType>;
13
+ uploadMediaInChunks(data: MessageMediaChunksParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaChunkType>;
14
+ chunkUploadDone(data: MessageChunkUploadDoneParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaType>;
14
15
  }
15
16
  /**
16
17
  * Contains all the endpoints needed to manage private messages.
@@ -18,57 +19,67 @@ export interface PrivateMessageApiClientInterface {
18
19
  export declare class PrivateMessageApiClient {
19
20
  /**
20
21
  * This endpoint retrieves all snippets.
22
+ * @param config
21
23
  */
22
- static getAllSnippets(): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
24
+ static getAllSnippets(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
23
25
  /**
24
26
  * This endpoint retrieves all messages in a thread.
25
27
  * @param data
28
+ * @param config
26
29
  */
27
- static getAThread(data: ThreadParams): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
30
+ static getAThread(data: ThreadParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
28
31
  /**
29
32
  * This endpoint retrieves a single message using ID.
30
33
  * @param id
34
+ * @param config
31
35
  */
32
- static getASingleMessage(id: number): Promise<SCPrivateMessageType>;
36
+ static getASingleMessage(id: number, config?: AxiosRequestConfig): Promise<SCPrivateMessageType>;
33
37
  /**
34
38
  * This endpoint sends a message.
35
39
  * @param data
40
+ * @param config
36
41
  */
37
- static sendAMessage(data: MessageCreateParams): Promise<SCPrivateMessageType>;
42
+ static sendAMessage(data: MessageCreateParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageType>;
38
43
  /**
39
44
  * This endpoint deletes a single message.
40
45
  * @param id
46
+ * @param config
41
47
  */
42
- static deleteAMessage(id: number): Promise<any>;
48
+ static deleteAMessage(id: number, config?: AxiosRequestConfig): Promise<any>;
43
49
  /**
44
50
  * This endpoint deletes a thread.
45
51
  * @param id
52
+ * @param config
46
53
  */
47
- static deleteAThread(id: number): Promise<any>;
54
+ static deleteAThread(id: number, config?: AxiosRequestConfig): Promise<any>;
48
55
  /**
49
56
  * This endpoint uploads a media.
50
57
  * @param data
58
+ * @param config
51
59
  */
52
- static uploadMedia(data: MessageMediaUploadParams): Promise<SCPrivateMessageUploadMediaType>;
60
+ static uploadMedia(data: MessageMediaUploadParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaType>;
53
61
  /**
54
62
  * This endpoint uploads a thumbnail.
55
63
  * @param data
64
+ * @param config
56
65
  */
57
- static uploadThumbnail(data: MessageThumbnailUploadParams): Promise<SCPrivateMessageUploadThumbnailType>;
66
+ static uploadThumbnail(data: MessageThumbnailUploadParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadThumbnailType>;
58
67
  /**
59
68
  * This endpoint performs the chunk upload of a file.
60
69
  * @param data
70
+ * @param config
61
71
  */
62
- static uploadMediaInChunks(data: MessageMediaChunksParams): Promise<SCPrivateMessageUploadMediaChunkType>;
72
+ static uploadMediaInChunks(data: MessageMediaChunksParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaChunkType>;
63
73
  /**
64
74
  * This endpoint finalizes the chunk upload and creates the file.
65
75
  * @param data
76
+ * @param config
66
77
  */
67
- static chunkUploadDone(data: MessageChunkUploadDoneParams): Promise<SCPrivateMessageUploadMediaType>;
78
+ static chunkUploadDone(data: MessageChunkUploadDoneParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaType>;
68
79
  }
69
80
  /**
70
81
  *
71
- :::tipPrivate Message service can be used in the following ways:
82
+ :::tipPrivate Message service can be used in the following way:
72
83
 
73
84
  ```jsx
74
85
  1. Import the service from our library:
@@ -90,18 +101,27 @@ export declare class PrivateMessageApiClient {
90
101
  return await PrivateMessageService.getASingleMessage(messageId);
91
102
  }
92
103
  ```
104
+ ```jsx
105
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
106
+
107
+ 1. Declare it(or declare them, it is possible to add multiple params)
108
+
109
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
110
+
111
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
112
+ ```
93
113
  :::
94
114
  */
95
115
  export default class PrivateMessageService {
96
- static getAllSnippets(): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
97
- static getAThread(data: ThreadParams): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
98
- static getASingleMessage(id: number): Promise<SCPrivateMessageType>;
99
- static sendAMessage(data: MessageCreateParams): Promise<SCPrivateMessageType>;
100
- static deleteAMessage(id: number): Promise<any>;
101
- static deleteAThread(id: number): Promise<any>;
102
- static uploadMedia(data: MessageMediaUploadParams): Promise<SCPrivateMessageUploadMediaType>;
103
- static uploadThumbnail(data: MessageThumbnailUploadParams): Promise<SCPrivateMessageUploadThumbnailType>;
104
- static uploadMediaInChunks(data: MessageMediaChunksParams): Promise<SCPrivateMessageUploadMediaChunkType>;
105
- static chunkUploadDone(data: MessageChunkUploadDoneParams): Promise<SCPrivateMessageUploadMediaType>;
116
+ static getAllSnippets(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
117
+ static getAThread(data: ThreadParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrivateMessageType>>;
118
+ static getASingleMessage(id: number, config?: AxiosRequestConfig): Promise<SCPrivateMessageType>;
119
+ static sendAMessage(data: MessageCreateParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageType>;
120
+ static deleteAMessage(id: number, config?: AxiosRequestConfig): Promise<any>;
121
+ static deleteAThread(id: number, config?: AxiosRequestConfig): Promise<any>;
122
+ static uploadMedia(data: MessageMediaUploadParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaType>;
123
+ static uploadThumbnail(data: MessageThumbnailUploadParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadThumbnailType>;
124
+ static uploadMediaInChunks(data: MessageMediaChunksParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaChunkType>;
125
+ static chunkUploadDone(data: MessageChunkUploadDoneParams, config?: AxiosRequestConfig): Promise<SCPrivateMessageUploadMediaType>;
106
126
  }
107
127
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,4BAA4B,EAC5B,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,4BAA4B,EAC5B,mBAAmB,EACnB,YAAY,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,oBAAoB,EACpB,oCAAoC,EACpC,+BAA+B,EAC/B,mCAAmC,EACpC,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,gCAAgC;IAC/C,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACrE,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACnF,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7D,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACvE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACtF,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAClG,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;IACnG,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;CAC/F;AACD;;GAEG;AAEH,qBAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAI3E;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAIzF;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAInE;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/C;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAI5F;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAIxG;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC;IAIzG;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAGrG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAqB;WAC3B,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAGpE,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAGlF,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAG5D,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAGtE,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGxC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAGvC,WAAW,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,+BAA+B,CAAC;WAGrF,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,mCAAmC,CAAC;WAGjG,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,oCAAoC,CAAC;WAGlG,eAAe,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAG3G"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,4BAA4B,EAC5B,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,4BAA4B,EAC5B,mBAAmB,EACnB,YAAY,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,oBAAoB,EACpB,oCAAoC,EACpC,+BAA+B,EAC/B,mCAAmC,EACpC,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,gCAAgC;IAC/C,cAAc,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAChG,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAChH,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC1F,YAAY,CAAC,IAAI,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACpG,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtE,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACrE,WAAW,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACnH,eAAe,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAC/H,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;IAChI,eAAe,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;CAC5H;AACD;;GAEG;AAEH,qBAAa,uBAAuB;IAClC;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAItG;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAItH;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIhG;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI1G;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI3E;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAIzH;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mCAAmC,CAAC;IASrI;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oCAAoC,CAAC;IAStI;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAQlI;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAqB;WAC3B,cAAc,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAG/F,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAG/G,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAGzF,YAAY,CAAC,IAAI,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;WAGnG,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGrE,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGpE,WAAW,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,+BAA+B,CAAC;WAGlH,eAAe,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mCAAmC,CAAC;WAG9H,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oCAAoC,CAAC;WAG/H,eAAe,CAAC,IAAI,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,+BAA+B,CAAC;CAGxI"}
@@ -21,78 +21,88 @@ const Endpoints_1 = __importDefault(require("../../constants/Endpoints"));
21
21
  class PrivateMessageApiClient {
22
22
  /**
23
23
  * This endpoint retrieves all snippets.
24
+ * @param config
24
25
  */
25
- static getAllSnippets() {
26
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetSnippets.url({}), Endpoints_1.default.GetSnippets.method);
26
+ static getAllSnippets(config) {
27
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetSnippets.url({}), method: Endpoints_1.default.GetSnippets.method }));
27
28
  }
28
29
  /**
29
30
  * This endpoint retrieves all messages in a thread.
30
31
  * @param data
32
+ * @param config
31
33
  */
32
- static getAThread(data) {
33
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetAThread.url({}), Endpoints_1.default.GetAThread.method, data);
34
+ static getAThread(data, config) {
35
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetAThread.url({}), method: Endpoints_1.default.GetAThread.method, data: data }));
34
36
  }
35
37
  /**
36
38
  * This endpoint retrieves a single message using ID.
37
39
  * @param id
40
+ * @param config
38
41
  */
39
- static getASingleMessage(id) {
40
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetASingleMessage.url({ id }), Endpoints_1.default.GetASingleMessage.method);
42
+ static getASingleMessage(id, config) {
43
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetASingleMessage.url({ id }), method: Endpoints_1.default.GetASingleMessage.method }));
41
44
  }
42
45
  /**
43
46
  * This endpoint sends a message.
44
47
  * @param data
48
+ * @param config
45
49
  */
46
- static sendAMessage(data) {
47
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.SendMessage.url({}), Endpoints_1.default.SendMessage.method, data);
50
+ static sendAMessage(data, config) {
51
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.SendMessage.url({}), method: Endpoints_1.default.SendMessage.method, data: data }));
48
52
  }
49
53
  /**
50
54
  * This endpoint deletes a single message.
51
55
  * @param id
56
+ * @param config
52
57
  */
53
- static deleteAMessage(id) {
54
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.DeleteASingleMessage.url({ id }), Endpoints_1.default.DeleteASingleMessage.method);
58
+ static deleteAMessage(id, config) {
59
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.DeleteASingleMessage.url({ id }), method: Endpoints_1.default.DeleteASingleMessage.method }));
55
60
  }
56
61
  /**
57
62
  * This endpoint deletes a thread.
58
63
  * @param id
64
+ * @param config
59
65
  */
60
- static deleteAThread(id) {
61
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.DeleteAThread.url({ id }), Endpoints_1.default.DeleteAThread.method);
66
+ static deleteAThread(id, config) {
67
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.DeleteAThread.url({ id }), method: Endpoints_1.default.DeleteAThread.method }));
62
68
  }
63
69
  /**
64
70
  * This endpoint uploads a media.
65
71
  * @param data
72
+ * @param config
66
73
  */
67
- static uploadMedia(data) {
68
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.PrivateMessageUploadMedia.url({}), Endpoints_1.default.PrivateMessageUploadMedia.method, data);
74
+ static uploadMedia(data, config) {
75
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PrivateMessageUploadMedia.url({}), method: Endpoints_1.default.PrivateMessageUploadMedia.method, data: data }));
69
76
  }
70
77
  /**
71
78
  * This endpoint uploads a thumbnail.
72
79
  * @param data
80
+ * @param config
73
81
  */
74
- static uploadThumbnail(data) {
75
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.PrivateMessageUploadThumbnail.url({}), Endpoints_1.default.PrivateMessageUploadThumbnail.method, data);
82
+ static uploadThumbnail(data, config) {
83
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PrivateMessageUploadThumbnail.url({}), method: Endpoints_1.default.PrivateMessageUploadThumbnail.method, data: data }));
76
84
  }
77
85
  /**
78
86
  * This endpoint performs the chunk upload of a file.
79
87
  * @param data
88
+ * @param config
80
89
  */
81
- static uploadMediaInChunks(data) {
82
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.PrivateMessageUploadMediaInChunks.url({}), Endpoints_1.default.PrivateMessageUploadMediaInChunks.method, data);
90
+ static uploadMediaInChunks(data, config) {
91
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PrivateMessageUploadMediaInChunks.url({}), method: Endpoints_1.default.PrivateMessageUploadMediaInChunks.method, data: data }));
83
92
  }
84
93
  /**
85
94
  * This endpoint finalizes the chunk upload and creates the file.
86
95
  * @param data
96
+ * @param config
87
97
  */
88
- static chunkUploadDone(data) {
89
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.PrivateMessageChunkUploadDone.url({}), Endpoints_1.default.PrivateMessageChunkUploadDone.method, data);
98
+ static chunkUploadDone(data, config) {
99
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PrivateMessageChunkUploadDone.url({}), method: Endpoints_1.default.PrivateMessageChunkUploadDone.method, data: data }));
90
100
  }
91
101
  }
92
102
  exports.PrivateMessageApiClient = PrivateMessageApiClient;
93
103
  /**
94
104
  *
95
- :::tipPrivate Message service can be used in the following ways:
105
+ :::tipPrivate Message service can be used in the following way:
96
106
 
97
107
  ```jsx
98
108
  1. Import the service from our library:
@@ -114,57 +124,66 @@ exports.PrivateMessageApiClient = PrivateMessageApiClient;
114
124
  return await PrivateMessageService.getASingleMessage(messageId);
115
125
  }
116
126
  ```
127
+ ```jsx
128
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
129
+
130
+ 1. Declare it(or declare them, it is possible to add multiple params)
131
+
132
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
133
+
134
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
135
+ ```
117
136
  :::
118
137
  */
119
138
  class PrivateMessageService {
120
- static getAllSnippets() {
139
+ static getAllSnippets(config) {
121
140
  return __awaiter(this, void 0, void 0, function* () {
122
- return PrivateMessageApiClient.getAllSnippets();
141
+ return PrivateMessageApiClient.getAllSnippets(config);
123
142
  });
124
143
  }
125
- static getAThread(data) {
144
+ static getAThread(data, config) {
126
145
  return __awaiter(this, void 0, void 0, function* () {
127
- return PrivateMessageApiClient.getAThread(data);
146
+ return PrivateMessageApiClient.getAThread(data, config);
128
147
  });
129
148
  }
130
- static getASingleMessage(id) {
149
+ static getASingleMessage(id, config) {
131
150
  return __awaiter(this, void 0, void 0, function* () {
132
- return PrivateMessageApiClient.getASingleMessage(id);
151
+ return PrivateMessageApiClient.getASingleMessage(id, config);
133
152
  });
134
153
  }
135
- static sendAMessage(data) {
154
+ static sendAMessage(data, config) {
136
155
  return __awaiter(this, void 0, void 0, function* () {
137
- return PrivateMessageApiClient.sendAMessage(data);
156
+ return PrivateMessageApiClient.sendAMessage(data, config);
138
157
  });
139
158
  }
140
- static deleteAMessage(id) {
159
+ static deleteAMessage(id, config) {
141
160
  return __awaiter(this, void 0, void 0, function* () {
142
- return PrivateMessageApiClient.deleteAMessage(id);
161
+ return PrivateMessageApiClient.deleteAMessage(id, config);
143
162
  });
144
163
  }
145
- static deleteAThread(id) {
164
+ static deleteAThread(id, config) {
146
165
  return __awaiter(this, void 0, void 0, function* () {
147
- return PrivateMessageApiClient.deleteAThread(id);
166
+ return PrivateMessageApiClient.deleteAThread(id, config);
148
167
  });
149
168
  }
150
- static uploadMedia(data) {
169
+ static uploadMedia(data, config) {
151
170
  return __awaiter(this, void 0, void 0, function* () {
152
- return PrivateMessageApiClient.uploadMedia(data);
171
+ return PrivateMessageApiClient.uploadMedia(data, config);
153
172
  });
154
173
  }
155
- static uploadThumbnail(data) {
174
+ static uploadThumbnail(data, config) {
156
175
  return __awaiter(this, void 0, void 0, function* () {
157
- return PrivateMessageApiClient.uploadThumbnail(data);
176
+ return PrivateMessageApiClient.uploadThumbnail(data, config);
158
177
  });
159
178
  }
160
- static uploadMediaInChunks(data) {
179
+ static uploadMediaInChunks(data, config) {
161
180
  return __awaiter(this, void 0, void 0, function* () {
162
- return PrivateMessageApiClient.uploadMediaInChunks(data);
181
+ return PrivateMessageApiClient.uploadMediaInChunks(data, config);
163
182
  });
164
183
  }
165
- static chunkUploadDone(data) {
184
+ static chunkUploadDone(data, config) {
166
185
  return __awaiter(this, void 0, void 0, function* () {
167
- return PrivateMessageApiClient.chunkUploadDone(data);
186
+ return PrivateMessageApiClient.chunkUploadDone(data, config);
168
187
  });
169
188
  }
170
189
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AA6BlD;;GAEG;AAEH,MAAa,uBAAuB;IAClC;;OAEG;IACH,MAAM,CAAC,cAAc;QACnB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,IAAkB;QAClC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU;QACjC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,IAAyB;QAC3C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,EAAU;QAC9B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,aAAa,CAAC,EAAU;QAC7B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACvF,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAA8B;QAC/C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3H,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAA8B;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iCAAiC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,iCAAiC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACnI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC;QACvD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC3H,CAAC;CACF;AA/ED,0DA+EC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAqB,qBAAqB;IACxC,MAAM,CAAO,cAAc;;YACzB,OAAO,uBAAuB,CAAC,cAAc,EAAE,CAAC;QAClD,CAAC;KAAA;IACD,MAAM,CAAO,UAAU,CAAC,IAAkB;;YACxC,OAAO,uBAAuB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU;;YACvC,OAAO,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,YAAY,CAAC,IAAyB;;YACjD,OAAO,uBAAuB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC;KAAA;IACD,MAAM,CAAO,cAAc,CAAC,EAAU;;YACpC,OAAO,uBAAuB,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;KAAA;IACD,MAAM,CAAO,aAAa,CAAC,EAAU;;YACnC,OAAO,uBAAuB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,IAA8B;;YACrD,OAAO,uBAAuB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC;;YAC7D,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;IACD,MAAM,CAAO,mBAAmB,CAAC,IAA8B;;YAC7D,OAAO,uBAAuB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC;;YAC7D,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;CACF;AA/BD,wCA+BC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/private_message/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AA8BlD;;GAEG;AAEH,MAAa,uBAAuB;IAClC;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,MAA2B;QAC/C,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,IAAE,CAAC;IAC3G,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,IAAkB,EAAE,MAA2B;QAC/D,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACrH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU,EAAE,MAA2B;QAC9D,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,IAAE,CAAC;IACzH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,IAAyB,EAAE,MAA2B;QACxE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACvH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,EAAU,EAAE,MAA2B;QAC3D,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,IAAE,CAAC;IAC/H,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,EAAU,EAAE,MAA2B;QAC1D,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,aAAa,CAAC,MAAM,IAAE,CAAC;IACjH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAA8B,EAAE,MAA2B;QAC5E,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,yBAAyB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,yBAAyB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACnJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC,EAAE,MAA2B;QACpF,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EACpD,MAAM,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EACtD,IAAI,EAAE,IAAI,IACV,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAA8B,EAAE,MAA2B;QACpF,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,iCAAiC,CAAC,GAAG,CAAC,EAAE,CAAC,EACxD,MAAM,EAAE,mBAAS,CAAC,iCAAiC,CAAC,MAAM,EAC1D,IAAI,EAAE,IAAI,IACV,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,IAAkC,EAAE,MAA2B;QACpF,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC,EACpD,MAAM,EAAE,mBAAS,CAAC,6BAA6B,CAAC,MAAM,EACtD,IAAI,EAAE,IAAI,IACV,CAAC;IACL,CAAC;CACF;AAxGD,0DAwGC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAqB,qBAAqB;IACxC,MAAM,CAAO,cAAc,CAAC,MAA2B;;YACrD,OAAO,uBAAuB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC;KAAA;IACD,MAAM,CAAO,UAAU,CAAC,IAAkB,EAAE,MAA2B;;YACrE,OAAO,uBAAuB,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1D,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU,EAAE,MAA2B;;YACpE,OAAO,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;IACD,MAAM,CAAO,YAAY,CAAC,IAAyB,EAAE,MAA2B;;YAC9E,OAAO,uBAAuB,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5D,CAAC;KAAA;IACD,MAAM,CAAO,cAAc,CAAC,EAAU,EAAE,MAA2B;;YACjE,OAAO,uBAAuB,CAAC,cAAc,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC5D,CAAC;KAAA;IACD,MAAM,CAAO,aAAa,CAAC,EAAU,EAAE,MAA2B;;YAChE,OAAO,uBAAuB,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,IAA8B,EAAE,MAA2B;;YAClF,OAAO,uBAAuB,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC,EAAE,MAA2B;;YAC1F,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;IACD,MAAM,CAAO,mBAAmB,CAAC,IAA8B,EAAE,MAA2B;;YAC1F,OAAO,uBAAuB,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnE,CAAC;KAAA;IACD,MAAM,CAAO,eAAe,CAAC,IAAkC,EAAE,MAA2B;;YAC1F,OAAO,uBAAuB,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;CACF;AA/BD,wCA+BC"}
@@ -1,9 +1,10 @@
1
1
  import { SCUserScoreType } from '@selfcommunity/types/src/types';
2
2
  import { ScoreParams, SCPaginatedResponse, UserScoreParams } from '../../types';
3
+ import { AxiosRequestConfig } from 'axios';
3
4
  export interface ScoreApiClientInterface {
4
- getAllScores(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
5
- searchScore(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
6
- addScore(data: UserScoreParams): Promise<SCUserScoreType>;
5
+ getAllScores(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
6
+ searchScore(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
7
+ addScore(data: UserScoreParams, config?: AxiosRequestConfig): Promise<SCUserScoreType>;
7
8
  }
8
9
  /**
9
10
  * Contains all the endpoints needed to manage user scores.
@@ -12,18 +13,21 @@ export declare class ScoreApiClient {
12
13
  /**
13
14
  * This endpoint retrieves all users scores.
14
15
  * @param params
16
+ * @param config
15
17
  */
16
- static getAllScores(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
18
+ static getAllScores(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
17
19
  /**
18
20
  * This endpoint performs search to user scores.
19
21
  * @param params
22
+ * @param config
20
23
  */
21
- static searchScore(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
24
+ static searchScore(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
22
25
  /**
23
26
  * This endpoint adds/removes score to a user.
24
27
  * @param data
28
+ * @param config
25
29
  */
26
- static addScore(data: UserScoreParams): Promise<SCUserScoreType>;
30
+ static addScore(data: UserScoreParams, config?: AxiosRequestConfig): Promise<SCUserScoreType>;
27
31
  }
28
32
  /**
29
33
  *
@@ -42,11 +46,20 @@ export declare class ScoreApiClient {
42
46
  return await ScoreService.getAllScores();
43
47
  }
44
48
  ```
49
+ ```jsx
50
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
51
+
52
+ 1. Declare it(or declare them, it is possible to add multiple params)
53
+
54
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
55
+
56
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
57
+ ```
45
58
  :::
46
59
  */
47
60
  export default class ScoreService {
48
- static getAllScores(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
49
- static searchScore(params?: ScoreParams): Promise<SCPaginatedResponse<SCUserScoreType>>;
50
- static addScore(data: UserScoreParams): Promise<SCUserScoreType>;
61
+ static getAllScores(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
62
+ static searchScore(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
63
+ static addScore(data: UserScoreParams, config?: AxiosRequestConfig): Promise<SCUserScoreType>;
51
64
  }
52
65
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAC,WAAW,EAAE,mBAAmB,EAAE,eAAe,EAAC,MAAM,aAAa,CAAC;AAE9E,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAClF,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACjF,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC3D;AACD;;GAEG;AAEH,qBAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKxF;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKvF;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAGjE;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGjF,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAGhF,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CAGvE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAC,WAAW,EAAE,mBAAmB,EAAE,eAAe,EAAC,MAAM,aAAa,CAAC;AAC9E,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,uBAAuB;IACtC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAC/G,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9G,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CACxF;AACD;;GAEG;AAEH,qBAAa,cAAc;IACzB;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKrH;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKpH;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;CAG9F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,YAAY,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAG9G,WAAW,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAG7G,QAAQ,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;CAGpG"}
@@ -22,25 +22,28 @@ class ScoreApiClient {
22
22
  /**
23
23
  * This endpoint retrieves all users scores.
24
24
  * @param params
25
+ * @param config
25
26
  */
26
- static getAllScores(params) {
27
+ static getAllScores(params, config) {
27
28
  const p = new URLSearchParams(params);
28
- return (0, apiRequest_1.apiRequest)(`${Endpoints_1.default.ScoresList.url({})}?${p.toString()}`, Endpoints_1.default.ScoresList.method);
29
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.ScoresList.url({})}?${p.toString()}`, method: Endpoints_1.default.ScoresList.method }));
29
30
  }
30
31
  /**
31
32
  * This endpoint performs search to user scores.
32
33
  * @param params
34
+ * @param config
33
35
  */
34
- static searchScore(params) {
36
+ static searchScore(params, config) {
35
37
  const p = new URLSearchParams(params);
36
- return (0, apiRequest_1.apiRequest)(`${Endpoints_1.default.SearchScore.url({})}?${p.toString()}`, Endpoints_1.default.SearchScore.method);
38
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.SearchScore.url({})}?${p.toString()}`, method: Endpoints_1.default.SearchScore.method }));
37
39
  }
38
40
  /**
39
41
  * This endpoint adds/removes score to a user.
40
42
  * @param data
43
+ * @param config
41
44
  */
42
- static addScore(data) {
43
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.AddScore.url({}), Endpoints_1.default.AddScore.method, data);
45
+ static addScore(data, config) {
46
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.AddScore.url({}), method: Endpoints_1.default.AddScore.method, data: data }));
44
47
  }
45
48
  }
46
49
  exports.ScoreApiClient = ScoreApiClient;
@@ -61,22 +64,31 @@ exports.ScoreApiClient = ScoreApiClient;
61
64
  return await ScoreService.getAllScores();
62
65
  }
63
66
  ```
67
+ ```jsx
68
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
69
+
70
+ 1. Declare it(or declare them, it is possible to add multiple params)
71
+
72
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
73
+
74
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
75
+ ```
64
76
  :::
65
77
  */
66
78
  class ScoreService {
67
- static getAllScores(params) {
79
+ static getAllScores(params, config) {
68
80
  return __awaiter(this, void 0, void 0, function* () {
69
- return ScoreApiClient.getAllScores(params);
81
+ return ScoreApiClient.getAllScores(params, config);
70
82
  });
71
83
  }
72
- static searchScore(params) {
84
+ static searchScore(params, config) {
73
85
  return __awaiter(this, void 0, void 0, function* () {
74
- return ScoreApiClient.searchScore(params);
86
+ return ScoreApiClient.searchScore(params, config);
75
87
  });
76
88
  }
77
- static addScore(data) {
89
+ static addScore(data, config) {
78
90
  return __awaiter(this, void 0, void 0, function* () {
79
- return ScoreApiClient.addScore(data);
91
+ return ScoreApiClient.addScore(data, config);
80
92
  });
81
93
  }
82
94
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AASlD;;GAEG;AAEH,MAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,YAAY,CAAC,MAAoB;QACtC,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACpG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,MAAoB;QACrC,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,EAAC,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACtG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAqB;QACnC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;CACF;AA1BD,wCA0BC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAqB,YAAY;IAC/B,MAAM,CAAO,YAAY,CAAC,MAAoB;;YAC5C,OAAO,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,MAAoB;;YAC3C,OAAO,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;KAAA;IACD,MAAM,CAAO,QAAQ,CAAC,IAAqB;;YACzC,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;KAAA;CACF;AAVD,+BAUC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/score/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAUlD;;GAEG;AAEH,MAAa,cAAc;IACzB;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,MAAoB,EAAE,MAA2B;QACnE,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,GAAG,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,IAAE,CAAC;IAC9H,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,MAAoB,EAAE,MAA2B;QAClE,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,GAAG,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,IAAE,CAAC;IAChI,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAqB,EAAE,MAA2B;QAChE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACjH,CAAC;CACF;AA7BD,wCA6BC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAqB,YAAY;IAC/B,MAAM,CAAO,YAAY,CAAC,MAAoB,EAAE,MAA2B;;YACzE,OAAO,cAAc,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;KAAA;IACD,MAAM,CAAO,WAAW,CAAC,MAAoB,EAAE,MAA2B;;YACxE,OAAO,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpD,CAAC;KAAA;IACD,MAAM,CAAO,QAAQ,CAAC,IAAqB,EAAE,MAA2B;;YACtE,OAAO,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;KAAA;CACF;AAVD,+BAUC"}