@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,74 +21,83 @@ const Endpoints_1 = __importDefault(require("../../constants/Endpoints"));
21
21
  class LoyaltyApiClient {
22
22
  /**
23
23
  * This endpoint retrieves all prizes.
24
+ * @param config
24
25
  */
25
- static getPrizes() {
26
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetPrizes.url({}), Endpoints_1.default.GetPrizes.method);
26
+ static getPrizes(config) {
27
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetPrizes.url({}), method: Endpoints_1.default.GetPrizes.method }));
27
28
  }
28
29
  /**
29
30
  * This endpoint creates a prize.
30
31
  * @param data
32
+ * @param config
31
33
  */
32
- static createPrize(data) {
33
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.CreatePrize.url({}), Endpoints_1.default.CreatePrize.method, data);
34
+ static createPrize(data, config) {
35
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreatePrize.url({}), method: Endpoints_1.default.CreatePrize.method, data: data }));
34
36
  }
35
37
  /**
36
38
  * This endpoint retrieves a specific prize
37
39
  * @param id
40
+ * @param config
38
41
  */
39
- static getSpecificPrize(id) {
40
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetSpecificPrize.url({ id }), Endpoints_1.default.GetSpecificPrize.method);
42
+ static getSpecificPrize(id, config) {
43
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetSpecificPrize.url({ id }), method: Endpoints_1.default.GetSpecificPrize.method }));
41
44
  }
42
45
  /**
43
46
  * This endpoint updates a specific prize.
44
47
  * @param id
45
48
  * @param data
49
+ * @param config
46
50
  */
47
- static updatePrize(id, data) {
48
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.UpdatePrize.url({ id }), Endpoints_1.default.UpdatePrize.method, data);
51
+ static updatePrize(id, data, config) {
52
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UpdatePrize.url({ id }), method: Endpoints_1.default.UpdatePrize.method, data: data }));
49
53
  }
50
54
  /**
51
55
  * This endpoint patches a specific prize.
52
56
  * @param id
53
57
  * @param data
58
+ * @param config
54
59
  */
55
- static patchPrize(id, data) {
56
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.PatchPrize.url({ id }), Endpoints_1.default.PatchPrize.method, data);
60
+ static patchPrize(id, data, config) {
61
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PatchPrize.url({ id }), method: Endpoints_1.default.PatchPrize.method, data: data }));
57
62
  }
58
63
  /**
59
64
  * This endpoint retrieves all requests of loyalty prizes.
65
+ * @param config
60
66
  */
61
- static getAllPrizeRequests() {
62
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetPrizeRequests.url({}), Endpoints_1.default.GetPrizeRequests.method);
67
+ static getAllPrizeRequests(config) {
68
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetPrizeRequests.url({}), method: Endpoints_1.default.GetPrizeRequests.method }));
63
69
  }
64
70
  /**
65
71
  * This endpoint creates a request for a loyalty prize
66
72
  * @param prize
73
+ * @param config
67
74
  */
68
- static createPrizeRequest(prize) {
69
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.CreatePrizeRequest.url({}), Endpoints_1.default.CreatePrizeRequest.method, { prize: prize });
75
+ static createPrizeRequest(prize, config) {
76
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreatePrizeRequest.url({}), method: Endpoints_1.default.CreatePrizeRequest.method, data: { prize: prize } }));
70
77
  }
71
78
  /**
72
79
  * This endpoint retrieves a specific request for a loyalty prize.
73
80
  * @param id
81
+ * @param config
74
82
  */
75
- static getSpecificPrizeRequest(id) {
76
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetSpecificPrizeRequest.url({ id }), Endpoints_1.default.GetSpecificPrizeRequest.method);
83
+ static getSpecificPrizeRequest(id, config) {
84
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetSpecificPrizeRequest.url({ id }), method: Endpoints_1.default.GetSpecificPrizeRequest.method }));
77
85
  }
78
86
  /**
79
87
  * This endpoint patches a specific request for a loyalty prize.
80
- * You can use this endpoint to to change status in an admin list/table interface.
88
+ * You can use this endpoint to change status in an admin list/table interface.
81
89
  * @param id
82
90
  * @param status
91
+ * @param config
83
92
  */
84
- static patchPrizeRequest(id, status) {
85
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.PatchPrizeRequest.url({ id }), Endpoints_1.default.PatchPrizeRequest.method, { status: status });
93
+ static patchPrizeRequest(id, status, config) {
94
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PatchPrizeRequest.url({ id }), method: Endpoints_1.default.PatchPrizeRequest.method, data: { status: status } }));
86
95
  }
87
96
  }
88
97
  exports.LoyaltyApiClient = LoyaltyApiClient;
