whop-sdk 0.0.10__py3-none-any.whl

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

@@ -0,0 +1,52 @@
+# 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.entry_status import EntryStatus
+
+__all__ = ["EntryListParams"]
+
+
+class EntryListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company"""
+
+    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."""
+
+    order: Optional[Literal["id", "created_at"]]
+    """Which columns can be used to sort."""
+
+    plan_ids: Optional[SequenceNotStr[str]]
+    """The plan IDs to filter the entries by"""
+
+    product_ids: Optional[SequenceNotStr[str]]
+    """The product IDs to filter the entries by"""
+
+    statuses: Optional[List[EntryStatus]]
+    """The statuses to filter the entries by"""

whop_sdk/types/entry_list_response.py

@@ -0,0 +1,56 @@
+# 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.entry_status import EntryStatus
+
+__all__ = ["EntryListResponse", "Plan", "Product", "User"]
+
+
+class Plan(BaseModel):
+    id: str
+    """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 User(BaseModel):
+    id: str
+    """The internal ID of the user."""
+
+    email: Optional[str] = None
+    """The email 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 EntryListResponse(BaseModel):
+    id: str
+    """The internal ID of the entry."""
+
+    created_at: Optional[datetime] = None
+    """When the entry was created."""
+
+    plan: Optional[Plan] = None
+    """The waitlist plan the entry if for."""
+
+    product: Optional[Product] = None
+    """The product tied to this entry, if there is one."""
+
+    status: EntryStatus
+    """The status of the entry."""
+
+    user: User
+    """The user who created the entry."""

whop_sdk/types/experience_attach_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__ = ["ExperienceAttachParams"]
+
+
+class ExperienceAttachParams(TypedDict, total=False):
+    product_id: Required[str]
+    """The ID of the Access Pass to add the Experience to."""

whop_sdk/types/experience_create_params.py

@@ -0,0 +1,22 @@
+# 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__ = ["ExperienceCreateParams"]
+
+
+class ExperienceCreateParams(TypedDict, total=False):
+    app_id: Required[str]
+    """The ID of the app to create the experience for"""
+
+    company_id: Required[str]
+    """The ID of the company to create the experience for"""
+
+    name: Optional[str]
+    """The name of the experience"""
+
+    section_id: Optional[str]
+    """The ID of the section to create the experience in"""

whop_sdk/types/experience_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__ = ["ExperienceDeleteResponse"]
+
+ExperienceDeleteResponse: TypeAlias = bool

whop_sdk/types/experience_detach_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__ = ["ExperienceDetachParams"]
+
+
+class ExperienceDetachParams(TypedDict, total=False):
+    product_id: Required[str]
+    """The ID of the Access Pass to add the Experience to."""

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_params.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["ExperienceListParams"]
+
+
+class ExperienceListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to filter experiences by"""
+
+    after: Optional[str]
+    """Returns the elements in the list that come after the specified cursor."""
+
+    app_id: Optional[str]
+    """The ID of the app to filter experiences by"""
+
+    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"""
+
+    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]
+    """The ID of the product to filter experiences by"""

whop_sdk/types/experience_list_response.py

@@ -0,0 +1,73 @@
+# 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
+
+__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"""
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    route: str
+    """The slug/route of the company on the Whop site."""
+
+    title: str
+    """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"""
+
+    app: App
+    """The experience interface for this experience."""
+
+    company: Company
+    """The company that owns this experience."""
+
+    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."""
+
+    order: Optional[str] = None
+    """The order of the experience in the section"""

whop_sdk/types/experience_update_params.py

