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

whop_sdk/types/promo_code_list_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 .promo_duration import PromoDuration
+from .shared.currency import Currency
+from .promo_code_status import PromoCodeStatus
+from .shared.promo_type import PromoType
+
+__all__ = ["PromoCodeListResponse", "Product"]
+
+
+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 PromoCodeListResponse(BaseModel):
+    id: str
+    """The ID of the promo."""
+
+    amount_off: float
+    """The amount off (% or flat amount) for the promo."""
+
+    churned_users_only: bool
+    """Restricts promo use to only users who have churned from the company before."""
+
+    code: Optional[str] = None
+    """The specific code used to apply the promo at checkout."""
+
+    created_at: datetime
+    """The timestamp of when the promo was created."""
+
+    currency: Currency
+    """The monetary currency of the promo code."""
+
+    duration: Optional[PromoDuration] = None
+    """The duration setting for the promo code"""
+
+    existing_memberships_only: bool
+    """Restricts promo use to only be applied to already purchased memberships."""
+
+    expires_at: Optional[datetime] = None
+    """The date/time of when the promo expires."""
+
+    new_users_only: bool
+    """
+    Restricts promo use to only users who have never purchased from the company
+    before.
+    """
+
+    one_per_customer: bool
+    """Restricts promo use to only be applied once per customer."""
+
+    product: Optional[Product] = None
+    """The access pass associated with the promo code."""
+
+    promo_duration_months: Optional[int] = None
+    """The number of months the promo is applied for."""
+
+    promo_type: PromoType
+    """The type (% or flat amount) of the promo."""
+
+    status: PromoCodeStatus
+    """Indicates if the promo code is live or disabled."""
+
+    stock: int
+    """The quantity limit on the number of uses."""
+
+    unlimited_stock: bool
+    """Whether or not the promo code has unlimited stock."""
+
+    uses: int
+    """The amount of times the promo codes has been used."""

whop_sdk/types/promo_code_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__ = ["PromoCodeStatus"]
+
+PromoCodeStatus: TypeAlias = Literal["active", "inactive", "archived"]

whop_sdk/types/promo_duration.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__ = ["PromoDuration"]
+
+PromoDuration: TypeAlias = Literal["forever", "once", "repeating"]

whop_sdk/types/review_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__ = ["ReviewListParams"]
+
+
+class ReviewListParams(TypedDict, total=False):
+    product_id: Required[str]
+    """The ID of the product"""
+
+    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."""
+
+    max_stars: Optional[int]
+    """The maximum star rating of the review (inclusive)"""
+
+    min_stars: Optional[int]
+    """The minimum star rating of the review (inclusive)"""

whop_sdk/types/review_list_response.py

@@ -0,0 +1,78 @@
+# 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 .review_status import ReviewStatus
+
+__all__ = ["ReviewListResponse", "Attachment", "User"]
+
+
+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 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 ReviewListResponse(BaseModel):
+    id: str
+    """The internal ID of the review."""
+
+    attachments: List[Attachment]
+    """The attachments attached to the review."""
+
+    created_at: datetime
+    """The timestamp of when the review was created."""
+
+    description: Optional[str] = None
+    """The description of the review."""
+
+    joined_at: Optional[datetime] = None
+    """The timestamp of when the user joined the product."""
+
+    paid_for_product: Optional[bool] = None
+    """Whether or not the user paid for the product.
+
+    If null, the payment status is unknown.
+    """
+
+    published_at: Optional[datetime] = None
+    """The timestamp of when the review was published."""
+
+    stars: int
+    """The number of stars the user gave the product."""
+
+    status: ReviewStatus
+    """The status of the review."""
+
+    title: Optional[str] = None
+    """The title of the review."""
+
+    updated_at: datetime
+    """The timestamp of when the review was last updated."""
+
+    user: User
+    """The user account that performed the action."""

whop_sdk/types/review_retrieve_response.py

@@ -0,0 +1,103 @@
+# 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 .review_status import ReviewStatus
+
+__all__ = ["ReviewRetrieveResponse", "Attachment", "Company", "Product", "User"]
+
+
+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 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."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+
+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 ReviewRetrieveResponse(BaseModel):
+    id: str
+    """The internal ID of the review."""
+
+    attachments: List[Attachment]
+    """The attachments attached to the review."""
+
+    company: Company
+    """The company the review is for."""
+
+    created_at: datetime
+    """The timestamp of when the review was created."""
+
+    description: Optional[str] = None
+    """The description of the review."""
+
+    joined_at: Optional[datetime] = None
+    """The timestamp of when the user joined the product."""
+
+    paid_for_product: Optional[bool] = None
+    """Whether or not the user paid for the product.
+
+    If null, the payment status is unknown.
+    """
+
+    product: Product
+    """The product the review is for."""
+
+    published_at: Optional[datetime] = None
+    """The timestamp of when the review was published."""
+
+    stars: int
+    """The number of stars the user gave the product."""
+
+    status: ReviewStatus
+    """The status of the review."""
+
+    title: Optional[str] = None
+    """The title of the review."""
+
+    updated_at: datetime
+    """The timestamp of when the review was last updated."""
+
+    user: User
+    """The user account that performed the action."""

whop_sdk/types/review_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__ = ["ReviewStatus"]
+
+ReviewStatus: TypeAlias = Literal["pending", "published", "removed"]

whop_sdk/types/shared/__init__.py

@@ -3,6 +3,7 @@
 from .app import App as App
 from .plan import Plan as Plan
 from .entry import Entry as Entry
+from .forum import Forum as Forum
 from .company import Company as Company
 from .invoice import Invoice as Invoice
 from .message import Message as Message
@@ -23,6 +24,7 @@ from .forum_post import ForumPost as ForumPost
 from .membership import Membership as Membership
 from .promo_type import PromoType as PromoType
 from .visibility import Visibility as Visibility
+from .access_level import AccessLevel as AccessLevel
 from .app_statuses import AppStatuses as AppStatuses
 from .chat_channel import ChatChannel as ChatChannel
 from .entry_status import EntryStatus as EntryStatus
@@ -35,6 +37,7 @@ from .industry_types import IndustryTypes as IndustryTypes
 from .invoice_status import InvoiceStatus as InvoiceStatus
 from .receipt_status import ReceiptStatus as ReceiptStatus
 from .release_method import ReleaseMethod as ReleaseMethod
+from .member_statuses import MemberStatuses as MemberStatuses
 from .shipment_status import ShipmentStatus as ShipmentStatus
 from .support_channel import SupportChannel as SupportChannel
 from .access_pass_type import AccessPassType as AccessPassType
@@ -46,10 +49,14 @@ from .product_list_item import ProductListItem as ProductListItem
 from .visibility_filter import VisibilityFilter as VisibilityFilter
 from .app_build_statuses import AppBuildStatuses as AppBuildStatuses
 from .shipment_substatus import ShipmentSubstatus as ShipmentSubstatus
+from .who_can_post_types import WhoCanPostTypes as WhoCanPostTypes
 from .app_build_platforms import AppBuildPlatforms as AppBuildPlatforms
 from .authorized_user_roles import AuthorizedUserRoles as AuthorizedUserRoles
+from .who_can_comment_types import WhoCanCommentTypes as WhoCanCommentTypes
 from .checkout_configuration import CheckoutConfiguration as CheckoutConfiguration
 from .friendly_receipt_status import FriendlyReceiptStatus as FriendlyReceiptStatus
 from .global_affiliate_status import GlobalAffiliateStatus as GlobalAffiliateStatus
 from .course_lesson_interaction import CourseLessonInteraction as CourseLessonInteraction
+from .member_most_recent_actions import MemberMostRecentActions as MemberMostRecentActions
+from .email_notification_preferences import EmailNotificationPreferences as EmailNotificationPreferences
 from .course_lesson_interaction_list_item import CourseLessonInteractionListItem as CourseLessonInteractionListItem

whop_sdk/types/shared/access_level.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__ = ["AccessLevel"]
+
+AccessLevel: TypeAlias = Literal["no_access", "admin", "customer"]

whop_sdk/types/shared/app.py

@@ -6,7 +6,16 @@ from datetime import datetime
 from ..._models import BaseModel
 from .app_statuses import AppStatuses
 
-__all__ = ["App", "APIKey", "Company", "Creator", "RequestedPermission", "RequestedPermissionPermissionAction", "Stats"]
+__all__ = [
+    "App",
+    "APIKey",
+    "Company",
+    "Creator",
+    "Icon",
+    "RequestedPermission",
+    "RequestedPermissionPermissionAction",
+    "Stats",
+]
 
 
 class APIKey(BaseModel):
@@ -39,6 +48,14 @@ class Creator(BaseModel):
     """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."""
@@ -130,6 +147,13 @@ class App(BaseModel):
     /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"""
 

