whop-sdk 0.0.1__py3-none-any.whl

whop_sdk/types/shared/app_statuses.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__ = ["AppStatuses"]
+
+AppStatuses: TypeAlias = Literal["live", "unlisted", "hidden"]

whop_sdk/types/shared/app_view_type.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__ = ["AppViewType"]
+
+AppViewType: TypeAlias = Literal["hub", "discover", "dash", "dashboard", "analytics"]

whop_sdk/types/shared/authorized_user_roles.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["AuthorizedUserRoles"]
+
+AuthorizedUserRoles: TypeAlias = Literal[
+    "owner", "admin", "sales_manager", "moderator", "app_manager", "support", "manager"
+]

whop_sdk/types/shared/business_types.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["BusinessTypes"]
+
+BusinessTypes: TypeAlias = Literal[
+    "education_program",
+    "coaching",
+    "software",
+    "paid_group",
+    "newsletter",
+    "agency",
+    "physical_products",
+    "brick_and_mortar",
+    "events",
+    "coaching_and_courses",
+    "other",
+    "saas",
+    "course",
+    "community",
+]

whop_sdk/types/shared/chat_channel.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+from .who_can_post import WhoCanPost
+from .who_can_react import WhoCanReact
+
+__all__ = ["ChatChannel", "Experience"]
+
+
+class Experience(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+    name: str
+    """The written name of the description."""
+
+
+class ChatChannel(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    ban_media: bool
+    """Whether or not media is banned in this chat"""
+
+    ban_urls: bool
+    """Whether or not URLs are banned in this chat"""
+
+    banned_words: List[str]
+    """List of banned words in this chat"""
+
+    experience: Experience
+    """The experience for this chat"""
+
+    user_posts_cooldown_seconds: Optional[int] = None
+    """The number of seconds a user needs to wait before posting again, if any"""
+
+    who_can_post: WhoCanPost
+    """Who can post on this chat"""
+
+    who_can_react: WhoCanReact
+    """Who can react on this chat"""

whop_sdk/types/shared/checkout_configuration.py

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+
+from .currency import Currency
+from ..._models import BaseModel
+from .plan_type import PlanType
+from .visibility import Visibility
+from .release_method import ReleaseMethod
+
+__all__ = ["CheckoutConfiguration", "Plan"]
+
+
+class Plan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+    billing_period: Optional[int] = None
+    """The interval at which the plan charges (renewal plans)."""
+
+    currency: Currency
+    """The respective currency identifier for the plan."""
+
+    expiration_days: Optional[int] = None
+    """The interval at which the plan charges (expiration plans)."""
+
+    initial_price: float
+    """The price a person has to pay for a plan on the initial purchase."""
+
+    plan_type: PlanType
+    """Indicates if the plan is a one time payment or recurring."""
+
+    release_method: ReleaseMethod
+    """This is the release method the business uses to sell this plan."""
+
+    renewal_price: float
+    """The price a person has to pay for a plan on the renewal purchase."""
+
+    trial_period_days: Optional[int] = None
+    """The number of free trial days added before a renewal plan."""
+
+    visibility: Visibility
+    """Shows or hides the plan from public/business view."""
+
+
+class CheckoutConfiguration(BaseModel):
+    id: str
+    """The ID of the checkout session"""
+
+    affiliate_code: str
+    """The affiliate code to use for the checkout session"""
+
+    company_id: str
+    """The ID of the company to use for the checkout session"""
+
+    metadata: Dict[str, object]
+    """The metadata to use for the checkout session"""
+
+    plan: Plan
+    """The plan to use for the checkout session"""
+
+    purchase_url: str
+    """The URL to redirect the user to after the checkout session is created"""
+
+    redirect_url: str
+    """The URL to redirect the user to after the checkout session is created"""

whop_sdk/types/shared/collection_method.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__ = ["CollectionMethod"]
+
+CollectionMethod: TypeAlias = Literal["send_invoice", "charge_automatically"]

whop_sdk/types/shared/company.py

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .business_types import BusinessTypes
+from .industry_types import IndustryTypes
+
+__all__ = ["Company", "OwnerUser", "SocialLink"]
+
+
+class OwnerUser(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 SocialLink(BaseModel):
+    id: str
+    """The ID"""
+
+    url: str
+    """The URL"""
+
+    website: Literal["x", "instagram", "facebook", "tiktok", "youtube", "linkedin", "twitch", "website"]
+    """The website"""
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    business_type: Optional[BusinessTypes] = None
+    """The different business types a company can be."""
+
+    created_at: datetime
+    """When the company was created (signed up)"""
+
+    industry_type: Optional[IndustryTypes] = None
+    """The different industry types a company can be in."""
+
+    member_count: int
+    """The number of members in the company."""
+
+    owner_user: OwnerUser
+    """The user who owns this company"""
+
+    published_reviews_count: int
+    """The number of reviews that have been published for the company."""
+
+    route: str
+    """The slug/route of the company on the Whop site."""
+
+    social_links: List[SocialLink]
+    """The social media accounts of the company"""
+
+    title: str
+    """The title of the company."""
+
+    updated_at: datetime
+    """The time the company was last updated."""
+
+    verified: bool
+    """If the company is Whop Verified"""

whop_sdk/types/shared/course_lesson_interaction.py

@@ -0,0 +1,44 @@
+# 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__ = ["CourseLessonInteraction", "Lesson", "User"]
+
+
+class Lesson(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    title: str
+    """The title of the lesson"""
+
+
+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 CourseLessonInteraction(BaseModel):
+    id: str
+    """The ID of the lesson interaction"""
+
+    completed: bool
+    """Whether the lesson has been completed by the user"""
+
+    created_at: datetime
+    """When the interaction was created"""
+
+    lesson: Lesson
+    """The lesson this interaction is for"""
+
+    user: User
+    """The user who interacted with the lesson"""

whop_sdk/types/shared/course_lesson_interaction_list_item.py

@@ -0,0 +1,44 @@
+# 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__ = ["CourseLessonInteractionListItem", "Lesson", "User"]
+
+
+class Lesson(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    title: str
+    """The title of the lesson"""
+
+
+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 CourseLessonInteractionListItem(BaseModel):
+    id: str
+    """The ID of the lesson interaction"""
+
+    completed: bool
+    """Whether the lesson has been completed by the user"""
+
+    created_at: datetime
+    """When the interaction was created"""
+
+    lesson: Lesson
+    """The lesson this interaction is for"""
+
+    user: User
+    """The user who interacted with the lesson"""

whop_sdk/types/shared/currency.py

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["Currency"]
+
+Currency: TypeAlias = Literal[
+    "usd",
+    "sgd",
+    "inr",
+    "aud",
+    "brl",
+    "cad",
+    "dkk",
+    "eur",
+    "nok",
+    "gbp",
+    "sek",
+    "chf",
+    "hkd",
+    "huf",
+    "jpy",
+    "mxn",
+    "myr",
+    "pln",
+    "czk",
+    "nzd",
+    "aed",
+    "eth",
+    "ape",
+    "cop",
+    "ron",
+    "thb",
+    "bgn",
+    "idr",
+    "dop",
+    "php",
+    "try",
+    "krw",
+    "twd",
+    "vnd",
+    "pkr",
+    "clp",
+    "uyu",
+    "ars",
+    "zar",
+    "dzd",
+    "tnd",
+    "mad",
+    "kes",
+    "kwd",
+    "jod",
+    "all",
+    "xcd",
+    "amd",
+    "bsd",
+    "bhd",
+    "bob",
+    "bam",
+    "khr",
+    "crc",
+    "xof",
+    "egp",
+    "etb",
+    "gmd",
+    "ghs",
+    "gtq",
+    "gyd",
+    "ils",
+    "jmd",
+    "mop",
+    "mga",
+    "mur",
+    "mdl",
+    "mnt",
+    "nad",
+    "ngn",
+    "mkd",
+    "omr",
+    "pyg",
+    "pen",
+    "qar",
+    "rwf",
+    "sar",
+    "rsd",
+    "lkr",
+    "tzs",
+    "ttd",
+    "uzs",
+    "rub",
+    "btc",
+]

whop_sdk/types/shared/custom_cta.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["CustomCta"]
+
+CustomCta: TypeAlias = Literal[
+    "get_access",
+    "join",
+    "order_now",
+    "shop_now",
+    "call_now",
+    "donate_now",
+    "contact_us",
+    "sign_up",
+    "subscribe",
+    "purchase",
+    "get_offer",
+    "apply_now",
+    "complete_order",
+]

whop_sdk/types/shared/direction.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__ = ["Direction"]
+
+Direction: TypeAlias = Literal["asc", "desc"]

whop_sdk/types/shared/dms_post_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__ = ["DmsPostTypes"]
+
+DmsPostTypes: TypeAlias = Literal["regular", "system", "automated"]

whop_sdk/types/shared/entry.py

@@ -0,0 +1,70 @@
+# 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 .entry_status import EntryStatus
+
+__all__ = ["Entry", "CustomFieldResponse", "Plan", "Product", "User"]
+
+
+class CustomFieldResponse(BaseModel):
+    id: str
+    """The ID of the custom field item"""
+
+    answer: str
+    """The response a user gave to the specific question or field."""
+
+    question: str
+    """The question asked by the custom field"""
+
+
+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 Entry(BaseModel):
+    id: str
+    """The internal ID of the entry."""
+
+    created_at: Optional[datetime] = None
+    """When the entry was created."""
+
+    custom_field_responses: Optional[List[CustomFieldResponse]] = None
+    """Responses collected from the user when submitting their entry."""
+
+    plan: Optional[Plan] = None
+    """The waitlist plan the entry if for."""
+
+    product: Optional[Product] = None
+    """The access pass 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/shared/entry_status.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__ = ["EntryStatus"]
+
+EntryStatus: TypeAlias = Literal["drafted", "pending", "approved", "denied", "any"]

whop_sdk/types/shared/experience.py

@@ -0,0 +1,66 @@
+# 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
+
+__all__ = ["Experience", "App", "Company", "Product"]
+
+
+class App(BaseModel):
+    id: str
+    """The ID of the app"""
+
+    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 Product(BaseModel):
+    id: str
+    """The internal ID of the public product."""
+
+    route: str
+    """The route of the product."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+
+class Experience(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."""
+
+    name: str
+    """The written name of the description."""
+
+    order: Optional[str] = None
+    """The order of the experience in the section"""
+
+    products: List[Product]
+    """The access passes that are associated with this experience.
+
+    This should not be used unless you are trying to list all access passes the
+    experience has, for some reason. You probably don't want to use this though and
+    should be using accessPass.
+    """

whop_sdk/types/shared/forum_post.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ForumPost", "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 ForumPost(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    comment_count: int
+    """The amount of comments on this post"""
+
+    content: Optional[str] = None
+    """The content of the forum post in Markdown format"""
+
+    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"""
+
+    user: User
+    """The user who created this forum post"""
+
+    view_count: Optional[int] = None
+    """The number of times this message has been viewed"""

whop_sdk/types/shared/friendly_receipt_status.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["FriendlyReceiptStatus"]
+
+FriendlyReceiptStatus: TypeAlias = Literal[
+    "auto_refunded",
+    "refunded",
+    "partially_refunded",
+    "dispute_warning",
+    "open_resolution",
+    "open_dispute",
+    "failed",
+    "price_too_low",
+    "succeeded",
+    "drafted",
+    "uncollectible",
+    "unresolved",
+    "past_due",
+    "pending",
+    "incomplete",
+    "canceled",
+]