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

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

@@ -60,7 +60,10 @@ class CheckoutConfiguration(BaseModel):
     """The plan to use for the checkout configuration"""
 
     purchase_url: str
-    """The URL to redirect the user to after the checkout configuration is created"""
+    """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/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."""

whop_sdk/types/shared/membership.py

@@ -7,7 +7,7 @@ from .currency import Currency
 from ..._models import BaseModel
 from .membership_status import MembershipStatus
 
-__all__ = ["Membership", "Company", "Member", "Plan", "PromoCode", "User"]
+__all__ = ["Membership", "Company", "Member", "Plan", "Product", "PromoCode", "User"]
 
 
 class Company(BaseModel):
@@ -28,6 +28,14 @@ class Plan(BaseModel):
     """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 PromoCode(BaseModel):
     id: str
     """The ID of the promo."""
@@ -92,6 +100,9 @@ class Membership(BaseModel):
     plan: Plan
     """The Plan this Membership is for."""
 
+    product: Product
+    """The Product this Membership grants access to."""
+
     promo_code: Optional[PromoCode] = None
     """The Promo Code that is currently applied to this Membership."""
 

whop_sdk/types/shared/payment.py

@@ -6,8 +6,11 @@ from datetime import datetime
 from .currency import Currency
 from ..._models import BaseModel
 from .promo_type import PromoType
+from ..card_brands import CardBrands
 from .receipt_status import ReceiptStatus
+from ..billing_reasons import BillingReasons
 from .membership_status import MembershipStatus
+from ..payment_method_types import PaymentMethodTypes
 from .friendly_receipt_status import FriendlyReceiptStatus
 
 __all__ = ["Payment", "BillingAddress", "Company", "Member", "Membership", "Plan", "Product", "PromoCode", "User"]
@@ -93,7 +96,7 @@ class PromoCode(BaseModel):
     """The specific code used to apply the promo at checkout."""
 
     number_of_intervals: Optional[int] = None
-    """The number of billing cycles the promo is applied for."""
+    """The number of months the promo is applied for."""
 
     promo_type: PromoType
     """The type (% or flat amount) of the promo."""
@@ -126,11 +129,11 @@ class Payment(BaseModel):
     billing_address: Optional[BillingAddress] = None
     """The address of the user who made the payment."""
 
-    billing_reason: Optional[str] = None
-    """The billing reason"""
+    billing_reason: Optional[BillingReasons] = None
+    """The reason why a specific payment was billed"""
 
-    card_brand: Optional[str] = None
-    """The type of card used as the payment method."""
+    card_brand: Optional[CardBrands] = None
+    """Possible card brands that a payment token can have"""
 
     card_last4: Optional[str] = None
     """The last 4 digits of the card used to make the payment."""
@@ -162,11 +165,8 @@ class Payment(BaseModel):
     paid_at: Optional[datetime] = None
     """The datetime the payment was paid"""
 
-    payment_method_type: Optional[str] = None
-    """Returns the type of payment method used for the payment, if available.
-
-    Ex. klarna, affirm, card, cashapp
-    """
+    payment_method_type: Optional[PaymentMethodTypes] = None
+    """The different types of payment methods that can be used."""
 
     plan: Optional[Plan] = None
     """The plan attached to this payment."""
@@ -178,7 +178,10 @@ class Payment(BaseModel):
     """The promo code used for this payment."""
 
     refundable: bool
-    """Whether the payment can be refunded."""
+    """
+    True only for payments that are `paid`, have not been fully refunded, and were
+    processed by a payment processor that allows refunds.
+    """
 
     refunded_amount: Optional[float] = None
     """The payment refund amount(if applicable)."""
@@ -187,7 +190,11 @@ class Payment(BaseModel):
     """When the payment was refunded (if applicable)."""
 
     retryable: bool
-    """Whether the payment can be retried."""
+    """
+    True when the payment status is `open` and its membership is in one of the
+    retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
+    otherwise false. Used to decide if Whop can attempt the charge again.
+    """
 
     status: Optional[ReceiptStatus] = None
     """The status of a receipt"""
@@ -208,4 +215,7 @@ class Payment(BaseModel):
     """The user that made this payment."""
 
     voidable: bool
-    """Whether the payment can be voided."""
+    """
+    True when the payment is tied to a membership in `past_due`, the payment status
+    is `open`, and the processor allows voiding payments; otherwise false.
+    """

whop_sdk/types/shared/plan.py

@@ -110,12 +110,21 @@ class Plan(BaseModel):
     renewal_price: float
     """The price a person has to pay for a plan on the renewal purchase."""
 
+    stock: Optional[int] = None
+    """The number of units available for purchase. Only displayed to authorized actors"""
+
     tax_type: TaxType
     """The tax type for the plan."""
 
+    title: Optional[str] = None
+    """The title of the plan. This will be visible on the product page to customers."""
+
     trial_period_days: Optional[int] = None
     """The number of free trial days added before a renewal plan."""
 
+    unlimited_stock: bool
+    """Limits/doesn't limit the number of units available for purchase."""
+
     updated_at: datetime
     """When the plan was last updated."""
 

whop_sdk/types/shared/product.py

@@ -72,6 +72,14 @@ class Product(BaseModel):
     description: Optional[str] = None
     """A short description of what the company offers or does."""
 
+    external_identifier: Optional[str] = None
+    """A unique identifier used to create or update products.
+
+    When provided on product creation endpoints, we’ll look up an existing product
+    by this identifier — if it exists, we’ll update it; if not, we’ll create a new
+    one.
+    """
+
     global_affiliate_percentage: Optional[float] = None
     """
     The percentage of a transaction a user is eligible to earn from the whop

whop_sdk/types/shared/product_list_item.py

@@ -21,6 +21,14 @@ class ProductListItem(BaseModel):
     created_at: datetime
     """When the product was created."""
 
+    external_identifier: Optional[str] = None
+    """A unique identifier used to create or update products.
+
+    When provided on product creation endpoints, we’ll look up an existing product
+    by this identifier — if it exists, we’ll update it; if not, we’ll create a new
+    one.
+    """
+
     headline: Optional[str] = None
     """The headline of the product."""
 

whop_sdk/types/shared_params/__init__.py

@@ -5,6 +5,7 @@ from .tax_type import TaxType as TaxType
 from .direction import Direction as Direction
 from .plan_type import PlanType as PlanType
 from .custom_cta import CustomCta as CustomCta
+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

whop_sdk/types/shared_params/promo_type.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["PromoType"]
+
+PromoType: TypeAlias = Literal["percentage", "flat_amount"]

{whop_sdk-0.0.2.dist-info → whop_sdk-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: whop-sdk
-Version: 0.0.2
+Version: 0.0.3
 Summary: The official Python library for the Whop API
 Project-URL: Homepage, https://github.com/whopio/whopsdk-python
 Project-URL: Repository, https://github.com/whopio/whopsdk-python