89
98
  /**
90
99
  *
91
- :::tipLoyalty service can be used in the following ways:
100
+ :::tipLoyalty service can be used in the following way:
92
101
 
93
102
  ```jsx
94
103
  1. Import the service from our library:
@@ -110,52 +119,61 @@ exports.LoyaltyApiClient = LoyaltyApiClient;
110
119
  return await LoyaltyService.getSpecificPrize(prizeId);
111
120
  }
112
121
  ```
122
+ ```jsx
123
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
124
+
125
+ 1. Declare it(or declare them, it is possible to add multiple params)
126
+
127
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
128
+
129
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
130
+ ```
113
131
  :::
114
132
  */
115
133
  class LoyaltyService {
116
- static getPrizes() {
134
+ static getPrizes(config) {
117
135
  return __awaiter(this, void 0, void 0, function* () {
118
- return LoyaltyApiClient.getPrizes();
136
+ return LoyaltyApiClient.getPrizes(config);
119
137
  });
120
138
  }
121
- static createPrize(data) {
139
+ static createPrize(data, config) {
122
140
  return __awaiter(this, void 0, void 0, function* () {
123
- return LoyaltyApiClient.createPrize(data);
141
+ return LoyaltyApiClient.createPrize(data, config);
124
142
  });
125
143
  }
126
- static getSpecificPrize(id) {
144
+ static getSpecificPrize(id, config) {
127
145
  return __awaiter(this, void 0, void 0, function* () {
128
- return LoyaltyApiClient.getSpecificPrize(id);
146
+ return LoyaltyApiClient.getSpecificPrize(id, config);
129
147
  });
130
148
  }
131
- static updatePrize(id, data) {
149
+ static updatePrize(id, data, config) {
132
150
  return __awaiter(this, void 0, void 0, function* () {
133
- return LoyaltyApiClient.updatePrize(id, data);
151
+ return LoyaltyApiClient.updatePrize(id, data, config);
134
152
  });
135
153
  }
136
- static patchPrize(id, data) {
154
+ static patchPrize(id, data, config) {
137
155
  return __awaiter(this, void 0, void 0, function* () {
138
- return LoyaltyApiClient.patchPrize(id, data);
156
+ return LoyaltyApiClient.patchPrize(id, data, config);
139
157
  });
140
158
  }
141
- static getAllPrizeRequests() {
159
+ static getAllPrizeRequests(config) {
142
160
  return __awaiter(this, void 0, void 0, function* () {
143
- return LoyaltyApiClient.getAllPrizeRequests();
161
+ return LoyaltyApiClient.getAllPrizeRequests(config);
144
162
  });
145
163
  }
146
- static createPrizeRequest(prize) {
164
+ static createPrizeRequest(prize, config) {
147
165
  return __awaiter(this, void 0, void 0, function* () {
148
- return LoyaltyApiClient.createPrizeRequest(prize);
166
+ return LoyaltyApiClient.createPrizeRequest(prize, config);
149
167
  });
150
168
  }
151
- static getSpecificPrizeRequest(id) {
169
+ static getSpecificPrizeRequest(id, config) {
152
170
  return __awaiter(this, void 0, void 0, function* () {
153
- return LoyaltyApiClient.getSpecificPrizeRequest(id);
171
+ return LoyaltyApiClient.getSpecificPrizeRequest(id, config);
154
172
  });
155
173
  }
156
- static patchPrizeRequest(id, status) {
174
+ static patchPrizeRequest(id, status, config) {
157
175
  return __awaiter(this, void 0, void 0, function* () {
158
- return LoyaltyApiClient.patchPrizeRequest(id, status);
176
+ return LoyaltyApiClient.patchPrizeRequest(id, status, config);
159
177
  });
160
178
  }
161
179
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAelD;;GAEG;AAEH,MAAa,gBAAgB;IAC3B;;OAEG;IACH,MAAM,CAAC,SAAS;QACd,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAwB;QACzC,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,gBAAgB,CAAC,EAAU;QAChC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC7F,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,IAAwB;QACrD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACzF,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,IAAyB;QACrD,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,mBAAmB;QACxB,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,KAAa;QACrC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAU;QACvC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU,EAAE,MAA8B;QACjE,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IACjH,CAAC;CACF;AA1ED,4CA0EC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAqB,cAAc;IACjC,MAAM,CAAO,SAAS;;YACpB,OAAO,gBAAgB,CAAC,SAAS,EAAE,CAAC;QACtC,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAwB;;YAC/C,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU;;YACtC,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,IAAwB;;YAC3D,OAAO,gBAAgB,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,IAAyB;;YAC3D,OAAO,gBAAgB,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,mBAAmB;;YAC9B,OAAO,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QAChD,CAAC;KAAA;IAED,MAAM,CAAO,kBAAkB,CAAC,KAAa;;YAC3C,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpD,CAAC;KAAA;IAED,MAAM,CAAO,uBAAuB,CAAC,EAAU;;YAC7C,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QACtD,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU,EAAE,MAA8B;;YACvE,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;KAAA;CACF;AAnCD,iCAmCC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAgBlD;;GAEG;AAEH,MAAa,gBAAgB;IAC3B;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,MAA2B;QAC1C,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,SAAS,CAAC,MAAM,IAAE,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAwB,EAAE,MAA2B;QACtE,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,gBAAgB,CAAC,EAAU,EAAE,MAA2B;QAC7D,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,IAAE,CAAC;IACvH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,IAAwB,EAAE,MAA2B;QAClF,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACzH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,IAAyB,EAAE,MAA2B;QAClF,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACvH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAA2B;QACpD,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,gBAAgB,CAAC,MAAM,IAAE,CAAC;IACrH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,KAAa,EAAE,MAA2B;QAClE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,IAAE,CAAC;IAC/I,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAU,EAAE,MAA2B;QACpE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,uBAAuB,CAAC,MAAM,IAAE,CAAC;IACrI,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAU,EAAE,MAA8B,EAAE,MAA2B;QAC9F,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,EAAE,IAAI,EAAE,EAAC,MAAM,EAAE,MAAM,EAAC,IAAE,CAAC;IACjJ,CAAC;CACF;AAnFD,4CAmFC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAqB,cAAc;IACjC,MAAM,CAAO,SAAS,CAAC,MAA2B;;YAChD,OAAO,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAwB,EAAE,MAA2B;;YAC5E,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACpD,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU,EAAE,MAA2B;;YACnE,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,IAAwB,EAAE,MAA2B;;YACxF,OAAO,gBAAgB,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,IAAyB,EAAE,MAA2B;;YACxF,OAAO,gBAAgB,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC;KAAA;IAED,MAAM,CAAO,mBAAmB,CAAC,MAA2B;;YAC1D,OAAO,gBAAgB,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;KAAA;IAED,MAAM,CAAO,kBAAkB,CAAC,KAAa,EAAE,MAA2B;;YACxE,OAAO,gBAAgB,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5D,CAAC;KAAA;IAED,MAAM,CAAO,uBAAuB,CAAC,EAAU,EAAE,MAA2B;;YAC1E,OAAO,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC9D,CAAC;KAAA;IACD,MAAM,CAAO,iBAAiB,CAAC,EAAU,EAAE,MAA8B,EAAE,MAA2B;;YACpG,OAAO,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAChE,CAAC;KAAA;CACF;AAnCD,iCAmCC"}
@@ -1,13 +1,14 @@
1
1
  import { SCChunkMediaType, SCMediaType } from '@selfcommunity/types';
2
2
  import { ChunkUploadCompleteParams, ChunkUploadParams, MediaCreateParams } from '../../types';
3
+ import { AxiosRequestConfig } from 'axios';
3
4
  export interface MediaApiClientInterface {
4
- chunkUploadMedia(data: ChunkUploadParams): Promise<SCChunkMediaType>;
5
- chunkUploadMediaComplete(data: ChunkUploadCompleteParams): Promise<SCMediaType>;
6
- createMedia(data: MediaCreateParams): Promise<SCMediaType>;
7
- clickMedia(id: number, ip?: string): Promise<any>;
8
- getSpecificMedia(id: number): Promise<SCMediaType>;
9
- updateMedia(id: number, image: string): Promise<SCMediaType>;
10
- deleteMedia(id: number): Promise<any>;
5
+ chunkUploadMedia(data: ChunkUploadParams, bytesStart: number, bytesEnd: number, bytesTotal: number, config?: AxiosRequestConfig): Promise<SCChunkMediaType>;
6
+ chunkUploadMediaComplete(data: ChunkUploadCompleteParams, config?: AxiosRequestConfig): Promise<SCMediaType>;
7
+ createMedia(data: MediaCreateParams, config?: AxiosRequestConfig): Promise<SCMediaType>;
8
+ clickMedia(id: number, ip?: string, config?: AxiosRequestConfig): Promise<any>;
9
+ getSpecificMedia(id: number, config?: AxiosRequestConfig): Promise<SCMediaType>;
10
+ updateMedia(id: number, image: string, config?: AxiosRequestConfig): Promise<SCMediaType>;
11
+ deleteMedia(id: number, config?: AxiosRequestConfig): Promise<any>;
11
12
  }
12
13
  /**
13
14
  * Contains all the endpoints needed to manage medias.
@@ -16,42 +17,52 @@ export declare class MediaApiClient {
16
17
  /**
17
18
  * This endpoint performs the chunk upload of a media with type image or document.
18
19
  * The client must split the file into chunks and send to the server in series. After all the chunks have been uploaded the client must call the Chunk Upload Complete endpoint with the given upload_id parameter to finalize the upload and retrieve the Media.
19
- * To perform chunk upload the request must contain Content-Range header with the information about the chunk.
20
+ * To perform chunk upload the request must contain Content-Range header with the information about the chunk(range of the chunk upload in the format bytes start-end/total)
20
21
  * @param data
22
+ * @param bytesStart
23
+ * @param bytesEnd
24
+ * @param bytesTotal
25
+ * @param config
21
26
  */
22
- static chunkUploadMedia(data: ChunkUploadParams): Promise<SCChunkMediaType>;
27
+ static chunkUploadMedia(data: ChunkUploadParams, bytesStart: number, bytesEnd: number, bytesTotal: number, config?: AxiosRequestConfig): Promise<SCChunkMediaType>;
23
28
  /**
24
29
  * This endpoint completes the chunk upload and create the media.
25
30
  * @param data
31
+ * @param config
26
32
  */
27
- static chunkUploadMediaComplete(data: ChunkUploadCompleteParams): Promise<SCMediaType>;
33
+ static chunkUploadMediaComplete(data: ChunkUploadCompleteParams, config?: AxiosRequestConfig): Promise<SCMediaType>;
28
34
  /**
29
35
  * This endpoint creates a media.
30
36
  * @param data
37
+ * @param config
31
38
  */
32
- static createMedia(data: MediaCreateParams): Promise<SCMediaType>;
39
+ static createMedia(data: MediaCreateParams, config?: AxiosRequestConfig): Promise<SCMediaType>;
33
40
  /**
34
41
  * This endpoint saves a click on a specific media using ID.
35
42
  * @param id
36
43
  * @param ip
44
+ * @param config
37
45
  */
38
- static clickMedia(id: number, ip?: string): Promise<any>;
46
+ static clickMedia(id: number, ip?: string, config?: AxiosRequestConfig): Promise<any>;
39
47
  /**
40
48
  * This endpoint retrieves a specific media using ID.
41
49
  * @param id
50
+ * @param config
42
51
  */
43
- static getSpecificMedia(id: number): Promise<SCMediaType>;
52
+ static getSpecificMedia(id: number, config?: AxiosRequestConfig): Promise<SCMediaType>;
44
53
  /**
45
54
  * This endpoint updates a media.
46
55
  * @param id
47
56
  * @param image
57
+ * @param config
48
58
  */
49
- static updateMedia(id: number, image: string): Promise<SCMediaType>;
59
+ static updateMedia(id: number, image: string, config?: AxiosRequestConfig): Promise<SCMediaType>;
50
60
  /**
51
61
  * This endpoint deletes a media.
52
62
  * @param id
63
+ * @param config
53
64
  */
54
- static deleteMedia(id: number): Promise<any>;
65
+ static deleteMedia(id: number, config?: AxiosRequestConfig): Promise<any>;
55
66
  }
56
67
  /**
57
68
  *
@@ -71,15 +82,24 @@ export declare class MediaApiClient {
71
82
  return await MediaService.createMedia(body);
72
83
  }
73
84
  ```
85
+ ```jsx
86
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
87
+
88
+ 1. Declare it(or declare them, it is possible to add multiple params)
89
+
90
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
91
+
92
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
93
+ ```
74
94
  :::
75
95
  */
76
96
  export default class MediaService {
77
- static chunkUploadMedia(data: ChunkUploadParams): Promise<SCChunkMediaType>;
78
- static chunkUploadMediaComplete(data: ChunkUploadCompleteParams): Promise<SCMediaType>;
79
- static createMedia(data: MediaCreateParams): Promise<SCMediaType>;
80
- static clickMedia(id: number, ip?: string): Promise<any>;
81
- static getSpecificMedia(id: number): Promise<SCMediaType>;
82
- static updateMedia(id: number, image: string): Promise<SCMediaType>;
83
- static deleteMedia(id: number): Promise<any>;
97
+ static chunkUploadMedia(data: ChunkUploadParams, bytesStart: number, bytesEnd: number, bytesTotal: number, config?: AxiosRequestConfig): Promise<SCChunkMediaType>;
98
+ static chunkUploadMediaComplete(data: ChunkUploadCompleteParams, config?: AxiosRequestConfig): Promise<SCMediaType>;
99
+ static createMedia(data: MediaCreateParams, config?: AxiosRequestConfig): Promise<SCMediaType>;
100
+ static clickMedia(id: number, ip?: string, config?: AxiosRequestConfig): Promise<any>;
101
+ static getSpecificMedia(id: number, config?: AxiosRequestConfig): Promise<SCMediaType>;
102
+ static updateMedia(id: number, image: string, config?: AxiosRequestConfig): Promise<SCMediaType>;
103
+ static deleteMedia(id: number, config?: AxiosRequestConfig): Promise<any>;
84
104
  }
85
105
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAE,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,yBAAyB,EAAE,iBAAiB,EAAE,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAE5F,MAAM,WAAW,uBAAuB;IACtC,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrE,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChF,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACnD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACvC;AACD;;GAEG;AACH,qBAAa,cAAc;IACzB;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3E;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC;IAItF;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIjE;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzD;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAInE;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG7C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,gBAAgB,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;WAIpE,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI/E,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI1D,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;WAIjD,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAIlD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;WAI5D,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGnD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,gBAAgB,EAAE,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAC,yBAAyB,EAAE,iBAAiB,EAAE,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAC5F,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,uBAAuB;IACtC,gBAAgB,CACd,IAAI,EAAE,iBAAiB,EACvB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7G,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACxF,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/E,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChF,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC1F,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACpE;AACD;;GAEG;AACH,qBAAa,cAAc;IACzB;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CACrB,IAAI,EAAE,iBAAiB,EACvB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,gBAAgB,CAAC;IAU5B;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IASnH;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9F;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrF;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAItF;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIhG;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;CAG1E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,gBAAgB,CAC3B,IAAI,EAAE,iBAAiB,EACvB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,gBAAgB,CAAC;WAIf,wBAAwB,CAAC,IAAI,EAAE,yBAAyB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI5G,WAAW,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIvF,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAI9E,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI/E,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIzF,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;CAGhF"}
@@ -22,56 +22,66 @@ class MediaApiClient {
22
22
  /**
23
23
  * This endpoint performs the chunk upload of a media with type image or document.
24
24
  * The client must split the file into chunks and send to the server in series. After all the chunks have been uploaded the client must call the Chunk Upload Complete endpoint with the given upload_id parameter to finalize the upload and retrieve the Media.
25
- * To perform chunk upload the request must contain Content-Range header with the information about the chunk.
25
+ * To perform chunk upload the request must contain Content-Range header with the information about the chunk(range of the chunk upload in the format bytes start-end/total)
26
26
  * @param data
27
+ * @param bytesStart
28
+ * @param bytesEnd
29
+ * @param bytesTotal
30
+ * @param config
27
31
  */
28
- static chunkUploadMedia(data) {
29
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.ComposerChunkUploadMedia.url({}), Endpoints_1.default.ComposerChunkUploadMedia.method, data);
32
+ static chunkUploadMedia(data, bytesStart, bytesEnd, bytesTotal, config) {
33
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.ComposerChunkUploadMedia.url({}), method: Endpoints_1.default.ComposerChunkUploadMedia.method, data: data, headers: { 'Content-Range': `bytes ${bytesStart}-${bytesEnd}/${bytesTotal}` } }));
30
34
  }
31
35
  /**
32
36
  * This endpoint completes the chunk upload and create the media.
33
37
  * @param data
38
+ * @param config
34
39
  */
35
- static chunkUploadMediaComplete(data) {
36
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.ComposerChunkUploadMediaComplete.url({}), Endpoints_1.default.ComposerChunkUploadMediaComplete.method, data);
40
+ static chunkUploadMediaComplete(data, config) {
41
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.ComposerChunkUploadMediaComplete.url({}), method: Endpoints_1.default.ComposerChunkUploadMediaComplete.method, data: data }));
37
42
  }
38
43
  /**
39
44
  * This endpoint creates a media.
40
45
  * @param data
46
+ * @param config
41
47
  */
42
- static createMedia(data) {
43
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.ComposerMediaCreate.url({}), Endpoints_1.default.ComposerMediaCreate.method, data);
48
+ static createMedia(data, config) {
49
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.ComposerMediaCreate.url({}), method: Endpoints_1.default.ComposerMediaCreate.method, data: data }));
44
50
  }
45
51
  /**
46
52
  * This endpoint saves a click on a specific media using ID.
47
53
  * @param id
48
54
  * @param ip
55
+ * @param config
49
56
  */
50
- static clickMedia(id, ip) {
57
+ static clickMedia(id, ip, config) {
51
58
  var _a;
52
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.MediaClickTracker.url({ id }), Endpoints_1.default.MediaClickTracker.method, (_a = { ip: ip }) !== null && _a !== void 0 ? _a : null);
59
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.MediaClickTracker.url({ id }), method: Endpoints_1.default.MediaClickTracker.method, data: (_a = { ip: ip }) !== null && _a !== void 0 ? _a : null }));
53
60
  }
