whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/shared/membership.py

@@ -0,0 +1,128 @@
+# 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", "Product", "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 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."""
+
+
+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."""
+
+    product: Product
+    """The Product this Membership grants access to."""
+
+    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 of the resource."""
+
+    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,273 @@
+# 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 .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",
+    "PaymentToken",
+    "PaymentTokenCard",
+    "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 PaymentTokenCard(BaseModel):
+    brand: Optional[CardBrands] = None
+    """Possible card brands that a payment token can have"""
+
+    exp_month: Optional[int] = None
+    """Card expiration month, like 03 for March."""
+
+    exp_year: Optional[int] = None
+    """Card expiration year, like 27 for 2027."""
+
+    last4: Optional[str] = None
+    """Last four digits of the card."""
+
+
+class PaymentToken(BaseModel):
+    id: str
+    """The ID of the payment token"""
+
+    card: Optional[PaymentTokenCard] = None
+    """
+    The card data associated with the payment token, if its a debit or credit card
+    token.
+    """
+
+    created_at: datetime
+    """The date and time the payment token was created"""
+
+    payment_method_type: PaymentMethodTypes
+    """The payment method type of the payment token"""
+
+
+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 months 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[BillingReasons] = None
+    """The reason why a specific payment was billed"""
+
+    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."""
+
+    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."""
+
+    metadata: Optional[Dict[str, object]] = None
+    """The custom metadata stored on this payment.
+
+    This will be copied the checkout configuration for which this payment was made
+    """
+
+    paid_at: Optional[datetime] = None
+    """The datetime the payment was paid"""
+
+    payment_method_type: Optional[PaymentMethodTypes] = None
+    """The different types of payment methods that can be used."""
+
+    payment_token: Optional[PaymentToken] = None
+    """The payment token used for the payment, if available."""
+
+    plan: Optional[Plan] = None
+    """The plan attached to this payment."""
+
+    product: Optional[Product] = None
+    """The product this payment was made for"""
+
+    promo_code: Optional[PromoCode] = None
+    """The promo code used for this payment."""
+
+    refundable: bool
+    """
+    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)."""
+
+    refunded_at: Optional[datetime] = None
+    """When the payment was refunded (if applicable)."""
+
+    retryable: bool
+    """
+    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"""
+
+    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
+    """
+    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

@@ -0,0 +1,159 @@
+# 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 .currency import Currency
+from .tax_type import TaxType
+from ..._models import BaseModel
+from .plan_type import PlanType
+from .visibility import Visibility
+from .release_method import ReleaseMethod
+from ..payment_method_types import PaymentMethodTypes
+
+__all__ = ["Plan", "Company", "CustomField", "Invoice", "PaymentMethodConfiguration", "Product"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    title: str
+    """The title of the company."""
+
+
+class CustomField(BaseModel):
+    id: str
+    """The internal ID of the given custom field"""
+
+    field_type: Literal["text"]
+    """What type of input field to use."""
+
+    name: str
+    """The title/header of the custom field."""
+
+    order: Optional[int] = None
+    """How the custom field should be ordered when rendered on the checkout page."""
+
+    placeholder: Optional[str] = None
+    """An example response displayed in the input field."""
+
+    required: bool
+    """Whether or not the custom field is required."""
+
+
+class Invoice(BaseModel):
+    id: str
+    """The ID of the invoice."""
+
+
+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 Product(BaseModel):
+    id: str
+    """The internal ID of the public product."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+
+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)."""
+
+    collect_tax: bool
+    """Whether or not the plan collects tax."""
+
+    company: Optional[Company] = None
+    """The company for the plan."""
+
+    created_at: datetime
+    """When the plan was created."""
+
+    currency: Currency
+    """The respective currency identifier for the plan."""
+
+    custom_fields: List[CustomField]
+    """The custom fields for the plan."""
+
+    description: Optional[str] = None
+    """The description of 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."""
+
+    internal_notes: Optional[str] = None
+    """A personal description or notes section for the business."""
+
+    invoice: Optional[Invoice] = None
+    """The invoice associated with this plan."""
+
+    member_count: Optional[int] = None
+    """The number of members for the plan."""
+
+    payment_method_configuration: Optional[PaymentMethodConfiguration] = None
+    """The explicit payment method configuration for the plan, if any."""
+
+    plan_type: PlanType
+    """Indicates if the plan is a one time payment or recurring."""
+
+    product: Optional[Product] = None
+    """The product that this plan belongs to."""
+
+    purchase_url: str
+    """The direct link to purchase the product."""
+
+    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."""
+
+    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."""
+
+    visibility: Visibility
+    """Shows or hides the plan from public/business view."""

whop_sdk/types/shared/plan_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__ = ["PlanType"]
+
+PlanType: TypeAlias = Literal["renewal", "one_time"]