@selfcommunity/api-services 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (188) hide show
  1. package/lib/cjs/index.js +36 -0
  2. package/lib/cjs/services/category/index.js +168 -286
  3. package/lib/cjs/services/comment/index.js +107 -186
  4. package/lib/cjs/services/custom_adv/index.js +31 -51
  5. package/lib/cjs/services/custom_page/index.js +32 -52
  6. package/lib/cjs/services/data_portability/index.js +18 -43
  7. package/lib/cjs/services/embed/index.js +90 -151
  8. package/lib/cjs/services/feature/index.js +8 -16
  9. package/lib/cjs/services/feed/index.js +46 -81
  10. package/lib/cjs/services/feed_object/index.js +339 -505
  11. package/lib/cjs/services/incubator/index.js +64 -116
  12. package/lib/cjs/services/insight/index.js +51 -94
  13. package/lib/cjs/services/legal_page/index.js +60 -101
  14. package/lib/cjs/services/locality/index.js +14 -30
  15. package/lib/cjs/services/loyalty/index.js +92 -154
  16. package/lib/cjs/services/media/index.js +80 -122
  17. package/lib/cjs/services/moderation/index.js +65 -103
  18. package/lib/cjs/services/notification/index.js +67 -136
  19. package/lib/cjs/services/preference/index.js +25 -51
  20. package/lib/cjs/services/private_message/index.js +98 -177
  21. package/lib/cjs/services/score/index.js +22 -46
  22. package/lib/cjs/services/sso/index.js +17 -32
  23. package/lib/cjs/services/suggestion/index.js +23 -57
  24. package/lib/cjs/services/tag/index.js +72 -119
  25. package/lib/cjs/services/user/index.js +420 -767
  26. package/lib/cjs/services/webhook/index.js +4 -7
  27. package/lib/cjs/types/baseParams.js +3 -0
  28. package/lib/cjs/types/category.js +3 -0
  29. package/lib/cjs/types/comment.js +3 -0
  30. package/lib/cjs/types/customAdv.js +3 -0
  31. package/lib/cjs/types/customPage.js +3 -0
  32. package/lib/cjs/types/embed.js +3 -0
  33. package/lib/cjs/types/feed.js +3 -0
  34. package/lib/cjs/types/feedObject.js +3 -0
  35. package/lib/cjs/types/incubator.js +3 -0
  36. package/lib/cjs/types/index.js +91 -1
  37. package/lib/cjs/types/legalPage.js +3 -0
  38. package/lib/cjs/types/media.js +29 -0
  39. package/lib/cjs/types/moderation.js +3 -0
  40. package/lib/cjs/types/notification.js +3 -0
  41. package/lib/cjs/types/privateMessage.js +3 -0
  42. package/lib/cjs/types/prize.js +3 -0
  43. package/lib/cjs/types/sso.js +3 -0
  44. package/lib/cjs/types/tag.js +3 -0
  45. package/lib/cjs/types/user.js +3 -0
  46. package/lib/cjs/utils/apiRequest.js +2 -1
  47. package/lib/esm/index.js +36 -0
  48. package/lib/esm/services/category/index.js +168 -286
  49. package/lib/esm/services/comment/index.js +107 -186
  50. package/lib/esm/services/custom_adv/index.js +31 -51
  51. package/lib/esm/services/custom_page/index.js +32 -52
  52. package/lib/esm/services/data_portability/index.js +18 -43
  53. package/lib/esm/services/embed/index.js +90 -151
  54. package/lib/esm/services/feature/index.js +8 -16
  55. package/lib/esm/services/feed/index.js +46 -81
  56. package/lib/esm/services/feed_object/index.js +339 -505
  57. package/lib/esm/services/incubator/index.js +64 -116
  58. package/lib/esm/services/insight/index.js +51 -94
  59. package/lib/esm/services/legal_page/index.js +60 -101
  60. package/lib/esm/services/locality/index.js +14 -30
  61. package/lib/esm/services/loyalty/index.js +92 -154
  62. package/lib/esm/services/media/index.js +80 -122
  63. package/lib/esm/services/moderation/index.js +65 -103
  64. package/lib/esm/services/notification/index.js +67 -136
  65. package/lib/esm/services/preference/index.js +25 -51
  66. package/lib/esm/services/private_message/index.js +98 -177
  67. package/lib/esm/services/score/index.js +22 -46
  68. package/lib/esm/services/sso/index.js +17 -32
  69. package/lib/esm/services/suggestion/index.js +23 -57
  70. package/lib/esm/services/tag/index.js +72 -119
  71. package/lib/esm/services/user/index.js +420 -767
  72. package/lib/esm/services/webhook/index.js +4 -7
  73. package/lib/esm/types/baseParams.js +3 -0
  74. package/lib/esm/types/category.js +3 -0
  75. package/lib/esm/types/comment.js +3 -0
  76. package/lib/esm/types/customAdv.js +3 -0
  77. package/lib/esm/types/customPage.js +3 -0
  78. package/lib/esm/types/embed.js +3 -0
  79. package/lib/esm/types/feed.js +3 -0
  80. package/lib/esm/types/feedObject.js +3 -0
  81. package/lib/esm/types/incubator.js +3 -0
  82. package/lib/esm/types/index.js +91 -1
  83. package/lib/esm/types/legalPage.js +3 -0
  84. package/lib/esm/types/media.js +29 -0
  85. package/lib/esm/types/moderation.js +3 -0
  86. package/lib/esm/types/notification.js +3 -0
  87. package/lib/esm/types/privateMessage.js +3 -0
  88. package/lib/esm/types/prize.js +3 -0
  89. package/lib/esm/types/sso.js +3 -0
  90. package/lib/esm/types/tag.js +3 -0
  91. package/lib/esm/types/user.js +3 -0
  92. package/lib/esm/utils/apiRequest.js +2 -1
  93. package/lib/types/index.d.ts +2 -2
  94. package/lib/types/index.d.ts.map +1 -1
  95. package/lib/types/services/category/index.d.ts +114 -42
  96. package/lib/types/services/category/index.d.ts.map +1 -1
  97. package/lib/types/services/comment/index.d.ts +74 -23
  98. package/lib/types/services/comment/index.d.ts.map +1 -1
  99. package/lib/types/services/custom_adv/index.d.ts +26 -9
  100. package/lib/types/services/custom_adv/index.d.ts.map +1 -1
  101. package/lib/types/services/custom_page/index.d.ts +26 -9
  102. package/lib/types/services/custom_page/index.d.ts.map +1 -1
  103. package/lib/types/services/data_portability/index.d.ts +19 -6
  104. package/lib/types/services/data_portability/index.d.ts.map +1 -1
  105. package/lib/types/services/embed/index.d.ts +62 -24
  106. package/lib/types/services/embed/index.d.ts.map +1 -1
  107. package/lib/types/services/feature/index.d.ts +11 -3
  108. package/lib/types/services/feature/index.d.ts.map +1 -1
  109. package/lib/types/services/feed/index.d.ts +37 -15
  110. package/lib/types/services/feed/index.d.ts.map +1 -1
  111. package/lib/types/services/feed_object/index.d.ts +229 -81
  112. package/lib/types/services/feed_object/index.d.ts.map +1 -1
  113. package/lib/types/services/incubator/index.d.ts +51 -18
  114. package/lib/types/services/incubator/index.d.ts.map +1 -1
  115. package/lib/types/services/insight/index.d.ts +44 -18
  116. package/lib/types/services/insight/index.d.ts.map +1 -1
  117. package/lib/types/services/legal_page/index.d.ts +46 -18
  118. package/lib/types/services/legal_page/index.d.ts.map +1 -1
  119. package/lib/types/services/locality/index.d.ts +17 -6
  120. package/lib/types/services/locality/index.d.ts.map +1 -1
  121. package/lib/types/services/loyalty/index.d.ts +70 -27
  122. package/lib/types/services/loyalty/index.d.ts.map +1 -1
  123. package/lib/types/services/media/index.d.ts +55 -18
  124. package/lib/types/services/media/index.d.ts.map +1 -1
  125. package/lib/types/services/moderation/index.d.ts +51 -18
  126. package/lib/types/services/moderation/index.d.ts.map +1 -1
  127. package/lib/types/services/notification/index.d.ts +63 -27
  128. package/lib/types/services/notification/index.d.ts.map +1 -1
  129. package/lib/types/services/preference/index.d.ts +28 -9
  130. package/lib/types/services/preference/index.d.ts.map +1 -1
  131. package/lib/types/services/private_message/index.d.ts +68 -24
  132. package/lib/types/services/private_message/index.d.ts.map +1 -1
  133. package/lib/types/services/score/index.d.ts +24 -9
  134. package/lib/types/services/score/index.d.ts.map +1 -1
  135. package/lib/types/services/sso/index.d.ts +18 -6
  136. package/lib/types/services/sso/index.d.ts.map +1 -1
  137. package/lib/types/services/suggestion/index.d.ts +29 -12
  138. package/lib/types/services/suggestion/index.d.ts.map +1 -1
  139. package/lib/types/services/tag/index.d.ts +57 -21
  140. package/lib/types/services/tag/index.d.ts.map +1 -1
  141. package/lib/types/services/user/index.d.ts +313 -114
  142. package/lib/types/services/user/index.d.ts.map +1 -1
  143. package/lib/types/services/webhook/index.d.ts +3 -4
  144. package/lib/types/services/webhook/index.d.ts.map +1 -1
  145. package/lib/types/tsconfig.build.tsbuildinfo +1 -1
  146. package/lib/types/types/baseParams.d.ts +23 -0
  147. package/lib/types/types/baseParams.d.ts.map +1 -0
  148. package/lib/types/types/category.d.ts +15 -0
  149. package/lib/types/types/category.d.ts.map +1 -0
  150. package/lib/types/types/comment.d.ts +51 -0
  151. package/lib/types/types/comment.d.ts.map +1 -0
  152. package/lib/types/types/customAdv.d.ts +19 -0
  153. package/lib/types/types/customAdv.d.ts.map +1 -0
  154. package/lib/types/types/customPage.d.ts +24 -0
  155. package/lib/types/types/customPage.d.ts.map +1 -0
  156. package/lib/types/types/embed.d.ts +26 -0
  157. package/lib/types/types/embed.d.ts.map +1 -0
  158. package/lib/types/types/feed.d.ts +11 -0
  159. package/lib/types/types/feed.d.ts.map +1 -0
  160. package/lib/types/types/feedObject.d.ts +56 -0
  161. package/lib/types/types/feedObject.d.ts.map +1 -0
  162. package/lib/types/types/incubator.d.ts +33 -0
  163. package/lib/types/types/incubator.d.ts.map +1 -0
  164. package/lib/types/types/index.d.ts +19 -1
  165. package/lib/types/types/index.d.ts.map +1 -1
  166. package/lib/types/types/legalPage.d.ts +19 -0
  167. package/lib/types/types/legalPage.d.ts.map +1 -0
  168. package/lib/types/types/media.d.ts +80 -0
  169. package/lib/types/types/media.d.ts.map +1 -0
  170. package/lib/types/types/moderation.d.ts +23 -0
  171. package/lib/types/types/moderation.d.ts.map +1 -0
  172. package/lib/types/types/notification.d.ts +31 -0
  173. package/lib/types/types/notification.d.ts.map +1 -0
  174. package/lib/types/types/privateMessage.d.ts +176 -0
  175. package/lib/types/types/privateMessage.d.ts.map +1 -0
  176. package/lib/types/types/prize.d.ts +47 -0
  177. package/lib/types/types/prize.d.ts.map +1 -0
  178. package/lib/types/types/sso.d.ts +12 -0
  179. package/lib/types/types/sso.d.ts.map +1 -0
  180. package/lib/types/types/tag.d.ts +39 -0
  181. package/lib/types/types/tag.d.ts.map +1 -0
  182. package/lib/types/types/user.d.ts +105 -0
  183. package/lib/types/types/user.d.ts.map +1 -0
  184. package/lib/types/utils/apiRequest.d.ts +1 -1
  185. package/lib/types/utils/apiRequest.d.ts.map +1 -1
  186. package/lib/umd/api-services.js +1 -1
  187. package/lib/umd/api-services.js.map +1 -1
  188. package/package.json +4 -4
