whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/product_create_params.py

@@ -0,0 +1,147 @@
+# 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 .._types import SequenceNotStr
+from .shared.currency import Currency
+from .shared.plan_type import PlanType
+from .shared.custom_cta import CustomCta
+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.global_affiliate_status import GlobalAffiliateStatus
+
+__all__ = ["ProductCreateParams", "PlanOptions", "PlanOptionsCustomField", "ProductHighlight"]
+
+
+class ProductCreateParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to create the product for."""
+
+    title: Required[str]
+    """The title of the product."""
+
+    business_type: Optional[BusinessTypes]
+    """The different business types a company can be."""
+
+    collect_shipping_address: Optional[bool]
+    """Whether or not to collect shipping information at checkout from the customer."""
+
+    custom_cta: Optional[CustomCta]
+    """The different types of custom CTAs that can be selected."""
+
+    custom_cta_url: Optional[str]
+    """The custom call to action URL for the product."""
+
+    custom_statement_descriptor: Optional[str]
+    """The custom statement descriptor for the product i.e.
+
+    WHOP\\**SPORTS, must be between 5 and 22 characters, contain at least one letter,
+    and not contain any of the following characters: <, >, \\,, ', "
+    """
+
+    description: Optional[str]
+    """A written description of the product."""
+
+    experience_ids: Optional[SequenceNotStr[str]]
+    """An array of experience IDs that this pass has"""
+
+    global_affiliate_percentage: Optional[float]
+    """The percentage of the revenue that goes to the global affiliate program."""
+
+    global_affiliate_status: Optional[GlobalAffiliateStatus]
+    """The different statuses of the global affiliate program for a product."""
+
+    headline: Optional[str]
+    """The headline of the product."""
+
+    industry_type: Optional[IndustryTypes]
+    """The different industry types a company can be in."""
+
+    member_affiliate_percentage: Optional[float]
+    """The percentage of the revenue that goes to the member affiliate program."""
+
+    member_affiliate_status: Optional[GlobalAffiliateStatus]
+    """The different statuses of the global affiliate program for a product."""
+
+    plan_options: Optional[PlanOptions]
+    """The details to assign an autogenerated plan."""
+
+    product_highlights: Optional[Iterable[ProductHighlight]]
+    """The product highlights for the product."""
+
+    product_tax_code_id: Optional[str]
+    """The ID of the product tax code to apply to this product."""
+
+    redirect_purchase_url: Optional[str]
+    """The URL to redirect the customer to after a purchase."""
+
+    route: Optional[str]
+    """The route of the product."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+class PlanOptionsCustomField(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 PlanOptions(TypedDict, total=False):
+    base_currency: Optional[Currency]
+    """The available currencies on the platform"""
+
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    custom_fields: Optional[Iterable[PlanOptionsCustomField]]
+    """An array of custom field objects."""
+
+    initial_price: Optional[float]
+    """An additional amount charged upon first purchase."""
+
+    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."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+class ProductHighlight(TypedDict, total=False):
+    content: Required[str]
+    """
+    Text to display to describe the product highlight (max length 250 for
+    qualification or benefits, 170 for who this is for, 140 for pricing features).
+    """
+
+    highlight_type: Required[Literal["qualification", "benefit", "who_this_is_for", "pricing_feature"]]
+    """The type of this highlight."""
+
+    title: Optional[str]
+    """The title of the product highlight, if applicable."""

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

whop_sdk/types/product_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, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .shared.direction import Direction
+from .shared.access_pass_type import AccessPassType
+from .shared.visibility_filter import VisibilityFilter
+
+__all__ = ["ProductListParams"]
+
+
+class ProductListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to filter products by"""
+
+    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["active_memberships_count", "created_at", "usd_gmv", "usd_gmv_30_days"]]
+    """The ways a relation of AccessPasses can be ordered"""
+
+    product_types: Optional[List[AccessPassType]]
+    """The type of products to filter by"""
+
+    visibilities: Optional[List[VisibilityFilter]]
+    """The visibility of the products to filter by"""

whop_sdk/types/product_update_params.py

@@ -0,0 +1,82 @@
+# 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
+
+from .shared.custom_cta import CustomCta
+from .shared.visibility import Visibility
+from .shared.business_types import BusinessTypes
+from .shared.industry_types import IndustryTypes
+from .shared.global_affiliate_status import GlobalAffiliateStatus
+
+__all__ = ["ProductUpdateParams", "StorePageConfig"]
+
+
+class ProductUpdateParams(TypedDict, total=False):
+    business_type: Optional[BusinessTypes]
+    """The different business types a company can be."""
+
+    collect_shipping_address: Optional[bool]
+    """Whether or not to collect shipping information at checkout from the customer."""
+
+    custom_cta: Optional[CustomCta]
+    """The different types of custom CTAs that can be selected."""
+
+    custom_cta_url: Optional[str]
+    """The custom call to action URL for the product."""
+
+    custom_statement_descriptor: Optional[str]
+    """The custom statement descriptor for the product i.e.
+
+    WHOP\\**SPORTS, must be between 5 and 22 characters, contain at least one letter,
+    and not contain any of the following characters: <, >, \\,, ', "
+    """
+
+    description: Optional[str]
+    """A written description of the product."""
+
+    global_affiliate_percentage: Optional[float]
+    """The percentage of the revenue that goes to the global affiliate program."""
+
+    global_affiliate_status: Optional[GlobalAffiliateStatus]
+    """The different statuses of the global affiliate program for a product."""
+
+    headline: Optional[str]
+    """The headline of the product."""
+
+    industry_type: Optional[IndustryTypes]
+    """The different industry types a company can be in."""
+
+    member_affiliate_percentage: Optional[float]
+    """The percentage of the revenue that goes to the member affiliate program."""
+
+    member_affiliate_status: Optional[GlobalAffiliateStatus]
+    """The different statuses of the global affiliate program for a product."""
+
+    product_tax_code_id: Optional[str]
+    """The ID of the product tax code to apply to this product."""
+
+    redirect_purchase_url: Optional[str]
+    """The URL to redirect the customer to after a purchase."""
+
+    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."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+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 product this promo code applies to"""
+
+    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,45 @@
+# 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 .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."""
+
+    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"""
+
+    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"""

whop_sdk/types/promo_code_list_response.py

@@ -0,0 +1,79 @@
+# 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__ = ["PromoCodeListResponse", "Product"]
+
+
+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 PromoCodeListResponse(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."""
+
+    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 product this promo code applies to"""
+
+    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_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__ = ["PromoCodeStatus"]
+
+PromoCodeStatus: TypeAlias = Literal["active", "inactive", "archived"]

whop_sdk/types/promo_duration.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__ = ["PromoDuration"]
+
+PromoDuration: TypeAlias = Literal["forever", "once", "repeating"]

whop_sdk/types/reaction_create_params.py

@@ -0,0 +1,19 @@
+# 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
+
+__all__ = ["ReactionCreateParams"]
+
+
+class ReactionCreateParams(TypedDict, total=False):
+    resource_id: Required[str]
+    """The ID of the post or message to react to."""
+
+    emoji: Optional[str]
+    """The emoji to react with (e.g., :heart: or '😀').
+
+    It will be ignored in forums, as everything will be :heart:
+    """

whop_sdk/types/reaction_list_params.py

@@ -0,0 +1,25 @@
+# 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
+
+__all__ = ["ReactionListParams"]
+
+
+class ReactionListParams(TypedDict, total=False):
+    resource_id: Required[str]
+    """The ID of the post or message to list reactions 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."""

whop_sdk/types/reaction_list_response.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__ = ["ReactionListResponse", "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 ReactionListResponse(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"""