@parra/parra-js-sdk 0.3.486 → 0.3.488

package/dist/ParraAPI.d.ts

@@ -1395,6 +1395,131 @@ export interface Reaction {
     user_id: string;
     user: TenantUserNameStub;
 }
+export interface UpdateCourseRequestBody {
+    title?: string;
+    description?: string | null;
+}
+export interface CreateCourseRequestBody {
+    title?: string;
+    description?: string | null;
+}
+export declare enum LessonType {
+    youtubeVideo = "youtube_video"
+}
+export interface LessonYoutubeVideoContent {
+    youtube_video_id?: string | null;
+    duration: number;
+}
+export type LessonContent = LessonYoutubeVideoContent;
+export interface LessonSection {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    title: string;
+    description?: string | null;
+    start_time: number;
+    end_time?: number | null;
+}
+export interface Lesson {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    tenant_id: string;
+    type: LessonType;
+    title: string;
+    description?: string | null;
+    sort_order: number;
+    is_preview: boolean;
+    content?: LessonContent | null;
+    sections?: Array<LessonSection>;
+}
+export interface CourseModule {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    title: string;
+    description?: string | null;
+    sort_order: number;
+    is_preview: boolean;
+    lessons?: Array<Lesson>;
+}
+export interface CourseStub {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    tenant_id: string;
+    title: string;
+    description?: string | null;
+}
+export interface Course {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    tenant_id: string;
+    title: string;
+    description?: string | null;
+    modules?: Array<CourseModule>;
+}
+export interface AppLessonProgress {
+    complete: boolean;
+    progress?: number;
+}
+export interface AppLessonSection {
+    id: string;
+    title: string;
+    description?: string | null;
+    start_time: number;
+    end_time?: number | null;
+}
+export interface AppLesson {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    tenant_id: string;
+    type: LessonType;
+    title: string;
+    description?: string | null;
+    is_preview: boolean;
+    content?: LessonContent;
+    progress?: AppLessonProgress | null;
+    sections?: Array<AppLessonSection>;
+}
+export interface AppCourseModule {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    title: string;
+    description?: string | null;
+    is_preview: boolean;
+    lessons?: Array<AppLesson>;
+}
+export interface AppCourse {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+    tenant_id: string;
+    title: string;
+    description?: string | null;
+    modules?: Array<AppCourseModule>;
+}
+export interface UpdateCourseModuleRequestBody {
+    title?: string;
+    description?: string | null;
+    sort_order?: number;
+    is_preview?: boolean;
+}
+export interface ReportLessonProgressRequestBody {
+    complete?: boolean;
+    progress?: number;
+}
 export interface AppFaq {
     id: string;
     created_at: string;
@@ -3743,6 +3868,10 @@ export interface WebauthnAuthenticateResponseBody {
     message: string;
     token: string;
 }
+export declare enum ClientType {
+    native = "native",
+    web = "web"
+}
 export declare enum GrantType {
     authorizationCode = "authorization_code",
     clientCredentials = "client_credentials",
@@ -3792,7 +3921,7 @@ export interface Client {
     created_at: string;
     updated_at: string;
     deleted_at?: string | null;
-    type: string;
+    type: ClientType;
     is_first_party: boolean;
     client_id: string;
     client_secret: string;
@@ -4064,7 +4193,9 @@ export declare enum ConnectedAppType {
     youtube = "youtube",
     tiktok = "tiktok",
     instagram = "instagram",
-    facebook = "facebook"
+    facebook = "facebook",
+    twitch = "twitch",
+    linkedin = "linkedin"
 }
 export declare enum ConnectedAppConnectionStatus {
     pending = "pending",
@@ -4982,6 +5113,23 @@ declare class ParraAPI {
     flagChatMessage: (tenant_id: string, message_id: string, body?: FlagMessageRequestBody, options?: Options) => Promise<Response>;
     addReactionToChatMessage: (tenant_id: string, message_id: string, body: CreateReactionRequestBody, options?: Options) => Promise<Reaction>;
     removeReactionFromChatMessage: (tenant_id: string, message_id: string, reaction_id: string, options?: Options) => Promise<Response>;
+    createCourse: (tenant_id: string, body: CreateCourseRequestBody, options?: Options) => Promise<Course>;
+    listCourses: (tenant_id: string, options?: Options) => Promise<Array<Course>>;
+    getCourseById: (tenant_id: string, course_id: string, options?: Options) => Promise<Course>;
+    updateCourseById: (tenant_id: string, course_id: string, body?: UpdateCourseRequestBody, options?: Options) => Promise<Course>;
+    deleteCourseById: (tenant_id: string, course_id: string, options?: Options) => Promise<Response>;
+    getAppCourseById: (tenant_id: string, application_id: string, course_id: string, options?: Options) => Promise<AppCourse>;
+    enrollInCourse: (tenant_id: string, course_id: string, options?: Options) => Promise<Course>;
+    createModuleForCourse: (tenant_id: string, course_id: string, body: CreateCourseRequestBody, options?: Options) => Promise<CourseModule>;
+    updateModuleForCourseById: (tenant_id: string, course_id: string, course_module_id: string, body?: UpdateCourseModuleRequestBody, options?: Options) => Promise<CourseModule>;
+    deleteModuleForCourseById: (tenant_id: string, course_id: string, course_module_id: string, options?: Options) => Promise<Response>;
+    createLessonForModule: (tenant_id: string, course_id: string, course_module_id: string, body: CreateCourseRequestBody, options?: Options) => Promise<CourseModule>;
+    updateLessonForCourseById: (tenant_id: string, course_id: string, lesson_id: string, body?: UpdateCourseModuleRequestBody, options?: Options) => Promise<CourseModule>;
+    deleteLessonForCourseById: (tenant_id: string, course_id: string, lesson_id: string, options?: Options) => Promise<Response>;
+    createSectionForLesson: (tenant_id: string, course_id: string, lesson_id: string, body?: UpdateCourseModuleRequestBody, options?: Options) => Promise<CourseModule>;
+    updateSectionForLesson: (tenant_id: string, course_id: string, lesson_id: string, lesson_section_id: string, body?: UpdateCourseModuleRequestBody, options?: Options) => Promise<CourseModule>;
+    deleteSectionForLesson: (tenant_id: string, course_id: string, lesson_id: string, lesson_section_id: string, options?: Options) => Promise<Response>;
+    reportCourseLessonProgress: (tenant_id: string, lesson_id: string, body?: ReportLessonProgressRequestBody, options?: Options) => Promise<Response>;
     listAppFaqs: (tenant_id: string, application_id: string, query?: {
         app_area_id?: string | null;
     }, options?: Options) => Promise<AppFaqView>;

package/dist/ParraAPI.js

@@ -11,8 +11,8 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BoardType = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.SubmitCommentReviewStatus = exports.CommentReviewStatus = exports.ReactionType = exports.FeedItemType = exports.SocialAccountType = exports.CreatorUpdateGiveawayCriteria = exports.CreatorUpdateChannelType = exports.CreatorUpdateStatus = exports.CreatorUpdateVisibilityType = exports.CreatorUpdateTopic = exports.AttachmentType = exports.ChannelMemberRole = exports.ChannelMemberType = exports.ChatChannelStatus = exports.ChatChannelType = exports.BillingSourceType = exports.ApplePurchaseType = exports.ApplePurchaseEnvironment = exports.PurchaseEnvironment = exports.PurchasePlatform = exports.PurchaseType = exports.PaywallIapType = exports.AppPaywallType = exports.ShareAssetType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
-exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.TenantUserMetricType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TicketLinkType = void 0;
+exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.SubmitCommentReviewStatus = exports.CommentReviewStatus = exports.ReactionType = exports.FeedItemType = exports.SocialAccountType = exports.CreatorUpdateGiveawayCriteria = exports.CreatorUpdateChannelType = exports.CreatorUpdateStatus = exports.CreatorUpdateVisibilityType = exports.CreatorUpdateTopic = exports.LessonType = exports.AttachmentType = exports.ChannelMemberRole = exports.ChannelMemberType = exports.ChatChannelStatus = exports.ChatChannelType = exports.BillingSourceType = exports.ApplePurchaseType = exports.ApplePurchaseEnvironment = exports.PurchaseEnvironment = exports.PurchasePlatform = exports.PurchaseType = exports.PaywallIapType = exports.AppPaywallType = exports.ShareAssetType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
+exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.TenantUserMetricType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.ClientType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TicketLinkType = exports.BoardType = void 0;
 var TicketType;
 (function (TicketType) {
     TicketType["bug"] = "bug";
@@ -208,6 +208,10 @@ var AttachmentType;
 (function (AttachmentType) {
     AttachmentType["image"] = "image";
 })(AttachmentType || (exports.AttachmentType = AttachmentType = {}));
+var LessonType;
+(function (LessonType) {
+    LessonType["youtubeVideo"] = "youtube_video";
+})(LessonType || (exports.LessonType = LessonType = {}));
 var CreatorUpdateTopic;
 (function (CreatorUpdateTopic) {
     CreatorUpdateTopic["giveaway"] = "giveaway";
@@ -390,6 +394,11 @@ var PasswordlessStrategy;
     PasswordlessStrategy["sms"] = "sms";
     PasswordlessStrategy["phone"] = "phone";
 })(PasswordlessStrategy || (exports.PasswordlessStrategy = PasswordlessStrategy = {}));
+var ClientType;
+(function (ClientType) {
+    ClientType["native"] = "native";
+    ClientType["web"] = "web";
+})(ClientType || (exports.ClientType = ClientType = {}));
 var GrantType;
 (function (GrantType) {
     GrantType["authorizationCode"] = "authorization_code";
@@ -452,6 +461,8 @@ var ConnectedAppType;
     ConnectedAppType["tiktok"] = "tiktok";
     ConnectedAppType["instagram"] = "instagram";
     ConnectedAppType["facebook"] = "facebook";
+    ConnectedAppType["twitch"] = "twitch";
+    ConnectedAppType["linkedin"] = "linkedin";
 })(ConnectedAppType || (exports.ConnectedAppType = ConnectedAppType = {}));
 var ConnectedAppConnectionStatus;
 (function (ConnectedAppConnectionStatus) {
@@ -1004,6 +1015,92 @@ var ParraAPI = /** @class */ (function () {
             if (options === void 0) { options = {}; }
             return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/chat/messages/").concat(message_id, "/reactions/").concat(reaction_id), __assign({ method: "delete" }, options));
         };
+        this.createCourse = function (tenant_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses"), __assign({ method: "post", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.listCourses = function (tenant_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses"), __assign({ method: "get" }, options));
+        };
+        this.getCourseById = function (tenant_id, course_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id), __assign({ method: "get" }, options));
+        };
+        this.updateCourseById = function (tenant_id, course_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.deleteCourseById = function (tenant_id, course_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id), __assign({ method: "delete" }, options));
+        };
+        this.getAppCourseById = function (tenant_id, application_id, course_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/applications/").concat(application_id, "/courses/").concat(course_id), __assign({ method: "get" }, options));
+        };
+        this.enrollInCourse = function (tenant_id, course_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/enroll"), __assign({ method: "post" }, options));
+        };
+        this.createModuleForCourse = function (tenant_id, course_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/modules"), __assign({ method: "post", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.updateModuleForCourseById = function (tenant_id, course_id, course_module_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/modules/").concat(course_module_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.deleteModuleForCourseById = function (tenant_id, course_id, course_module_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/modules/").concat(course_module_id), __assign({ method: "delete" }, options));
+        };
+        this.createLessonForModule = function (tenant_id, course_id, course_module_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/modules/").concat(course_module_id, "/lessons"), __assign({ method: "post", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.updateLessonForCourseById = function (tenant_id, course_id, lesson_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/lessons/").concat(lesson_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.deleteLessonForCourseById = function (tenant_id, course_id, lesson_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/lessons/").concat(lesson_id), __assign({ method: "delete" }, options));
+        };
+        this.createSectionForLesson = function (tenant_id, course_id, lesson_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/lessons/").concat(lesson_id, "/sections"), __assign({ method: "post", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.updateSectionForLesson = function (tenant_id, course_id, lesson_id, lesson_section_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/lessons/").concat(lesson_id, "/sections/").concat(lesson_section_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                } }, options));
+        };
+        this.deleteSectionForLesson = function (tenant_id, course_id, lesson_id, lesson_section_id, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/courses/").concat(course_id, "/lessons/").concat(lesson_id, "/sections/").concat(lesson_section_id), __assign({ method: "delete" }, options));
+        };
+        this.reportCourseLessonProgress = function (tenant_id, lesson_id, body, options) {
+            if (options === void 0) { options = {}; }
+            return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/lessons/").concat(lesson_id, "/progress"), __assign({ method: "post", body: JSON.stringify(body), headers: {
+                    "content-type": "application/json",
+                }, raw: true }, options));
+        };
         this.listAppFaqs = function (tenant_id, application_id, query, options) {
             if (options === void 0) { options = {}; }
             return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/applications/").concat(application_id, "/faqs"), __assign({ method: "get", query: query }, options));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parra/parra-js-sdk",
-  "version": "0.3.486",
+  "version": "0.3.488",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",