whop-sdk 0.0.10__py3-none-any.whl

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

@@ -0,0 +1,38 @@
+# 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 .._utils import PropertyInfo
+from .shared.direction import Direction
+
+__all__ = ["PaymentTokenListParams"]
+
+
+class PaymentTokenListParams(TypedDict, total=False):
+    member_id: Required[str]
+    """The ID of the Member to list payment tokens 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."""
+
+    created_after: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The minimum creation date to filter by"""
+
+    created_before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The maximum creation date to filter by"""
+
+    direction: Optional[Direction]
+    """The direction of the sort."""
+
+    first: Optional[int]
+    """Returns the first _n_ elements from the list."""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""

whop_sdk/types/payment_token_list_response.py

@@ -0,0 +1,41 @@
+# 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 .card_brands import CardBrands
+from .payment_method_types import PaymentMethodTypes
+
+__all__ = ["PaymentTokenListResponse", "Card"]
+
+
+class Card(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 PaymentTokenListResponse(BaseModel):
+    id: str
+    """The ID of the payment token"""
+
+    card: Optional[Card] = 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"""

whop_sdk/types/payment_token_retrieve_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["PaymentTokenRetrieveParams"]
+
+
+class PaymentTokenRetrieveParams(TypedDict, total=False):
+    member_id: Required[str]
+    """The ID of the Member associated with the PaymentToken"""

whop_sdk/types/payment_token_retrieve_response.py

@@ -0,0 +1,41 @@
+# 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 .card_brands import CardBrands
+from .payment_method_types import PaymentMethodTypes
+
+__all__ = ["PaymentTokenRetrieveResponse", "Card"]
+
+
+class Card(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 PaymentTokenRetrieveResponse(BaseModel):
+    id: str
+    """The ID of the payment token"""
+
+    card: Optional[Card] = 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"""

whop_sdk/types/plan_create_params.py

@@ -0,0 +1,162 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Iterable, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .shared.currency import Currency
+from .shared.tax_type import TaxType
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .payment_method_types import PaymentMethodTypes
+from .shared.release_method import ReleaseMethod
+
+__all__ = [
+    "PlanCreateParams",
+    "CustomField",
+    "Image",
+    "ImageAttachmentInputWithDirectUploadID",
+    "ImageAttachmentInputWithID",
+    "PaymentMethodConfiguration",
+]
+
+
+class PlanCreateParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The company the plan should be created for."""
+
+    product_id: Required[str]
+    """The product the plan is related to."""
+
+    billing_period: Optional[int]
+    """The interval in days at which the plan charges (renewal plans)."""
+
+    currency: Optional[Currency]
+    """The available currencies on the platform"""
+
+    custom_fields: Optional[Iterable[CustomField]]
+    """An array of custom field objects."""
+
+    description: Optional[str]
+    """The description of the plan."""
+
+    expiration_days: Optional[int]
+    """The interval at which the plan expires and revokes access (expiration plans)."""
+
+    image: Optional[Image]
+    """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.
+
+    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."""
+
+    override_tax_type: Optional[TaxType]
+    """
+    Whether or not the tax is included in a plan's price (or if it hasn't been set
+    up)
+    """
+
+    payment_method_configuration: Optional[PaymentMethodConfiguration]
+    """The explicit payment method configuration for the plan.
+
+    If not provided, the platform or company's defaults will apply.
+    """
+
+    plan_type: Optional[PlanType]
+    """The type of plan that can be attached to a product"""
+
+    release_method: Optional[ReleaseMethod]
+    """The methods of how a plan can be released."""
+
+    renewal_price: Optional[float]
+    """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."""
+
+    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"""
+
+
+class CustomField(TypedDict, total=False):
+    field_type: Required[Literal["text"]]
+    """The type of the custom field."""
+
+    name: Required[str]
+    """The name of the custom field."""
+
+    id: Optional[str]
+    """The ID of the custom field (if being updated)"""
+
+    order: Optional[int]
+    """The order of the field."""
+
+    placeholder: Optional[str]
+    """The placeholder value of the field."""
+
+    required: Optional[bool]
+    """Whether or not the field is required."""
+
+
+class ImageAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[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 ImageAttachmentInputWithID(TypedDict, total=False):
+    id: Required[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.
+    """
+
+
+Image: TypeAlias = Union[ImageAttachmentInputWithDirectUploadID, ImageAttachmentInputWithID]
+
+
+class PaymentMethodConfiguration(TypedDict, total=False):
+    disabled: Required[List[PaymentMethodTypes]]
+    """An array of payment method identifiers that are explicitly disabled.
+
+    Only applies if the include_platform_defaults is true.
+    """
+
+    enabled: Required[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: Required[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.
+    """

whop_sdk/types/plan_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__ = ["PlanDeleteResponse"]
+
+PlanDeleteResponse: TypeAlias = bool

whop_sdk/types/plan_list_params.py

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .shared.direction import Direction
+from .shared.plan_type import PlanType
+from .shared.release_method import ReleaseMethod
+from .shared.visibility_filter import VisibilityFilter
+
+__all__ = ["PlanListParams"]
+
+
+class PlanListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company"""
+
+    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."""
+
+    created_after: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The minimum creation date to filter by"""
+
+    created_before: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """The maximum creation date to filter by"""
+
+    direction: Optional[Direction]
+    """The direction of the sort."""
+
+    first: Optional[int]
+    """Returns the first _n_ elements from the list."""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""
+
+    order: Optional[Literal["id", "active_members_count", "created_at", "internal_notes", "expires_at"]]
+    """The ways a relation of Plans can be ordered"""
+
+    plan_types: Optional[List[PlanType]]
+    """The plan type to filter the plans by"""
+
+    product_ids: Optional[SequenceNotStr[str]]
+    """The product IDs to filter the plans by"""
+
+    release_methods: Optional[List[ReleaseMethod]]
+    """The release method to filter the plans by"""
+
+    visibilities: Optional[List[VisibilityFilter]]
+    """The visibility to filter the plans by"""

whop_sdk/types/plan_list_response.py

@@ -0,0 +1,128 @@
+# 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 .shared.currency import Currency
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .payment_method_types import PaymentMethodTypes
+from .shared.release_method import ReleaseMethod
+
+__all__ = ["PlanListResponse", "Company", "Invoice", "PaymentMethodConfiguration", "Product"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    title: str
+    """The title of the company."""
+
+
+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 PlanListResponse(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+    billing_period: Optional[int] = None
+    """The interval at which the plan charges (renewal plans)."""
+
+    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."""
+
+    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"""
+
+    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/plan_update_params.py

@@ -0,0 +1,155 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Iterable, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .shared.currency import Currency
+from .shared.tax_type import TaxType
+from .shared.visibility import Visibility
+from .payment_method_types import PaymentMethodTypes
+
+__all__ = [
+    "PlanUpdateParams",
+    "CustomField",
+    "Image",
+    "ImageAttachmentInputWithDirectUploadID",
+    "ImageAttachmentInputWithID",
+    "PaymentMethodConfiguration",
+]
+
+
+class PlanUpdateParams(TypedDict, total=False):
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    currency: Optional[Currency]
+    """The available currencies on the platform"""
+
+    custom_fields: Optional[Iterable[CustomField]]
+    """An array of custom field objects."""
+
+    description: Optional[str]
+    """The description of the plan."""
+
+    expiration_days: Optional[int]
+    """The interval at which the plan charges (expiration plans)."""
+
+    image: Optional[Image]
+    """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."""
+
+    internal_notes: Optional[str]
+    """A personal description or notes section for the business."""
+
+    offer_cancel_discount: Optional[bool]
+    """Whether or not to offer a discount to cancel a subscription."""
+
+    override_tax_type: Optional[TaxType]
+    """
+    Whether or not the tax is included in a plan's price (or if it hasn't been set
+    up)
+    """
+
+    payment_method_configuration: Optional[PaymentMethodConfiguration]
+    """The explicit payment method configuration for the plan.
+
+    If sent as null, the custom configuration will be removed.
+    """
+
+    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"""
+
+
+class CustomField(TypedDict, total=False):
+    field_type: Required[Literal["text"]]
+    """The type of the custom field."""
+
+    name: Required[str]
+    """The name of the custom field."""
+
+    id: Optional[str]
+    """The ID of the custom field (if being updated)"""
+
+    order: Optional[int]
+    """The order of the field."""
+
+    placeholder: Optional[str]
+    """The placeholder value of the field."""
+
+    required: Optional[bool]
+    """Whether or not the field is required."""
+
+
+class ImageAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[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 ImageAttachmentInputWithID(TypedDict, total=False):
+    id: Required[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.
+    """
+
+
+Image: TypeAlias = Union[ImageAttachmentInputWithDirectUploadID, ImageAttachmentInputWithID]
+
+
+class PaymentMethodConfiguration(TypedDict, total=False):
+    disabled: Required[List[PaymentMethodTypes]]
+    """An array of payment method identifiers that are explicitly disabled.
+
+    Only applies if the include_platform_defaults is true.
+    """
+
+    enabled: Required[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: Required[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.
+    """