whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/course_lesson_update_params.py

@@ -0,0 +1,222 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .embed_type import EmbedType
+from .lesson_types import LessonTypes
+from .lesson_visibilities import LessonVisibilities
+from .assessment_question_types import AssessmentQuestionTypes
+
+__all__ = [
+    "CourseLessonUpdateParams",
+    "AssessmentCompletionRequirement",
+    "AssessmentQuestion",
+    "AssessmentQuestionImage",
+    "AssessmentQuestionImageAttachmentInputWithDirectUploadID",
+    "AssessmentQuestionImageAttachmentInputWithID",
+    "AssessmentQuestionOption",
+    "Attachment",
+    "AttachmentAttachmentInputWithDirectUploadID",
+    "AttachmentAttachmentInputWithID",
+    "MainPdf",
+    "MainPdfAttachmentInputWithDirectUploadID",
+    "MainPdfAttachmentInputWithID",
+    "Thumbnail",
+    "ThumbnailAttachmentInputWithDirectUploadID",
+    "ThumbnailAttachmentInputWithID",
+]
+
+
+class CourseLessonUpdateParams(TypedDict, total=False):
+    assessment_completion_requirement: Optional[AssessmentCompletionRequirement]
+    """Completion requirements for quiz/knowledge check lessons"""
+
+    assessment_questions: Optional[Iterable[AssessmentQuestion]]
+    """Assessment questions for quiz/knowledge check lessons.
+
+    Replaces all existing questions.
+    """
+
+    attachments: Optional[Iterable[Attachment]]
+    """General attachments for the lesson (PDFs, files, etc).
+
+    Replaces all existing attachments.
+    """
+
+    content: Optional[str]
+    """The content of the lesson"""
+
+    days_from_course_start_until_unlock: Optional[int]
+    """Days from course start until unlock"""
+
+    embed_id: Optional[str]
+    """ID for the embed (YouTube video ID or Loom share ID)"""
+
+    embed_type: Optional[EmbedType]
+    """The type of embed for a lesson"""
+
+    lesson_type: Optional[LessonTypes]
+    """The available types for a lesson"""
+
+    main_pdf: Optional[MainPdf]
+    """The main PDF file for this lesson"""
+
+    max_attempts: Optional[int]
+    """Maximum number of attempts allowed for assessments"""
+
+    mux_asset_id: Optional[str]
+    """The ID of the Mux asset to attach to this lesson for video lessons"""
+
+    thumbnail: Optional[Thumbnail]
+    """The thumbnail for the lesson in png, jpeg, or gif format"""
+
+    title: Optional[str]
+    """The title of the lesson"""
+
+    visibility: Optional[LessonVisibilities]
+    """The available visibilities for a lesson.
+
+    Determines how / whether a lesson is visible to users.
+    """
+
+
+class AssessmentCompletionRequirement(TypedDict, total=False):
+    minimum_grade_percent: Optional[float]
+    """The minimum grade percentage required to pass (0-100).
+
+    Cannot be set together with minimum_questions_correct.
+    """
+
+    minimum_questions_correct: Optional[int]
+    """The minimum number of questions that must be answered correctly.
+
+    Cannot be set together with minimum_grade_percent.
+    """
+
+
+class AssessmentQuestionImageAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[str]
+    """This ID should be used the first time you upload an attachment.
+
+    It is the ID of the direct upload that was created when uploading the file to S3
+    via the mediaDirectUpload mutation.
+    """
+
+
+class AssessmentQuestionImageAttachmentInputWithID(TypedDict, total=False):
+    id: Required[str]
+    """The ID of an existing attachment object.
+
+    Use this when updating a resource and keeping a subset of the attachments. Don't
+    use this unless you know what you're doing.
+    """
+
+
+AssessmentQuestionImage: TypeAlias = Union[
+    AssessmentQuestionImageAttachmentInputWithDirectUploadID, AssessmentQuestionImageAttachmentInputWithID
+]
+
+
+class AssessmentQuestionOption(TypedDict, total=False):
+    is_correct: Required[bool]
+    """Whether this option is a correct answer"""
+
+    option_text: Required[str]
+    """The text of the answer option"""
+
+    id: Optional[str]
+    """The ID of an existing option.
+
+    If provided, the option will be updated. If not provided, a new option will be
+    created.
+    """
+
+
+class AssessmentQuestion(TypedDict, total=False):
+    correct_answer: Required[str]
+    """The correct answer for the question. Used for short answer questions"""
+
+    question_text: Required[str]
+    """The text of the question"""
+
+    question_type: Required[AssessmentQuestionTypes]
+    """The type of the question"""
+
+    id: Optional[str]
+    """The ID of an existing question.
+
+    If provided, the question will be updated. If not provided, a new question will
+    be created.
+    """
+
+    image: Optional[AssessmentQuestionImage]
+    """Optional image attachment for the question"""
+
+    options: Optional[Iterable[AssessmentQuestionOption]]
+    """The answer options for multiple choice/select questions"""
+
+
+class AttachmentAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[str]
+    """This ID should be used the first time you upload an attachment.
+
+    It is the ID of the direct upload that was created when uploading the file to S3
+    via the mediaDirectUpload mutation.
+    """
+
+
+class AttachmentAttachmentInputWithID(TypedDict, total=False):
+    id: Required[str]
+    """The ID of an existing attachment object.
+
+    Use this when updating a resource and keeping a subset of the attachments. Don't
+    use this unless you know what you're doing.
+    """
+
+
+Attachment: TypeAlias = Union[AttachmentAttachmentInputWithDirectUploadID, AttachmentAttachmentInputWithID]
+
+
+class MainPdfAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[str]
+    """This ID should be used the first time you upload an attachment.
+
+    It is the ID of the direct upload that was created when uploading the file to S3
+    via the mediaDirectUpload mutation.
+    """
+
+
+class MainPdfAttachmentInputWithID(TypedDict, total=False):
+    id: Required[str]
+    """The ID of an existing attachment object.
+
+    Use this when updating a resource and keeping a subset of the attachments. Don't
+    use this unless you know what you're doing.
+    """
+
+
+MainPdf: TypeAlias = Union[MainPdfAttachmentInputWithDirectUploadID, MainPdfAttachmentInputWithID]
+
+
+class ThumbnailAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[str]
+    """This ID should be used the first time you upload an attachment.
+
+    It is the ID of the direct upload that was created when uploading the file to S3
+    via the mediaDirectUpload mutation.
+    """
+
+
+class ThumbnailAttachmentInputWithID(TypedDict, total=False):
+    id: Required[str]
+    """The ID of an existing attachment object.
+
+    Use this when updating a resource and keeping a subset of the attachments. Don't
+    use this unless you know what you're doing.
+    """
+
+
+Thumbnail: TypeAlias = Union[ThumbnailAttachmentInputWithDirectUploadID, ThumbnailAttachmentInputWithID]

whop_sdk/types/course_list_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["CourseListParams"]
+
+
+class CourseListParams(TypedDict, total=False):
+    after: Optional[str]
+    """Returns the elements in the list that come after the specified cursor."""
+
+    before: Optional[str]
+    """Returns the elements in the list that come before the specified cursor."""
+
+    company_id: Optional[str]
+    """The ID of the company"""
+
+    experience_id: Optional[str]
+    """The ID of the experience"""
+
+    first: Optional[int]
+    """Returns the first _n_ elements from the list."""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""

whop_sdk/types/course_list_response.py

@@ -0,0 +1,90 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+from .languages import Languages
+from .course_visibilities import CourseVisibilities
+
+__all__ = ["CourseListResponse", "Thumbnail"]
+
+
+class Thumbnail(BaseModel):
+    id: str
+    """The ID of the attachment"""
+
+    content_type: Optional[str] = None
+    """The attachment's content type (e.g., image/jpg, video/mp4)"""
+
+    filename: Optional[str] = None
+    """The name of the file"""
+
+    optimized_url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
+
+    source_url: Optional[str] = None
+    """The original URL of the attachment, such as a direct link to S3.
+
+    This should never be displayed on the client and always passed to an Imgproxy
+    transformer.
+    """
+
+
+class CourseListResponse(BaseModel):
+    id: str
+    """The ID of the course. Looks like cors_XXX"""
+
+    certificate_after_completion_enabled: Optional[bool] = None
+    """
+    Whether the course will award its students a PDF certificate after completing
+    all lessons
+    """
+
+    cover_image: Optional[str] = None
+    """The URL of the course's cover image, which is shown in course preview cards"""
+
+    created_at: datetime
+    """The timestamp of when the course was created"""
+
+    description: Optional[str] = None
+    """A short description of the course"""
+
+    language: Languages
+    """
+    The language spoken in the video content of the course, used to generate closed
+    captions in the right language
+    """
+
+    order: str
+    """The order of the course within its experience"""
+
+    require_completing_lessons_in_order: bool
+    """
+    Whether the course requires students to complete the previous lesson before
+    moving on to the next one
+    """
+
+    tagline: Optional[str] = None
+    """A short tagline for the course.
+
+    It is displayed under the course title in the UI
+    """
+
+    thumbnail: Optional[Thumbnail] = None
+    """The thumbnail for the course"""
+
+    title: Optional[str] = None
+    """The title of the course"""
+
+    updated_at: datetime
+    """The timestamp of when the course was last updated"""
+
+    visibility: CourseVisibilities
+    """The visibility of the course.
+
+    Determines how / whether this course is visible to users.
+    """

whop_sdk/types/course_student_list_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["CourseStudentListParams"]
+
+
+class CourseStudentListParams(TypedDict, total=False):
+    course_id: Required[str]
+    """The ID of the course"""
+
+    after: Optional[str]
+    """Returns the elements in the list that come after the specified cursor."""
+
+    before: Optional[str]
+    """Returns the elements in the list that come before the specified cursor."""
+
+    first: Optional[int]
+    """Returns the first _n_ elements from the list."""
+
+    keyword: Optional[str]
+    """Filter students by name - returns students whose names match the keyword"""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""

whop_sdk/types/course_student_list_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["CourseStudentListResponse", "User"]
+
+
+class User(BaseModel):
+    id: str
+    """The internal ID of the user."""
+
+    name: Optional[str] = None
+    """The name of the user from their Whop account."""
+
+    username: str
+    """The username of the user from their Whop account."""
+
+
+class CourseStudentListResponse(BaseModel):
+    id: str
+    """The ID of the course student. Looks like crsi_XXX"""
+
+    completed_lessons_count: int
+    """The number of lessons the student has completed"""
+
+    completion_rate: float
+    """The percentage of lessons completed (0-100)"""
+
+    first_interaction_at: datetime
+    """When the student first interacted with the course"""
+
+    last_interaction_at: datetime
+    """When the student last interacted with the course"""
+
+    total_lessons_count: int
+    """The total number of lessons the student has access to"""
+
+    user: User
+    """The user who is enrolled in the course"""

whop_sdk/types/course_student_retrieve_response.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["CourseStudentRetrieveResponse", "Course", "CourseExperience", "User"]
+
+
+class CourseExperience(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+
+class Course(BaseModel):
+    id: str
+    """The ID of the course. Looks like cors_XXX"""
+
+    experience: CourseExperience
+    """The experience that the course belongs to"""
+
+    title: Optional[str] = None
+    """The title of the course"""
+
+
+class User(BaseModel):
+    id: str
+    """The internal ID of the user."""
+
+    name: Optional[str] = None
+    """The name of the user from their Whop account."""
+
+    username: str
+    """The username of the user from their Whop account."""
+
+
+class CourseStudentRetrieveResponse(BaseModel):
+    id: str
+    """The ID of the course student. Looks like crsi_XXX"""
+
+    completed_lessons_count: int
+    """The number of lessons the student has completed"""
+
+    completion_rate: float
+    """The percentage of lessons completed (0-100)"""
+
+    course: Course
+    """The course the student is enrolled in"""
+
+    first_interaction_at: datetime
+    """When the student first interacted with the course"""
+
+    last_interaction_at: datetime
+    """When the student last interacted with the course"""
+
+    total_lessons_count: int
+    """The total number of lessons the student has access to"""
+
+    user: User
+    """The user who is enrolled in the course"""

whop_sdk/types/course_update_params.py

@@ -0,0 +1,114 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .languages import Languages
+from .course_visibilities import CourseVisibilities
+
+__all__ = [
+    "CourseUpdateParams",
+    "Chapter",
+    "ChapterLesson",
+    "Thumbnail",
+    "ThumbnailAttachmentInputWithDirectUploadID",
+    "ThumbnailAttachmentInputWithID",
+]
+
+
+class CourseUpdateParams(TypedDict, total=False):
+    certificate_after_completion_enabled: Optional[bool]
+    """
+    Whether the course will award its students a PDF certificate after completing
+    all lessons
+    """
+
+    chapters: Optional[Iterable[Chapter]]
+    """The chapters and lessons to update"""
+
+    cover_image: Optional[str]
+    """The cover image URL of the course"""
+
+    description: Optional[str]
+    """A short description of the course"""
+
+    language: Optional[Languages]
+    """The available languages for a course"""
+
+    order: Optional[str]
+    """The decimal order position of the course within its experience.
+
+    Use fractional values (e.g., 1.5) to place between existing courses.
+    """
+
+    require_completing_lessons_in_order: Optional[bool]
+    """
+    Whether the course requires students to complete the previous lesson before
+    moving on to the next one
+    """
+
+    tagline: Optional[str]
+    """A short tagline for the course"""
+
+    thumbnail: Optional[Thumbnail]
+    """The thumbnail for the course in png, jpeg, or gif format"""
+
+    title: Optional[str]
+    """The title of the course"""
+
+    visibility: Optional[CourseVisibilities]
+    """The available visibilities for a course.
+
+    Determines how / whether a course is visible to users.
+    """
+
+
+class ChapterLesson(TypedDict, total=False):
+    id: Required[str]
+    """The ID of the lesson to update"""
+
+    chapter_id: Required[str]
+    """The ID of the chapter this lesson belongs to (for moving between chapters)"""
+
+    order: Required[int]
+    """The order of the lesson within its chapter"""
+
+    title: Required[str]
+    """The title of the lesson"""
+
+
+class Chapter(TypedDict, total=False):
+    id: Required[str]
+    """The ID of the chapter to update"""
+
+    order: Required[int]
+    """The order of the chapter within its course"""
+
+    title: Required[str]
+    """The title of the chapter"""
+
+    lessons: Optional[Iterable[ChapterLesson]]
+    """The lessons to update within this chapter"""
+
+
+class ThumbnailAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[str]
+    """This ID should be used the first time you upload an attachment.
+
+    It is the ID of the direct upload that was created when uploading the file to S3
+    via the mediaDirectUpload mutation.
+    """
+
+
+class ThumbnailAttachmentInputWithID(TypedDict, total=False):
+    id: Required[str]
+    """The ID of an existing attachment object.
+
+    Use this when updating a resource and keeping a subset of the attachments. Don't
+    use this unless you know what you're doing.
+    """
+
+
+Thumbnail: TypeAlias = Union[ThumbnailAttachmentInputWithDirectUploadID, ThumbnailAttachmentInputWithID]

whop_sdk/types/course_visibilities.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["CourseVisibilities"]
+
+CourseVisibilities: TypeAlias = Literal["visible", "hidden"]