whop-sdk 0.0.1__py3-none-any.whl

whop_sdk/types/payment_list_response.py

@@ -0,0 +1,221 @@
+# 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 .shared.currency import Currency
+from .shared.promo_type import PromoType
+from .shared.receipt_status import ReceiptStatus
+from .shared.membership_status import MembershipStatus
+from .shared.friendly_receipt_status import FriendlyReceiptStatus
+
+__all__ = [
+    "PaymentListResponse",
+    "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 PaymentListResponse(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."""

whop_sdk/types/payment_refund_params.py

@@ -0,0 +1,13 @@
+# 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 TypedDict
+
+__all__ = ["PaymentRefundParams"]
+
+
+class PaymentRefundParams(TypedDict, total=False):
+    partial_amount: Optional[float]
+    """An amount if the refund is supposed to be partial."""

whop_sdk/types/plan_create_params.py

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .shared.currency import Currency
+from .shared.tax_type import TaxType
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .shared.release_method import ReleaseMethod
+
+__all__ = ["PlanCreateParams", "CustomField", "Image"]
+
+
+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 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."""
+
+    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)
+    """
+
+    plan_type: Optional[PlanType]
+    """The type of plan that can be attached to an access pass"""
+
+    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."""
+
+    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."""
+
+    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 Image(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.
+    """

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,49 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .._types import SequenceNotStr
+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."""
+
+    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,92 @@
+# 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 .shared.currency import Currency
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .shared.release_method import ReleaseMethod
+
+__all__ = ["PlanListResponse", "Company", "Invoice", "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 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."""
+
+    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."""
+
+    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/plan_update_params.py

@@ -0,0 +1,95 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .shared.currency import Currency
+from .shared.tax_type import TaxType
+from .shared.visibility import Visibility
+
+__all__ = ["PlanUpdateParams", "CustomField", "Image"]
+
+
+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)
+    """
+
+    renewal_price: Optional[float]
+    """The amount the customer is charged every billing period."""
+
+    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."""
+
+    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 Image(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.
+    """