@selfcommunity/api-services 0.1.2-alpha.0

package/lib/cjs/constants/Endpoints.js

@@ -0,0 +1,622 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _utils = require("@selfcommunity/utils");
+
+const Endpoints = {
+  /**
+   * OAuth2 Endpoints
+   */
+  OAuthToken: {
+    url: (0, _utils.urlReplacer)('/oauth/token/'),
+    method: 'POST'
+  },
+
+  /**
+   * Preferences Endpoints
+   */
+  Preferences: {
+    url: (0, _utils.urlReplacer)('/api/v2/dynamic_preference/'),
+    method: 'GET'
+  },
+
+  /**
+   * Features Endpoints
+   * */
+  Feature: {
+    url: (0, _utils.urlReplacer)('/api/v2/feature/'),
+    method: 'GET'
+  },
+
+  /**
+   * FeedObject Endpoints
+   */
+  FeedObject: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/'),
+    method: 'GET'
+  },
+  DeleteFeedObject: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/'),
+    method: 'DELETE'
+  },
+  RestoreFeedObject: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/restore/'),
+    method: 'POST'
+  },
+  RelatedFeedObjects: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/related/'),
+    method: 'GET'
+  },
+
+  /**
+   * Comments
+   */
+  Comment: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/$(id)/'),
+    method: 'GET'
+  },
+  NewComment: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/'),
+    method: 'POST'
+  },
+  UpdateComment: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/$(id)/'),
+    method: 'PUT'
+  },
+  DeleteComment: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/$(id)/'),
+    method: 'DELETE'
+  },
+  RestoreComment: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/$(id)/restore/'),
+    method: 'POST'
+  },
+  Comments: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/'),
+    method: 'GET'
+  },
+  CommentVote: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/$(id)/vote/'),
+    method: 'POST'
+  },
+  CommentRestore: {
+    url: (0, _utils.urlReplacer)('/api/v2/comment/$(id)/restore'),
+    method: 'POST'
+  },
+
+  /**
+   * Reporting Flag Endpoints
+   */
+  FlagStatus: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/flag/status/'),
+    method: 'GET'
+  },
+  Flag: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/flag/'),
+    method: 'POST'
+  },
+
+  /**
+   * Categories Endpoints
+   */
+  CategoryList: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/'),
+    method: 'GET'
+  },
+  Category: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/$(id)/'),
+    method: 'GET'
+  },
+  CategoriesFollowed: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/followed/'),
+    method: 'GET'
+  },
+  CategoryFollowers: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/$(id)/followers/'),
+    method: 'GET'
+  },
+  CategoriesSuggestion: {
+    url: (0, _utils.urlReplacer)('/api/v2/suggestion/category/'),
+    method: 'GET'
+  },
+  CategoryTrendingFeed: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/$(id)/feed/trending/'),
+    method: 'GET'
+  },
+  CategoryTrendingPeople: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/$(id)/followers/trending/'),
+    method: 'GET'
+  },
+  FollowCategory: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/$(id)/follow/'),
+    method: 'POST'
+  },
+  CheckCategoryIsFollowed: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/$(id)/is_followed/'),
+    method: 'GET'
+  },
+  PopularCategories: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/popular/'),
+    method: 'GET'
+  },
+
+  /**
+   * Tag Endpoints
+   */
+  Tag: {
+    url: (0, _utils.urlReplacer)('/api/v2/tag/$(id)/'),
+    method: 'GET'
+  },
+
+  /**
+   * User Endpoints
+   */
+  UserSearch: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/search/'),
+    method: 'GET'
+  },
+  User: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/'),
+    method: 'GET'
+  },
+  UserPatch: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/'),
+    method: 'PATCH'
+  },
+  UserSettings: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/settings/'),
+    method: 'GET'
+  },
+  UserSettingsPatch: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/settings/'),
+    method: 'PATCH'
+  },
+  GetUserLoyaltyPoints: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/loyalty/points/'),
+    method: 'GET'
+  },
+  UserFollowers: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/followers/'),
+    method: 'GET'
+  },
+  UsersFollowed: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/followings/'),
+    method: 'GET'
+  },
+  FollowUser: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/follow/'),
+    method: 'POST'
+  },
+  CheckUserFollowed: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/is_followed/'),
+    method: 'GET'
+  },
+  UserConnections: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connections/'),
+    method: 'GET'
+  },
+  UserCheckConnection: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/is_connection/'),
+    method: 'GET'
+  },
+  UserConnectionStatuses: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/connection/statuses/'),
+    method: 'POST'
+  },
+  UserConnectionRequests: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/requests/'),
+    method: 'POST'
+  },
+  UserRequestConnections: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/requests_sent/'),
+    method: 'POST'
+  },
+  UserRequestConnection: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/request'),
+    method: 'POST'
+  },
+  UserCancelRequestConnection: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/cancel_request'),
+    method: 'POST'
+  },
+  UserAcceptRequestConnection: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/accept/'),
+    method: 'POST'
+  },
+  UserRejectConnectionRequest: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/reject'),
+    method: 'POST'
+  },
+  UserCancelRejectConnectionRequest: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/cancel_reject'),
+    method: 'POST'
+  },
+  UserRemoveConnection: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/connection/remove'),
+    method: 'POST'
+  },
+  Me: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/me/'),
+    method: 'GET'
+  },
+  UpdateUser: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/'),
+    method: 'PATCH'
+  },
+  FollowedCategories: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/categories'),
+    method: 'GET'
+  },
+  GetAvatars: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/avatar/'),
+    method: 'GET'
+  },
+  SetPrimaryAvatar: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/avatar/'),
+    method: 'PATCH'
+  },
+  AddAvatar: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/avatar/'),
+    method: 'POST'
+  },
+  RemoveAvatar: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/avatar/'),
+    method: 'DELETE'
+  },
+  CheckEmailToken: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/check_email_token/'),
+    method: 'GET'
+  },
+
+  /**
+   * Broadcast Messages
+   */
+  BroadcastMessagesList: {
+    url: (0, _utils.urlReplacer)('/api/v2/notification/banner/'),
+    method: 'GET'
+  },
+  BroadcastMessagesMarkRead: {
+    url: (0, _utils.urlReplacer)('/api/v2/notification/banner/read/'),
+    method: 'POST'
+  },
+  BroadcastMessagesDispose: {
+    url: (0, _utils.urlReplacer)('/api/v2/notification/banner/dispose/'),
+    method: 'POST'
+  },
+  BroadcastMessagesUnseenCount: {
+    url: (0, _utils.urlReplacer)('/api/v2/notification/banner/unseen/count/'),
+    method: 'GET'
+  },
+
+  /**
+   * Notifications
+   */
+  UserNotificationList: {
+    url: (0, _utils.urlReplacer)('/api/v2/notification/'),
+    method: 'GET'
+  },
+  UserMarkReadNotification: {
+    url: (0, _utils.urlReplacer)('/api/v2/notification/read/'),
+    method: 'POST'
+  },
+  UserUnseenNotificationCount: {
+    url: (0, _utils.urlReplacer)('/api/v2/notification/unseen/'),
+    method: 'GET'
+  },
+  UserSuspendContributionNotification: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/suspend/'),
+    method: 'POST'
+  },
+  UserCheckContributionNotificationSuspended: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/suspended/'),
+    method: 'GET'
+  },
+  UserListContributionNotificationSuspended: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/suspended/'),
+    method: 'GET'
+  },
+
+  /**
+   * Suggestion Endpoints
+   */
+  UserSuggestion: {
+    url: (0, _utils.urlReplacer)('/api/v2/suggestion/user/'),
+    method: 'GET'
+  },
+  Platform: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/me/platform_url'),
+    method: 'GET'
+  },
+  PollSuggestion: {
+    url: (0, _utils.urlReplacer)('/api/v2/suggestion/poll/'),
+    method: 'GET'
+  },
+
+  /**
+   * Follow
+   */
+  FollowContribution: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/follow/'),
+    method: 'POST'
+  },
+
+  /**
+   * Manage votes for post, discussion, status and comment
+   */
+  Vote: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/vote/'),
+    method: 'POST'
+  },
+  VotesList: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/vote/'),
+    method: 'GET'
+  },
+
+  /**
+   * Shares
+   */
+  ShareUsersList: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/shares_users/'),
+    method: 'GET'
+  },
+
+  /**
+   * Poll
+   */
+  PollVote: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/poll/vote/'),
+    method: 'POST'
+  },
+  PollVotesList: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/poll/vote/'),
+    method: 'GET'
+  },
+
+  /**
+   * Contributors
+   */
+  Contributors: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/contributors/'),
+    method: 'GET'
+  },
+
+  /**
+   * Loyalty Endpoints
+   */
+  GetPrizes: {
+    url: (0, _utils.urlReplacer)('/api/v2/loyalty/prize/'),
+    method: 'GET'
+  },
+
+  /**
+   * Composer Endpoints
+   */
+  Composer: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/'),
+    method: 'POST'
+  },
+  ComposerEdit: {
+    url: (0, _utils.urlReplacer)('/api/v2/$(type)/$(id)/'),
+    method: 'PUT'
+  },
+  ComposerChunkUploadMedia: {
+    url: (0, _utils.urlReplacer)('/api/v2/media/upload/chunk/'),
+    method: 'POST'
+  },
+  ComposerChunkUploadMediaComplete: {
+    url: (0, _utils.urlReplacer)('/api/v2/media/upload/complete/'),
+    method: 'POST'
+  },
+  ComposerMediaCreate: {
+    url: (0, _utils.urlReplacer)('/api/v2/media/'),
+    method: 'POST'
+  },
+  ComposerCategoryList: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/'),
+    method: 'GET'
+  },
+  ComposerAddressingTagList: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/tag/tags_to_address_a_contribution/'),
+    method: 'GET'
+  },
+  ComposerLocalitySearch: {
+    url: (0, _utils.urlReplacer)('/api/v2/locality/search/'),
+    method: 'GET'
+  },
+
+  /**
+   * Custom ADV
+   */
+  CustomAdvSearch: {
+    url: (0, _utils.urlReplacer)('/api/v2/custom_adv/search/'),
+    method: 'GET'
+  },
+
+  /**
+   * Feed
+   */
+  MainFeed: {
+    url: (0, _utils.urlReplacer)('/api/v2/feed/'),
+    method: 'GET'
+  },
+  MainFeedUnseenCount: {
+    url: (0, _utils.urlReplacer)('/api/v2/feed/unseen/count/'),
+    method: 'GET'
+  },
+  FeedObjectMarkRead: {
+    url: (0, _utils.urlReplacer)('/api/v2/feed/read/'),
+    method: 'POST'
+  },
+  ExploreFeed: {
+    url: (0, _utils.urlReplacer)('/api/v2/feed/explore/'),
+    method: 'GET'
+  },
+  FeedLikeThese: {
+    url: (0, _utils.urlReplacer)('/api/v2/feed/likethis/'),
+    method: 'POST'
+  },
+  CategoryFeed: {
+    url: (0, _utils.urlReplacer)('/api/v2/category/$(id)/feed/'),
+    method: 'GET'
+  },
+  UserFeed: {
+    url: (0, _utils.urlReplacer)('/api/v2/user/$(id)/feed/'),
+    method: 'GET'
+  },
+  EmbedFeed: {
+    url: (0, _utils.urlReplacer)('/api/v2/embed/feed/'),
+    method: 'GET'
+  },
+
+  /**
+   * Private Messages Endpoints
+   */
+  GetSnippets: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/'),
+    method: 'GET'
+  },
+  GetASingleMessage: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/$(id)/'),
+    method: 'GET'
+  },
+  SendMessage: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/'),
+    method: 'POST'
+  },
+  GetAThread: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/'),
+    method: 'GET'
+  },
+  PrivateMessageUploadMediaInChunks: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/upload/'),
+    method: 'POST'
+  },
+  PrivateMessageChunkUploadDone: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/upload/?done'),
+    method: 'POST'
+  },
+  DeleteASingleMessage: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/$(id)/'),
+    method: 'DELETE'
+  },
+  DeleteAThread: {
+    url: (0, _utils.urlReplacer)('/api/v2/pm/$(id)/?hide=1'),
+    method: 'DELETE'
+  },
+
+  /**
+   * Device
+   */
+  Device: {
+    url: (0, _utils.urlReplacer)('/api/v2/device/$(type)/$(id)/'),
+    method: 'GET'
+  },
+  NewDevice: {
+    url: (0, _utils.urlReplacer)('/api/v2/device/$(type)/'),
+    method: 'POST'
+  },
+  DeleteDevice: {
+    url: (0, _utils.urlReplacer)('/api/v2/device/$(type)/$(id)/'),
+    method: 'DELETE'
+  },
+
+  /**
+   * Moderation
+   */
+  ModerateContribution: {
+    url: (0, _utils.urlReplacer)('/api/v2/moderation/contribution/$(id)/'),
+    method: 'PATCH'
+  },
+
+  /**
+   * Moderation
+   */
+  ModerateContributionStatus: {
+    url: (0, _utils.urlReplacer)('/api/v2/moderation/contribution/$(id)/status/?contribution_type=$(contribution_type)'),
+    method: 'GET'
+  },
+
+  /**
+   * Insights
+   **/
+  InsightBestContribution: {
+    url: (0, _utils.urlReplacer)('/api/v2/insight/contribution/'),
+    method: 'GET'
+  },
+  InsightBestEmbed: {
+    url: (0, _utils.urlReplacer)('/api/v2/insight/embed/'),
+    method: 'GET'
+  },
+  InsightBestUser: {
+    url: (0, _utils.urlReplacer)('/api/v2/insight/user/'),
+    method: 'GET'
+  },
+  InsightContributionCounter: {
+    url: (0, _utils.urlReplacer)('/api/v2/insight/contribution/counters/?contribution_id=$(id)'),
+    method: 'GET'
+  },
+  InsightEmbedCounter: {
+    url: (0, _utils.urlReplacer)('/api/v2/insight/embed/counters/?embed_type=$(type)&embed_id=$(id)'),
+    method: 'GET'
+  },
+  InsightUserCounter: {
+    url: (0, _utils.urlReplacer)('/api/v2/insight/user/counters/?user_id=$(id)'),
+    method: 'GET'
+  },
+
+  /**
+   * Incubators
+   */
+  GetAllIncubators: {
+    url: (0, _utils.urlReplacer)('/api/v2/incubator/'),
+    method: 'GET'
+  },
+  GetIncubatorSuggestion: {
+    url: (0, _utils.urlReplacer)('/api/v2/suggestion/incubator/'),
+    method: 'GET'
+  },
+  GetASpecificIncubator: {
+    url: (0, _utils.urlReplacer)('/api/v2/incubator/$(id)/'),
+    method: 'GET'
+  },
+  CheckIncubatorSubscription: {
+    url: (0, _utils.urlReplacer)('/api/v2/incubator/$(id)/subscribed/'),
+    method: 'GET'
+  },
+  SubscribeToIncubator: {
+    url: (0, _utils.urlReplacer)('/api/v2/incubator/$(id)/subscribe/'),
+    method: 'POST'
+  },
+  CreateAnIncubator: {
+    url: (0, _utils.urlReplacer)('/api/v2/incubator/'),
+    method: 'POST'
+  },
+  GetIncubatorSubscribers: {
+    url: (0, _utils.urlReplacer)('/api/v2/incubator/$(id)/subscribers/'),
+    method: 'GET'
+  },
+
+  /**
+   * Footer
+   */
+  GetCustomPages: {
+    url: (0, _utils.urlReplacer)('/api/v2/custom_page/'),
+    method: 'GET'
+  },
+  GetLegalPages: {
+    url: (0, _utils.urlReplacer)('/api/v2/legal_page/'),
+    method: 'GET'
+  },
+
+  /**
+   * Media
+   */
+  MediaClickTracker: {
+    url: (0, _utils.urlReplacer)('/api/v2/media/$(id)/click/'),
+    method: 'POST'
+  }
+};
+var _default = Endpoints;
+exports.default = _default;

