whop-sdk 0.0.1__py3-none-any.whl

whop_sdk/types/shared/global_affiliate_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__ = ["GlobalAffiliateStatus"]
+
+GlobalAffiliateStatus: TypeAlias = Literal["enabled", "disabled"]

whop_sdk/types/shared/industry_types.py

@@ -0,0 +1,67 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["IndustryTypes"]
+
+IndustryTypes: TypeAlias = Literal[
+    "trading",
+    "sports_betting",
+    "reselling",
+    "fitness",
+    "amazon_fba",
+    "real_estate",
+    "kindle_book_publishing",
+    "dating",
+    "agencies",
+    "health_and_wellness",
+    "social_media",
+    "sales",
+    "business",
+    "ecommerce",
+    "video_games",
+    "home_services",
+    "ai",
+    "public_speaking",
+    "personal_finance",
+    "careers",
+    "travel",
+    "clipping",
+    "spirituality",
+    "vas",
+    "personal_development",
+    "software",
+    "other",
+    "marketing_agency",
+    "sales_agency",
+    "ai_agency",
+    "design_agency",
+    "coaching_agency",
+    "development_agency",
+    "recruiting_agency",
+    "customer_support_agency",
+    "clipping_agency",
+    "clothing",
+    "supplements",
+    "beauty_and_personal_care",
+    "fitness_gear",
+    "accessories",
+    "home_goods",
+    "electronics_and_gadgets",
+    "food_and_beverages",
+    "gym",
+    "restaurant",
+    "retail_store",
+    "coffee_shop",
+    "salon_spa",
+    "medical_dentist_office",
+    "hotel_lodging",
+    "auto_repair_shop",
+    "masterminds",
+    "webinars",
+    "bootcamps",
+    "convention",
+    "concerts",
+    "meetups",
+    "parties",
+]

whop_sdk/types/shared/invoice.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .currency import Currency
+from ..._models import BaseModel
+from .invoice_status import InvoiceStatus
+
+__all__ = ["Invoice", "CurrentPlan", "User"]
+
+
+class CurrentPlan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+    currency: Currency
+    """The respective currency identifier for the plan."""
+
+    formatted_price: str
+    """The formatted price (including currency) for the plan."""
+
+
+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 Invoice(BaseModel):
+    id: str
+    """The ID of the invoice."""
+
+    created_at: datetime
+    """The date the invoice was created."""
+
+    current_plan: CurrentPlan
+    """The plan that the invoice was created for."""
+
+    due_date: Optional[datetime] = None
+    """The date the invoice is due."""
+
+    email_address: Optional[str] = None
+    """The email address that the invoice was created for."""
+
+    fetch_invoice_token: str
+    """The token to fetch the invoice."""
+
+    number: str
+    """The number of the invoice."""
+
+    status: InvoiceStatus
+    """The status of the invoice."""
+
+    user: Optional[User] = None
+    """The user that the invoice was created for."""

whop_sdk/types/shared/invoice_list_item.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .currency import Currency
+from ..._models import BaseModel
+from .invoice_status import InvoiceStatus
+
+__all__ = ["InvoiceListItem", "CurrentPlan", "User"]
+
+
+class CurrentPlan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+    currency: Currency
+    """The respective currency identifier for the plan."""
+
+    formatted_price: str
+    """The formatted price (including currency) for the plan."""
+
+
+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 InvoiceListItem(BaseModel):
+    id: str
+    """The ID of the invoice."""
+
+    created_at: datetime
+    """The date the invoice was created."""
+
+    current_plan: CurrentPlan
+    """The plan that the invoice was created for."""
+
+    due_date: Optional[datetime] = None
+    """The date the invoice is due."""
+
+    email_address: Optional[str] = None
+    """The email address that the invoice was created for."""
+
+    fetch_invoice_token: str
+    """The token to fetch the invoice."""
+
+    number: str
+    """The number of the invoice."""
+
+    status: InvoiceStatus
+    """The status of the invoice."""
+
+    user: Optional[User] = None
+    """The user that the invoice was created for."""

whop_sdk/types/shared/invoice_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__ = ["InvoiceStatus"]
+
+InvoiceStatus: TypeAlias = Literal["open", "paid", "past_due", "void"]

whop_sdk/types/shared/membership.py

