@selfcommunity/api-services 1.0.19 → 1.1.0-alpha.0

package/lib/cjs/constants/Endpoints.js

@@ -1155,6 +1155,10 @@ const Endpoints = {
         url: (0, utils_1.urlReplacer)('/api/v2/score/'),
         method: 'POST'
     },
+    GetLeaderboards: {
+        url: (0, utils_1.urlReplacer)('/api/v2/score/leaderboard/'),
+        method: 'GET'
+    },
     /**
      * Reactions
      */

package/lib/cjs/services/score/index.d.ts

@@ -1,5 +1,5 @@
-import { SCUserScoreType } from '@selfcommunity/types';
-import { ScoreParams, SCPaginatedResponse, UserScoreParams } from '../../types';
+import { SCUserLeaderboardType, SCUserScoreType } from '@selfcommunity/types';
+import { ScoreParams, SCPaginatedResponse, UserScoreParams, LeaderboardParams } from '../../types';
 import { AxiosRequestConfig } from 'axios';
 export interface ScoreApiClientInterface {
     getAllScores(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
@@ -28,6 +28,14 @@ export declare class ScoreApiClient {
      * @param config
      */
     static addScore(data: UserScoreParams, config?: AxiosRequestConfig): Promise<SCUserScoreType>;
+    /**
+     * Fetches a list of user leaderboards based on the provided parameters.
+     *
+     * @param {LeaderboardParams} [params] - Optional query parameters for filtering and pagination of the leaderboards.
+     * @param {AxiosRequestConfig} [config] - Optional Axios request configuration object for customizing the API request.
+     * @return {Promise<SCUserLeaderboardType>} A promise that resolves to a paginated response containing the user leaderboard data.
+     */
+    static getLeaderboards(params?: LeaderboardParams, config?: AxiosRequestConfig): Promise<SCUserLeaderboardType>;
 }
 /**
  *
@@ -61,4 +69,5 @@ export default class ScoreService {
     static getAllScores(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
     static searchScore(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
     static addScore(data: UserScoreParams, config?: AxiosRequestConfig): Promise<SCUserScoreType>;
+    static getLeaderboards(params?: LeaderboardParams, config?: AxiosRequestConfig): Promise<SCUserLeaderboardType>;
 }

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

@@ -35,6 +35,17 @@ class ScoreApiClient {
     static addScore(data, config) {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.AddScore.url({}), method: Endpoints_1.default.AddScore.method, data: data }));
     }
+    /**
+     * Fetches a list of user leaderboards based on the provided parameters.
+     *
+     * @param {LeaderboardParams} [params] - Optional query parameters for filtering and pagination of the leaderboards.
+     * @param {AxiosRequestConfig} [config] - Optional Axios request configuration object for customizing the API request.
+     * @return {Promise<SCUserLeaderboardType>} A promise that resolves to a paginated response containing the user leaderboard data.
+     */
+    static getLeaderboards(params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.GetLeaderboards.url({})}?${p.toString()}`, method: Endpoints_1.default.GetLeaderboards.method }));
+    }
 }
 exports.ScoreApiClient = ScoreApiClient;
 /**
@@ -81,5 +92,10 @@ class ScoreService {
             return ScoreApiClient.addScore(data, config);
         });
     }
+    static getLeaderboards(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return ScoreApiClient.getLeaderboards(params, config);
+        });
+    }
 }
 exports.default = ScoreService;

package/lib/cjs/types/index.d.ts

@@ -7,7 +7,7 @@ import { IncubatorCreateParams, IncubatorSearchParams } from './incubator';
 import { LoyaltyPrizeParams, LoyaltyGetPrizeParams } from './prize';
 import { ModerationParams, ModerateContributionParams, FlaggedContributionParams } from './moderation';
 import { CustomNotificationParams } from './notification';
-import { UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams } from './user';
+import { UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, LeaderboardParams } from './user';
 import { TagParams, TagGetParams } from './tag';
 import { MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams } from './media';
 import { ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, ThreadDeleteParams } from './privateMessage';
@@ -30,4 +30,4 @@ import { StartStepParams, OnBoardingStep } from './onBoarding';
 import { CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams } from './course';
 import { PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams } from './payment';
 import { ContactUsRequestParams } from './contactUs';
-export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams, ContactUsRequestParams };
+export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, LeaderboardParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams, ContactUsRequestParams };

package/lib/cjs/types/user.d.ts

@@ -49,6 +49,27 @@ export interface UserScoreParams {
      */
     user: number;
 }
+/**
+ * interface LeaderboardParams
+ */
+export interface LeaderboardParams extends BaseGetParams {
+    /**
+     * Represents the starting timestamp or date from which a reputation-related event or status is considered.
+     * This property is optional and may not always be present.
+     * Expected to be in string format, typically representing a valid date or datetime.
+     */
+    reputed_at_from?: string;
+    /**
+     * An optional property representing the timestamp or date string to which
+     * the "reputed at" status is applicable. Typically used to denote an end time
+     * or boundary in contexts where a reputation or status is evaluated over a period.
+     */
+    reputed_at_to?: string;
+    /**
+     * Filter the results based on tag or campaign
+     */
+    search_reputation_context?: string;
+}
 export interface UserGetParams extends BaseGetParams {
     mutual?: number;
 }

package/lib/esm/constants/Endpoints.js

@@ -1153,6 +1153,10 @@ const Endpoints = {
         url: urlReplacer('/api/v2/score/'),
         method: 'POST'
     },
+    GetLeaderboards: {
+        url: urlReplacer('/api/v2/score/leaderboard/'),
+        method: 'GET'
+    },
     /**
      * Reactions
      */

package/lib/esm/services/score/index.d.ts

@@ -1,5 +1,5 @@
-import { SCUserScoreType } from '@selfcommunity/types';
-import { ScoreParams, SCPaginatedResponse, UserScoreParams } from '../../types';
+import { SCUserLeaderboardType, SCUserScoreType } from '@selfcommunity/types';
+import { ScoreParams, SCPaginatedResponse, UserScoreParams, LeaderboardParams } from '../../types';
 import { AxiosRequestConfig } from 'axios';
 export interface ScoreApiClientInterface {
     getAllScores(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
@@ -28,6 +28,14 @@ export declare class ScoreApiClient {
      * @param config
      */
     static addScore(data: UserScoreParams, config?: AxiosRequestConfig): Promise<SCUserScoreType>;
+    /**
+     * Fetches a list of user leaderboards based on the provided parameters.
+     *
+     * @param {LeaderboardParams} [params] - Optional query parameters for filtering and pagination of the leaderboards.
+     * @param {AxiosRequestConfig} [config] - Optional Axios request configuration object for customizing the API request.
+     * @return {Promise<SCUserLeaderboardType>} A promise that resolves to a paginated response containing the user leaderboard data.
+     */
+    static getLeaderboards(params?: LeaderboardParams, config?: AxiosRequestConfig): Promise<SCUserLeaderboardType>;
 }
 /**
  *
@@ -61,4 +69,5 @@ export default class ScoreService {
     static getAllScores(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
     static searchScore(params?: ScoreParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserScoreType>>;
     static addScore(data: UserScoreParams, config?: AxiosRequestConfig): Promise<SCUserScoreType>;
+    static getLeaderboards(params?: LeaderboardParams, config?: AxiosRequestConfig): Promise<SCUserLeaderboardType>;
 }

package/lib/esm/services/score/index.js

@@ -32,6 +32,17 @@ export class ScoreApiClient {
     static addScore(data, config) {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.AddScore.url({}), method: Endpoints.AddScore.method, data: data }));
     }
+    /**
+     * Fetches a list of user leaderboards based on the provided parameters.
+     *
+     * @param {LeaderboardParams} [params] - Optional query parameters for filtering and pagination of the leaderboards.
+     * @param {AxiosRequestConfig} [config] - Optional Axios request configuration object for customizing the API request.
+     * @return {Promise<SCUserLeaderboardType>} A promise that resolves to a paginated response containing the user leaderboard data.
+     */
+    static getLeaderboards(params, config) {
+        const p = urlParams(params);
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetLeaderboards.url({})}?${p.toString()}`, method: Endpoints.GetLeaderboards.method }));
+    }
 }
 /**
  *
@@ -77,4 +88,9 @@ export default class ScoreService {
             return ScoreApiClient.addScore(data, config);
         });
     }
+    static getLeaderboards(params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return ScoreApiClient.getLeaderboards(params, config);
+        });
+    }
 }

package/lib/esm/types/index.d.ts

@@ -7,7 +7,7 @@ import { IncubatorCreateParams, IncubatorSearchParams } from './incubator';
 import { LoyaltyPrizeParams, LoyaltyGetPrizeParams } from './prize';
 import { ModerationParams, ModerateContributionParams, FlaggedContributionParams } from './moderation';
 import { CustomNotificationParams } from './notification';
-import { UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams } from './user';
+import { UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, LeaderboardParams } from './user';
 import { TagParams, TagGetParams } from './tag';
 import { MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams } from './media';
 import { ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, ThreadDeleteParams } from './privateMessage';
@@ -30,4 +30,4 @@ import { StartStepParams, OnBoardingStep } from './onBoarding';
 import { CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams } from './course';
 import { PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams } from './payment';
 import { ContactUsRequestParams } from './contactUs';
-export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams, ContactUsRequestParams };
+export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, LeaderboardParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams, ContactUsRequestParams };

package/lib/esm/types/user.d.ts

@@ -49,6 +49,27 @@ export interface UserScoreParams {
      */
     user: number;
 }
+/**
+ * interface LeaderboardParams
+ */
+export interface LeaderboardParams extends BaseGetParams {
+    /**
+     * Represents the starting timestamp or date from which a reputation-related event or status is considered.
+     * This property is optional and may not always be present.
+     * Expected to be in string format, typically representing a valid date or datetime.
+     */
+    reputed_at_from?: string;
+    /**
+     * An optional property representing the timestamp or date string to which
+     * the "reputed at" status is applicable. Typically used to denote an end time
+     * or boundary in contexts where a reputation or status is evaluated over a period.
+     */
+    reputed_at_to?: string;
+    /**
+     * Filter the results based on tag or campaign
+     */
+    search_reputation_context?: string;
+}
 export interface UserGetParams extends BaseGetParams {
     mutual?: number;
 }