package/lib/cjs/index.d.js

@@ -0,0 +1,2 @@
+/* eslint-disable global-require */
+"use strict";

package/lib/cjs/index.js

@@ -0,0 +1,46 @@
+"use strict";
+
+exports.__esModule = true;
+
+var _client = _interopRequireWildcard(require("./client"));
+
+exports.http = _client.default;
+exports.HttpResponse = _client.HttpResponse;
+exports.HttpMethod = _client.HttpMethod;
+
+var _Endpoints = _interopRequireWildcard(require("./constants/Endpoints"));
+
+exports.Endpoints = _Endpoints.default;
+exports.EndpointType = _Endpoints.EndpointType;
+
+var _http = require("./utils/http");
+
+exports.formatHttpError = _http.formatHttpError;
+
+var _preference = _interopRequireWildcard(require("./services/preference"));
+
+exports.PreferenceService = _preference.default;
+exports.PreferenceApiClient = _preference.PreferenceApiClient;
+exports.PreferenceApiClientInterface = _preference.PreferenceApiClientInterface;
+
+var _user = _interopRequireWildcard(require("./services/user"));
+
+exports.UserService = _user.default;
+exports.UserApiClient = _user.UserApiClient;
+exports.UserApiClientInterface = _user.UserApiClientInterface;
+
+var _feature = _interopRequireWildcard(require("./services/feature"));
+
+exports.FeatureService = _feature.default;
+exports.FeatureApiClient = _feature.FeatureApiClient;
+exports.FeatureApiClientInterface = _feature.FeatureApiClientInterface;
+
+var _category = _interopRequireWildcard(require("./services/category"));
+
+exports.CategoryService = _category.default;
+exports.CategoryApiClient = _category.CategoryApiClient;
+exports.CategoryApiClientInterface = _category.CategoryApiClientInterface;
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }