whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/course.py

@@ -0,0 +1,122 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+from .languages import Languages
+from .lesson_types import LessonTypes
+from .course_visibilities import CourseVisibilities
+
+__all__ = ["Course", "Chapter", "ChapterLesson", "Thumbnail"]
+
+
+class ChapterLesson(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    lesson_type: LessonTypes
+    """The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)"""
+
+    order: int
+    """The order of the lesson within its chapter"""
+
+    title: str
+    """The title of the lesson"""
+
+
+class Chapter(BaseModel):
+    id: str
+    """The ID of the chapter. Looks like chap_XXX"""
+
+    lessons: List[ChapterLesson]
+    """The lessons in this chapter"""
+
+    order: int
+    """The order of the chapter within its course"""
+
+    title: str
+    """The title of the chapter"""
+
+
+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 Course(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
+    """
+
+    chapters: List[Chapter]
+    """The chapters in this course"""
+
+    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_chapter.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .._models import BaseModel
+
+__all__ = ["CourseChapter", "Lesson"]
+
+
+class Lesson(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    order: int
+    """The order of the lesson within its chapter"""
+
+    title: str
+    """The title of the lesson"""
+
+
+class CourseChapter(BaseModel):
+    id: str
+    """The ID of the chapter. Looks like chap_XXX"""
+
+    lessons: List[Lesson]
+    """The lessons in this chapter"""
+
+    order: int
+    """The order of the chapter within its course"""
+
+    title: str
+    """The title of the chapter"""

whop_sdk/types/course_chapter_create_params.py

@@ -0,0 +1,16 @@
+# 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__ = ["CourseChapterCreateParams"]
+
+
+class CourseChapterCreateParams(TypedDict, total=False):
+    course_id: Required[str]
+    """The ID of the course to create the chapter in"""
+
+    title: Optional[str]
+    """The title of the chapter"""

whop_sdk/types/course_chapter_delete_response.py

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

whop_sdk/types/course_chapter_list_params.py

@@ -0,0 +1,25 @@
+# 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__ = ["CourseChapterListParams"]
+
+
+class CourseChapterListParams(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."""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""

whop_sdk/types/course_chapter_list_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["CourseChapterListResponse"]
+
+
+class CourseChapterListResponse(BaseModel):
+    id: str
+    """The ID of the chapter. Looks like chap_XXX"""
+
+    order: int
+    """The order of the chapter within its course"""
+
+    title: str
+    """The title of the chapter"""

whop_sdk/types/course_chapter_update_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["CourseChapterUpdateParams"]
+
+
+class CourseChapterUpdateParams(TypedDict, total=False):
+    title: Required[str]
+    """The title of the chapter"""

whop_sdk/types/course_create_params.py

@@ -0,0 +1,78 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .course_visibilities import CourseVisibilities
+
+__all__ = [
+    "CourseCreateParams",
+    "Thumbnail",
+    "ThumbnailAttachmentInputWithDirectUploadID",
+    "ThumbnailAttachmentInputWithID",
+]
+
+
+class CourseCreateParams(TypedDict, total=False):
+    experience_id: Required[str]
+    """The ID of the experience to create the course in"""
+
+    title: Required[str]
+    """The title of the course"""
+
+    certificate_after_completion_enabled: Optional[bool]
+    """
+    Whether the course will award its students a PDF certificate after completing
+    all lessons
+    """
+
+    cover_image: Optional[str]
+    """The cover image URL of the course"""
+
+    order: Optional[str]
+    """The decimal order position of the course within its experience.
+
+    If not provided, it will be set to the next sequential order. 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]
+    """The tagline of the course"""
+
+    thumbnail: Optional[Thumbnail]
+    """The thumbnail for the course in png, jpeg, or gif format"""
+
+    visibility: Optional[CourseVisibilities]
+    """The available visibilities for a course.
+
+    Determines how / whether a course is visible to users.
+    """
+
+
+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_delete_response.py

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

whop_sdk/types/course_lesson_create_params.py

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .embed_type import EmbedType
+from .lesson_types import LessonTypes
+
+__all__ = [
+    "CourseLessonCreateParams",
+    "Thumbnail",
+    "ThumbnailAttachmentInputWithDirectUploadID",
+    "ThumbnailAttachmentInputWithID",
+]
+
+
+class CourseLessonCreateParams(TypedDict, total=False):
+    chapter_id: Required[str]
+    """The ID of the chapter to create the lesson in"""
+
+    lesson_type: Required[LessonTypes]
+    """The type of the lesson"""
+
+    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"""
+
+    thumbnail: Optional[Thumbnail]
+    """The thumbnail for the lesson in png, jpeg, or gif format"""
+
+    title: Optional[str]
+    """The title of the lesson"""
+
+
+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_lesson_delete_response.py

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

whop_sdk/types/course_lesson_interaction_completed_webhook_event.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .shared.course_lesson_interaction import CourseLessonInteraction
+
+__all__ = ["CourseLessonInteractionCompletedWebhookEvent"]
+
+
+class CourseLessonInteractionCompletedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: CourseLessonInteraction
+    """A lesson interaction tracking user progress in courses"""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["course_lesson_interaction.completed"]
+    """The webhook event type"""

whop_sdk/types/course_lesson_interaction_list_params.py

@@ -0,0 +1,34 @@
+# 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__ = ["CourseLessonInteractionListParams"]
+
+
+class CourseLessonInteractionListParams(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."""
+
+    completed: Optional[bool]
+    """Whether the lesson has been completed by the user"""
+
+    course_id: Optional[str]
+    """The ID of the course to list course lesson interactions for"""
+
+    first: Optional[int]
+    """Returns the first _n_ elements from the list."""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""
+
+    lesson_id: Optional[str]
+    """The ID of the lesson to list course lesson interactions for"""
+
+    user_id: Optional[str]
+    """The ID of the user to list course lesson interactions for"""

whop_sdk/types/course_lesson_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__ = ["CourseLessonListParams"]
+
+
+class CourseLessonListParams(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."""
+
+    chapter_id: Optional[str]
+    """The ID of the chapter (returns lessons only for this chapter)"""
+
+    course_id: Optional[str]
+    """The ID of the course (returns all lessons across all chapters)"""
+
+    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_lesson_list_response.py

@@ -0,0 +1,57 @@
+# 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 .embed_type import EmbedType
+from .lesson_types import LessonTypes
+from .lesson_visibilities import LessonVisibilities
+
+__all__ = ["CourseLessonListResponse", "Thumbnail"]
+
+
+class Thumbnail(BaseModel):
+    url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
+
+
+class CourseLessonListResponse(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    content: Optional[str] = None
+    """The content of the lesson"""
+
+    created_at: datetime
+    """The timestamp of when the lesson was created"""
+
+    days_from_course_start_until_unlock: Optional[int] = None
+    """Number of days from course start until the lesson is unlocked"""
+
+    embed_id: Optional[str] = None
+    """ID for the embed (YouTube video ID or Loom share ID)"""
+
+    embed_type: Optional[EmbedType] = None
+    """The type of embed for a lesson"""
+
+    lesson_type: LessonTypes
+    """The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)"""
+
+    order: int
+    """The order of the lesson within its chapter"""
+
+    thumbnail: Optional[Thumbnail] = None
+    """The thumbnail for the lesson"""
+
+    title: str
+    """The title of the lesson"""
+
+    visibility: LessonVisibilities
+    """The visibility of the lesson.
+
+    Determines how / whether this lesson is visible to users.
+    """

whop_sdk/types/course_lesson_mark_as_completed_response.py

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

whop_sdk/types/course_lesson_start_response.py

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

whop_sdk/types/course_lesson_submit_assessment_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["CourseLessonSubmitAssessmentParams", "Answer"]
+
+
+class CourseLessonSubmitAssessmentParams(TypedDict, total=False):
+    answers: Required[Iterable[Answer]]
+    """The answers to the assessment questions"""
+
+
+class Answer(TypedDict, total=False):
+    question_id: Required[str]
+    """The ID of the question being answered"""
+
+    answer_text: Optional[str]
+    """The text answer provided by the user (for short answer questions)"""
+
+    selected_option_ids: Optional[SequenceNotStr[str]]
+    """The IDs of the selected options (for multiple choice/select questions)"""

whop_sdk/types/course_lesson_submit_assessment_response.py

@@ -0,0 +1,62 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["CourseLessonSubmitAssessmentResponse", "Lesson", "User"]
+
+
+class Lesson(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    title: str
+    """The title of the lesson"""
+
+
+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 CourseLessonSubmitAssessmentResponse(BaseModel):
+    id: str
+    """The ID of the assessment result"""
+
+    created_at: datetime
+    """When the assessment was taken"""
+
+    lesson: Lesson
+    """The lesson this assessment result is for"""
+
+    result_correct: int
+    """The number of correct answers"""
+
+    result_grade: float
+    """The grade achieved on the assessment"""
+
+    result_graded_questions: Dict[str, object]
+    """Array of graded questions with details"""
+
+    result_passing_grade: bool
+    """Whether the user achieved a passing grade"""
+
+    result_question_count: int
+    """The total number of questions in the assessment"""
+
+    score_percent: float
+    """The percentage score achieved on the assessment"""
+
+    updated_at: datetime
+    """When the assessment result was last updated"""
+
+    user: User
+    """The user who took the assessment"""