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

whop_sdk/types/course_list_response.py

@@ -0,0 +1,77 @@
+# 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
+
+__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
+    """
+
+    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_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/entry_approved_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.entry import Entry
+
+__all__ = ["EntryApprovedWebhookEvent"]
+
+
+class EntryApprovedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.approved"]
+    """The webhook event type"""

whop_sdk/types/entry_created_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.entry import Entry
+
+__all__ = ["EntryCreatedWebhookEvent"]
+
+
+class EntryCreatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.created"]
+    """The webhook event type"""

whop_sdk/types/entry_deleted_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.entry import Entry
+
+__all__ = ["EntryDeletedWebhookEvent"]
+
+
+class EntryDeletedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.deleted"]
+    """The webhook event type"""

whop_sdk/types/entry_denied_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.entry import Entry
+
+__all__ = ["EntryDeniedWebhookEvent"]
+
+
+class EntryDeniedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.denied"]
+    """The webhook event type"""

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/experience_list_response.py

@@ -5,13 +5,28 @@ from datetime import datetime
 
 from .._models import BaseModel
 
-__all__ = ["ExperienceListResponse", "App", "Company"]
+__all__ = ["ExperienceListResponse", "App", "AppIcon", "Company", "Image"]
+
+
+class AppIcon(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 App(BaseModel):
     id: str
     """The ID of the app"""
 
+    icon: Optional[AppIcon] = None
+    """The icon for the app.
+
+    This icon is shown on discovery, on the product page, on checkout, and as a
+    default icon for the experiences.
+    """
+
     name: str
     """The name of the app"""
 
@@ -27,6 +42,14 @@ class Company(BaseModel):
     """The title of the company."""
 
 
+class Image(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 ExperienceListResponse(BaseModel):
     id: str
     """The unique ID representing this experience"""
@@ -40,6 +63,9 @@ class ExperienceListResponse(BaseModel):
     created_at: datetime
     """The timestamp of when this experience was created."""
 
+    image: Optional[Image] = None
+    """The logo for the experience."""
+
     name: str
     """The written name of the description."""
 

whop_sdk/types/forum_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__ = ["ForumListParams"]
+
+
+class ForumListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list forums for"""
+
+    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."""
+
+    product_id: Optional[str]
+    """If provided, only forums connected to this product are returned"""

whop_sdk/types/forum_list_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+from .shared.who_can_post_types import WhoCanPostTypes
+from .shared.who_can_comment_types import WhoCanCommentTypes
+from .shared.email_notification_preferences import EmailNotificationPreferences
+
+__all__ = ["ForumListResponse", "Experience"]
+
+
+class Experience(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+    name: str
+    """The written name of the description."""
+
+
+class ForumListResponse(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    email_notification_preference: EmailNotificationPreferences
+    """The email notification preference for this forum"""
+
+    experience: Experience
+    """The experience for this forum"""
+
+    who_can_comment: WhoCanCommentTypes
+    """Who can comment on this forum"""
+
+    who_can_post: WhoCanPostTypes
+    """Who can post on this forum"""

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/forum_update_params.py

@@ -0,0 +1,23 @@
+# 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
+
+from .shared.who_can_post_types import WhoCanPostTypes
+from .shared.who_can_comment_types import WhoCanCommentTypes
+from .shared.email_notification_preferences import EmailNotificationPreferences
+
+__all__ = ["ForumUpdateParams"]
+
+
+class ForumUpdateParams(TypedDict, total=False):
+    email_notification_preference: Optional[EmailNotificationPreferences]
+    """Email notification preference option for a forum feed"""
+
+    who_can_comment: Optional[WhoCanCommentTypes]
+    """Who can comment on a forum feed"""
+
+    who_can_post: Optional[WhoCanPostTypes]
+    """Who can post on a forum feed"""

whop_sdk/types/invoice_create_params.py

@@ -108,7 +108,11 @@ class Plan(TypedDict, total=False):
     """The interval at which the plan charges (expiration plans)."""
 
     initial_price: Optional[float]
-    """An additional amount charged upon first purchase."""
+    """An additional amount charged upon first purchase.
+
+    Use only if a one time payment OR you want to charge an additional amount on top
+    of the renewal price. Provided as a number in dollars. Eg: 10.43 for $10.43
+    """
 
     internal_notes: Optional[str]
     """A personal description or notes section for the business."""
@@ -120,7 +124,11 @@ class Plan(TypedDict, total=False):
     """The methods of how a plan can be released."""
 
     renewal_price: Optional[float]
-    """The amount the customer is charged every billing period."""
+    """The amount the customer is charged every billing period.
+
+    Use only if a recurring payment. Provided as a number in dollars. Eg: 10.43 for
+    $10.43
+    """
 
     trial_period_days: Optional[int]
     """The number of free trial days added before a renewal plan."""

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