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

whop_sdk/types/payment_list_response.py

@@ -4,8 +4,11 @@ from typing import Optional
 from datetime import datetime
 
 from .._models import BaseModel
+from .card_brands import CardBrands
+from .billing_reasons import BillingReasons
 from .shared.currency import Currency
 from .shared.promo_type import PromoType
+from .payment_method_types import PaymentMethodTypes
 from .shared.receipt_status import ReceiptStatus
 from .shared.membership_status import MembershipStatus
 from .shared.friendly_receipt_status import FriendlyReceiptStatus
@@ -103,7 +106,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."""
@@ -136,11 +139,11 @@ class PaymentListResponse(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."""
@@ -172,11 +175,8 @@ class PaymentListResponse(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."""
@@ -188,7 +188,10 @@ class PaymentListResponse(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)."""
@@ -197,7 +200,11 @@ class PaymentListResponse(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"""
@@ -218,4 +225,7 @@ class PaymentListResponse(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/payment_method_types.py

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["PaymentMethodTypes"]
+
+PaymentMethodTypes: TypeAlias = Literal[
+    "acss_debit",
+    "affirm",
+    "afterpay_clearpay",
+    "alipay",
+    "alma",
+    "amazon_pay",
+    "apple_pay",
+    "au_becs_debit",
+    "bacs_debit",
+    "bancontact",
+    "billie",
+    "blik",
+    "boleto",
+    "card",
+    "cashapp",
+    "crypto",
+    "eps",
+    "fpx",
+    "giropay",
+    "google_pay",
+    "grabpay",
+    "ideal",
+    "kakao_pay",
+    "klarna",
+    "konbini",
+    "kr_card",
+    "link",
+    "mobilepay",
+    "multibanco",
+    "naver_pay",
+    "nz_bank_account",
+    "oxxo",
+    "p24",
+    "pay_by_bank",
+    "payco",
+    "paynow",
+    "pix",
+    "promptpay",
+    "revolut_pay",
+    "samsung_pay",
+    "satispay",
+    "sepa_debit",
+    "sofort",
+    "swish",
+    "twint",
+    "us_bank_account",
+    "wechat_pay",
+    "zip",
+    "bizum",
+    "capchase_pay",
+    "kriya",
+    "mondu",
+    "ng_wallet",
+    "paypay",
+    "sequra",
+    "scalapay",
+    "vipps",
+    "custom",
+    "customer_balance",
+    "gopay",
+    "mb_way",
+    "ng_bank",
+    "ng_bank_transfer",
+    "ng_card",
+    "ng_market",
+    "ng_ussd",
+    "paypal",
+    "payto",
+    "qris",
+    "rechnung",
+    "south_korea_market",
+    "kr_market",
+    "shopeepay",
+    "upi",
+    "sunbit",
+    "netbanking",
+    "id_bank_transfer",
+    "demo_pay",
+    "shop_pay",
+    "apple",
+    "sezzle",
+    "coinbase",
+    "splitit",
+    "unknown",
+]

whop_sdk/types/payment_pending_webhook_event.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .shared.payment import Payment
+
+__all__ = ["PaymentPendingWebhookEvent"]
+
+
+class PaymentPendingWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Payment
+    """An object representing a receipt for a membership."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["payment.pending"]
+    """The webhook event type"""

whop_sdk/types/payment_succeeded_webhook_event.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .shared.payment import Payment
+
+__all__ = ["PaymentSucceededWebhookEvent"]
+
+
+class PaymentSucceededWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Payment
+    """An object representing a receipt for a membership."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["payment.succeeded"]
+    """The webhook event type"""

whop_sdk/types/plan_create_params.py

@@ -22,7 +22,7 @@ class PlanCreateParams(TypedDict, total=False):
     """The product the plan is related to."""
 
     billing_period: Optional[int]
-    """The interval at which the plan charges (renewal plans)."""
+    """The interval in days at which the plan charges (renewal plans)."""
 
     currency: Optional[Currency]
     """The available currencies on the platform"""
@@ -40,7 +40,11 @@ class PlanCreateParams(TypedDict, total=False):
     """An image for the plan. This will be visible on the product page to customers."""
 
     initial_price: Optional[float]
-    """An additional amount charged upon first purchase."""
+    """An additional amount charged upon first purchase.
+
+    Use only if a one time payment OR you want to charge an additional amount on top
+    of the renewal price. Provided as a number in dollars. Eg: 10.43 for $10.43
+    """
 
     internal_notes: Optional[str]
     """A personal description or notes section for the business."""
@@ -58,7 +62,26 @@ class PlanCreateParams(TypedDict, total=False):
     """The methods of how a plan can be released."""
 
     renewal_price: Optional[float]
-    """The amount the customer is charged every billing period."""
+    """The amount the customer is charged every billing period.
+
+    Use only if a recurring payment. Provided as a number in dollars. Eg: 10.43 for
+    $10.43
+    """
+
+    stock: Optional[int]
+    """The number of units available for purchase."""
+
+    strike_through_initial_price: Optional[float]
+    """The price to display with a strikethrough for the initial price.
+
+    Provided as a number in dollars. Eg: 19.99 for $19.99
+    """
+
+    strike_through_renewal_price: Optional[float]
+    """The price to display with a strikethrough for the renewal price.
+
+    Provided as a number in dollars. Eg: 19.99 for $19.99
+    """
 
     title: Optional[str]
     """The title of the plan. This will be visible on the product page to customers."""
@@ -66,6 +89,9 @@ class PlanCreateParams(TypedDict, total=False):
     trial_period_days: Optional[int]
     """The number of free trial days added before a renewal plan."""
 
+    unlimited_stock: Optional[bool]
+    """Limits/doesn't limit the number of units available for purchase."""
+
     visibility: Optional[Visibility]
     """Visibility of a resource"""
 

whop_sdk/types/plan_list_response.py

@@ -82,9 +82,18 @@ class PlanListResponse(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"""
+
+    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/plan_update_params.py

@@ -49,12 +49,30 @@ class PlanUpdateParams(TypedDict, total=False):
     renewal_price: Optional[float]
     """The amount the customer is charged every billing period."""
 
+    stock: Optional[int]
+    """The number of units available for purchase."""
+
+    strike_through_initial_price: Optional[float]
+    """The price to display with a strikethrough for the initial price.
+
+    Provided as a number in dollars. Eg: 19.99 for $19.99
+    """
+
+    strike_through_renewal_price: Optional[float]
+    """The price to display with a strikethrough for the renewal price.
+
+    Provided as a number in dollars. Eg: 19.99 for $19.99
+    """
+
     title: Optional[str]
     """The title of the plan. This will be visible on the product page to customers."""
 
     trial_period_days: Optional[int]
     """The number of free trial days added before a renewal plan."""
 
+    unlimited_stock: Optional[bool]
+    """Limits/doesn't limit the number of units available for purchase."""
+
     visibility: Optional[Visibility]
     """Visibility of a resource"""
 

whop_sdk/types/product_create_params.py

@@ -13,10 +13,9 @@ from .shared.visibility import Visibility
 from .shared.business_types import BusinessTypes
 from .shared.industry_types import IndustryTypes
 from .shared.release_method import ReleaseMethod
-from .shared.access_pass_type import AccessPassType
 from .shared.global_affiliate_status import GlobalAffiliateStatus
 
-__all__ = ["ProductCreateParams", "BannerImage", "PlanOptions", "PlanOptionsCustomField", "ProductHighlight"]
+__all__ = ["ProductCreateParams", "PlanOptions", "PlanOptionsCustomField", "ProductHighlight"]
 
 
 class ProductCreateParams(TypedDict, total=False):
@@ -26,12 +25,6 @@ class ProductCreateParams(TypedDict, total=False):
     title: Required[str]
     """The title of the product."""
 
-    access_pass_type: Optional[AccessPassType]
-    """The different types an access pass can be."""
-
-    banner_image: Optional[BannerImage]
-    """A banner image for the product in png, jpeg format"""
-
     business_type: Optional[BusinessTypes]
     """The different business types a company can be."""
 
@@ -94,22 +87,6 @@ class ProductCreateParams(TypedDict, total=False):
     """Visibility of a resource"""
 
 
-class BannerImage(TypedDict, total=False):
-    id: Optional[str]
-    """The ID of an existing attachment object.
-
-    Use this when updating a resource and keeping a subset of the attachments. Don't
-    use this unless you know what you're doing.
-    """
-
-    direct_upload_id: Optional[str]
-    """This ID should be used the first time you upload an attachment.
-
-    It is the ID of the direct upload that was created when uploading the file to S3
-    via the mediaDirectUpload mutation.
-    """
-
-
 class PlanOptionsCustomField(TypedDict, total=False):
     field_type: Required[Literal["text"]]
     """The type of the custom field."""

whop_sdk/types/product_update_params.py

@@ -11,7 +11,7 @@ from .shared.business_types import BusinessTypes
 from .shared.industry_types import IndustryTypes
 from .shared.global_affiliate_status import GlobalAffiliateStatus
 
-__all__ = ["ProductUpdateParams", "BannerImage"]
+__all__ = ["ProductUpdateParams", "BannerImage", "StorePageConfig"]
 
 
 class ProductUpdateParams(TypedDict, total=False):
@@ -67,6 +67,9 @@ class ProductUpdateParams(TypedDict, total=False):
     route: Optional[str]
     """The route of the product."""
 
+    store_page_config: Optional[StorePageConfig]
+    """Configuration for a product on the company's store page."""
+
     title: Optional[str]
     """The title of the product."""
 
@@ -88,3 +91,11 @@ class BannerImage(TypedDict, total=False):
     It is the ID of the direct upload that was created when uploading the file to S3
     via the mediaDirectUpload mutation.
     """
+
+
+class StorePageConfig(TypedDict, total=False):
+    custom_cta: Optional[str]
+    """Custom call-to-action text for the product's store page."""
+
+    show_price: Optional[bool]
+    """Whether or not to show the price on the product's store page."""

whop_sdk/types/promo_code.py

@@ -0,0 +1,90 @@
+# 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__ = ["PromoCode", "Company", "Product"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID of the company"""
+
+    title: str
+    """The written name 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 PromoCode(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."""
+
+    company: Company
+    """The company for the promo code."""
+
+    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_create_params.py

@@ -0,0 +1,70 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .shared.currency import Currency
+from .shared.promo_type import PromoType
+
+__all__ = ["PromoCodeCreateParams"]
+
+
+class PromoCodeCreateParams(TypedDict, total=False):
+    amount_off: Required[float]
+    """The amount off (% or flat amount) for the promo."""
+
+    base_currency: Required[Currency]
+    """The monetary currency of the promo code."""
+
+    code: Required[str]
+    """The specific code used to apply the promo at checkout."""
+
+    company_id: Required[str]
+    """The id of the company to create the promo code for."""
+
+    new_users_only: Required[bool]
+    """
+    Restricts promo use to only users who have never purchased from the company
+    before.
+    """
+
+    promo_duration_months: Required[int]
+    """The number of months this promo code is applied and valid for."""
+
+    promo_type: Required[PromoType]
+    """The type (% or flat amount) of the promo."""
+
+    churned_users_only: Optional[bool]
+    """Restricts promo use to only users who have churned from the company before."""
+
+    existing_memberships_only: Optional[bool]
+    """Whether this promo code is for existing memberships only (cancelations)"""
+
+    expires_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The date/time of when the promo expires."""
+
+    one_per_customer: Optional[bool]
+    """Restricts promo use to only be applied once per customer."""
+
+    plan_ids: Optional[SequenceNotStr[str]]
+    """The IDs of the plans that the promo code applies to.
+
+    If product_id is provided, it will only apply to plans attached to that product
+    """
+
+    product_id: Optional[str]
+    """The product to lock the promo code to, if any.
+
+    If provided will filter out any plan ids not attached to this product
+    """
+
+    stock: Optional[int]
+    """The quantity limit on the number of uses."""
+
+    unlimited_stock: Optional[bool]
+    """Whether or not the promo code should have unlimited stock."""

whop_sdk/types/promo_code_delete_response.py

@@ -0,0 +1,7 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import TypeAlias
+
+__all__ = ["PromoCodeDeleteResponse"]
+
+PromoCodeDeleteResponse: TypeAlias = bool

whop_sdk/types/promo_code_list_params.py

@@ -0,0 +1,37 @@
+# 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
+
+from .._types import SequenceNotStr
+from .promo_code_status import PromoCodeStatus
+
+__all__ = ["PromoCodeListParams"]
+
+
+class PromoCodeListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list promo codes for"""
+
+    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."""
+
+    plan_ids: Optional[SequenceNotStr[str]]
+    """Filter promo codes by plan ID(s)"""
+
+    product_ids: Optional[SequenceNotStr[str]]
+    """Filter promo codes by product ID(s)"""
+
+    status: Optional[PromoCodeStatus]
+    """Statuses for promo codes"""