54
61
  /**
55
62
  * This endpoint retrieves a specific media using ID.
56
63
  * @param id
64
+ * @param config
57
65
  */
58
- static getSpecificMedia(id) {
59
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.GetMedia.url({ id }), Endpoints_1.default.GetMedia.method);
66
+ static getSpecificMedia(id, config) {
67
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetMedia.url({ id }), method: Endpoints_1.default.GetMedia.method }));
60
68
  }
61
69
  /**
62
70
  * This endpoint updates a media.
63
71
  * @param id
64
72
  * @param image
73
+ * @param config
65
74
  */
66
- static updateMedia(id, image) {
67
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.UpdateMedia.url({ id }), Endpoints_1.default.UpdateMedia.method, { image: image });
75
+ static updateMedia(id, image, config) {
76
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UpdateMedia.url({ id }), method: Endpoints_1.default.UpdateMedia.method, data: { image: image } }));
68
77
  }
69
78
  /**
70
79
  * This endpoint deletes a media.
71
80
  * @param id
81
+ * @param config
72
82
  */
73
- static deleteMedia(id) {
74
- return (0, apiRequest_1.apiRequest)(Endpoints_1.default.DeleteMedia.url({ id }), Endpoints_1.default.DeleteMedia.method);
83
+ static deleteMedia(id, config) {
84
+ return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.DeleteMedia.url({ id }), method: Endpoints_1.default.DeleteMedia.method }));
75
85
  }
