@selfcommunity/api-services 0.6.4-alpha.0 → 0.6.4-courses.147

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

@@ -0,0 +1,140 @@
+import { SCLiveStreamConnectionDetailsType, SCLiveStreamMonthlyDurationType, SCLiveStreamType } from '@selfcommunity/types';
+import { AxiosRequestConfig } from 'axios';
+import { SCPaginatedResponse } from '../../types';
+import { LiveStreamCreateParams, LiveStreamRemoveParticipantParams, LiveStreamSearchParams } from '../../types/liveStream';
+export interface LiveStreamApiClientInterface {
+    search(params?: LiveStreamSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
+    getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    create(data: LiveStreamCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    close(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
+    removeParticipant(id: number | string, data: LiveStreamRemoveParticipantParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    getMonthlyDuration(config?: AxiosRequestConfig): Promise<SCLiveStreamMonthlyDurationType>;
+}
+/**
+ * Contains all the endpoints needed to manage LiveStreams.
+ */
+export declare class LiveStreamApiClient {
+    /**
+     * This endpoint performs LiveStreams search
+     * @param params
+     * @param config
+     */
+    static search(params?: LiveStreamSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
+    /**
+     * This endpoint retrieves a specific LiveStream.
+     * @param id
+     * @param config
+     */
+    static getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    /**
+     * This endpoint creates an LiveStream.
+     * @param data
+     * @param config
+     */
+    static create(data: LiveStreamCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    /**
+     * This endpoint updates an LiveStream.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    /**
+     * This endpoint patches an LiveStream.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    /**
+     * This endpoint deletes an LiveStream.
+     * @param id
+     * @param config
+     */
+    static delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint allows to close permanently a room
+     * @param id
+     * @param config
+     */
+    static close(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint changes the LiveStream avatar
+     * @param id
+     * @param data
+     * @param config
+     */
+    static changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    /**
+     * This endpoint allows to attend an LiveStream
+     * @param id
+     * @param config
+     */
+    static join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
+    /**
+     * This endpoint remove participant from the specified live stream.
+     * If ban=true in the payload the user can no longer join the meet
+     * @param id
+     * @param data
+     * @param config
+     */
+    static removeParticipant(id: number | string, data: LiveStreamRemoveParticipantParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint retrieves LiveStream montlhy duration.
+     * @param config
+     */
+    static getMonthlyDuration(config?: AxiosRequestConfig): Promise<SCLiveStreamMonthlyDurationType>;
+}
+/**
+ *
+ :::tip LiveStream service can be used in the following way:
+
+ ```jsx
+ 1. Import the service from our library:
+
+ import {LiveStreamService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `search` will return the LiveStreams matching the search query.
+
+ async searchLiveStreams() {
+     return await LiveStreamService.search();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async getSpecificInfo(liveStreamId) {
+     return await LiveStreamService.getSpecificInfo(liveStreamId);
+ }
+ ```
+ ```jsx
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+
+ 1. Declare it(or declare them, it is possible to add multiple params)
+
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
+
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
+ ```
+ :::
+ */
+export default class LiveStreamService {
+    static search(params?: LiveStreamSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
+    static getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    static create(data: LiveStreamCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    static update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    static patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    static delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
+    static close(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    static changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
+    static join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
+    static removeParticipant(id: number | string, data: LiveStreamRemoveParticipantParams | FormData, config?: AxiosRequestConfig): Promise<any>;
+    static getMonthlyDuration(config?: AxiosRequestConfig): Promise<SCLiveStreamMonthlyDurationType>;
+}

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

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveStreamApiClient = void 0;
+const tslib_1 = require("tslib");
+const Endpoints_1 = tslib_1.__importDefault(require("../../constants/Endpoints"));
+const apiRequest_1 = require("../../utils/apiRequest");
+const url_1 = require("../../utils/url");
+/**
+ * Contains all the endpoints needed to manage LiveStreams.
+ */
+class LiveStreamApiClient {
+    /**
+     * This endpoint performs LiveStreams search
+     * @param params
+     * @param config
+     */
+    static search(params, config) {
+        const p = (0, url_1.urlParams)(params);
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.SearchLiveStream.url({})}?${p.toString()}`, method: Endpoints_1.default.SearchLiveStream.method }));
+    }
+    /**
+     * This endpoint retrieves a specific LiveStream.
+     * @param id
+     * @param config
+     */
+    static getSpecificInfo(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetLiveStreamInfo.url({ id }), method: Endpoints_1.default.GetLiveStreamInfo.method }));
+    }
+    /**
+     * This endpoint creates an LiveStream.
+     * @param data
+     * @param config
+     */
+    static create(data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreateLiveStream.url({}), method: Endpoints_1.default.CreateLiveStream.method, data: data }));
+    }
+    /**
+     * This endpoint updates an LiveStream.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static update(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UpdateLiveStream.url({ id }), method: Endpoints_1.default.UpdateLiveStream.method, data: data }));
+    }
+    /**
+     * This endpoint patches an LiveStream.
+     * @param id
+     * @param data
+     * @param config
+     */
+    static patch(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PatchLiveStream.url({ id }), method: Endpoints_1.default.PatchLiveStream.method, data: data }));
+    }
+    /**
+     * This endpoint deletes an LiveStream.
+     * @param id
+     * @param config
+     */
+    static delete(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.DeleteLiveStream.url({ id }), method: Endpoints_1.default.DeleteLiveStream.method }));
+    }
+    /**
+     * This endpoint allows to close permanently a room
+     * @param id
+     * @param config
+     */
+    static close(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CloseLiveStream.url({ id }), method: Endpoints_1.default.CloseLiveStream.method }));
+    }
+    /**
+     * This endpoint changes the LiveStream avatar
+     * @param id
+     * @param data
+     * @param config
+     */
+    static changeCover(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign({ url: Endpoints_1.default.PatchLiveStream.url({ id }), method: Endpoints_1.default.PatchLiveStream.method, data }, config));
+    }
+    /**
+     * This endpoint allows to attend an LiveStream
+     * @param id
+     * @param config
+     */
+    static join(id, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.JoinLiveStream.url({ id }), method: Endpoints_1.default.JoinLiveStream.method }));
+    }
+    /**
+     * This endpoint remove participant from the specified live stream.
+     * If ban=true in the payload the user can no longer join the meet
+     * @param id
+     * @param data
+     * @param config
+     */
+    static removeParticipant(id, data, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign({ url: Endpoints_1.default.RemoveParticipant.url({ id }), method: Endpoints_1.default.RemoveParticipant.method, data }, config));
+    }
+    /**
+     * This endpoint retrieves LiveStream montlhy duration.
+     * @param config
+     */
+    static getMonthlyDuration(config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetLiveStreamMonthlyDuration.url({}), method: Endpoints_1.default.GetLiveStreamMonthlyDuration.method }));
+    }
+}
+exports.LiveStreamApiClient = LiveStreamApiClient;
+/**
+ *
+ :::tip LiveStream service can be used in the following way:
+
+ ```jsx
+ 1. Import the service from our library:
+
+ import {LiveStreamService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `search` will return the LiveStreams matching the search query.
+
+ async searchLiveStreams() {
+     return await LiveStreamService.search();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async getSpecificInfo(liveStreamId) {
+     return await LiveStreamService.getSpecificInfo(liveStreamId);
+ }
+ ```
+ ```jsx
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+
+ 1. Declare it(or declare them, it is possible to add multiple params)
+
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
+
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
+ ```
+ :::
+ */
+class LiveStreamService {
+    static search(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.search(params, config);
+        });
+    }
+    static getSpecificInfo(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.getSpecificInfo(id, config);
+        });
+    }
+    static create(data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.create(data, config);
+        });
+    }
+    static update(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.update(id, data, config);
+        });
+    }
+    static patch(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.patch(id, data, config);
+        });
+    }
+    static delete(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.delete(id, config);
+        });
+    }
+    static close(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.close(id, config);
+        });
+    }
+    static changeCover(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.changeCover(id, data, config);
+        });
+    }
+    static join(id, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.join(id, config);
+        });
+    }
+    static removeParticipant(id, data, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.removeParticipant(id, data, config);
+        });
+    }
+    static getMonthlyDuration(config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return LiveStreamApiClient.getMonthlyDuration(config);
+        });
+    }
+}
+exports.default = LiveStreamService;

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

@@ -1,8 +1,9 @@
 import { BaseGetParams, SCPaginatedResponse } from '../../types';
-import { SCCategoryType, SCEventType, SCFeedObjectType, SCIncubatorType, SCSuggestionType, SCUserType } from '@selfcommunity/types';
+import { SCCategoryType, SCCourseType, SCEventType, SCFeedObjectType, SCIncubatorType, SCSuggestionType, SCUserType } from '@selfcommunity/types';
 import { AxiosRequestConfig } from 'axios';
 export interface SuggestionApiClientInterface {
     getCategorySuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCategoryType>>;
+    getCourseSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCourseType>>;
     getIncubatorSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCIncubatorType>>;
     getPollSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCFeedObjectType>>;
     getUserSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCUserType>>;
@@ -19,6 +20,12 @@ export declare class SuggestionApiClient {
      * @param config
      */
     static getCategorySuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCategoryType>>;
+    /**
+     * This endpoint retrieves a list of courses suggested to the current user.
+     * @param params
+     * @param config
+     */
+    static getCourseSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCourseType>>;
     /**
      * This endpoint retrieves a list of suggested incubators.
      * @param params
@@ -81,6 +88,7 @@ export declare class SuggestionApiClient {
  */
 export default class SuggestionService {
     static getCategorySuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCategoryType>>;
+    static getCourseSuggestion(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCourseType>>;
     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>>;

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

@@ -17,6 +17,14 @@ class SuggestionApiClient {
     static getCategorySuggestion(params, config) {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CategoriesSuggestion.url({}), method: Endpoints_1.default.CategoriesSuggestion.method, params }));
     }
+    /**
+     * This endpoint retrieves a list of courses suggested to the current user.
+     * @param params
+     * @param config
+     */
+    static getCourseSuggestion(params, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CourseSuggestion.url({}), method: Endpoints_1.default.CourseSuggestion.method, params }));
+    }
     /**
      * This endpoint retrieves a list of suggested incubators.
      * @param params
@@ -95,6 +103,11 @@ class SuggestionService {
             return SuggestionApiClient.getCategorySuggestion(params, config);
         });
     }
+    static getCourseSuggestion(params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return SuggestionApiClient.getCourseSuggestion(params, config);
+        });
+    }
     static getIncubatorSuggestion(params, config) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             return SuggestionApiClient.getIncubatorSuggestion(params, config);

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

@@ -1,4 +1,4 @@
-import { SCAvatarType, SCCategoryType, SCFeedUnitType, SCPlatformType, SCTagType, SCUserAutocompleteType, SCUserAvatarType, SCUserChangeEmailType, SCUserConnectionRequestType, SCUserConnectionStatusType, SCUserCounterType, SCUserEmailTokenType, SCUserFollowedStatusType, SCUserFollowerStatusType, SCUserHiddenByStatusType, SCUserHiddenStatusType, SCUserLoyaltyPointsType, SCUserPermissionType, SCUserProviderAssociationType, SCUserSettingsType, SCUserType } from '@selfcommunity/types';
+import { SCAvatarType, SCCategoryType, SCFeedUnitType, SCLiveStreamType, SCPlatformType, SCTagType, SCUserAutocompleteType, SCUserAvatarType, SCUserChangeEmailType, SCUserConnectionRequestType, SCUserConnectionStatusType, SCUserCounterType, SCUserEmailTokenType, SCUserFollowedStatusType, SCUserFollowerStatusType, SCUserHiddenByStatusType, SCUserHiddenStatusType, SCUserLoyaltyPointsType, SCUserPermissionType, SCUserProviderAssociationType, SCUserSettingsType, SCUserType } from '@selfcommunity/types';
 import { BaseGetParams, SCPaginatedResponse, UserAutocompleteParams, UserGetParams, UserSearchParams } from '../../types';
 import { AxiosRequestConfig } from 'axios';
 import { DeleteProviderAssociation } from '../../types/user';
@@ -54,6 +54,7 @@ export interface UserApiClientInterface {
     getProviderAssociations(userId: string | number, config?: AxiosRequestConfig): Promise<SCUserProviderAssociationType[]>;
     createProviderAssociation(data: SCUserProviderAssociationType, config?: AxiosRequestConfig): Promise<SCUserProviderAssociationType>;
     deleteProviderAssociation(data: DeleteProviderAssociation, config?: AxiosRequestConfig): Promise<any>;
+    getUserLiveStream(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
 }
 /**
  * Contains all the endpoints needed to manage users.
@@ -384,6 +385,13 @@ export declare class UserApiClient {
      * @param config
      */
     static deleteProviderAssociation(data: DeleteProviderAssociation, config?: AxiosRequestConfig): Promise<any>;
+    /**
+     * This endpoint retrieves the list of live stream currently started by user identified by ID.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUserLiveStream(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
 }
 /**
  *
@@ -474,4 +482,5 @@ export default class UserService {
     static getProviderAssociations(userId: string | number, config?: AxiosRequestConfig): Promise<SCUserProviderAssociationType[]>;
     static createProviderAssociation(data: SCUserProviderAssociationType, config?: AxiosRequestConfig): Promise<SCUserProviderAssociationType>;
     static deleteProviderAssociation(data: DeleteProviderAssociation, config?: AxiosRequestConfig): Promise<any>;
+    static getUserLiveStream(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
 }

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

@@ -451,6 +451,15 @@ class UserApiClient {
     static deleteProviderAssociation(data, config) {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { data, url: Endpoints_1.default.DeleteProviderAssociation.url({ id: data.user_id }), method: Endpoints_1.default.DeleteProviderAssociation.method }));
     }
+    /**
+     * This endpoint retrieves the list of live stream currently started by user identified by ID.
+     * @param id
+     * @param params
+     * @param config
+     */
+    static getUserLiveStream(id, params, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetLiveStream.url({ id }), method: Endpoints_1.default.UserFeed.method, params }));
+    }
 }
 exports.UserApiClient = UserApiClient;
 /**
@@ -746,5 +755,10 @@ class UserService {
             return UserApiClient.deleteProviderAssociation(data, config);
         });
     }
+    static getUserLiveStream(id, params, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return UserApiClient.getUserLiveStream(id, params, config);
+        });
+    }
 }
 exports.default = UserService;

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

@@ -0,0 +1,123 @@
+/**
+ * CourseCreateParams interface
+ */
+import { SCCoursePrivacyType, SCCourseJoinStatusType, SCCourseTypologyType } from '@selfcommunity/types';
+import { BaseGetParams, BaseSearchParams } from './baseParams';
+export interface CourseCreateParams {
+    /**
+     * A unique name for the course
+     */
+    name: string;
+    /**
+     * The course description
+     */
+    description?: string;
+    /**
+     * The course type
+     */
+    type: SCCourseTypologyType;
+    /**
+     * The course privacy
+     */
+    privacy: SCCoursePrivacyType;
+    /**
+     * The categories id
+     */
+    categories: number[];
+}
+export interface CourseSectionParams {
+    /**
+     * A unique name for the course section
+     */
+    name: string;
+}
+/**
+ * CourseUserParams interface.
+ */
+export interface CourseUserParams extends BaseGetParams {
+    /**
+     * Filter results by subscription_status
+     */
+    join_status?: SCCourseJoinStatusType;
+    /**
+     * Return only courses created by this user id
+     */
+    created_by?: number;
+}
+/**
+ * CourseSearchParams interface.
+ */
+export interface CourseSearchParams extends BaseSearchParams {
+    /**
+     * The categories ids
+     */
+    categories?: number[];
+}
+/**
+ * CourseInfoView enum
+ */
+export declare enum CourseInfoViewType {
+    USER = "user",
+    EDIT = "edit",
+    DASHBOARD = "dashboard"
+}
+/**
+ * CourseInfoParams interface.
+ */
+export interface CourseInfoParams {
+    view?: CourseInfoViewType;
+    user?: number;
+}
+/**
+ * CourseLessonCommentsParams interface.
+ */
+export interface CourseLessonCommentsParams extends BaseGetParams {
+    /**
+     * The ordering of the comments; use - for order desc.
+     * Default to created_at
+     */
+    ordering?: string;
+    /**
+     * The Id of the parent Course Comment; used for retrieve nested comments
+     */
+    parent?: string;
+}
+/**
+ * CourseUserRoleParams interface.
+ */
+export interface CourseUserRoleParams {
+    /**
+     * List of id of User to set as managers role.
+     * At least one parameter between managers, joined and unjoined is required.
+     */
+    managers?: number[];
+    /**
+     * List of id of User to force to join the course as normal users.
+     * At least one parameter between managers, joined and unjoined is required.
+     */
+    joined?: number[];
+    /**
+     * List of id of User to force to unjoin the course.
+     * At least one parameter between managers, joined and unjoined is required.
+     */
+    unjoined?: number[];
+}
+/**
+ * CourseUsersParams interface.
+ */
+export interface CourseUsersParams extends BaseGetParams {
+    /**
+     * Filter by join_status; default: ["manager", "joined"].
+     * Only creator, manager and joined are valid status for this route
+     */
+    statuses?: SCCourseJoinStatusType[];
+}
+/**
+ * CourseDashboardUsersParams interface.
+ */
+export interface CourseDashboardUsersParams extends BaseSearchParams {
+    /**
+     *  Filter by join_status; default: ["manager", "joined"]
+     */
+    statuses?: SCCourseJoinStatusType[];
+}

package/lib/cjs/types/course.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CourseInfoViewType = void 0;
+/**
+ * CourseInfoView enum
+ */
+var CourseInfoViewType;
+(function (CourseInfoViewType) {
+    CourseInfoViewType["USER"] = "user";
+    CourseInfoViewType["EDIT"] = "edit";
+    CourseInfoViewType["DASHBOARD"] = "dashboard";
+})(CourseInfoViewType = exports.CourseInfoViewType || (exports.CourseInfoViewType = {}));

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

@@ -25,5 +25,7 @@ import { InsightCommonParams, InsightEmbedParams, InsightUserParams, InsightCont
 import { ReactionParams } from './reaction';
 import { GroupCreateParams, GroupFeedParams } from './group';
 import { EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams } from './event';
+import { LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams } from './liveStream';
 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 };
+import { CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams } from './course';
+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, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams };

package/lib/cjs/types/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnBoardingStep = exports.MediaTypes = void 0;
+exports.CourseInfoViewType = exports.OnBoardingStep = exports.MediaTypes = void 0;
 const media_1 = require("./media");
 Object.defineProperty(exports, "MediaTypes", { enumerable: true, get: function () { return media_1.MediaTypes; } });
 const onBoarding_1 = require("./onBoarding");
 Object.defineProperty(exports, "OnBoardingStep", { enumerable: true, get: function () { return onBoarding_1.OnBoardingStep; } });
+const course_1 = require("./course");
+Object.defineProperty(exports, "CourseInfoViewType", { enumerable: true, get: function () { return course_1.CourseInfoViewType; } });

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

@@ -0,0 +1,54 @@
+import { BaseSearchParams } from './baseParams';
+/**
+ * LiveStreamCreateParams interface
+ */
+export interface LiveStreamCreateParams {
+    /**
+     * A unique name for the live
+     */
+    name: string;
+    /**
+     * The livestream description
+     */
+    description?: string;
+    /**
+     * The users to invite to the group
+     */
+    invite_users?: number[];
+    /**
+     * The liveStream image
+     */
+    cover?: File;
+    /**
+     * The liveStream slug
+     */
+    slug?: string;
+    /**
+     * The livestream settings
+     */
+    settings?: Record<string, any>;
+}
+export interface LiveStreamSearchParams extends BaseSearchParams {
+    /**
+     * Id
+     */
+    id?: string | number;
+    /**
+     * 	Room name
+     */
+    room_name?: string;
+    /**
+     * Slug
+     */
+    slug?: string;
+}
+export interface LiveStreamRemoveParticipantParams {
+    /**
+     * Participant Id
+     */
+    participant_id?: string | number;
+    /**
+     * Ban participant
+     */
+    ban?: boolean;
+}