whop_sdk/types/shared/checkout_configuration.py

@@ -45,22 +45,25 @@ class Plan(BaseModel):
 
 class CheckoutConfiguration(BaseModel):
     id: str
-    """The ID of the checkout session"""
+    """The ID of the checkout configuration"""
 
-    affiliate_code: str
-    """The affiliate code to use for the checkout session"""
+    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 session"""
+    """The ID of the company to use for the checkout configuration"""
 
     metadata: Dict[str, object]
-    """The metadata to use for the checkout session"""
+    """The metadata to use for the checkout configuration"""
 
     plan: Plan
-    """The plan to use for the checkout session"""
+    """The plan to use for the checkout configuration"""
 
     purchase_url: str
-    """The URL to redirect the user to after the checkout session is created"""
+    """A URL you can send to customers to complete a checkout.
 
-    redirect_url: str
-    """The URL to redirect the user to after the checkout session is created"""
+    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/company.py

@@ -8,7 +8,15 @@ from ..._models import BaseModel
 from .business_types import BusinessTypes
 from .industry_types import IndustryTypes
 
-__all__ = ["Company", "OwnerUser", "SocialLink"]
+__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):
@@ -43,9 +51,15 @@ class Company(BaseModel):
     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."""
 

whop_sdk/types/shared/course_lesson_interaction.py

@@ -5,7 +5,23 @@ from datetime import datetime
 
 from ..._models import BaseModel
 
-__all__ = ["CourseLessonInteraction", "Lesson", "User"]
+__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):
@@ -34,6 +50,9 @@ class CourseLessonInteraction(BaseModel):
     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"""
 

whop_sdk/types/shared/email_notification_preferences.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__ = ["EmailNotificationPreferences"]
+
+EmailNotificationPreferences: TypeAlias = Literal["all_admin_posts", "only_weekly_summary", "none"]

whop_sdk/types/shared/experience.py

@@ -5,13 +5,28 @@ from datetime import datetime
 
 from ..._models import BaseModel
 
-__all__ = ["Experience", "App", "Company", "Product"]
+__all__ = ["Experience", "App", "AppIcon", "Company", "Image", "Product"]
+
+
+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 Product(BaseModel):
     id: str
     """The internal ID of the public product."""
@@ -51,6 +74,9 @@ class Experience(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/shared/forum.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+from .who_can_post_types import WhoCanPostTypes
+from .who_can_comment_types import WhoCanCommentTypes
+from .email_notification_preferences import EmailNotificationPreferences
+
+__all__ = ["Forum", "Experience"]
+
+
+class Experience(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+    name: str
+    """The written name of the description."""
+
+
+class Forum(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/shared/forum_post.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 ForumPost(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 ForumPost(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/shared/invoice.py

@@ -49,7 +49,10 @@ class Invoice(BaseModel):
     """The email address that the invoice was created for."""
 
     fetch_invoice_token: str
-    """The token to fetch the invoice."""
+    """
+    A signed token that allows fetching the invoice data publically without being
+    authenticated.
+    """
 
     number: str
     """The number of the invoice."""

whop_sdk/types/shared/invoice_list_item.py

@@ -49,7 +49,10 @@ class InvoiceListItem(BaseModel):
     """The email address that the invoice was created for."""
 
     fetch_invoice_token: str
-    """The token to fetch the invoice."""
+    """
+    A signed token that allows fetching the invoice data publically without being
+    authenticated.
+    """
 
     number: str
     """The number of the invoice."""