@@ -0,0 +1,117 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from .currency import Currency
+from ..._models import BaseModel
+from .membership_status import MembershipStatus
+
+__all__ = ["Membership", "Company", "Member", "Plan", "PromoCode", "User"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    title: str
+    """The title of the company."""
+
+
+class Member(BaseModel):
+    id: str
+    """The ID of the member"""
+
+
+class Plan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+
+class PromoCode(BaseModel):
+    id: str
+    """The ID of the promo."""
+
+
+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 Membership(BaseModel):
+    id: str
+    """The ID of the membership"""
+
+    cancel_at_period_end: bool
+    """Whether this Membership is set to cancel at the end of the current billing
+    cycle.
+
+    Only applies for memberships that have a renewal plan.
+    """
+
+    canceled_at: Optional[datetime] = None
+    """The epoch timestamp of when the customer initiated a cancellation."""
+
+    cancellation_reason: Optional[str] = None
+    """The reason that the member canceled the membership (filled out by the member)."""
+
+    company: Company
+    """The Company this Membership belongs to."""
+
+    created_at: datetime
+    """The timestamp, in seconds, that this Membership was created at."""
+
+    currency: Optional[Currency] = None
+    """The available currencies on the platform"""
+
+    license_key: Optional[str] = None
+    """The license key for this Membership.
+
+    This is only present if the membership grants access to an instance of the Whop
+    Software app.
+    """
+
+    manage_url: Optional[str] = None
+    """The URL for the customer to manage their membership."""
+
+    member: Optional[Member] = None
+    """The Member that this Membership belongs to."""
+
+    metadata: Dict[str, object]
+    """A JSON object used to store software licensing information. Ex. HWID"""
+
+    payment_collection_paused: bool
+    """Whether the membership's payments are currently paused."""
+
+    plan: Plan
+    """The Plan this Membership is for."""
+
+    promo_code: Optional[PromoCode] = None
+    """The Promo Code that is currently applied to this Membership."""
+
+    renewal_period_end: Optional[datetime] = None
+    """
+    The timestamp in seconds at which the current billing cycle for this
+    subscription ends. Only applies for memberships that have a renewal plan.
+    """
+
+    renewal_period_start: Optional[datetime] = None
+    """
+    The timestamp in seconds at which the current billing cycle for this
+    subscription start. Only applies for memberships that have a renewal plan.
+    """
+
+    status: MembershipStatus
+    """The status of the membership."""
+
+    updated_at: datetime
+    """A timestamp of when the membership was last updated"""
+
+    user: Optional[User] = None
+    """The user this membership belongs to"""

whop_sdk/types/shared/membership_status.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__ = ["MembershipStatus"]
+
+MembershipStatus: TypeAlias = Literal[
+    "trialing", "active", "past_due", "completed", "canceled", "expired", "unresolved", "drafted"
+]

whop_sdk/types/shared/message.py

@@ -0,0 +1,90 @@
+# 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 .dms_post_types import DmsPostTypes
+
+__all__ = ["Message", "Poll", "PollOption", "PollVote", "ReactionCount", "User"]
+
+
+class PollOption(BaseModel):
+    id: str
+    """The ID of the poll option"""
+
+    text: str
+    """The text of the poll option"""
+
+
+class Poll(BaseModel):
+    options: Optional[List[PollOption]] = None
+    """The options for the poll"""
+
+
+class PollVote(BaseModel):
+    count: int
+    """The number of users who reacted"""
+
+    option_id: Optional[str] = None
+    """The reaction that was used"""
+
+
+class ReactionCount(BaseModel):
+    count: int
+    """The number of users who reacted"""
+
+    emoji: Optional[str] = None
+    """The emoji that was used in shortcode format (:heart:)"""
+
+
+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 Message(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    content: Optional[str] = None
+    """The content of the message in Markdown format"""
+
+    created_at: datetime
+    """The timestamp when the post was created"""
+
+    is_edited: bool
+    """Whether the message has been edited"""
+
+    is_pinned: bool
+    """Whether this message is pinned"""
+
+    message_type: DmsPostTypes
+    """The type of post"""
+
+    poll: Optional[Poll] = None
+    """The poll for this message"""
+
+    poll_votes: List[PollVote]
+    """The reaction counts for this message"""
+
+    reaction_counts: List[ReactionCount]
+    """The reaction counts for this message"""
+
+    replying_to_message_id: Optional[str] = None
+    """The ID of the message this is replying to, if applicable"""
+
+    updated_at: datetime
+    """The timestamp when the post was last updated"""
+
+    user: User
+    """The user who sent this message"""
+
+    view_count: Optional[int] = None
+    """The number of times this message has been viewed"""

whop_sdk/types/shared/page_info.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["PageInfo"]
+
+
+class PageInfo(BaseModel):
+    end_cursor: Optional[str] = None
+    """When paginating forwards, the cursor to continue."""
+
+    has_next_page: bool
+    """When paginating forwards, are there more items?"""
+
+    has_previous_page: bool
+    """When paginating backwards, are there more items?"""
+
+    start_cursor: Optional[str] = None
+    """When paginating backwards, the cursor to continue."""

whop_sdk/types/shared/payment.py

@@ -0,0 +1,211 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from .currency import Currency
+from ..._models import BaseModel
+from .promo_type import PromoType
+from .receipt_status import ReceiptStatus
+from .membership_status import MembershipStatus
+from .friendly_receipt_status import FriendlyReceiptStatus
+
+__all__ = ["Payment", "BillingAddress", "Company", "Member", "Membership", "Plan", "Product", "PromoCode", "User"]
+
+
+class BillingAddress(BaseModel):
+    city: Optional[str] = None
+    """The city of the address."""
+
+    country: Optional[str] = None
+    """The country of the address."""
+
+    line1: Optional[str] = None
+    """The line 1 of the address."""
+
+    line2: Optional[str] = None
+    """The line 2 of the address."""
+
+    name: Optional[str] = None
+    """The name of the customer."""
+
+    postal_code: Optional[str] = None
+    """The postal code of the address."""
+
+    state: Optional[str] = None
+    """The state of the address."""
+
+
+class Company(BaseModel):
+    id: str
+    """The ID of the company"""
+
+    route: str
+    """The slug/route of the company on the Whop site."""
+
+    title: str
+    """The written name of the company."""
+
+
+class Member(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+
+class Membership(BaseModel):
+    id: str
+    """The internal ID of the membership."""
+
+    status: MembershipStatus
+    """The state of the membership."""
+
+
+class Plan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+
+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 PromoCode(BaseModel):
+    id: str
+    """The ID of the promo."""
+
+    amount_off: float
+    """The amount off (% or flat amount) for the promo."""
+
+    base_currency: Currency
+    """The monetary currency of the promo code."""
+
+    code: Optional[str] = None
+    """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."""
+
+    promo_type: PromoType
+    """The type (% or flat amount) of the promo."""
+
+
+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 Payment(BaseModel):
+    id: str
+    """The payment ID"""
+
+    amount_after_fees: float
+    """How much the payment is for after fees"""
+
+    auto_refunded: bool
+    """Whether this payment was auto refunded or not"""
+
+    billing_address: Optional[BillingAddress] = None
+    """The address of the user who made the payment."""
+
+    billing_reason: Optional[str] = None
+    """The billing reason"""
+
+    card_brand: Optional[str] = None
+    """The type of card used as the payment method."""
+
+    card_last4: Optional[str] = None
+    """The last 4 digits of the card used to make the payment."""
+
+    company: Optional[Company] = None
+    """The company for the payment."""
+
+    created_at: datetime
+    """The datetime the payment was created"""
+
+    currency: Optional[Currency] = None
+    """The available currencies on the platform"""
+
+    dispute_alerted_at: Optional[datetime] = None
+    """When an alert came in that this transaction will be disputed"""
+
+    failure_message: Optional[str] = None
+    """If the payment failed, the reason for the failure."""
+
+    last_payment_attempt: Optional[datetime] = None
+    """The time of the last payment attempt."""
+
+    member: Optional[Member] = None
+    """The member attached to this payment."""
+
+    membership: Optional[Membership] = None
+    """The membership attached to this payment."""
+
+    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
+    """
+
+    plan: Optional[Plan] = None
+    """The plan attached to this payment."""
+
+    product: Optional[Product] = None
+    """The access pass attached to this payment."""
+
+    promo_code: Optional[PromoCode] = None
+    """The promo code used for this payment."""
+
+    refundable: bool
+    """Whether the payment can be refunded."""
+
+    refunded_amount: Optional[float] = None
+    """The payment refund amount(if applicable)."""
+
+    refunded_at: Optional[datetime] = None
+    """When the payment was refunded (if applicable)."""
+
+    retryable: bool
+    """Whether the payment can be retried."""
+
+    status: Optional[ReceiptStatus] = None
+    """The status of a receipt"""
+
+    substatus: FriendlyReceiptStatus
+    """The friendly status of the payment."""
+
+    subtotal: Optional[float] = None
+    """The subtotal to show to the creator (excluding buyer fees)."""
+
+    total: Optional[float] = None
+    """The total to show to the creator (excluding buyer fees)."""
+
+    usd_total: Optional[float] = None
+    """The total in USD to show to the creator (excluding buyer fees)."""
+
+    user: Optional[User] = None
+    """The user that made this payment."""
+
+    voidable: bool
+    """Whether the payment can be voided."""