76
86
  }
77
87
  exports.MediaApiClient = MediaApiClient;
@@ -93,42 +103,51 @@ exports.MediaApiClient = MediaApiClient;
93
103
  return await MediaService.createMedia(body);
94
104
  }
95
105
  ```
106
+ ```jsx
107
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
108
+
109
+ 1. Declare it(or declare them, it is possible to add multiple params)
110
+
111
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
112
+
113
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
114
+ ```
96
115
  :::
97
116
  */
98
117
  class MediaService {
99
- static chunkUploadMedia(data) {
118
+ static chunkUploadMedia(data, bytesStart, bytesEnd, bytesTotal, config) {
100
119
  return __awaiter(this, void 0, void 0, function* () {
101
- return MediaApiClient.chunkUploadMedia(data);
120
+ return MediaApiClient.chunkUploadMedia(data, bytesStart, bytesEnd, bytesTotal, config);
102
121
  });
103
122
  }
104
- static chunkUploadMediaComplete(data) {
123
+ static chunkUploadMediaComplete(data, config) {
105
124
  return __awaiter(this, void 0, void 0, function* () {
106
- return MediaApiClient.chunkUploadMediaComplete(data);
125
+ return MediaApiClient.chunkUploadMediaComplete(data, config);
107
126
  });
108
127
  }
109
- static createMedia(data) {
128
+ static createMedia(data, config) {
110
129
  return __awaiter(this, void 0, void 0, function* () {
111
- return MediaApiClient.createMedia(data);
130
+ return MediaApiClient.createMedia(data, config);
112
131
  });
113
132
  }
114
- static clickMedia(id, ip) {
133
+ static clickMedia(id, ip, config) {
115
134
  return __awaiter(this, void 0, void 0, function* () {
116
- return MediaApiClient.clickMedia(id, ip);
135
+ return MediaApiClient.clickMedia(id, ip, config);
117
136
  });
118
137
  }
119
- static getSpecificMedia(id) {
138
+ static getSpecificMedia(id, config) {
120
139
  return __awaiter(this, void 0, void 0, function* () {
121
- return MediaApiClient.getSpecificMedia(id);
140
+ return MediaApiClient.getSpecificMedia(id, config);
122
141
  });
123
142
  }
124
- static updateMedia(id, image) {
143
+ static updateMedia(id, image, config) {
125
144
  return __awaiter(this, void 0, void 0, function* () {
126
- return MediaApiClient.updateMedia(id, image);
145
+ return MediaApiClient.updateMedia(id, image, config);
127
146
  });
128
147
  }
129
- static deleteMedia(id) {
148
+ static deleteMedia(id, config) {
130
149
  return __awaiter(this, void 0, void 0, function* () {
131
- return MediaApiClient.deleteMedia(id);
150
+ return MediaApiClient.deleteMedia(id, config);
132
151
  });
133
152
  }
134
153
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAalD;;GAEG;AACH,MAAa,cAAc;IACzB;;;;;OAKG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAuB;QAC7C,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;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA+B;QAC7D,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACjI,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,IAAuB;QACxC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,mBAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,EAAW;;QACvC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAA,EAAC,EAAE,EAAE,EAAE,EAAC,mCAAI,IAAI,CAAC,CAAC;IACjH,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAU;QAChC,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,KAAa;QAC1C,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU;QAC3B,OAAO,IAAA,uBAAU,EAAC,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACnF,CAAC;CACF;AA5DD,wCA4DC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAqB,YAAY;IAC/B,MAAM,CAAO,gBAAgB,CAAC,IAAuB;;YACnD,OAAO,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,wBAAwB,CAAC,IAA+B;;YACnE,OAAO,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAuB;;YAC9C,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,EAAW;;YAC7C,OAAO,cAAc,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3C,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU;;YACtC,OAAO,cAAc,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,KAAa;;YAChD,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU;;YACjC,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC;KAAA;CACF;AA5BD,+BA4BC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/media/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAkD;AAClD,0EAAkD;AAoBlD;;GAEG;AACH,MAAa,cAAc;IACzB;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CACrB,IAAuB,EACvB,UAAkB,EAClB,QAAgB,EAChB,UAAkB,EAClB,MAA2B;QAE3B,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,IAAI,EACV,OAAO,EAAE,EAAC,eAAe,EAAE,SAAS,UAAU,IAAI,QAAQ,IAAI,UAAU,EAAE,EAAC,IAC3E,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAA+B,EAAE,MAA2B;QAC1F,OAAO,IAAA,uBAAU,kCACZ,MAAM,KACT,GAAG,EAAE,mBAAS,CAAC,gCAAgC,CAAC,GAAG,CAAC,EAAE,CAAC,EACvD,MAAM,EAAE,mBAAS,CAAC,gCAAgC,CAAC,MAAM,EACzD,IAAI,EAAE,IAAI,IACV,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAuB,EAAE,MAA2B;QACrE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAE,CAAC;IACvI,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,EAAU,EAAE,EAAW,EAAE,MAA2B;;QACpE,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,EAAE,IAAI,EAAE,MAAA,EAAC,EAAE,EAAE,EAAE,EAAC,mCAAI,IAAI,IAAE,CAAC;IACjJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAU,EAAE,MAA2B;QAC7D,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,QAAQ,CAAC,MAAM,IAAE,CAAC;IACvG,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,KAAa,EAAE,MAA2B;QACvE,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,IAAE,CAAC;IACnI,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,EAAU,EAAE,MAA2B;QACxD,OAAO,IAAA,uBAAU,kCAAK,MAAM,KAAE,GAAG,EAAE,mBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,mBAAS,CAAC,WAAW,CAAC,MAAM,IAAE,CAAC;IAC7G,CAAC;CACF;AAvFD,wCAuFC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAqB,YAAY;IAC/B,MAAM,CAAO,gBAAgB,CAC3B,IAAuB,EACvB,UAAkB,EAClB,QAAgB,EAChB,UAAkB,EAClB,MAA2B;;YAE3B,OAAO,cAAc,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QACzF,CAAC;KAAA;IAED,MAAM,CAAO,wBAAwB,CAAC,IAA+B,EAAE,MAA2B;;YAChG,OAAO,cAAc,CAAC,wBAAwB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/D,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,IAAuB,EAAE,MAA2B;;YAC3E,OAAO,cAAc,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClD,CAAC;KAAA;IAED,MAAM,CAAO,UAAU,CAAC,EAAU,EAAE,EAAW,EAAE,MAA2B;;YAC1E,OAAO,cAAc,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,EAAU,EAAE,MAA2B;;YACnE,OAAO,cAAc,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACrD,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,KAAa,EAAE,MAA2B;;YAC7E,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,EAAU,EAAE,MAA2B;;YAC9D,OAAO,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;KAAA;CACF;AAlCD,+BAkCC"}
@@ -1,13 +1,14 @@
1
1
  import { SCUserModerationType, SCUserStatus, SCFlaggedContributionType, SCFlagType, SCFlagTypeEnum, SCContributionType } from '@selfcommunity/types';
2
2
  import { ModerateContributionParams, SCPaginatedResponse } from '../../types';
3
3
  import { SCContributionStatus } from '@selfcommunity/types';
4
+ import { AxiosRequestConfig } from 'axios';
4
5
  export interface ModerationApiClientInterface {
5
- getUsersForModeration(): Promise<SCPaginatedResponse<SCUserModerationType>>;
6
- moderateASpecificUser(id: number, status: SCUserStatus): Promise<any>;
7
- getAllFlaggedContributions(): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
8
- getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum): Promise<SCPaginatedResponse<SCFlagType>>;
9
- moderateAContribution(id: number, data: ModerateContributionParams): Promise<any>;
10
- getContributionModerationStatus(id: number, contribution_type: SCContributionType): Promise<SCContributionStatus>;
6
+ getUsersForModeration(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserModerationType>>;
7
+ moderateASpecificUser(id: number, status: SCUserStatus, config?: AxiosRequestConfig): Promise<any>;
8
+ getAllFlaggedContributions(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
9
+ getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFlagType>>;
10
+ moderateAContribution(id: number, data: ModerateContributionParams, config?: AxiosRequestConfig): Promise<any>;
11
+ getContributionModerationStatus(id: number, contribution_type: SCContributionType, config?: AxiosRequestConfig): Promise<SCContributionStatus>;
11
12
  }
12
13
  /**
13
14
  * Contains all the endpoints needed to manage moderation.
@@ -16,40 +17,44 @@ export declare class ModerationApiClient {
16
17
  /**
17
18
  * This endpoint retrieves all users for moderation purpose.
18
19
  */
19
- static getUsersForModeration(): Promise<SCPaginatedResponse<SCUserModerationType>>;
20
+ static getUsersForModeration(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserModerationType>>;
20
21
  /**
21
22
  * This endpoint performs users moderation.
22
23
  * @param id
23
24
  * @param status
25
+ * @param config
24
26
  */
25
- static moderateASpecificUser(id: number, status: SCUserStatus): Promise<any>;
27
+ static moderateASpecificUser(id: number, status: SCUserStatus, config?: AxiosRequestConfig): Promise<any>;
26
28
  /**
27
29
  * This endpoint retrieves all flagged contributions.
28
30
  */
29
- static getAllFlaggedContributions(): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
31
+ static getAllFlaggedContributions(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
30
32
  /**
31
33
  * This endpoint retrieves all flags for a specific contribution.
32
34
  * @param id
33
35
  * @param contribution_type
34
36
  * @param flag_type
37
+ * @param config
35
38
  */
36
- static getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum): Promise<SCPaginatedResponse<SCFlagType>>;
39
+ static getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFlagType>>;
37
40
  /**
38
41
  * This endpoint provides actions for flagged contributions moderation.
39
42
  * @param id
40
43
  * @param data
44
+ * @param config
41
45
  */
42
- static moderateAContribution(id: number, data: ModerateContributionParams): Promise<any>;
46
+ static moderateAContribution(id: number, data: ModerateContributionParams, config?: AxiosRequestConfig): Promise<any>;
43
47
  /**
44
48
  * This endpoint retrieves moderation status for a specific contribution.
45
49
  * @param id
46
50
  * @param contribution_type
51
+ * @param config
47
52
  */
48
- static getContributionModerationStatus(id: number, contribution_type: SCContributionType): Promise<SCContributionStatus>;
53
+ static getContributionModerationStatus(id: number, contribution_type: SCContributionType, config?: AxiosRequestConfig): Promise<SCContributionStatus>;
49
54
  }
50
55
  /**
51
56
  *
52
- :::tipModeration service can be used in the following ways:
57
+ :::tipModeration service can be used in the following way:
53
58
 
54
59
  ```jsx
