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

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

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .shared.direction import Direction
+from .shared.access_level import AccessLevel
+from .shared.member_statuses import MemberStatuses
+from .shared.member_most_recent_actions import MemberMostRecentActions
+
+__all__ = ["MemberListParams"]
+
+
+class MemberListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list members for"""
+
+    access_level: Optional[AccessLevel]
+    """The access level a given user (or company) has to an access pass or company."""
+
+    access_pass_ids: Optional[SequenceNotStr[str]]
+    """The access pass IDs to filter the members by"""
+
+    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."""
+
+    created_after: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The minimum creation date to filter by"""
+
+    created_before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The maximum creation date to filter by"""
+
+    direction: Optional[Direction]
+    """The direction of the sort."""
+
+    first: Optional[int]
+    """Returns the first _n_ elements from the list."""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""
+
+    most_recent_actions: Optional[List[MemberMostRecentActions]]
+    """The most recent actions to filter the members by"""
+
+    order: Optional[Literal["id", "usd_total_spent", "created_at", "joined_at", "most_recent_action"]]
+    """Which columns can be used to sort."""
+
+    plan_ids: Optional[SequenceNotStr[str]]
+    """The plan IDs to filter the members by"""
+
+    promo_code_ids: Optional[SequenceNotStr[str]]
+    """The promo code IDs to filter the members by"""
+
+    query: Optional[str]
+    """The name, username, or email to filter the members by.
+
+    The email filter will only apply if the current actor has the
+    `member:email:read` permission.
+    """
+
+    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/member_list_response.py

@@ -0,0 +1,65 @@
+# 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 .shared.access_level import AccessLevel
+from .shared.member_statuses import MemberStatuses
+from .shared.member_most_recent_actions import MemberMostRecentActions
+
+__all__ = ["MemberListResponse", "User"]
+
+
+class User(BaseModel):
+    id: str
+    """The internal ID of the user account."""
+
+    email: Optional[str] = None
+    """The digital mailing address of the user."""
+
+    name: Optional[str] = None
+    """The user's full name."""
+
+    username: str
+    """The whop username."""
+
+
+class MemberListResponse(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    access_level: AccessLevel
+    """The access level of the product member.
+
+    If its admin, the member is an authorized user of the access pass. If its
+    customer, the member has a valid membership to the access pass. If its
+    no_access, the member does not have access to the access pass.
+    """
+
+    created_at: datetime
+    """When the member was created"""
+
+    joined_at: datetime
+    """When the member joined the company"""
+
+    most_recent_action: Optional[MemberMostRecentActions] = None
+    """The different most recent actions a member can have."""
+
+    most_recent_action_at: Optional[datetime] = None
+    """The time for the most recent action, if applicable."""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+    status: MemberStatuses
+    """The status of the member"""
+
+    updated_at: datetime
+    """The timestamp of when this member was last updated"""
+
+    usd_total_spent: float
+    """How much money this customer has spent on the company's products and plans"""
+
+    user: Optional[User] = None
+    """The user for this member, if any."""

whop_sdk/types/member_retrieve_response.py

@@ -0,0 +1,79 @@
+# 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 .shared.access_level import AccessLevel
+from .shared.member_statuses import MemberStatuses
+from .shared.member_most_recent_actions import MemberMostRecentActions
+
+__all__ = ["MemberRetrieveResponse", "Company", "User"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID of the company"""
+
+    route: str
+    """The slug/route of the company on the Whop site."""
+
+    title: str
+    """The written name of the company."""
+
+
+class User(BaseModel):
+    id: str
+    """The internal ID of the user account."""
+
+    email: Optional[str] = None
+    """The digital mailing address of the user."""
+
+    name: Optional[str] = None
+    """The user's full name."""
+
+    username: str
+    """The whop username."""
+
+
+class MemberRetrieveResponse(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    access_level: AccessLevel
+    """The access level of the product member.
+
+    If its admin, the member is an authorized user of the access pass. If its
+    customer, the member has a valid membership to the access pass. If its
+    no_access, the member does not have access to the access pass.
+    """
+
+    company: Company
+    """The company for the member."""
+
+    created_at: datetime
+    """When the member was created"""
+
+    joined_at: datetime
+    """When the member joined the company"""
+
+    most_recent_action: Optional[MemberMostRecentActions] = None
+    """The different most recent actions a member can have."""
+
+    most_recent_action_at: Optional[datetime] = None
+    """The time for the most recent action, if applicable."""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+    status: MemberStatuses
+    """The status of the member"""
+
+    updated_at: datetime
+    """The timestamp of when this member was last updated"""
+
+    usd_total_spent: float
+    """How much money this customer has spent on the company's products and plans"""
+
+    user: Optional[User] = None
+    """The user for this member, if any."""

whop_sdk/types/membership_activated_webhook_event.py

@@ -0,0 +1,29 @@
+# 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.membership import Membership
+
+__all__ = ["MembershipActivatedWebhookEvent"]
+
+
+class MembershipActivatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Membership
+    """
+    A membership represents a purchase between a User and a Company for a specific
+    Product.
+    """
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["membership.activated"]
+    """The webhook event type"""

whop_sdk/types/membership_deactivated_webhook_event.py

@@ -0,0 +1,29 @@
+# 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.membership import Membership
+
+__all__ = ["MembershipDeactivatedWebhookEvent"]
+
+
+class MembershipDeactivatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Membership
+    """
+    A membership represents a purchase between a User and a Company for a specific
+    Product.
+    """
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["membership.deactivated"]
+    """The webhook event type"""

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_failed_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.payment import Payment
+
+__all__ = ["PaymentFailedWebhookEvent"]
+
+
+class PaymentFailedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Payment
+    """An object representing a receipt for a membership."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["payment.failed"]
+    """The webhook event type"""

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")]