@selfcommunity/api-services 0.4.55 → 0.5.0-alpha.0

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

@@ -1,11 +1,12 @@
 import { BaseGetParams, SCPaginatedResponse } from '../../types';
-import { SCCategoryType, SCFeedObjectType, SCIncubatorType, SCSuggestionType, SCUserType } from '@selfcommunity/types';
+import { SCCategoryType, SCEventType, SCFeedObjectType, SCIncubatorType, SCSuggestionType, SCUserType } from '@selfcommunity/types';
 import { AxiosRequestConfig } from 'axios';
 export interface SuggestionApiClientInterface {
     getCategorySuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCategoryType>>;
     getIncubatorSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCIncubatorType>>;
     getPollSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFeedObjectType>>;
     getUserSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    getEventSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCEventType>>;
     getSearchSuggestion(search: string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCSuggestionType>>;
 }
 /**
@@ -36,6 +37,12 @@ export declare class SuggestionApiClient {
      * @param config
      */
     static getUserSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    /**
+     * This endpoint retrieves a list of events suggested to the current user.
+     * @param params
+     * @param config
+     */
+    static getEventSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCEventType>>;
     /**
      * This endpoint retrieves a list of users suggested to the current user.
      * @param search
@@ -77,5 +84,6 @@ export default class SuggestionService {
     static getIncubatorSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCIncubatorType>>;
     static getPollSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFeedObjectType>>;
     static getUserSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
+    static getEventSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCEventType>>;
     static getSearchSuggestion(search: string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCSuggestionType>>;
 }

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

@@ -38,6 +38,14 @@ export class SuggestionApiClient {
     static getUserSuggestion(params, config) {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserSuggestion.url({}), method: Endpoints.UserSuggestion.method, params }));
     }
+    /**
+     * This endpoint retrieves a list of events suggested to the current user.
+     * @param params
+     * @param config
+     */
+    static getEventSuggestion(params, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.EventSuggestion.url({}), method: Endpoints.EventSuggestion.method, params }));
+    }
     /**
      * This endpoint retrieves a list of users suggested to the current user.
      * @param search
@@ -98,6 +106,11 @@ export default class SuggestionService {
             return SuggestionApiClient.getUserSuggestion(params, config);
         });
     }
+    static getEventSuggestion(params, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return SuggestionApiClient.getEventSuggestion(params, config);
+        });
+    }
     static getSearchSuggestion(search, params, config) {
         return __awaiter(this, void 0, void 0, function* () {
             return SuggestionApiClient.getSearchSuggestion(search, params, config);

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

@@ -0,0 +1,108 @@
+/**
+ * EventCreateParams interface
+ */
+import { SCEventDateFilterType, SCEventPrivacyType, SCEventRecurrenceType, SCEventSubscriptionStatusType } from '@selfcommunity/types';
+import { BaseGetParams, BaseSearchParams } from './baseParams';
+import { SCEventLocationType } from '@selfcommunity/types/src/types/event';
+export interface EventCreateParams {
+    /**
+     * A unique name for the group
+     */
+    name: string;
+    /**
+     * The group privacy
+     */
+    privacy: SCEventPrivacyType;
+    /**
+     * The group visibility. It is required when privacy = private.
+     */
+    visible?: boolean;
+    /**
+     * The group description
+     */
+    description?: string;
+    /**
+     * The event starting date and time
+     */
+    start_date: string;
+    /**
+     * The group ending date and time
+     */
+    end_date?: string;
+    /**
+     * The users to invite to the group
+     */
+    invite_users?: number[];
+    /**
+     * The event image
+     */
+    image_original?: File;
+    /**
+     * The event location
+     */
+    location: SCEventLocationType;
+    /**
+     * The event exact point
+     */
+    geolocation: string;
+    /**
+     * The event latitude
+     */
+    geolocation_lat: number;
+    /**
+     * The event longitude
+     */
+    geolocation_lng: number;
+    /**
+     * The event recurrency
+     */
+    recurring?: SCEventRecurrenceType;
+}
+/**
+ * EventFeedParams interface.
+ */
+export interface EventFeedParams extends BaseGetParams {
+    /**
+     * Which field to use when ordering the results.
+     */
+    ordering?: string;
+}
+/**
+ * EventRelatedParams interface.
+ */
+export interface EventRelatedParams extends BaseGetParams {
+    /**
+     * Filter results by created_by user id.
+     */
+    created_by?: number;
+}
+/**
+ * EventUserParams interface.
+ */
+export interface EventUserParams extends BaseGetParams {
+    /**
+     * Filter results by subscription_status
+     */
+    subscription_status?: SCEventSubscriptionStatusType;
+    /**
+     *  Filtered past events
+     */
+    past?: boolean | number;
+}
+/**
+ * EventFeedParams interface.
+ */
+export interface EventSearchParams extends BaseSearchParams {
+    /**
+     * The events filtered by a specific time frame
+     */
+    date_filter?: SCEventDateFilterType;
+    /**
+     * The events created or followed by the users followed
+     */
+    follows?: boolean | number;
+    /**
+     * Filtered past events
+     */
+    past?: boolean | number;
+}

package/lib/esm/types/event.js

@@ -0,0 +1 @@
+export {};

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

@@ -24,4 +24,6 @@ import { ScoreParams } from './score';
 import { InsightCommonParams, InsightEmbedParams, InsightUserParams, InsightContributionParams } from './insight';
 import { ReactionParams } from './reaction';
 import { GroupCreateParams, GroupFeedParams } from './group';
-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, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams };
+import { EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams } from './event';
+import { StartStepParams, OnBoardingStep } from './onBoarding';
+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, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, StartStepParams, OnBoardingStep };

package/lib/esm/types/index.js

@@ -1,2 +1,3 @@
 import { MediaTypes } from './media';
-export { MediaTypes };
+import { OnBoardingStep } from './onBoarding';
+export { MediaTypes, OnBoardingStep };

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

@@ -0,0 +1,30 @@
+/**
+ * StartStepParams interface
+ */
+export interface StartStepParams {
+    /**
+     * The number of the post to generate.
+     * @default 10
+     */
+    num_posts?: number;
+    /**
+     * The number of the post images to generate
+     * @default 1
+     */
+    num_images?: number;
+    /**
+     * only for stage
+     */
+    force?: number;
+}
+/**
+ * OnBoardingStepType enum
+ */
+export declare enum OnBoardingStep {
+    CONTENTS = 1,
+    CATEGORIES = 2,
+    APPEARANCE = 3,
+    PROFILE = 4,
+    INVITE = 5,
+    APP = 6
+}

package/lib/esm/types/onBoarding.js

@@ -0,0 +1,15 @@
+/**
+ * StartStepParams interface
+ */
+/**
+ * OnBoardingStepType enum
+ */
+export var OnBoardingStep;
+(function (OnBoardingStep) {
+    OnBoardingStep[OnBoardingStep["CONTENTS"] = 1] = "CONTENTS";
+    OnBoardingStep[OnBoardingStep["CATEGORIES"] = 2] = "CATEGORIES";
+    OnBoardingStep[OnBoardingStep["APPEARANCE"] = 3] = "APPEARANCE";
+    OnBoardingStep[OnBoardingStep["PROFILE"] = 4] = "PROFILE";
+    OnBoardingStep[OnBoardingStep["INVITE"] = 5] = "INVITE";
+    OnBoardingStep[OnBoardingStep["APP"] = 6] = "APP";
+})(OnBoardingStep || (OnBoardingStep = {}));