whop-sdk 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

whop_sdk/types/checkout_configuration_list_response.py

@@ -45,22 +45,25 @@ class Plan(BaseModel):
 
 class CheckoutConfigurationListResponse(BaseModel):
     id: str
-    """The ID of the checkout session"""
+    """The ID of the checkout configuration"""
 
-    affiliate_code: str
-    """The affiliate code to use for the checkout session"""
+    affiliate_code: Optional[str] = None
+    """The affiliate code to use for the checkout configuration"""
 
     company_id: str
-    """The ID of the company to use for the checkout session"""
+    """The ID of the company to use for the checkout configuration"""
 
     metadata: Dict[str, object]
-    """The metadata to use for the checkout session"""
+    """The metadata to use for the checkout configuration"""
 
     plan: Plan
-    """The plan to use for the checkout session"""
+    """The plan to use for the checkout configuration"""
 
     purchase_url: str
-    """The URL to redirect the user to after the checkout session is created"""
+    """A URL you can send to customers to complete a checkout.
 
-    redirect_url: str
-    """The URL to redirect the user to after the checkout session is created"""
+    It looks like `/checkout/plan_xxxx?session={id}`
+    """
+
+    redirect_url: Optional[str] = None
+    """The URL to redirect the user to after the checkout configuration is created"""

whop_sdk/types/course.py

@@ -0,0 +1,109 @@
+# 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
+
+__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"""
+
+    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
+    """
+
+    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"""

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,41 @@
+# 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__ = ["CourseCreateParams", "Thumbnail"]
+
+
+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"""
+
+    cover_image: Optional[str]
+    """The cover image URL of the course"""
+
+    tagline: Optional[str]
+    """The tagline of the course"""
+
+    thumbnail: Optional[Thumbnail]
+    """The thumbnail for the course in png, jpeg, or gif format"""
+
+
+class Thumbnail(TypedDict, total=False):
+    id: Optional[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.
+    """
+
+    direct_upload_id: Optional[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.
+    """

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,27 @@
+# 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
+
+from .lesson_types import LessonTypes
+
+__all__ = ["CourseLessonCreateParams"]
+
+
+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"""
+
+    title: Optional[str]
+    """The title of the lesson"""

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_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,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .lesson_types import LessonTypes
+from .lesson_visibilities import LessonVisibilities
+
+__all__ = ["CourseLessonListResponse"]
+
+
+class CourseLessonListResponse(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    content: Optional[str] = None
+    """The content of the lesson"""
+
+    days_from_course_start_until_unlock: Optional[int] = None
+    """Number of days from course start until the lesson is unlocked"""
+
+    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"""
+
+    visibility: LessonVisibilities
+    """The visibility of the lesson.
+
+    Determines how / whether this lesson is visible to users.
+    """

whop_sdk/types/course_lesson_update_params.py

@@ -0,0 +1,144 @@
+# 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 .lesson_types import LessonTypes
+from .lesson_visibilities import LessonVisibilities
+from .assessment_question_types import AssessmentQuestionTypes
+
+__all__ = [
+    "CourseLessonUpdateParams",
+    "AssessmentQuestion",
+    "AssessmentQuestionImage",
+    "AssessmentQuestionOption",
+    "Attachment",
+    "MainPdf",
+]
+
+
+class CourseLessonUpdateParams(TypedDict, total=False):
+    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"""
+
+    lesson_type: Optional[LessonTypes]
+    """The available types for a lesson"""
+
+    main_pdf: Optional[MainPdf]
+    """The main PDF file for this lesson"""
+
+    mux_asset_id: Optional[str]
+    """The ID of the Mux asset to attach to this lesson for video lessons"""
+
+    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 AssessmentQuestionImage(TypedDict, total=False):
+    id: Optional[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.
+    """
+
+    direct_upload_id: Optional[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 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 Attachment(TypedDict, total=False):
+    id: Optional[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.
+    """
+
+    direct_upload_id: Optional[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 MainPdf(TypedDict, total=False):
+    id: Optional[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.
+    """
+
+    direct_upload_id: Optional[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.
+    """

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."""