55
60
  1. Import the service from our library:
@@ -71,14 +76,23 @@ export declare class ModerationApiClient {
71
76
  return await ModerationService.moderateASpecificUser(userId, userStatus);
72
77
  }
73
78
  ```
79
+ ```jsx
80
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
81
+
82
+ 1. Declare it(or declare them, it is possible to add multiple params)
83
+
84
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
85
+
86
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
87
+ ```
74
88
  :::
75
89
  */
76
90
  export default class ModerationService {
77
- static getUsersForModeration(): Promise<SCPaginatedResponse<SCUserModerationType>>;
78
- static moderateASpecificUser(id: number, status: SCUserStatus): Promise<any>;
79
- static getAllFlaggedContributions(): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
80
- static getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum): Promise<SCPaginatedResponse<SCFlagType>>;
81
- static moderateAContribution(id: number, data: ModerateContributionParams): Promise<any>;
82
- static getContributionModerationStatus(id: number, contribution_type: SCContributionType): Promise<SCContributionStatus>;
91
+ static getUsersForModeration(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserModerationType>>;
92
+ static moderateASpecificUser(id: number, status: SCUserStatus, config?: AxiosRequestConfig): Promise<any>;
93
+ static getAllFlaggedContributions(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFlaggedContributionType>>;
94
+ static getAllFlagsForSpecificContribution(id: number, contribution_type: SCContributionType, flag_type?: SCFlagTypeEnum, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFlagType>>;
95
+ static moderateAContribution(id: number, data: ModerateContributionParams, config?: AxiosRequestConfig): Promise<any>;
96
+ static getContributionModerationStatus(id: number, contribution_type: SCContributionType, config?: AxiosRequestConfig): Promise<SCContributionStatus>;
83
97
  }
84
98
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,oBAAoB,EAAE,YAAY,EAAE,yBAAyB,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnJ,OAAO,EAAC,0BAA0B,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,MAAM,WAAW,4BAA4B;IAC3C,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC5E,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACtE,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACtF,kCAAkC,CAChC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5C,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAClF,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CACnH;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAIlF;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IAI5E;;OAEG;IACH,MAAM,CAAC,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;IAI5F;;;;;OAKG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAM3C;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxF;;;;OAIG;IACH,MAAM,CAAC,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAGzH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,qBAAqB,IAAI,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAG3E,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;WAGrE,0BAA0B,IAAI,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;WAGrF,kCAAkC,CAC7C,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAG9B,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;WAGjF,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAG/H"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/moderation/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,oBAAoB,EAAE,YAAY,EAAE,yBAAyB,EAAE,UAAU,EAAE,cAAc,EAAE,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AACnJ,OAAO,EAAC,0BAA0B,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,4BAA4B;IAC3C,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACvG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnG,0BAA0B,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACjH,kCAAkC,CAChC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,EAC1B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5C,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/G,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAChJ;AACD;;GAEG;AAEH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAI7G;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzG;;OAEG;IACH,MAAM,CAAC,0BAA0B,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;IAIvH;;;;;;OAMG;IACH,MAAM,CAAC,kCAAkC,CACvC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,EAC1B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAW3C;;;;;OAKG;IACH,MAAM,CAAC,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrH;;;;;OAKG;IACH,MAAM,CAAC,+BAA+B,CACpC,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,oBAAoB,CAAC;CAOjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,qBAAqB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;WAGtG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAGlG,0BAA0B,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;WAGhH,kCAAkC,CAC7C,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,SAAS,CAAC,EAAE,cAAc,EAC1B,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;WAG9B,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,0BAA0B,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC;WAG9G,+BAA+B,CAC1C,EAAE,EAAE,MAAM,EACV,iBAAiB,EAAE,kBAAkB,EACrC,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,oBAAoB,CAAC;CAGjC"}