whop-sdk 0.0.1__py3-none-any.whl

whop_sdk/types/shared/plan.py

@@ -0,0 +1,123 @@
+# 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
+
+__all__ = ["Plan", "Company", "CustomField", "Invoice", "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 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."""
+
+    plan_type: PlanType
+    """Indicates if the plan is a one time payment or recurring."""
+
+    product: Optional[Product] = None
+    """The access pass for the plan."""
+
+    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."""
+
+    tax_type: TaxType
+    """The tax type for the plan."""
+
+    trial_period_days: Optional[int] = None
+    """The number of free trial days added before a renewal plan."""
+
+    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"]

whop_sdk/types/shared/product.py

@@ -0,0 +1,124 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .custom_cta import CustomCta
+from .visibility import Visibility
+from .business_types import BusinessTypes
+from .industry_types import IndustryTypes
+from .global_affiliate_status import GlobalAffiliateStatus
+
+__all__ = ["Product", "Company", "OwnerUser", "ProductTaxCode"]
+
+
+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 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 ProductTaxCode(BaseModel):
+    id: str
+    """The internal ID of the product tax code."""
+
+    name: str
+    """The name of the product tax code."""
+
+    product_type: Literal["physical", "digital", "services"]
+    """The type of product this tax code applies to."""
+
+
+class Product(BaseModel):
+    id: str
+    """The internal ID of the public product."""
+
+    business_type: Optional[BusinessTypes] = None
+    """The different business types a company can be."""
+
+    company: Company
+    """A short type of the company that this product belongs to."""
+
+    created_at: datetime
+    """When the product was created."""
+
+    custom_cta: CustomCta
+    """The custom call to action for the product."""
+
+    custom_cta_url: Optional[str] = None
+    """The custom call to action URL for the product, if any."""
+
+    custom_statement_descriptor: Optional[str] = None
+    """The custom statement descriptor for the product."""
+
+    description: Optional[str] = None
+    """A short description of what the company offers or does."""
+
+    global_affiliate_percentage: Optional[float] = None
+    """
+    The percentage of a transaction a user is eligible to earn from the whop
+    marketplace global affiliate program.
+    """
+
+    global_affiliate_status: GlobalAffiliateStatus
+    """The status of the global affiliate program for this product."""
+
+    headline: Optional[str] = None
+    """The headline of the product."""
+
+    industry_type: Optional[IndustryTypes] = None
+    """The different industry types a company can be in."""
+
+    member_affiliate_percentage: Optional[float] = None
+    """
+    The percentage of a transaction a user is eligible to earn from the whop
+    marketplace member affiliate program.
+    """
+
+    member_affiliate_status: GlobalAffiliateStatus
+    """The status of the member affiliate program for this product."""
+
+    member_count: int
+    """The number of active users for this product."""
+
+    owner_user: OwnerUser
+    """The user that owns the product (company owner)."""
+
+    product_tax_code: Optional[ProductTaxCode] = None
+    """The product tax code for the product, if any."""
+
+    published_reviews_count: int
+    """The number of reviews that have been published for the product."""
+
+    route: str
+    """The route of the product."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+    updated_at: datetime
+    """When the product was updated."""
+
+    verified: bool
+    """Whether this product is Whop verified."""
+
+    visibility: Visibility
+    """This product will/will not be displayed publicly."""

whop_sdk/types/shared/product_list_item.py

@@ -0,0 +1,49 @@
+# 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 .visibility import Visibility
+from .business_types import BusinessTypes
+from .industry_types import IndustryTypes
+
+__all__ = ["ProductListItem"]
+
+
+class ProductListItem(BaseModel):
+    id: str
+    """The internal ID of the public product."""
+
+    business_type: Optional[BusinessTypes] = None
+    """The different business types a company can be."""
+
+    created_at: datetime
+    """When the product was created."""
+
+    headline: Optional[str] = None
+    """The headline of the product."""
+
+    industry_type: Optional[IndustryTypes] = None
+    """The different industry types a company can be in."""
+
+    member_count: int
+    """The number of active users for this product."""
+
+    published_reviews_count: int
+    """The number of reviews that have been published for the product."""
+
+    route: str
+    """The route of the product."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+    updated_at: datetime
+    """When the product was updated."""
+
+    verified: bool
+    """Whether this product is Whop verified."""
+
+    visibility: Visibility
+    """This product will/will not be displayed publicly."""

whop_sdk/types/shared/promo_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__ = ["PromoType"]
+
+PromoType: TypeAlias = Literal["percentage", "flat_amount"]

whop_sdk/types/shared/reaction.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["Reaction", "User"]
+
+
+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 Reaction(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    emoji: Optional[str] = None
+    """The emoji that was used in shortcode format (:heart:)"""
+
+    resource_id: str
+    """The ID of the post this reaction belongs to"""
+
+    user: User
+    """The user who reacted to the post"""

whop_sdk/types/shared/receipt_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__ = ["ReceiptStatus"]
+
+ReceiptStatus: TypeAlias = Literal["draft", "open", "paid", "pending", "uncollectible", "unresolved", "void"]

whop_sdk/types/shared/release_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__ = ["ReleaseMethod"]
+
+ReleaseMethod: TypeAlias = Literal["buy_now", "waitlist"]

whop_sdk/types/shared/shipment.py

@@ -0,0 +1,48 @@
+# 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 .shipment_status import ShipmentStatus
+from .shipment_carrier import ShipmentCarrier
+from .shipment_substatus import ShipmentSubstatus
+
+__all__ = ["Shipment", "Payment"]
+
+
+class Payment(BaseModel):
+    id: str
+    """The payment ID"""
+
+
+class Shipment(BaseModel):
+    id: str
+    """The ID of the shipment"""
+
+    carrier: ShipmentCarrier
+    """The carrier of the shipment"""
+
+    created_at: datetime
+    """The date and time the shipment was created"""
+
+    delivery_estimate: Optional[datetime] = None
+    """The delivery estimate of the shipment"""
+
+    payment: Payment
+    """The payment of the shipment"""
+
+    service: Optional[str] = None
+    """The service of the shipment"""
+
+    status: ShipmentStatus
+    """The status of the shipment"""
+
+    substatus: Optional[ShipmentSubstatus] = None
+    """The substatus of a shipment"""
+
+    tracking_code: str
+    """The tracking code of the shipment"""
+
+    updated_at: datetime
+    """The date and time the shipment was last updated"""

whop_sdk/types/shared/shipment_carrier.py

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["ShipmentCarrier"]
+
+ShipmentCarrier: TypeAlias = Literal[
+    "accurate",
+    "amazon_mws",
+    "amazon_shipping",
+    "apc",
+    "asendia_usa",
+    "australia_post",
+    "axlehire_v3",
+    "better_trucks",
+    "canada_post",
+    "canpar",
+    "columbus_last_mile",
+    "chronopost",
+    "cloud_sort",
+    "courier_express",
+    "couriers_please",
+    "cs_logistics",
+    "dai_post",
+    "deutsche_post_uk",
+    "deutsche_post",
+    "dhl_ecommerce_asia",
+    "dhl_ecs",
+    "dhl_express",
+    "dhl_paket",
+    "door_dash",
+    "dpd_nl",
+    "dpd_uk",
+    "dpd",
+    "epost_global",
+    "estafeta",
+    "evri",
+    "fastway",
+    "fedex_cross_border",
+    "fedex_default",
+    "fedex_mailview",
+    "fedex_smartpost",
+    "fedex",
+    "first_choice",
+    "first_mile",
+    "flexport",
+    "gio",
+    "gio_express",
+    "gso",
+    "hailify",
+    "henry",
+    "interlink_express",
+    "jet",
+    "kuroneko_yamato",
+    "la_post",
+    "lasership_v2",
+    "loomis_express",
+    "lso",
+    "ontrac",
+    "optima",
+    "osm_worldwide",
+    "parcelforce",
+    "parcll",
+    "passport_global",
+    "post_nl",
+    "purolator",
+    "quick",
+    "royal_mail",
+    "omni_parcel",
+    "sendle",
+    "sf_express",
+    "smart_kargo",
+    "sonic",
+    "spee_dee",
+    "swyft",
+    "tforce",
+    "uds",
+    "ups_iparcel",
+    "ups_mail_innovations",
+    "ups",
+    "usps",
+    "veho",
+    "yanwen",
+]

whop_sdk/types/shared/shipment_status.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["ShipmentStatus"]
+
+ShipmentStatus: TypeAlias = Literal[
+    "unknown",
+    "pre_transit",
+    "in_transit",
+    "out_for_delivery",
+    "delivered",
+    "available_for_pickup",
+    "return_to_sender",
+    "failure",
+    "cancelled",
+    "error",
+]

whop_sdk/types/shared/shipment_substatus.py

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["ShipmentSubstatus"]
+
+ShipmentSubstatus: TypeAlias = Literal[
+    "address_correction",
+    "arrived_at_destination",
+    "arrived_at_facility",
+    "arrived_at_pickup_location",
+    "awaiting_information",
+    "substatus_cancelled",
+    "damaged",
+    "delayed",
+    "delivery_exception",
+    "departed_facility",
+    "departed_origin_facility",
+    "expired",
+    "substatus_failure",
+    "held",
+    "substatus_in_transit",
+    "label_created",
+    "lost",
+    "missorted",
+    "substatus_out_for_delivery",
+    "received_at_destination_facility",
+    "received_at_origin_facility",
+    "refused",
+    "return",
+    "status_update",
+    "transferred_to_destination_carrier",
+    "transit_exception",
+    "substatus_unknown",
+    "weather_delay",
+]

whop_sdk/types/shared/support_channel.py

@@ -0,0 +1,39 @@
+# 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__ = ["SupportChannel", "CustomerUser"]
+
+
+class CustomerUser(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 SupportChannel(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    company_id: Optional[str] = None
+    """The bot ID if this is a support chat"""
+
+    custom_name: Optional[str] = None
+    """The custom name of the DM channel, if any"""
+
+    customer_user: Optional[CustomerUser] = None
+    """The customer user if this is a support chat"""
+
+    last_message_at: Optional[datetime] = None
+    """When the last message was sent"""
+
+    resolved_at: Optional[datetime] = None
+    """When the support ticket was resolved (null if unresolved)"""

whop_sdk/types/shared/tax_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__ = ["TaxType"]
+
+TaxType: TypeAlias = Literal["inclusive", "exclusive", "unspecified"]