@selfcommunity/api-services 0.1.6 → 0.1.7

package/lib/cjs/services/moderation/index.js

@@ -3,122 +3,84 @@
 exports.__esModule = true;
 exports.default = exports.ModerationApiClient = void 0;
 
-var _client = _interopRequireDefault(require("../../client"));
+var _apiRequest = require("../../utils/apiRequest");
 
 var _Endpoints = _interopRequireDefault(require("../../constants/Endpoints"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/**
+ * Contains all the endpoints needed to manage moderation.
+ */
 class ModerationApiClient {
+  /**
+   * This endpoint retrieves all users for moderation purpose.
+   */
   static getUsersForModeration() {
-    return _client.default.request({
-      url: _Endpoints.default.UsersForModeration.url({}),
-      method: _Endpoints.default.UsersForModeration.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve users (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve users.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.UsersForModeration.url({}), _Endpoints.default.UsersForModeration.method);
   }
-
-  static moderateASpecificUser(id) {
-    return _client.default.request({
-      url: _Endpoints.default.ModerateUser.url({
-        id
-      }),
-      method: _Endpoints.default.ModerateUser.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
+  /**
+   * This endpoint performs users moderation.
+   * @param id
+   * @param status
+   */
+
+
+  static moderateASpecificUser(id, status) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.ModerateUser.url({
+      id
+    }), _Endpoints.default.ModerateUser.method, {
+      status: status
     });
   }
+  /**
+   * This endpoint retrieves all flagged contributions.
+   */
+
 
   static getAllFlaggedContributions() {
-    return _client.default.request({
-      url: _Endpoints.default.FlaggedContributions.url({}),
-      method: _Endpoints.default.FlaggedContributions.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve contributions (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve contributions.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.FlaggedContributions.url({}), _Endpoints.default.FlaggedContributions.method);
   }
-
-  static getSpecificContributionFlag(id, contribution_type) {
-    return _client.default.request({
-      url: _Endpoints.default.FlagsForSpecificContribution.url({
-        id,
-        contribution_type
-      }),
-      method: _Endpoints.default.FlagsForSpecificContribution.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
+  /**
+   * This endpoint retrieves all flags for a specific contribution.
+   * @param id
+   * @param contribution_type
+   * @param flag_type
+   */
+
+
+  static getAllFlagsForSpecificContribution(id, contribution_type, flag_type) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.FlagsForSpecificContribution.url({
+      id
+    }), _Endpoints.default.FlagsForSpecificContribution.method, {
+      contribution_type: contribution_type,
+      flag_type: flag_type != null ? flag_type : null
     });
   }
+  /**
+   * This endpoint provides actions for flagged contributions moderation.
+   * @param id
+   * @param data
+   */
 
-  static moderateAContribution(id) {
-    return _client.default.request({
-      url: _Endpoints.default.ModerateContribution.url({
-        id
-      }),
-      method: _Endpoints.default.ModerateContribution.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
+
+  static moderateAContribution(id, data) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.ModerateContribution.url({
+      id
+    }), _Endpoints.default.ModerateContribution.method, data);
   }
+  /**
+   * This endpoint retrieves moderation status for a specific contribution.
+   * @param id
+   * @param contribution_type
+   */
+
 
   static getContributionModerationStatus(id, contribution_type) {
-    return _client.default.request({
-      url: _Endpoints.default.ModerateContributionStatus.url({
-        id,
-        contribution_type
-      }),
-      method: _Endpoints.default.ModerateContributionStatus.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve moderation status for this contribute (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve moderation status for this contribute.');
-      return Promise.reject(error);
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.ModerateContributionStatus.url({
+      id
+    }), _Endpoints.default.ModerateContributionStatus.method, {
+      contribution_type: contribution_type
     });
   }
 
@@ -131,20 +93,20 @@ class ModerationService {
     return ModerationApiClient.getUsersForModeration();
   }
 
-  static async moderateASpecificUser(id) {
-    return ModerationApiClient.moderateASpecificUser(id);
+  static async moderateASpecificUser(id, status) {
+    return ModerationApiClient.moderateASpecificUser(id, status);
   }
 
   static async getAllFlaggedContributions() {
     return ModerationApiClient.getAllFlaggedContributions();
   }
 
-  static async getSpecificContributionFlag(id, contribution_type) {
-    return ModerationApiClient.getSpecificContributionFlag(id, contribution_type);
+  static async getAllFlagsForSpecificContribution(id, contribution_type, flag_type) {
+    return ModerationApiClient.getAllFlagsForSpecificContribution(id, contribution_type, flag_type);
   }
 
-  static async moderateAContribution(id) {
-    return ModerationApiClient.moderateAContribution(id);
+  static async moderateAContribution(id, data) {
+    return ModerationApiClient.moderateAContribution(id, data);
   }
 
   static async getContributionModerationStatus(id, contribution_type) {

package/lib/cjs/services/notification/index.js

@@ -3,163 +3,94 @@
 exports.__esModule = true;
 exports.default = exports.NotificationApiClient = void 0;
 
-var _client = _interopRequireDefault(require("../../client"));
+var _apiRequest = require("../../utils/apiRequest");
 
 var _Endpoints = _interopRequireDefault(require("../../constants/Endpoints"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/**
+ * Contains all the endpoints needed to manage notifications.
+ */
 class NotificationApiClient {
+  /**
+   * List all user notifications (in aggregate form) related to the community.
+   */
   static listUserNotification() {
-    return _client.default.request({
-      url: _Endpoints.default.UserNotificationList.url({}),
-      method: _Endpoints.default.UserNotificationList.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve results (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve results.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.UserNotificationList.url({}), _Endpoints.default.UserNotificationList.method);
   }
+  /**
+   * This endpoint marks as read a list of notifications identified by serialization_ids (sids).
+   * @param sids
+   */
+
 
-  static markReadNotification() {
-    return _client.default.request({
-      url: _Endpoints.default.UserMarkReadNotification.url({}),
-      method: _Endpoints.default.UserMarkReadNotification.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
+  static markReadNotification(sids) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.UserMarkReadNotification.url({}), _Endpoints.default.UserMarkReadNotification.method, {
+      sids: sids
     });
   }
+  /**
+   * This endpoint retrieves the number of unseen/unread notifications.
+   */
+
 
   static getUnseenNotification() {
-    return _client.default.request({
-      url: _Endpoints.default.UserUnseenNotificationCount.url({}),
-      method: _Endpoints.default.UserUnseenNotificationCount.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve results (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve results.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.UserUnseenNotificationCount.url({}), _Endpoints.default.UserUnseenNotificationCount.method);
   }
+  /**
+   * This endpoint generates a custom notification starting from the user. The recipients of the notification can be the user's friends/followers or the user himself (based on recipients_type value). Es. connections -> "user" added an item to the wishlist.
+   * @param data
+   */
 
-  static createCustomNotification() {
-    return _client.default.request({
-      url: _Endpoints.default.CreateCustomNotification.url({}),
-      method: _Endpoints.default.CreateCustomNotification.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
-    });
+
+  static createCustomNotification(data) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.CreateCustomNotification.url({}), _Endpoints.default.CreateCustomNotification.method, data);
   }
+  /**
+   * This endpoint lists all broadcast messages. Broadcast Message is a feature which allows a specific user to send messages and announcements to a larger group of users at once.
+   */
+
 
   static listBroadcastMessages() {
-    return _client.default.request({
-      url: _Endpoints.default.BroadcastMessagesList.url({}),
-      method: _Endpoints.default.BroadcastMessagesList.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve results (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve results.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.BroadcastMessagesList.url({}), _Endpoints.default.BroadcastMessagesList.method);
   }
+  /**
+   * This endpoint retrieves the total number of broadcast messages not yet seen by the user.
+   */
+
 
   static listBroadcastMessagesUnseenCount() {
-    return _client.default.request({
-      url: _Endpoints.default.BroadcastMessagesUnseenCount.url({}),
-      method: _Endpoints.default.BroadcastMessagesUnseenCount.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve results  (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve results.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.BroadcastMessagesUnseenCount.url({}), _Endpoints.default.BroadcastMessagesUnseenCount.method);
   }
+  /**
+   * This endpoint retrieves the total number of broadcast messages not yet disposed by the user.
+   */
+
 
   static listBroadcastMessagesUndisposedCount() {
-    return _client.default.request({
-      url: _Endpoints.default.BroadcastMessagesUndisposedCount.url({}),
-      method: _Endpoints.default.BroadcastMessagesUndisposedCount.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve results (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve results.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.BroadcastMessagesUndisposedCount.url({}), _Endpoints.default.BroadcastMessagesUndisposedCount.method);
   }
+  /**
+   * This endpoint marks as viewed/read a broadcast message for a user.
+   * @param banner_ids
+   */
+
 
-  static markReadBroadcastMessages() {
-    return _client.default.request({
-      url: _Endpoints.default.BroadcastMessagesMarkRead.url({}),
-      method: _Endpoints.default.BroadcastMessagesMarkRead.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to perform action (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to perform action.');
-      return Promise.reject(error);
+  static markReadBroadcastMessages(banner_ids) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.BroadcastMessagesMarkRead.url({}), _Endpoints.default.BroadcastMessagesMarkRead.method, {
+      banner_ids: banner_ids
     });
   }
+  /**
+   * This endpoint disposes a broadcast message for a user.
+   * @param banner_ids
+   */
+
 
-  static disposeBroadcastMessages() {
-    return _client.default.request({
-      url: _Endpoints.default.BroadcastMessagesDispose.url({}),
-      method: _Endpoints.default.BroadcastMessagesDispose.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve results  (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve results.');
-      return Promise.reject(error);
+  static disposeBroadcastMessages(banner_ids) {
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.BroadcastMessagesDispose.url({}), _Endpoints.default.BroadcastMessagesDispose.method, {
+      banner_ids: banner_ids
     });
   }
 
@@ -172,16 +103,16 @@ class NotificationService {
     return NotificationApiClient.listUserNotification();
   }
 
-  static async markReadNotification() {
-    return NotificationApiClient.markReadNotification();
+  static async markReadNotification(sids) {
+    return NotificationApiClient.markReadNotification(sids);
   }
 
   static async getUnseenNotification() {
     return NotificationApiClient.getUnseenNotification();
   }
 
-  static async createCustomNotification() {
-    return NotificationApiClient.createCustomNotification();
+  static async createCustomNotification(data) {
+    return NotificationApiClient.createCustomNotification(data);
   }
 
   static async listBroadcastMessages() {
@@ -196,12 +127,12 @@ class NotificationService {
     return NotificationApiClient.listBroadcastMessagesUndisposedCount();
   }
 
-  static async disposeBroadcastMessages() {
-    return NotificationApiClient.disposeBroadcastMessages();
+  static async disposeBroadcastMessages(banner_ids) {
+    return NotificationApiClient.disposeBroadcastMessages(banner_ids);
   }
 
-  static async markReadBroadcastMessages() {
-    return NotificationApiClient.markReadBroadcastMessages();
+  static async markReadBroadcastMessages(banner_ids) {
+    return NotificationApiClient.markReadBroadcastMessages(banner_ids);
   }
 
 }

package/lib/cjs/services/preference/index.js

@@ -3,32 +3,30 @@
 exports.__esModule = true;
 exports.default = exports.PreferenceApiClient = void 0;
 
-var _client = _interopRequireDefault(require("../../client"));
+var _apiRequest = require("../../utils/apiRequest");
 
 var _Endpoints = _interopRequireDefault(require("../../constants/Endpoints"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/**
+ * Contains all the endpoints needed to manage dynamic preferences.
+ */
 class PreferenceApiClient {
+  /**
+   * This endpoint retrieves all available dynamic preferences.
+   */
   static getAllPreferences() {
-    return _client.default.request({
-      url: _Endpoints.default.Preferences.url({}),
-      method: _Endpoints.default.Preferences.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve community preferences (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      const data = res.data['results'].reduce((obj, p) => Object.assign({}, obj, {
-        [`${p.section}.${p.name}`]: p
-      }), {});
-      return Promise.resolve(data);
-    }).catch(error => {
-      console.log('Unable to retrieve community preferences.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.Preferences.url({}), _Endpoints.default.Preferences.method);
   }
+  /**
+   * This endpoint searches dynamic preferences.
+   * @param search
+   * @param section
+   * @param keys
+   * @param ordering
+   */
+
 
   static searchPreferences(search, section, keys, ordering) {
     const params = new URLSearchParams(Object.assign({}, search && {
@@ -40,42 +38,18 @@ class PreferenceApiClient {
     }, ordering && {
       ordering: ordering
     }));
-    return _client.default.request({
-      url: `${_Endpoints.default.Preferences.url({})}?${params.toString()}`,
-      method: _Endpoints.default.Preferences.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve community preferences (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      const data = res.data['results'].reduce((obj, p) => Object.assign({}, obj, {
-        [`${p.section}.${p.name}`]: p
-      }), {});
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve community preferences.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(`${_Endpoints.default.Preferences.url({})}?${params.toString()}`, _Endpoints.default.Preferences.method);
   }
+  /**
+   * This endpoint retrieves a specific dynamic preference.
+   * @param id
+   */
+
 
   static getSpecificPreference(id) {
-    return _client.default.request({
-      url: _Endpoints.default.Preferences.url({
-        id
-      }),
-      method: _Endpoints.default.Preferences.method
-    }).then(res => {
-      if (res.status >= 300) {
-        console.log(`Unable to retrieve community preference (Response code: ${res.status}).`);
-        return Promise.reject(res);
-      }
-
-      return Promise.resolve(res);
-    }).catch(error => {
-      console.log('Unable to retrieve community preference.');
-      return Promise.reject(error);
-    });
+    return (0, _apiRequest.apiRequest)(_Endpoints.default.Preferences.url({
+      id
+    }), _Endpoints.default.Preferences.method);
   }
 
 }