@@ -3,137 +3,90 @@
3
3
  exports.__esModule = true;
4
4
  exports.default = exports.TagApiClient = void 0;
5
5
 
6
- var _client = _interopRequireDefault(require("../../client"));
6
+ var _apiRequest = require("../../utils/apiRequest");
7
7
 
8
8
  var _Endpoints = _interopRequireDefault(require("../../constants/Endpoints"));
9
9
 
10
10
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
11
11
 
12
+ /**
13
+ * Contains all the endpoints needed to manage tags.
14
+ */
12
15
  class TagApiClient {
16
+ /**
17
+ * This endpoint retrieves all tags.
18
+ */
13
19
  static getAllTags() {
14
- return _client.default.request({
15
- url: _Endpoints.default.TagsList.url({}),
16
- method: _Endpoints.default.TagsList.method
17
- }).then(res => {
18
- if (res.status >= 300) {
19
- console.log(`Unable to retrieve (Response code: ${res.status}).`);
20
- return Promise.reject(res);
21
- }
22
-
23
- return Promise.resolve(res);
24
- }).catch(error => {
25
- console.log('Unable to retrieve.');
26
- return Promise.reject(error);
27
- });
20
+ return (0, _apiRequest.apiRequest)(_Endpoints.default.TagsList.url({}), _Endpoints.default.TagsList.method);
28
21
  }
22
+ /**
23
+ * This endpoint creates a tag
24
+ * @param data
25
+ */
29
26
 
30
- static createTag() {
31
- return _client.default.request({
32
- url: _Endpoints.default.CreateTag.url({}),
33
- method: _Endpoints.default.CreateTag.method
34
- }).then(res => {
35
- if (res.status >= 300) {
36
- console.log(`Unable to retrieve (Response code: ${res.status}).`);
37
- return Promise.reject(res);
38
- }
39
-
40
- return Promise.resolve(res);
41
- }).catch(error => {
42
- console.log('Unable to retrieve.');
43
- return Promise.reject(error);
44
- });
27
+
28
+ static createTag(data) {
29
+ return (0, _apiRequest.apiRequest)(_Endpoints.default.CreateTag.url({}), _Endpoints.default.CreateTag.method, data);
45
30
  }
31
+ /**
32
+ * This endpoint performs tag search.
33
+ */
34
+
46
35
 
47
36
  static searchTag() {
48
- return _client.default.request({
49
- url: _Endpoints.default.SearchTag.url({}),
50
- method: _Endpoints.default.SearchTag.method
51
- }).then(res => {
52
- if (res.status >= 300) {
53
- console.log(`Unable to retrieve (Response code: ${res.status}).`);
54
- return Promise.reject(res);
55
- }
56
-
57
- return Promise.resolve(res);
58
- }).catch(error => {
59
- console.log('Unable to retrieve.');
60
- return Promise.reject(error);
61
- });
37
+ return (0, _apiRequest.apiRequest)(_Endpoints.default.SearchTag.url({}), _Endpoints.default.SearchTag.method);
62
38
  }
39
+ /**
40
+ * This endpoint retrieves a specific tag.
41
+ * @param id
42
+ */
43
+
63
44
 
64
45
  static getSpecificTag(id) {
65
- return _client.default.request({
66
- url: _Endpoints.default.Tag.url({
67
- id
68
- }),
69
- method: _Endpoints.default.Tag.method
70
- }).then(res => {
71
- if (res.status >= 300) {
72
- console.log(`Unable to retrieve (Response code: ${res.status}).`);
73
- return Promise.reject(res);
74
- }
75
-
76
- return Promise.resolve(res);
77
- }).catch(error => {
78
- console.log('Unable to retrieve.');
79
- return Promise.reject(error);
80
- });
46
+ return (0, _apiRequest.apiRequest)(_Endpoints.default.Tag.url({
47
+ id
48
+ }), _Endpoints.default.Tag.method);
81
49
  }
50
+ /**
51
+ * This endpoint updates a specific tag.
52
+ * @param id
53
+ * @param data
54
+ */
82
55
 
83
- static updateTag(id) {
84
- return _client.default.request({
85
- url: _Endpoints.default.UpdateTag.url({
86
- id
87
- }),
88
- method: _Endpoints.default.UpdateTag.method
89
- }).then(res => {
90
- if (res.status >= 300) {
91
- console.log(`Unable to retrieve (Response code: ${res.status}).`);
92
- return Promise.reject(res);
93
- }
94
-
95
- return Promise.resolve(res);
96
- }).catch(error => {
97
- console.log('Unable to retrieve.');
98
- return Promise.reject(error);
99
- });
100
- }
101
56
 
102
- static patchTag(id) {
103
- return _client.default.request({
104
- url: _Endpoints.default.PatchTag.url({
105
- id
106
- }),
107
- method: _Endpoints.default.PatchTag.method
108
- }).then(res => {
109
- if (res.status >= 300) {
110
- console.log(`Unable to retrieve (Response code: ${res.status}).`);
111
- return Promise.reject(res);
112
- }
113
-
114
- return Promise.resolve(res);
115
- }).catch(error => {
116
- console.log('Unable to retrieve.');
117
- return Promise.reject(error);
118
- });
57
+ static updateTag(id, data) {
58
+ return (0, _apiRequest.apiRequest)(_Endpoints.default.UpdateTag.url({
59
+ id
60
+ }), _Endpoints.default.UpdateTag.method, data != null ? data : null);
119
61
  }
62
+ /**
63
+ * This endpoint patches a specific tag.
64
+ * @param id
65
+ * @param data
66
+ */
67
+
120
68
 
121
- static assignATag(id) {
122
- return _client.default.request({
123
- url: _Endpoints.default.AssignTag.url({
124
- id
125
- }),
126
- method: _Endpoints.default.AssignTag.method
127
- }).then(res => {
128
- if (res.status >= 300) {
129
- console.log(`Unable to retrieve (Response code: ${res.status}).`);
130
- return Promise.reject(res);
131
- }
132
-
133
- return Promise.resolve(res);
134
- }).catch(error => {
135
- console.log('Unable to retrieve.');
136
- return Promise.reject(error);
69
+ static patchTag(id, data) {
70
+ return (0, _apiRequest.apiRequest)(_Endpoints.default.PatchTag.url({
71
+ id
72
+ }), _Endpoints.default.PatchTag.method, data != null ? data : null);
73
+ }
74
+ /**
75
+ * This endpoint assigns a tag to a user or to a category.
76
+ * One param between "user" and "category" need to be passed to this endpoint.
77
+ * @param id
78
+ * @param user
79
+ * @param category
80
+ */
81
+
82
+
83
+ static assignATag(id, user, category) {
84
+ return (0, _apiRequest.apiRequest)(_Endpoints.default.AssignTag.url({
85
+ id
86
+ }), _Endpoints.default.AssignTag.method, user ? {
87
+ user: user
88
+ } : {
89
+ category: category
137
90
  });
138
91
  }
139
92
 
@@ -146,8 +99,8 @@ class TagService {
146
99
  return TagApiClient.getAllTags();
147
100
  }
148
101
 
149
- static async createTag() {
150
- return TagApiClient.createTag();
102
+ static async createTag(data) {
103
+ return TagApiClient.createTag(data);
151
104
  }
152
105
 
153
106
  static async searchTag() {
@@ -158,16 +111,16 @@ class TagService {
158
111
  return TagApiClient.getSpecificTag(id);
159
112
  }
160
113
 
161
- static async updateTag(id) {
162
- return TagApiClient.updateTag(id);
114
+ static async updateTag(id, data) {
115
+ return TagApiClient.updateTag(id, data);
163
116
  }
164
117
 
165
- static async patchTag(id) {
166
- return TagApiClient.patchTag(id);
118
+ static async patchTag(id, data) {
119
+ return TagApiClient.patchTag(id, data);
167
120
  }
168
121
 
169
- static async assignATag(id) {
170
- return TagApiClient.assignATag(id);
122
+ static async assignATag(id, user, category) {
123
+ return TagApiClient.assignATag(id, user, category);
171
124
  }
172
125
 
173
126
  }