whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/shared/app.py

@@ -0,0 +1,187 @@
+# 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 ..app_type import AppType
+from .app_statuses import AppStatuses
+
+__all__ = [
+    "App",
+    "APIKey",
+    "Company",
+    "Creator",
+    "Icon",
+    "RequestedPermission",
+    "RequestedPermissionPermissionAction",
+    "Stats",
+]
+
+
+class APIKey(BaseModel):
+    id: str
+    """The ID of this API key"""
+
+    token: str
+    """This is the API key used to authenticate requests"""
+
+    created_at: datetime
+    """When this API key was created at"""
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    title: str
+    """The title of the company."""
+
+
+class Creator(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 Icon(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 RequestedPermissionPermissionAction(BaseModel):
+    action: str
+    """The identifier of the action."""
+
+    name: str
+    """The human readable name of the action."""
+
+
+class RequestedPermission(BaseModel):
+    is_required: bool
+    """Whether the action is required for the app to function."""
+
+    justification: str
+    """The reason for requesting the action."""
+
+    permission_action: RequestedPermissionPermissionAction
+    """The action that the app will request off of users when a user installs the app."""
+
+
+class Stats(BaseModel):
+    dau: int
+    """
+    This is the number of users that have spent time in this app in the last 24
+    hours.
+    """
+
+    mau: int
+    """
+    This is the number of users that have spent time in this app in the last 28
+    days.
+    """
+
+    time_spent_last24_hours: int
+    """
+    This how much time, in seconds, users have spent in this app in the last 24
+    hours.
+    """
+
+    wau: int
+    """
+    This is the number of users that have spent time in this app in the last 7 days.
+    """
+
+
+class App(BaseModel):
+    id: str
+    """The ID of the app"""
+
+    api_key: Optional[APIKey] = None
+    """The API key for the app"""
+
+    app_type: AppType
+    """The type of end-user an app is built for"""
+
+    base_url: Optional[str] = None
+    """The base url of the app"""
+
+    company: Company
+    """The company that owns the app"""
+
+    creator: Creator
+    """The creator of the app"""
+
+    dashboard_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    description: Optional[str] = None
+    """The description of the app"""
+
+    discover_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    domain_id: str
+    """The unique part of the proxied domain for this app.
+
+    Used to generate the base url used to display the app inside the whop platform.
+    Refers to the id part in the final url: https://{domain_id}.apps.whop.com
+    """
+
+    experience_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    icon: Optional[Icon] = 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"""
+
+    requested_permissions: List[RequestedPermission]
+    """
+    The set of permissions that an app requests to be granted when a user installs
+    the app.
+    """
+
+    stats: Optional[Stats] = None
+    """A collection of stats for the app."""
+
+    status: AppStatuses
+    """If the status is live, the app is visible on Whop discovery.
+
+    In order to be live, you need to set the name, icon, and description. Being
+    unlisted or hidden means it's not visible on Whop but you can still install the
+    app via direct link. To remove the app from whop discovery, you should set the
+    status to unlisted.
+    """
+
+    verified: bool
+    """Whether this app has been verified by Whop.
+
+    Verified apps are endorsed by whop and are shown in the 'featured apps' section
+    of the app store.
+    """

whop_sdk/types/shared/app_build.py

@@ -0,0 +1,50 @@
+# 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 .app_view_type import AppViewType
+from .app_build_statuses import AppBuildStatuses
+from .app_build_platforms import AppBuildPlatforms
+
+__all__ = ["AppBuild"]
+
+
+class AppBuild(BaseModel):
+    id: str
+    """The ID of the app build. It will look like apbu_xxxxx."""
+
+    checksum: str
+    """
+    This is generated by the client and used to verify the integrity of the file
+    that is submitted. It is a SHA256 hash of the app build file.
+    """
+
+    created_at: datetime
+    """When this app build was created."""
+
+    file_url: str
+    """The URL to download the app build .zip file."""
+
+    is_production: bool
+    """Whether this app build is currently being used in production."""
+
+    platform: AppBuildPlatforms
+    """The platform of the app build (ios, android, web)"""
+
+    review_message: Optional[str] = None
+    """The review message for the app build, if any.
+
+    This is populated when the build is rejected and there is a reason specified by
+    the reviewer.
+    """
+
+    status: AppBuildStatuses
+    """The status of the app build (draft, approved, rejected, pending, etc)"""
+
+    supported_app_view_types: List[AppViewType]
+    """The supported app view types for the app build.
+
+    These are the views that the developer has specified that this build supports.
+    """

whop_sdk/types/shared/app_build_platforms.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__ = ["AppBuildPlatforms"]
+
+AppBuildPlatforms: TypeAlias = Literal["ios", "android", "web"]

whop_sdk/types/shared/app_build_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__ = ["AppBuildStatuses"]
+
+AppBuildStatuses: TypeAlias = Literal["draft", "pending", "approved", "rejected"]

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,104 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .currency import Currency
+from ..._models import BaseModel
+from .plan_type import PlanType
+from .visibility import Visibility
+from .release_method import ReleaseMethod
+from ..checkout_modes import CheckoutModes
+from ..payment_method_types import PaymentMethodTypes
+
+__all__ = ["CheckoutConfiguration", "PaymentMethodConfiguration", "Plan"]
+
+
+class PaymentMethodConfiguration(BaseModel):
+    disabled: List[PaymentMethodTypes]
+    """An array of payment method identifiers that are explicitly disabled.
+
+    Only applies if the include_platform_defaults is true.
+    """
+
+    enabled: List[PaymentMethodTypes]
+    """An array of payment method identifiers that are explicitly enabled.
+
+    This means these payment methods will be shown on checkout. Example use case is
+    to only enable a specific payment method like cashapp, or extending the platform
+    defaults with additional methods.
+    """
+
+    include_platform_defaults: bool
+    """
+    Whether Whop's platform default payment method enablement settings are included
+    in this configuration. The full list of default payment methods can be found in
+    the documentation at docs.whop.com/payments.
+    """
+
+
+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 configuration"""
+
+    affiliate_code: Optional[str] = None
+    """The affiliate code to use for the checkout configuration"""
+
+    company_id: str
+    """The ID of the company to use for the checkout configuration"""
+
+    metadata: Optional[Dict[str, object]] = None
+    """The metadata to use for the checkout configuration"""
+
+    mode: CheckoutModes
+    """The mode of the checkout session."""
+
+    payment_method_configuration: Optional[PaymentMethodConfiguration] = None
+    """The explicit payment method configuration for the session, if any.
+
+    This currently only works in 'setup' mode. Use the plan's
+    payment_method_configuration for payment method.
+    """
+
+    plan: Optional[Plan] = None
+    """The plan to use for the checkout configuration"""
+
+    purchase_url: str
+    """A URL you can send to customers to complete a checkout.
+
+    It looks like `/checkout/plan_xxxx?session={id}`
+    """
+
+    redirect_url: Optional[str] = None
+    """The URL to redirect the user to after the checkout configuration 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,91 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, 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", "Logo", "OwnerUser", "SocialLink"]
+
+
+class Logo(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 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", "custom"]
+    """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)"""
+
+    description: Optional[str] = None
+    """The creator pitch for the company."""
+
+    industry_type: Optional[IndustryTypes] = None
+    """The different industry types a company can be in."""
+
+    logo: Optional[Logo] = None
+    """The company's logo."""
+
+    member_count: int
+    """The number of members in the company."""
+
+    metadata: Optional[Dict[str, object]] = None
+    """
+    A key-value store of data for the account, created/updated by the platform that
+    made the account.
+    """
+
+    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,63 @@
+# 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", "Course", "CourseExperience", "Lesson", "User"]
+
+
+class CourseExperience(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+
+class Course(BaseModel):
+    id: str
+    """The ID of the course. Looks like cors_XXX"""
+
+    experience: CourseExperience
+    """The experience that the course belongs to"""
+
+    title: Optional[str] = None
+    """The title of the course"""
+
+
+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"""
+
+    course: Course
+    """The course for this lesson interaction"""
+
+    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"""