@selfcommunity/types 0.7.4-alpha.1 → 0.7.4-courses.147
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.
- package/lib/cjs/index.d.ts +4 -4
- package/lib/cjs/index.js +10 -1
- package/lib/cjs/types/course.d.ts +369 -0
- package/lib/cjs/types/course.js +58 -0
- package/lib/cjs/types/event.d.ts +7 -1
- package/lib/cjs/types/event.js +1 -0
- package/lib/cjs/types/feature.d.ts +3 -1
- package/lib/cjs/types/feature.js +2 -0
- package/lib/cjs/types/index.d.ts +5 -2
- package/lib/cjs/types/index.js +13 -1
- package/lib/cjs/types/liveStream.d.ts +55 -0
- package/lib/cjs/types/liveStream.js +17 -0
- package/lib/cjs/types/notification.d.ts +17 -3
- package/lib/cjs/types/notification.js +5 -0
- package/lib/cjs/types/preference.d.ts +9 -1
- package/lib/cjs/types/preference.js +8 -0
- package/lib/cjs/types/tier.d.ts +9 -0
- package/lib/cjs/types/tier.js +13 -0
- package/lib/cjs/types/user.d.ts +1 -1
- package/lib/esm/index.d.ts +4 -4
- package/lib/esm/index.js +2 -2
- package/lib/esm/types/course.d.ts +369 -0
- package/lib/esm/types/course.js +55 -0
- package/lib/esm/types/event.d.ts +7 -1
- package/lib/esm/types/event.js +1 -0
- package/lib/esm/types/feature.d.ts +3 -1
- package/lib/esm/types/feature.js +2 -0
- package/lib/esm/types/index.d.ts +5 -2
- package/lib/esm/types/index.js +4 -1
- package/lib/esm/types/liveStream.d.ts +55 -0
- package/lib/esm/types/liveStream.js +14 -0
- package/lib/esm/types/notification.d.ts +17 -3
- package/lib/esm/types/notification.js +5 -0
- package/lib/esm/types/preference.d.ts +9 -1
- package/lib/esm/types/preference.js +8 -0
- package/lib/esm/types/tier.d.ts +9 -0
- package/lib/esm/types/tier.js +10 -0
- package/lib/esm/types/user.d.ts +1 -1
- package/lib/umd/types.js +1 -1
- package/package.json +108 -103
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { SCUserType } from './user';
|
|
2
|
+
import { SCEventType } from './event';
|
|
3
|
+
export interface SCLiveStreamType {
|
|
4
|
+
id?: number;
|
|
5
|
+
title: string;
|
|
6
|
+
description?: string;
|
|
7
|
+
created_at?: Date | string;
|
|
8
|
+
last_started_at?: Date | string;
|
|
9
|
+
last_finished_at?: Date | string;
|
|
10
|
+
closed_at_by_host?: Date | string;
|
|
11
|
+
slug?: string;
|
|
12
|
+
roomName?: string;
|
|
13
|
+
settings?: Record<string, any>;
|
|
14
|
+
host?: SCUserType;
|
|
15
|
+
cover?: string;
|
|
16
|
+
event?: SCEventType;
|
|
17
|
+
}
|
|
18
|
+
export declare enum SCLiveStreamViewType {
|
|
19
|
+
GALLERY = "gallery",
|
|
20
|
+
SPEAKER = "speaker"
|
|
21
|
+
}
|
|
22
|
+
export interface SCLiveStreamConnectionDetailsType {
|
|
23
|
+
serverUrl: string;
|
|
24
|
+
roomName: string;
|
|
25
|
+
participantToken: string;
|
|
26
|
+
}
|
|
27
|
+
export declare enum SCLiveStreamConnectionDetailsErrorType {
|
|
28
|
+
LIVE_STREAM_IS_CLOSED = "LIVE_STREAM_IS_CLOSED",
|
|
29
|
+
MONTHLY_MINUTE_LIMIT_REACHED = "MONTHLY_MINUTE_LIMIT_REACHED",
|
|
30
|
+
WAITING_HOST_TO_START_LIVE_STREAM = "WAITING_HOST_TO_START_LIVE_STREAM",
|
|
31
|
+
PARTICIPANTS_LIMIT_REACHED = "PARTICIPANTS_LIMIT_REACHED",
|
|
32
|
+
PARTICIPATE_THE_EVENT_TO_JOIN_LIVE_STREAM = "PARTICIPATE_THE_EVENT_TO_JOIN_LIVE_STREAM",
|
|
33
|
+
USER_BANNED_FOR_THIS_LIVE_STREAM = "USER_BANNED_FOR_THIS_LIVE_STREAM"
|
|
34
|
+
}
|
|
35
|
+
export interface SCLiveStreamConnectionDetailsResponseErrorType {
|
|
36
|
+
errors: [{
|
|
37
|
+
code: SCLiveStreamConnectionDetailsErrorType;
|
|
38
|
+
}];
|
|
39
|
+
}
|
|
40
|
+
export interface SCLiveStreamSettingsType {
|
|
41
|
+
muteParticipants?: boolean;
|
|
42
|
+
disableVideo?: boolean;
|
|
43
|
+
disableChat?: boolean;
|
|
44
|
+
disableShareScreen?: boolean;
|
|
45
|
+
hideParticipantsList?: boolean;
|
|
46
|
+
automaticallyNotifyFollowers?: boolean;
|
|
47
|
+
showInProfile?: boolean;
|
|
48
|
+
view?: SCLiveStreamViewType;
|
|
49
|
+
}
|
|
50
|
+
export interface SCLiveStreamMonthlyDurationType {
|
|
51
|
+
duration_total_minutes: number;
|
|
52
|
+
max_minutes: number;
|
|
53
|
+
remaining_minutes: number;
|
|
54
|
+
minutes_exausted: boolean;
|
|
55
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SCLiveStreamConnectionDetailsErrorType = exports.SCLiveStreamViewType = void 0;
|
|
4
|
+
var SCLiveStreamViewType;
|
|
5
|
+
(function (SCLiveStreamViewType) {
|
|
6
|
+
SCLiveStreamViewType["GALLERY"] = "gallery";
|
|
7
|
+
SCLiveStreamViewType["SPEAKER"] = "speaker";
|
|
8
|
+
})(SCLiveStreamViewType = exports.SCLiveStreamViewType || (exports.SCLiveStreamViewType = {}));
|
|
9
|
+
var SCLiveStreamConnectionDetailsErrorType;
|
|
10
|
+
(function (SCLiveStreamConnectionDetailsErrorType) {
|
|
11
|
+
SCLiveStreamConnectionDetailsErrorType["LIVE_STREAM_IS_CLOSED"] = "LIVE_STREAM_IS_CLOSED";
|
|
12
|
+
SCLiveStreamConnectionDetailsErrorType["MONTHLY_MINUTE_LIMIT_REACHED"] = "MONTHLY_MINUTE_LIMIT_REACHED";
|
|
13
|
+
SCLiveStreamConnectionDetailsErrorType["WAITING_HOST_TO_START_LIVE_STREAM"] = "WAITING_HOST_TO_START_LIVE_STREAM";
|
|
14
|
+
SCLiveStreamConnectionDetailsErrorType["PARTICIPANTS_LIMIT_REACHED"] = "PARTICIPANTS_LIMIT_REACHED";
|
|
15
|
+
SCLiveStreamConnectionDetailsErrorType["PARTICIPATE_THE_EVENT_TO_JOIN_LIVE_STREAM"] = "PARTICIPATE_THE_EVENT_TO_JOIN_LIVE_STREAM";
|
|
16
|
+
SCLiveStreamConnectionDetailsErrorType["USER_BANNED_FOR_THIS_LIVE_STREAM"] = "USER_BANNED_FOR_THIS_LIVE_STREAM";
|
|
17
|
+
})(SCLiveStreamConnectionDetailsErrorType = exports.SCLiveStreamConnectionDetailsErrorType || (exports.SCLiveStreamConnectionDetailsErrorType = {}));
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { SCCommentType, SCEventType, SCFeedDiscussionType, SCFeedPostType, SCFeedStatusType, SCGroupType, SCUserType } from '../index';
|
|
1
|
+
import { SCCommentType, SCEventType, SCFeedDiscussionType, SCFeedPostType, SCFeedStatusType, SCGroupType, SCLiveStreamType, SCUserType } from '../index';
|
|
2
2
|
import { SCPrivateMessageThreadType } from './privateMessage';
|
|
3
3
|
import { SCUserBlockedSettingsType } from './user';
|
|
4
4
|
import { SCCustomNotificationType } from './customNotification';
|
|
@@ -52,7 +52,12 @@ export declare enum SCNotificationTypologyType {
|
|
|
52
52
|
USER_INVITED_TO_JOIN_EVENT = "user_invited_to_join_event",
|
|
53
53
|
USER_REQUESTED_TO_JOIN_EVENT = "user_requested_to_join_event",
|
|
54
54
|
USER_ACCEPTED_TO_JOIN_EVENT = "user_accepted_to_join_event",
|
|
55
|
-
USER_ADDED_TO_EVENT = "user_added_to_event"
|
|
55
|
+
USER_ADDED_TO_EVENT = "user_added_to_event",
|
|
56
|
+
LIVE_STREAM_STARTED = "live_stream_started",
|
|
57
|
+
USER_INVITED_TO_JOIN_COURSE = "user_invited_to_join_course",
|
|
58
|
+
USER_REQUESTED_TO_JOIN_COURSE = "user_requested_to_join_course",
|
|
59
|
+
USER_ACCEPTED_TO_JOIN_COURSE = "user_accepted_to_join_course",
|
|
60
|
+
USER_ADDED_TO_COURSE = "user_added_to_course"
|
|
56
61
|
}
|
|
57
62
|
/**
|
|
58
63
|
* Define topic for notifications
|
|
@@ -478,7 +483,16 @@ export interface SCNotificationEventActivityType extends SCNotificationType {
|
|
|
478
483
|
*/
|
|
479
484
|
user: SCUserType;
|
|
480
485
|
/**
|
|
481
|
-
* The
|
|
486
|
+
* The event obj
|
|
482
487
|
*/
|
|
483
488
|
event: Partial<SCEventType>;
|
|
484
489
|
}
|
|
490
|
+
/**
|
|
491
|
+
* Interface SCNotificationGroupActivityType.
|
|
492
|
+
*/
|
|
493
|
+
export interface SCNotificationLiveStreamActivityType extends SCNotificationType {
|
|
494
|
+
/**
|
|
495
|
+
* The LiveStream obj
|
|
496
|
+
*/
|
|
497
|
+
live_stream: Partial<SCLiveStreamType>;
|
|
498
|
+
}
|
|
@@ -52,6 +52,11 @@ var SCNotificationTypologyType;
|
|
|
52
52
|
SCNotificationTypologyType["USER_REQUESTED_TO_JOIN_EVENT"] = "user_requested_to_join_event";
|
|
53
53
|
SCNotificationTypologyType["USER_ACCEPTED_TO_JOIN_EVENT"] = "user_accepted_to_join_event";
|
|
54
54
|
SCNotificationTypologyType["USER_ADDED_TO_EVENT"] = "user_added_to_event";
|
|
55
|
+
SCNotificationTypologyType["LIVE_STREAM_STARTED"] = "live_stream_started";
|
|
56
|
+
SCNotificationTypologyType["USER_INVITED_TO_JOIN_COURSE"] = "user_invited_to_join_course";
|
|
57
|
+
SCNotificationTypologyType["USER_REQUESTED_TO_JOIN_COURSE"] = "user_requested_to_join_course";
|
|
58
|
+
SCNotificationTypologyType["USER_ACCEPTED_TO_JOIN_COURSE"] = "user_accepted_to_join_course";
|
|
59
|
+
SCNotificationTypologyType["USER_ADDED_TO_COURSE"] = "user_added_to_course";
|
|
55
60
|
})(SCNotificationTypologyType = exports.SCNotificationTypologyType || (exports.SCNotificationTypologyType = {}));
|
|
56
61
|
/**
|
|
57
62
|
* Define topic for notifications
|
|
@@ -103,6 +103,7 @@ export declare enum SCPreferenceName {
|
|
|
103
103
|
URL_TEMPLATE_NOTIFICATIONS = "url_template_notifications",
|
|
104
104
|
URL_TEMPLATE_USER_PRIVATE_MESSAGES = "url_template_private_message",
|
|
105
105
|
URL_TEMPLATE_INCUBATOR = "url_template_incubator",
|
|
106
|
+
URL_TEMPLATE_LIVE_STREAM = "url_template_live_stream",
|
|
106
107
|
APP_URL = "app_url",
|
|
107
108
|
USER_METADATA_DEFINITIONS = "user_metadata_definition",
|
|
108
109
|
TAG_MANAGER_CONTAINER_ID = "tag_manager_container_id",
|
|
@@ -136,8 +137,15 @@ export declare enum SCPreferenceName {
|
|
|
136
137
|
EVENTS_VISIBILITY_ENABLED = "events_visibility_enabled",
|
|
137
138
|
EVENTS_PRIVATE_ENABLED = "events_private_enabled",
|
|
138
139
|
EVENTS_ONLY_STAFF_ENABLED = "events_only_staff_enabled",
|
|
140
|
+
COURSES_ENABLED = "courses_enabled",
|
|
141
|
+
COURSES_VISIBILITY_ENABLED = "courses_visibility_enabled",
|
|
142
|
+
COURSES_PRIVATE_ENABLED = "courses_private_enabled",
|
|
143
|
+
COURSES_ONLY_STAFF_ENABLED = "courses_only_staff_enabled",
|
|
144
|
+
LIVE_STREAM_ENABLED = "live_stream_enabled",
|
|
145
|
+
LIVE_STREAM_ONLY_STAFF_ENABLED = "live_stream_only_staff_enabled",
|
|
139
146
|
ONBOARDING_ENABLED = "onboarding_enabled",
|
|
140
|
-
ONBOARDING_HIDDEN = "onboarding_hidden"
|
|
147
|
+
ONBOARDING_HIDDEN = "onboarding_hidden",
|
|
148
|
+
SUBSCRIPTION_TIER = "subscription_tier"
|
|
141
149
|
}
|
|
142
150
|
/**
|
|
143
151
|
* SCPreferenceType interface
|
|
@@ -108,6 +108,7 @@ var SCPreferenceName;
|
|
|
108
108
|
SCPreferenceName["URL_TEMPLATE_NOTIFICATIONS"] = "url_template_notifications";
|
|
109
109
|
SCPreferenceName["URL_TEMPLATE_USER_PRIVATE_MESSAGES"] = "url_template_private_message";
|
|
110
110
|
SCPreferenceName["URL_TEMPLATE_INCUBATOR"] = "url_template_incubator";
|
|
111
|
+
SCPreferenceName["URL_TEMPLATE_LIVE_STREAM"] = "url_template_live_stream";
|
|
111
112
|
SCPreferenceName["APP_URL"] = "app_url";
|
|
112
113
|
SCPreferenceName["USER_METADATA_DEFINITIONS"] = "user_metadata_definition";
|
|
113
114
|
SCPreferenceName["TAG_MANAGER_CONTAINER_ID"] = "tag_manager_container_id";
|
|
@@ -141,6 +142,13 @@ var SCPreferenceName;
|
|
|
141
142
|
SCPreferenceName["EVENTS_VISIBILITY_ENABLED"] = "events_visibility_enabled";
|
|
142
143
|
SCPreferenceName["EVENTS_PRIVATE_ENABLED"] = "events_private_enabled";
|
|
143
144
|
SCPreferenceName["EVENTS_ONLY_STAFF_ENABLED"] = "events_only_staff_enabled";
|
|
145
|
+
SCPreferenceName["COURSES_ENABLED"] = "courses_enabled";
|
|
146
|
+
SCPreferenceName["COURSES_VISIBILITY_ENABLED"] = "courses_visibility_enabled";
|
|
147
|
+
SCPreferenceName["COURSES_PRIVATE_ENABLED"] = "courses_private_enabled";
|
|
148
|
+
SCPreferenceName["COURSES_ONLY_STAFF_ENABLED"] = "courses_only_staff_enabled";
|
|
149
|
+
SCPreferenceName["LIVE_STREAM_ENABLED"] = "live_stream_enabled";
|
|
150
|
+
SCPreferenceName["LIVE_STREAM_ONLY_STAFF_ENABLED"] = "live_stream_only_staff_enabled";
|
|
144
151
|
SCPreferenceName["ONBOARDING_ENABLED"] = "onboarding_enabled";
|
|
145
152
|
SCPreferenceName["ONBOARDING_HIDDEN"] = "onboarding_hidden";
|
|
153
|
+
SCPreferenceName["SUBSCRIPTION_TIER"] = "subscription_tier";
|
|
146
154
|
})(SCPreferenceName = exports.SCPreferenceName || (exports.SCPreferenceName = {}));
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SCCommunitySubscriptionTier = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* SelfCommunity subscription tiers
|
|
6
|
+
*/
|
|
7
|
+
var SCCommunitySubscriptionTier;
|
|
8
|
+
(function (SCCommunitySubscriptionTier) {
|
|
9
|
+
SCCommunitySubscriptionTier["FREE_TRIAL"] = "FREE_TRIAL";
|
|
10
|
+
SCCommunitySubscriptionTier["GO"] = "GO";
|
|
11
|
+
SCCommunitySubscriptionTier["PROFESSIONAL"] = "PROFESSIONAL";
|
|
12
|
+
SCCommunitySubscriptionTier["ENTERPRISE"] = "ENTERPRISE";
|
|
13
|
+
})(SCCommunitySubscriptionTier = exports.SCCommunitySubscriptionTier || (exports.SCCommunitySubscriptionTier = {}));
|
package/lib/cjs/types/user.d.ts
CHANGED
|
@@ -123,7 +123,7 @@ export interface SCUserType {
|
|
|
123
123
|
/**
|
|
124
124
|
* List of user permission. Only for the resource /user/me/.
|
|
125
125
|
*/
|
|
126
|
-
permission?:
|
|
126
|
+
permission?: Record<string, any>;
|
|
127
127
|
/**
|
|
128
128
|
* The connection status between the request user and this user.
|
|
129
129
|
*/
|
package/lib/esm/index.d.ts
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Types
|
|
3
3
|
*/
|
|
4
|
-
import { type SCBannerType, type SCBroadcastMessageType, type SCAuthTokenType, type SCCustomAdvType, type SCCustomMenuItemType, type SCCustomMenuType, type SCUserType, type SCUserSettingsType, type SCUserBlockedSettingsType, type SCUserModerationType, type SCUserScoreVariation, type SCUserScoreType, type SCUserReputationType, type SCUserAutocompleteType, type SCUserCounterType, type SCUserChangeEmailType, type SCUserAvatarType, type SCUserPermissionType, type SCUserFollowedStatusType, type SCUserFollowerStatusType, type SCUserConnectionStatusType, type SCUserHiddenStatusType, type SCUserHiddenByStatusType, type SCUserConnectionRequestType, type SCUserEmailTokenType, type SCUserProviderAssociationType, type SCMetadataType, type SCTagType, type SCCategoryType, type SCCategoryAudienceType, type SCCategoryFollowedStatusType, type SCEmbedType, type SCMediaType, type SCChunkMediaType, type SCContributionLocation, type SCLocalityType, type SCPollChoiceType, type SCPollType, type SCPollVoteType, type SCFeedUnitType, type SCFeedUnitActivityType, type SCFeedObjectType, type SCFeedPostType, type SCFeedDiscussionType, type SCFeedStatusType, type SCFeedUnseenCountType, type SCFeedObjectSuspendedStatusType, type SCFeedObjectHideStatusType, type SCFeedObjectFollowingStatusType, type SCCommentType, type SCPrivateMessageThreadType, type SCPrivateMessageSnippetType, type SCPrivateMessageFileType, type SCPrivateMessageUploadMediaType, type SCPrivateMessageUploadThumbnailType, type SCPrivateMessageUploadMediaChunkType, type SCNotificationAggregatedType, type SCNotificationCommentType, type SCNotificationConnectionAcceptType, type SCNotificationConnectionRequestType, type SCNotificationPrivateMessageType, type SCNotificationMentionType, type SCNotificationType, type SCNotificationBlockedUserType, type SCNotificationCollapsedForType, type SCNotificationCustomNotificationType, type SCNotificationDeletedForType, type SCNotificationFollowType, type SCNotificationKindlyNoticeType, type SCNotificationUnBlockedUserType, type SCNotificationUnDeletedForType, type SCNotificationUserFollowType, type SCNotificationVoteUpType, type SCCustomNotificationType, type SCNotificationUnseenCountType, type SCNotificationContributionType, type SCNotificationGroupActivityType, type SCNotificationEventActivityType, type SCIncubatorType, type SCIncubatorSubscriptionType, type SCInviteType, type SCNotificationIncubatorType, type SCPrizeType, type SCPrizeUserType, type SCPromoType, type SCUserLoyaltyPointsType, type SCWebhookEndpointType, type SCWebhookEndpointAttemptType, type SCWebhookEndpointSecretType, type SCWebhookEventsType, type SCVoteType, type SCFlagType, type SCCustomPageType, type SCDataPortabilityType, type SCPreferenceType, type SCFeatureType, type SSOSignInType, type SSOSignUpType, type SCLegalPageType, type SCLegalPageAckType, type SCContributionInsightCountersType, type SCContributionInsightType, type SCEmbedInsightType, type SCEmbedInsightCountersType, type SCUsersInsightType, type SCUsersInsightCountersType, type SCFlaggedContributionType, type SCPlatformType, type SCAvatarType, type SCReactionType, type SCDeviceType, type SCApnsDeviceType, type SCGcmDeviceType, type SCSuggestionType, type SCContributionStatus, type SCGroupType, type SCEventType, type SCStepType } from './types';
|
|
4
|
+
import { type SCBannerType, type SCBroadcastMessageType, type SCAuthTokenType, type SCCustomAdvType, type SCCustomMenuItemType, type SCCustomMenuType, type SCUserType, type SCUserSettingsType, type SCUserBlockedSettingsType, type SCUserModerationType, type SCUserScoreVariation, type SCUserScoreType, type SCUserReputationType, type SCUserAutocompleteType, type SCUserCounterType, type SCUserChangeEmailType, type SCUserAvatarType, type SCUserPermissionType, type SCUserFollowedStatusType, type SCUserFollowerStatusType, type SCUserConnectionStatusType, type SCUserHiddenStatusType, type SCUserHiddenByStatusType, type SCUserConnectionRequestType, type SCUserEmailTokenType, type SCUserProviderAssociationType, type SCMetadataType, type SCTagType, type SCCategoryType, type SCCategoryAudienceType, type SCCategoryFollowedStatusType, type SCEmbedType, type SCMediaType, type SCChunkMediaType, type SCContributionLocation, type SCLocalityType, type SCPollChoiceType, type SCPollType, type SCPollVoteType, type SCFeedUnitType, type SCFeedUnitActivityType, type SCFeedObjectType, type SCFeedPostType, type SCFeedDiscussionType, type SCFeedStatusType, type SCFeedUnseenCountType, type SCFeedObjectSuspendedStatusType, type SCFeedObjectHideStatusType, type SCFeedObjectFollowingStatusType, type SCCommentType, type SCPrivateMessageThreadType, type SCPrivateMessageSnippetType, type SCPrivateMessageFileType, type SCPrivateMessageUploadMediaType, type SCPrivateMessageUploadThumbnailType, type SCPrivateMessageUploadMediaChunkType, type SCNotificationAggregatedType, type SCNotificationCommentType, type SCNotificationConnectionAcceptType, type SCNotificationConnectionRequestType, type SCNotificationPrivateMessageType, type SCNotificationMentionType, type SCNotificationType, type SCNotificationBlockedUserType, type SCNotificationCollapsedForType, type SCNotificationCustomNotificationType, type SCNotificationDeletedForType, type SCNotificationFollowType, type SCNotificationKindlyNoticeType, type SCNotificationUnBlockedUserType, type SCNotificationUnDeletedForType, type SCNotificationUserFollowType, type SCNotificationVoteUpType, type SCCustomNotificationType, type SCNotificationUnseenCountType, type SCNotificationContributionType, type SCNotificationGroupActivityType, type SCNotificationEventActivityType, type SCNotificationLiveStreamActivityType, type SCIncubatorType, type SCIncubatorSubscriptionType, type SCInviteType, type SCNotificationIncubatorType, type SCPrizeType, type SCPrizeUserType, type SCPromoType, type SCUserLoyaltyPointsType, type SCWebhookEndpointType, type SCWebhookEndpointAttemptType, type SCWebhookEndpointSecretType, type SCWebhookEventsType, type SCVoteType, type SCFlagType, type SCCustomPageType, type SCDataPortabilityType, type SCPreferenceType, type SCFeatureType, type SSOSignInType, type SSOSignUpType, type SCLegalPageType, type SCLegalPageAckType, type SCContributionInsightCountersType, type SCContributionInsightType, type SCEmbedInsightType, type SCEmbedInsightCountersType, type SCUsersInsightType, type SCUsersInsightCountersType, type SCFlaggedContributionType, type SCPlatformType, type SCAvatarType, type SCReactionType, type SCDeviceType, type SCApnsDeviceType, type SCGcmDeviceType, type SCSuggestionType, type SCContributionStatus, type SCGroupType, type SCEventType, type SCStepType, type SCCourseType, type SCCourseCommentType, type SCCourseLessonType, type SCCourseSectionType, type SCLiveStreamType, type SCLiveStreamConnectionDetailsType, type SCLiveStreamMonthlyDurationType, type SCLiveStreamSettingsType, type SCLiveStreamConnectionDetailsResponseErrorType } from './types';
|
|
5
5
|
/**
|
|
6
6
|
* Import enums
|
|
7
7
|
*/
|
|
8
|
-
import { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType } from './types';
|
|
8
|
+
import { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType, SCCoursePrivacyType, SCCourseJoinStatusType, SCCourseLessonTypologyType, SCCourseTypologyType, SCCourseLessonStatusType, SCCourseLessonCompletionStatusType, SCLiveStreamConnectionDetailsErrorType, SCLiveStreamViewType, SCCommunitySubscriptionTier } from './types';
|
|
9
9
|
/**
|
|
10
10
|
* List all exports enums and types
|
|
11
11
|
*/
|
|
12
|
-
export { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType };
|
|
13
|
-
export { type SCBannerType, type SCBroadcastMessageType, type SCCustomAdvType, type SCCustomMenuItemType, type SCCustomMenuType, type SCAuthTokenType, type SCUserType, type SCUserSettingsType, type SCUserBlockedSettingsType, type SCUserModerationType, type SCUserScoreVariation, type SCUserScoreType, type SCUserReputationType, type SCUserAutocompleteType, type SCUserCounterType, type SCUserAvatarType, type SCUserChangeEmailType, type SCUserPermissionType, type SCUserFollowedStatusType, type SCUserFollowerStatusType, type SCUserConnectionStatusType, type SCUserHiddenStatusType, type SCUserHiddenByStatusType, type SCUserConnectionRequestType, type SCUserEmailTokenType, type SCUserProviderAssociationType, type SCMetadataType, type SCTagType, type SCCategoryType, type SCCategoryAudienceType, type SCCategoryFollowedStatusType, type SCEmbedType, type SCMediaType, type SCChunkMediaType, type SCContributionLocation, type SCLocalityType, type SCPollChoiceType, type SCPollType, type SCPollVoteType, type SCFeedUnitType, type SCFeedUnitActivityType, type SCFeedObjectType, type SCFeedPostType, type SCFeedDiscussionType, type SCFeedStatusType, type SCFeedUnseenCountType, type SCFeedObjectSuspendedStatusType, type SCFeedObjectHideStatusType, type SCFeedObjectFollowingStatusType, type SCCommentType, type SCPrivateMessageThreadType, type SCPrivateMessageSnippetType, type SCPrivateMessageFileType, type SCPrivateMessageUploadMediaType, type SCPrivateMessageUploadThumbnailType, type SCPrivateMessageUploadMediaChunkType, type SCPromoType, type SCNotificationAggregatedType, type SCNotificationCommentType, type SCNotificationConnectionAcceptType, type SCNotificationConnectionRequestType, type SCNotificationPrivateMessageType, type SCNotificationMentionType, type SCNotificationType, type SCNotificationBlockedUserType, type SCNotificationCollapsedForType, type SCNotificationCustomNotificationType, type SCNotificationDeletedForType, type SCNotificationFollowType, type SCNotificationKindlyNoticeType, type SCNotificationUnBlockedUserType, type SCNotificationUnDeletedForType, type SCNotificationUserFollowType, type SCNotificationVoteUpType, type SCCustomNotificationType, type SCNotificationContributionType, type SCNotificationGroupActivityType, type SCNotificationEventActivityType, type SCIncubatorType, type SCIncubatorSubscriptionType, type SCInviteType, type SCNotificationIncubatorType, type SCNotificationUnseenCountType, type SCPrizeType, type SCPrizeUserType, type SCUserLoyaltyPointsType, type SCWebhookEndpointType, type SCWebhookEndpointAttemptType, type SCWebhookEndpointSecretType, type SCWebhookEventsType, type SCContributionStatus, type SCVoteType, type SCFlagType, type SCCustomPageType, type SCDataPortabilityType, type SCPreferenceType, type SCFeatureType, type SSOSignInType, type SSOSignUpType, type SCLegalPageType, type SCLegalPageAckType, type SCContributionInsightCountersType, type SCContributionInsightType, type SCEmbedInsightType, type SCEmbedInsightCountersType, type SCUsersInsightType, type SCUsersInsightCountersType, type SCFlaggedContributionType, type SCPlatformType, type SCAvatarType, type SCReactionType, type SCDeviceType, type SCApnsDeviceType, type SCGcmDeviceType, type SCSuggestionType, type SCGroupType, type SCEventType, type SCStepType };
|
|
12
|
+
export { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType, SCCoursePrivacyType, SCCourseJoinStatusType, SCCourseLessonTypologyType, SCCourseTypologyType, SCCourseLessonCompletionStatusType, SCCourseLessonStatusType, SCLiveStreamConnectionDetailsErrorType, SCLiveStreamViewType, SCCommunitySubscriptionTier };
|
|
13
|
+
export { type SCBannerType, type SCBroadcastMessageType, type SCCustomAdvType, type SCCustomMenuItemType, type SCCustomMenuType, type SCAuthTokenType, type SCUserType, type SCUserSettingsType, type SCUserBlockedSettingsType, type SCUserModerationType, type SCUserScoreVariation, type SCUserScoreType, type SCUserReputationType, type SCUserAutocompleteType, type SCUserCounterType, type SCUserAvatarType, type SCUserChangeEmailType, type SCUserPermissionType, type SCUserFollowedStatusType, type SCUserFollowerStatusType, type SCUserConnectionStatusType, type SCUserHiddenStatusType, type SCUserHiddenByStatusType, type SCUserConnectionRequestType, type SCUserEmailTokenType, type SCUserProviderAssociationType, type SCMetadataType, type SCTagType, type SCCategoryType, type SCCategoryAudienceType, type SCCategoryFollowedStatusType, type SCEmbedType, type SCMediaType, type SCChunkMediaType, type SCContributionLocation, type SCLocalityType, type SCPollChoiceType, type SCPollType, type SCPollVoteType, type SCFeedUnitType, type SCFeedUnitActivityType, type SCFeedObjectType, type SCFeedPostType, type SCFeedDiscussionType, type SCFeedStatusType, type SCFeedUnseenCountType, type SCFeedObjectSuspendedStatusType, type SCFeedObjectHideStatusType, type SCFeedObjectFollowingStatusType, type SCCommentType, type SCPrivateMessageThreadType, type SCPrivateMessageSnippetType, type SCPrivateMessageFileType, type SCPrivateMessageUploadMediaType, type SCPrivateMessageUploadThumbnailType, type SCPrivateMessageUploadMediaChunkType, type SCPromoType, type SCNotificationAggregatedType, type SCNotificationCommentType, type SCNotificationConnectionAcceptType, type SCNotificationConnectionRequestType, type SCNotificationPrivateMessageType, type SCNotificationMentionType, type SCNotificationType, type SCNotificationBlockedUserType, type SCNotificationCollapsedForType, type SCNotificationCustomNotificationType, type SCNotificationDeletedForType, type SCNotificationFollowType, type SCNotificationKindlyNoticeType, type SCNotificationUnBlockedUserType, type SCNotificationUnDeletedForType, type SCNotificationUserFollowType, type SCNotificationVoteUpType, type SCCustomNotificationType, type SCNotificationContributionType, type SCNotificationGroupActivityType, type SCNotificationEventActivityType, type SCNotificationLiveStreamActivityType, type SCIncubatorType, type SCIncubatorSubscriptionType, type SCInviteType, type SCNotificationIncubatorType, type SCNotificationUnseenCountType, type SCPrizeType, type SCPrizeUserType, type SCUserLoyaltyPointsType, type SCWebhookEndpointType, type SCWebhookEndpointAttemptType, type SCWebhookEndpointSecretType, type SCWebhookEventsType, type SCContributionStatus, type SCVoteType, type SCFlagType, type SCCustomPageType, type SCDataPortabilityType, type SCPreferenceType, type SCFeatureType, type SSOSignInType, type SSOSignUpType, type SCLegalPageType, type SCLegalPageAckType, type SCContributionInsightCountersType, type SCContributionInsightType, type SCEmbedInsightType, type SCEmbedInsightCountersType, type SCUsersInsightType, type SCUsersInsightCountersType, type SCFlaggedContributionType, type SCPlatformType, type SCAvatarType, type SCReactionType, type SCDeviceType, type SCApnsDeviceType, type SCGcmDeviceType, type SCSuggestionType, type SCGroupType, type SCEventType, type SCStepType, type SCCourseType, type SCCourseCommentType, type SCCourseSectionType, type SCCourseLessonType, type SCLiveStreamType, type SCLiveStreamConnectionDetailsType, type SCLiveStreamMonthlyDurationType, type SCLiveStreamSettingsType, type SCLiveStreamConnectionDetailsResponseErrorType };
|
package/lib/esm/index.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Import enums
|
|
3
3
|
*/
|
|
4
|
-
import { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType } from './types';
|
|
4
|
+
import { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType, SCCoursePrivacyType, SCCourseJoinStatusType, SCCourseLessonTypologyType, SCCourseTypologyType, SCCourseLessonStatusType, SCCourseLessonCompletionStatusType, SCLiveStreamConnectionDetailsErrorType, SCLiveStreamViewType, SCCommunitySubscriptionTier } from './types';
|
|
5
5
|
/**
|
|
6
6
|
* List all exports enums and types
|
|
7
7
|
*/
|
|
8
|
-
export { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType };
|
|
8
|
+
export { SCContributionType, SCBroadcastMessageBannerType, SCCategoryAutoFollowType, SCCommentsOrderBy, SCCustomAdvPosition, SCCustomPageTypeEnum, SCDeviceTypeEnum, SCDeviceApnsTypeEnum, SCFeatureName, SCFeedTypologyType, SCFeedUnitActivityTypologyType, SCFlagTypeEnum, SCFlagModerationStatusType, SCConnectionStatus, SCIncubatorStatusType, SCLegalPagePoliciesType, SCLanguageType, SCNotificationTypologyType, SCNotificationTopicType, SCPreferenceSection, SCPreferenceName, SCMessageFileType, SCPrizeUserStatusType, SCUserStatus, SuggestionType, SCPrivateMessageStatusType, SCMetadataTypeFieldType, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCPrivateMessageType, SCEventPrivacyType, SCEventSubscriptionStatusType, SCEventRecurrenceType, SCEventLocationType, SCEventLocationFilterType, SCEventDateFilterType, SCOnBoardingStepType, SCOnBoardingStepStatusType, SCOnBoardingStepIdType, SCCoursePrivacyType, SCCourseJoinStatusType, SCCourseLessonTypologyType, SCCourseTypologyType, SCCourseLessonCompletionStatusType, SCCourseLessonStatusType, SCLiveStreamConnectionDetailsErrorType, SCLiveStreamViewType, SCCommunitySubscriptionTier };
|
|
@@ -0,0 +1,369 @@
|
|
|
1
|
+
import { SCUserType } from './user';
|
|
2
|
+
import { SCCategoryType } from './category';
|
|
3
|
+
import { SCMediaType } from './media';
|
|
4
|
+
/**
|
|
5
|
+
* SCCoursePrivacyType enum
|
|
6
|
+
*/
|
|
7
|
+
export declare enum SCCoursePrivacyType {
|
|
8
|
+
OPEN = "open",
|
|
9
|
+
PRIVATE = "private",
|
|
10
|
+
SECRET = "secret",
|
|
11
|
+
DRAFT = ""
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* SCCourseTypologyType enum
|
|
15
|
+
*/
|
|
16
|
+
export declare enum SCCourseTypologyType {
|
|
17
|
+
SELF = "self-paced",
|
|
18
|
+
SCHEDULED = "scheduled",
|
|
19
|
+
STRUCTURED = "structured"
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* SCCourseSubscriptionStatusType enum
|
|
23
|
+
*/
|
|
24
|
+
export declare enum SCCourseJoinStatusType {
|
|
25
|
+
JOINED = "joined",
|
|
26
|
+
REQUESTED = "requested",
|
|
27
|
+
INVITED = "invited",
|
|
28
|
+
MANAGER = "manager",
|
|
29
|
+
CREATOR = "creator"
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Interface SCCourseType.
|
|
33
|
+
* Course Schema.
|
|
34
|
+
*/
|
|
35
|
+
export interface SCCourseType {
|
|
36
|
+
/**
|
|
37
|
+
* The ID of the course.
|
|
38
|
+
*/
|
|
39
|
+
id: number;
|
|
40
|
+
/**
|
|
41
|
+
* The name of the course.
|
|
42
|
+
*/
|
|
43
|
+
name?: string;
|
|
44
|
+
/**
|
|
45
|
+
* The slug for the course.
|
|
46
|
+
*/
|
|
47
|
+
slug?: string;
|
|
48
|
+
/**
|
|
49
|
+
* The description of the course.
|
|
50
|
+
*/
|
|
51
|
+
description?: string;
|
|
52
|
+
/**
|
|
53
|
+
* The course type
|
|
54
|
+
*/
|
|
55
|
+
type?: SCCourseTypologyType;
|
|
56
|
+
/**
|
|
57
|
+
* The course privacy.
|
|
58
|
+
*/
|
|
59
|
+
privacy?: SCCoursePrivacyType;
|
|
60
|
+
/**
|
|
61
|
+
* The lesson order enforcement
|
|
62
|
+
*/
|
|
63
|
+
enforce_lessons_order?: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* Notifies course admins about new lesson comments
|
|
66
|
+
*/
|
|
67
|
+
new_comment_notification_enabled?: boolean;
|
|
68
|
+
/**
|
|
69
|
+
* Hide member count (default: false).
|
|
70
|
+
* If enabled, only managers can see the member count
|
|
71
|
+
*/
|
|
72
|
+
hide_member_count?: boolean;
|
|
73
|
+
/**
|
|
74
|
+
* The course meta title
|
|
75
|
+
*/
|
|
76
|
+
meta_title?: string;
|
|
77
|
+
/**
|
|
78
|
+
* The course meta description
|
|
79
|
+
*/
|
|
80
|
+
meta_description?: string;
|
|
81
|
+
/**
|
|
82
|
+
* The course Open Graph title
|
|
83
|
+
*/
|
|
84
|
+
og_title?: string;
|
|
85
|
+
/**
|
|
86
|
+
* The course Open Graph description
|
|
87
|
+
*/
|
|
88
|
+
og_description?: string;
|
|
89
|
+
/**
|
|
90
|
+
* The course Open Graph image
|
|
91
|
+
*/
|
|
92
|
+
og_image?: string;
|
|
93
|
+
/**
|
|
94
|
+
* The list of all section IDs belonging to the current course
|
|
95
|
+
*/
|
|
96
|
+
sections_order?: number[];
|
|
97
|
+
/**
|
|
98
|
+
* The course image, original format.
|
|
99
|
+
*/
|
|
100
|
+
image_original?: string;
|
|
101
|
+
/**
|
|
102
|
+
* The course image, bigger format.
|
|
103
|
+
*/
|
|
104
|
+
image_bigger?: string;
|
|
105
|
+
/**
|
|
106
|
+
* The course image, big format.
|
|
107
|
+
*/
|
|
108
|
+
image_big?: string;
|
|
109
|
+
/**
|
|
110
|
+
* The course image, medium format.
|
|
111
|
+
*/
|
|
112
|
+
image_medium?: string;
|
|
113
|
+
/**
|
|
114
|
+
* The course image, small format.
|
|
115
|
+
*/
|
|
116
|
+
image_small?: string;
|
|
117
|
+
/**
|
|
118
|
+
* The course subscription status.
|
|
119
|
+
*/
|
|
120
|
+
join_status?: SCCourseJoinStatusType | null;
|
|
121
|
+
/**
|
|
122
|
+
* The course creation date.
|
|
123
|
+
*/
|
|
124
|
+
created_at?: string;
|
|
125
|
+
/**
|
|
126
|
+
* The course creator.
|
|
127
|
+
*/
|
|
128
|
+
created_by?: SCUserType;
|
|
129
|
+
/**
|
|
130
|
+
* The categories list ids
|
|
131
|
+
*/
|
|
132
|
+
categories?: SCCategoryType[];
|
|
133
|
+
/**
|
|
134
|
+
* The course sections
|
|
135
|
+
*/
|
|
136
|
+
sections?: SCCourseSectionType[] | any;
|
|
137
|
+
/**
|
|
138
|
+
* Total number of published lessons of the course
|
|
139
|
+
*/
|
|
140
|
+
num_lessons?: number;
|
|
141
|
+
/**
|
|
142
|
+
* Total number of sections with at least one lesson
|
|
143
|
+
*/
|
|
144
|
+
num_sections?: number;
|
|
145
|
+
/**
|
|
146
|
+
* Number of lessons completed by the user
|
|
147
|
+
*/
|
|
148
|
+
num_lessons_completed?: number;
|
|
149
|
+
/**
|
|
150
|
+
* User completion rate of the course (percentage)
|
|
151
|
+
*/
|
|
152
|
+
user_completion_rate?: number;
|
|
153
|
+
/**
|
|
154
|
+
* Users completion rate of the course (percentage)
|
|
155
|
+
*/
|
|
156
|
+
avg_completion_rate?: number;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Interface SCCourseCommentType.
|
|
160
|
+
* Course Comment Schema.
|
|
161
|
+
*/
|
|
162
|
+
export interface SCCourseCommentType {
|
|
163
|
+
/**
|
|
164
|
+
* The unique integer value identifying this comment on a specific course
|
|
165
|
+
*/
|
|
166
|
+
id: number;
|
|
167
|
+
/**
|
|
168
|
+
* The comment text.
|
|
169
|
+
* @default empty string.
|
|
170
|
+
* Only available when creating or updating a comment
|
|
171
|
+
*/
|
|
172
|
+
text: string;
|
|
173
|
+
/**
|
|
174
|
+
* The comment text.
|
|
175
|
+
* Only available when getting a comment
|
|
176
|
+
*/
|
|
177
|
+
html: string;
|
|
178
|
+
/**
|
|
179
|
+
* The Id of the parent comment
|
|
180
|
+
*/
|
|
181
|
+
parent: number;
|
|
182
|
+
/**
|
|
183
|
+
* The Id of the reply comment.
|
|
184
|
+
* It must have the same parent
|
|
185
|
+
*/
|
|
186
|
+
in_reply_to: number;
|
|
187
|
+
/**
|
|
188
|
+
* Datetime of comment creation
|
|
189
|
+
*/
|
|
190
|
+
created_at: string;
|
|
191
|
+
/**
|
|
192
|
+
* The comment creator
|
|
193
|
+
*/
|
|
194
|
+
created_by: SCUserType;
|
|
195
|
+
/**
|
|
196
|
+
* List of id of Media for this comment
|
|
197
|
+
*/
|
|
198
|
+
medias: SCMediaType[];
|
|
199
|
+
/**
|
|
200
|
+
* The last comment in reply to (with parent) this comment.
|
|
201
|
+
* Not available if replies are presents.
|
|
202
|
+
*/
|
|
203
|
+
latest_reply: SCCourseCommentType | null;
|
|
204
|
+
/**
|
|
205
|
+
* The list of comments in reply to (with parent) this comment.
|
|
206
|
+
* Not available if latest_reply are presents.
|
|
207
|
+
* Only available on the route: Get Course Comments
|
|
208
|
+
*/
|
|
209
|
+
replies: SCCourseCommentType[];
|
|
210
|
+
/**
|
|
211
|
+
* Some extra useful data for the call that retrieves all the comments received within the entire course.
|
|
212
|
+
* Only available on the route: Get Course Comments
|
|
213
|
+
*/
|
|
214
|
+
extras: {
|
|
215
|
+
/**
|
|
216
|
+
* The course object associated to this comment
|
|
217
|
+
*/
|
|
218
|
+
course: {
|
|
219
|
+
id: number;
|
|
220
|
+
slug: string;
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* The section object associated to this comment
|
|
224
|
+
*/
|
|
225
|
+
section: {
|
|
226
|
+
id: number;
|
|
227
|
+
name: string;
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* The lesson object associated to this comment
|
|
231
|
+
*/
|
|
232
|
+
lesson: {
|
|
233
|
+
id: number;
|
|
234
|
+
name: string;
|
|
235
|
+
};
|
|
236
|
+
};
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Interface SCCourseSectionType.
|
|
240
|
+
* Course Schema.
|
|
241
|
+
*/
|
|
242
|
+
export interface SCCourseSectionType {
|
|
243
|
+
/**
|
|
244
|
+
* The ID of the course section.
|
|
245
|
+
*/
|
|
246
|
+
id?: number;
|
|
247
|
+
/**
|
|
248
|
+
* The name of the section course
|
|
249
|
+
*/
|
|
250
|
+
name?: string;
|
|
251
|
+
/**
|
|
252
|
+
* Sections are dripped relative to this date; used only id course type is scheduled
|
|
253
|
+
*/
|
|
254
|
+
dripped_at?: Date | string;
|
|
255
|
+
/**
|
|
256
|
+
* Sections are dripped relative to the enrollment date of the current user; used only if the course type is structured .
|
|
257
|
+
*/
|
|
258
|
+
drip_delay?: number;
|
|
259
|
+
/**
|
|
260
|
+
* The list of all lesson IDs belonging to the current section course
|
|
261
|
+
*/
|
|
262
|
+
lessons_order?: number[];
|
|
263
|
+
/**
|
|
264
|
+
* The lessons associated to the course section
|
|
265
|
+
*/
|
|
266
|
+
lessons?: SCCourseLessonType[];
|
|
267
|
+
/**
|
|
268
|
+
* Determines when the current section will be available for the user.
|
|
269
|
+
* The value will be null if the course type is self-paced
|
|
270
|
+
*/
|
|
271
|
+
available_date?: string;
|
|
272
|
+
/**
|
|
273
|
+
* Determines whether the current section is locked for the user based on the section availability strategy.
|
|
274
|
+
* The value will not be considered if the course type is self-paced
|
|
275
|
+
*/
|
|
276
|
+
locked?: boolean;
|
|
277
|
+
/**
|
|
278
|
+
* Total number of published lessons of the current course section
|
|
279
|
+
*/
|
|
280
|
+
num_lessons?: number;
|
|
281
|
+
/**
|
|
282
|
+
* Number of lessons completed by the user in the current course section
|
|
283
|
+
*/
|
|
284
|
+
num_lessons_completed?: number;
|
|
285
|
+
}
|
|
286
|
+
/**
|
|
287
|
+
* SCCourseLessonTypologyType enum
|
|
288
|
+
*/
|
|
289
|
+
export declare enum SCCourseLessonTypologyType {
|
|
290
|
+
LESSON = "lesson",
|
|
291
|
+
QUIZ = "quiz"
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* SCCourseLessonStatusType enum
|
|
295
|
+
*/
|
|
296
|
+
export declare enum SCCourseLessonStatusType {
|
|
297
|
+
DRAFT = "draft",
|
|
298
|
+
PUBLISHED = "published"
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* SCCourseLessonCompletionStatusType enum
|
|
302
|
+
*/
|
|
303
|
+
export declare enum SCCourseLessonCompletionStatusType {
|
|
304
|
+
UNCOMPLETED = "uncompleted",
|
|
305
|
+
COMPLETED = "completed",
|
|
306
|
+
FAILED = "failed"
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* Interface SCCourseLessonType.
|
|
310
|
+
* Course Schema.
|
|
311
|
+
*/
|
|
312
|
+
export interface SCCourseLessonType {
|
|
313
|
+
/**
|
|
314
|
+
* The ID of the lesson.
|
|
315
|
+
*/
|
|
316
|
+
id: number;
|
|
317
|
+
/**
|
|
318
|
+
* The ID of the course the lesson belongs to.
|
|
319
|
+
*/
|
|
320
|
+
course_id?: number;
|
|
321
|
+
/**
|
|
322
|
+
* The ID of the section within the course the lesson belongs to,
|
|
323
|
+
*/
|
|
324
|
+
section_id?: number;
|
|
325
|
+
/**
|
|
326
|
+
* The name of the lesson
|
|
327
|
+
*/
|
|
328
|
+
name: string;
|
|
329
|
+
/**
|
|
330
|
+
* The type of the lesson.
|
|
331
|
+
*/
|
|
332
|
+
type: SCCourseLessonTypologyType;
|
|
333
|
+
/**
|
|
334
|
+
* The status of the lesson.
|
|
335
|
+
*/
|
|
336
|
+
status?: SCCourseLessonStatusType;
|
|
337
|
+
/**
|
|
338
|
+
* Enable the comments on the current lesson.
|
|
339
|
+
*/
|
|
340
|
+
comments_enabled?: boolean;
|
|
341
|
+
/**
|
|
342
|
+
* The lesson course text.
|
|
343
|
+
*/
|
|
344
|
+
text?: string;
|
|
345
|
+
/**
|
|
346
|
+
* The lesson course html.
|
|
347
|
+
*/
|
|
348
|
+
html?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Datetime of lesson course creation.
|
|
351
|
+
*/
|
|
352
|
+
created_at?: string;
|
|
353
|
+
/**
|
|
354
|
+
* The lesson course creator.
|
|
355
|
+
*/
|
|
356
|
+
created_by?: SCUserType;
|
|
357
|
+
/**
|
|
358
|
+
* The list of Media ids for the lesson course
|
|
359
|
+
*/
|
|
360
|
+
medias?: SCMediaType[];
|
|
361
|
+
/**
|
|
362
|
+
* Determines whether the current lesson is locked for the user based on the user and on the course property: type and enforce_lessons_order
|
|
363
|
+
*/
|
|
364
|
+
locked?: boolean;
|
|
365
|
+
/**
|
|
366
|
+
* Enum to define the course lesson completion status for the user
|
|
367
|
+
*/
|
|
368
|
+
completion_status?: SCCourseLessonCompletionStatusType;
|
|
369
|
+
}
|