@@ -0,0 +1,46 @@
+# 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 Literal, Required, TypeAlias, TypedDict
+
+__all__ = ["ExperienceUpdateParams", "Logo", "LogoAttachmentInputWithDirectUploadID", "LogoAttachmentInputWithID"]
+
+
+class ExperienceUpdateParams(TypedDict, total=False):
+    access_level: Optional[Literal["public", "private"]]
+    """The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE)."""
+
+    logo: Optional[Logo]
+    """The logo for the experience"""
+
+    name: Optional[str]
+    """The name of the experience."""
+
+    order: Optional[str]
+    """The order of the experience in the section."""
+
+    section_id: Optional[str]
+    """The ID of the section to update."""
+
+
+class LogoAttachmentInputWithDirectUploadID(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 LogoAttachmentInputWithID(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.
+    """
+
+
+Logo: TypeAlias = Union[LogoAttachmentInputWithDirectUploadID, LogoAttachmentInputWithID]

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_create_params.py

@@ -0,0 +1,101 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .shared.currency import Currency
+from .forum_post_visibility_type import ForumPostVisibilityType
+
+__all__ = [
+    "ForumPostCreateParams",
+    "Attachment",
+    "AttachmentAttachmentInputWithDirectUploadID",
+    "AttachmentAttachmentInputWithID",
+    "Poll",
+    "PollOption",
+]
+
+
+class ForumPostCreateParams(TypedDict, total=False):
+    experience_id: Required[str]
+    """The experience to create this post in"""
+
+    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_mention: Optional[bool]
+    """
+    This is used to determine if the post should be sent as a 'mention' notification
+    to all of the users who are in the experience. This means that anyone with
+    'mentions' enabled will receive a notification about this post.
+    """
+
+    parent_id: Optional[str]
+    """The ID of the parent post.
+
+    Set it to the ID of the post you want to comment on or don't include it if its a
+    top level post.
+    """
+
+    paywall_amount: Optional[float]
+    """The amount to paywall this post by.
+
+    A paywalled post requires the user to purchase it in order to view its content.
+    """
+
+    paywall_currency: Optional[Currency]
+    """The available currencies on the platform"""
+
+    pinned: Optional[bool]
+    """Whether the post should be pinned"""
+
+    poll: Optional[Poll]
+    """The poll for this post"""
+
+    title: Optional[str]
+    """The title of the post. Only visible if paywalled."""
+
+    visibility: Optional[ForumPostVisibilityType]
+    """The visibility types for forum posts"""
+
+
+class AttachmentAttachmentInputWithDirectUploadID(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 AttachmentAttachmentInputWithID(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.
+    """
+
+
+Attachment: TypeAlias = Union[AttachmentAttachmentInputWithDirectUploadID, AttachmentAttachmentInputWithID]
+
+
+class PollOption(TypedDict, total=False):
+    id: Required[str]
+    """Sequential ID for the poll option (starting from '1')"""
+
+    text: Required[str]
+    """The text of the poll option"""
+
+
+class Poll(TypedDict, total=False):
+    options: Required[Iterable[PollOption]]
+    """The options for the poll. Must have sequential IDs starting from 1"""

whop_sdk/types/forum_post_list_params.py

@@ -0,0 +1,31 @@
+# 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__ = ["ForumPostListParams"]
+
+
+class ForumPostListParams(TypedDict, total=False):
+    experience_id: Required[str]
+    """The ID of the experience to list forum posts 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."""
+
+    parent_id: Optional[str]
+    """The ID of the parent post to list forum post comments for"""
+
+    pinned: Optional[bool]
+    """Set to true to only return pinned posts"""

whop_sdk/types/forum_post_list_response.py

@@ -0,0 +1,60 @@
+# 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
+
+__all__ = ["ForumPostListResponse", "User"]
+
+
+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 ForumPostListResponse(BaseModel):
+    id: str
+    """The unique identifier of the resource."""
+
+    comment_count: int
+    """The amount of comments on this post"""
+
+    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"""
+
+    is_pinned: bool
+    """Whether this forum post is pinned"""
+
+    is_poster_admin: bool
+    """Whether the user that sent the post is an admin of the company"""
+
+    like_count: Optional[int] = None
+    """The number of likes this post has received"""
+
+    parent_id: Optional[str] = None
+    """The ID of the parent forum post, if applicable"""
+
+    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"""
+
+    view_count: Optional[int] = None
+    """The number of times this message has been viewed"""