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

whop_sdk/types/course_update_params.py

@@ -0,0 +1,89 @@
+# 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 .languages import Languages
+
+__all__ = ["CourseUpdateParams", "Chapter", "ChapterLesson", "Thumbnail"]
+
+
+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"""
+
+    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"""
+
+
+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 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/experience_duplicate_params.py

@@ -0,0 +1,13 @@
+# 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__ = ["ExperienceDuplicateParams"]
+
+
+class ExperienceDuplicateParams(TypedDict, total=False):
+    name: Optional[str]
+    """The name of the new experience"""

whop_sdk/types/forum_post_list_response.py

@@ -1,6 +1,7 @@
 # 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
 
@@ -28,6 +29,9 @@ class ForumPostListResponse(BaseModel):
     content: Optional[str] = None
     """The content of the forum post in Markdown format"""
 
+    created_at: datetime
+    """The timestamp when the post was created"""
+
     is_edited: bool
     """Whether the forum post has been edited"""
 
@@ -46,6 +50,9 @@ class ForumPostListResponse(BaseModel):
     title: Optional[str] = None
     """The title of the forum post"""
 
+    updated_at: datetime
+    """The timestamp when the post was last updated"""
+
     user: User
     """The user who created this forum post"""
 

whop_sdk/types/forum_post_update_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 Iterable, Optional
+from typing_extensions import TypedDict
+
+__all__ = ["ForumPostUpdateParams", "Attachment"]
+
+
+class ForumPostUpdateParams(TypedDict, total=False):
+    attachments: Optional[Iterable[Attachment]]
+    """The attachments for this post"""
+
+    content: Optional[str]
+    """This is the main body of the post in Markdown format.
+
+    Hidden if paywalled and user hasn't purchased access to it.
+    """
+
+    is_pinned: Optional[bool]
+    """Whether the post is pinned. You can only pin a top level posts (not comments)."""
+
+    title: Optional[str]
+    """The title of the post. Only visible if paywalled."""
+
+
+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.
+    """

whop_sdk/types/languages.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["Languages"]
+
+Languages: TypeAlias = Literal[
+    "en",
+    "es",
+    "it",
+    "pt",
+    "de",
+    "fr",
+    "pl",
+    "ru",
+    "nl",
+    "ca",
+    "tr",
+    "sv",
+    "uk",
+    "no",
+    "fi",
+    "sk",
+    "el",
+    "cs",
+    "hr",
+    "da",
+    "ro",
+    "bg",
+]

whop_sdk/types/ledger_account_retrieve_response.py

@@ -62,7 +62,21 @@ class LedgerAccountRetrieveResponse(BaseModel):
     balances: List[Balance]
     """The balances associated with the account."""
 
-    ledger_account_audit_status: Optional[Literal["reserves_imposed", "requested_more_information"]] = None
+    ledger_account_audit_status: Optional[
+        Literal[
+            "pending",
+            "approved",
+            "reserves_imposed",
+            "suspended",
+            "ignored",
+            "rejected",
+            "requested_more_information",
+            "information_submitted",
+            "requested_tos_violation_correction",
+            "clawback_attempted",
+            "awaiting_sales_review",
+        ]
+    ] = None
     """The different statuses a LedgerAccountAudit can be"""
 
     ledger_type: Literal["primary", "pool"]

whop_sdk/types/lesson.py

@@ -0,0 +1,159 @@
+# 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 .lesson_types import LessonTypes
+from .lesson_visibilities import LessonVisibilities
+from .assessment_question_types import AssessmentQuestionTypes
+
+__all__ = [
+    "Lesson",
+    "AssessmentQuestion",
+    "AssessmentQuestionImage",
+    "AssessmentQuestionOption",
+    "Attachment",
+    "MainPdf",
+    "VideoAsset",
+]
+
+
+class AssessmentQuestionImage(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"""
+
+    url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
+
+
+class AssessmentQuestionOption(BaseModel):
+    id: str
+    """The ID of the assessment question option"""
+
+    is_correct: bool
+    """Whether this option is a correct answer"""
+
+    option_text: str
+    """The text of the answer option"""
+
+    order: int
+    """The order of this option within the question"""
+
+
+class AssessmentQuestion(BaseModel):
+    id: str
+    """The ID of the assessment question"""
+
+    correct_answer: str
+    """The correct answer for the question. Used for short answer questions"""
+
+    created_at: datetime
+    """When the question was created"""
+
+    image: Optional[AssessmentQuestionImage] = None
+    """Optional image attachment for the question"""
+
+    options: List[AssessmentQuestionOption]
+    """The answer options for multiple choice/select questions"""
+
+    order: int
+    """The order of the question within its lesson"""
+
+    question_text: str
+    """The text of the question"""
+
+    question_type: AssessmentQuestionTypes
+    """The type of the question"""
+
+
+class Attachment(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"""
+
+    url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
+
+
+class MainPdf(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"""
+
+    url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
+
+
+class VideoAsset(BaseModel):
+    id: str
+    """The ID of the Mux asset"""
+
+    asset_id: Optional[str] = None
+    """The Mux-provided ID of the asset"""
+
+    playback_id: Optional[str] = None
+    """The public playback ID of the Mux asset"""
+
+
+class Lesson(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    assessment_questions: List[AssessmentQuestion]
+    """Assessment questions for quiz/knowledge check lessons"""
+
+    attachments: List[Attachment]
+    """The attached files in this lesson as a flat array"""
+
+    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)"""
+
+    main_pdf: Optional[MainPdf] = None
+    """The main PDF file for this lesson"""
+
+    order: int
+    """The order of the lesson within its chapter"""
+
+    title: str
+    """The title of the lesson"""
+
+    video_asset: Optional[VideoAsset] = None
+    """The associated Mux asset for video lessons"""
+
+    visibility: LessonVisibilities
+    """The visibility of the lesson.
+
+    Determines how / whether this lesson is visible to users.
+    """

whop_sdk/types/lesson_types.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__ = ["LessonTypes"]
+
+LessonTypes: TypeAlias = Literal["text", "video", "pdf", "multi", "quiz", "knowledge_check"]

whop_sdk/types/lesson_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__ = ["LessonVisibilities"]
+
+LessonVisibilities: TypeAlias = Literal["visible", "hidden"]

whop_sdk/types/member_list_params.py

@@ -68,3 +68,6 @@ class MemberListParams(TypedDict, total=False):
 
     statuses: Optional[List[MemberStatuses]]
     """The statuses to filter the members by"""
+
+    user_ids: Optional[SequenceNotStr[str]]
+    """The user IDs to filter the members by"""

whop_sdk/types/membership_list_params.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 from typing import List, Union, Optional
 from datetime import datetime
-from typing_extensions import Literal, Required, Annotated, TypedDict
+from typing_extensions import Literal, Annotated, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
@@ -15,9 +15,6 @@ __all__ = ["MembershipListParams"]
 
 
 class MembershipListParams(TypedDict, total=False):
-    company_id: Required[str]
-    """The ID of the company to list memberships for"""
-
     access_pass_ids: Optional[SequenceNotStr[str]]
     """The access pass IDs to filter the memberships by"""
 
@@ -42,6 +39,9 @@ class MembershipListParams(TypedDict, total=False):
     ]
     """The cancel options to filter the memberships by"""
 
+    company_id: Optional[str]
+    """The ID of the company to list memberships for"""
+
     created_after: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """The minimum creation date to filter by"""
 
@@ -68,3 +68,6 @@ class MembershipListParams(TypedDict, total=False):
 
     statuses: Optional[List[MembershipStatus]]
     """The membership status to filter the memberships by"""
+
+    user_ids: Optional[SequenceNotStr[str]]
+    """Only return memberships from these whop user ids"""

whop_sdk/types/membership_list_response.py

@@ -7,7 +7,7 @@ from .._models import BaseModel
 from .shared.currency import Currency
 from .shared.membership_status import MembershipStatus
 
-__all__ = ["MembershipListResponse", "Company", "Member", "Plan", "PromoCode", "User"]
+__all__ = ["MembershipListResponse", "Company", "Member", "Plan", "Product", "PromoCode", "User"]
 
 
 class Company(BaseModel):
@@ -28,6 +28,14 @@ class Plan(BaseModel):
     """The internal ID of the plan."""
 
 
+class Product(BaseModel):
+    id: str
+    """The internal ID of the public product."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+
 class PromoCode(BaseModel):
     id: str
     """The ID of the promo."""
@@ -92,6 +100,9 @@ class MembershipListResponse(BaseModel):
     plan: Plan
     """The Plan this Membership is for."""
 
+    product: Product
+    """The Product this Membership grants access to."""
+
     promo_code: Optional[PromoCode] = None
     """The Promo Code that is currently applied to this Membership."""
 

whop_sdk/types/message_update_params.py

@@ -0,0 +1,35 @@
+# 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 TypedDict
+
+__all__ = ["MessageUpdateParams", "Attachment"]
+
+
+class MessageUpdateParams(TypedDict, total=False):
+    attachments: Optional[Iterable[Attachment]]
+    """The attachments for this message"""
+
+    content: Optional[str]
+    """The content of the message in Markdown format"""
+
+    is_pinned: Optional[bool]
+    """Whether this message is pinned"""
+
+
+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.
+    """

whop_sdk/types/payment_list_params.py

@@ -8,6 +8,7 @@ from typing_extensions import Literal, Required, Annotated, TypedDict
 
 from .._types import SequenceNotStr
 from .._utils import PropertyInfo
+from .billing_reasons import BillingReasons
 from .shared.currency import Currency
 from .shared.direction import Direction
 from .shared.receipt_status import ReceiptStatus
@@ -26,13 +27,7 @@ class PaymentListParams(TypedDict, total=False):
     before: Optional[str]
     """Returns the elements in the list that come before the specified cursor."""
 
-    billing_reasons: Optional[
-        List[
-            Literal[
-                "subscription_create", "subscription_cycle", "subscription_update", "one_time", "manual", "subscription"
-            ]
-        ]
-    ]
+    billing_reasons: Optional[List[BillingReasons]]
     """The billing reason for the payment"""
 
     created_after: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]

whop_sdk/types/payment_list_response.py

@@ -4,8 +4,11 @@ from typing import Optional
 from datetime import datetime
 
 from .._models import BaseModel
+from .card_brands import CardBrands
+from .billing_reasons import BillingReasons
 from .shared.currency import Currency
 from .shared.promo_type import PromoType
+from .payment_method_types import PaymentMethodTypes
 from .shared.receipt_status import ReceiptStatus
 from .shared.membership_status import MembershipStatus
 from .shared.friendly_receipt_status import FriendlyReceiptStatus
@@ -103,7 +106,7 @@ class PromoCode(BaseModel):
     """The specific code used to apply the promo at checkout."""
 
     number_of_intervals: Optional[int] = None
-    """The number of billing cycles the promo is applied for."""
+    """The number of months the promo is applied for."""
 
     promo_type: PromoType
     """The type (% or flat amount) of the promo."""
@@ -136,11 +139,11 @@ class PaymentListResponse(BaseModel):
     billing_address: Optional[BillingAddress] = None
     """The address of the user who made the payment."""
 
-    billing_reason: Optional[str] = None
-    """The billing reason"""
+    billing_reason: Optional[BillingReasons] = None
+    """The reason why a specific payment was billed"""
 
-    card_brand: Optional[str] = None
-    """The type of card used as the payment method."""
+    card_brand: Optional[CardBrands] = None
+    """Possible card brands that a payment token can have"""
 
     card_last4: Optional[str] = None
     """The last 4 digits of the card used to make the payment."""
@@ -172,11 +175,8 @@ class PaymentListResponse(BaseModel):
     paid_at: Optional[datetime] = None
     """The datetime the payment was paid"""
 
-    payment_method_type: Optional[str] = None
-    """Returns the type of payment method used for the payment, if available.
-
-    Ex. klarna, affirm, card, cashapp
-    """
+    payment_method_type: Optional[PaymentMethodTypes] = None
+    """The different types of payment methods that can be used."""
 
     plan: Optional[Plan] = None
     """The plan attached to this payment."""
@@ -188,7 +188,10 @@ class PaymentListResponse(BaseModel):
     """The promo code used for this payment."""
 
     refundable: bool
-    """Whether the payment can be refunded."""
+    """
+    True only for payments that are `paid`, have not been fully refunded, and were
+    processed by a payment processor that allows refunds.
+    """
 
     refunded_amount: Optional[float] = None
     """The payment refund amount(if applicable)."""
@@ -197,7 +200,11 @@ class PaymentListResponse(BaseModel):
     """When the payment was refunded (if applicable)."""
 
     retryable: bool
-    """Whether the payment can be retried."""
+    """
+    True when the payment status is `open` and its membership is in one of the
+    retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
+    otherwise false. Used to decide if Whop can attempt the charge again.
+    """
 
     status: Optional[ReceiptStatus] = None
     """The status of a receipt"""
@@ -218,4 +225,7 @@ class PaymentListResponse(BaseModel):
     """The user that made this payment."""
 
     voidable: bool
-    """Whether the payment can be voided."""
+    """
+    True when the payment is tied to a membership in `past_due`, the payment status
+    is `open`, and the processor allows voiding payments; otherwise false.
+    """