whop-sdk 0.0.1__py3-none-any.whl

whop_sdk/types/product_create_params.py

@@ -0,0 +1,170 @@
+# 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.access_pass_type import AccessPassType
+from .shared.global_affiliate_status import GlobalAffiliateStatus
+
+__all__ = ["ProductCreateParams", "BannerImage", "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."""
+
+    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."""
+
+    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 an access pass."""
+
+    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 an access pass."""
+
+    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 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."""
+
+    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 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."""
+
+    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,41 @@
+# 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 .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."""
+
+    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,90 @@
+# 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", "BannerImage"]
+
+
+class ProductUpdateParams(TypedDict, total=False):
+    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."""
+
+    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 an access pass."""
+
+    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 an access pass."""
+
+    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."""
+
+    title: Optional[str]
+    """The title of the product."""
+
+    visibility: Optional[Visibility]
+    """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.
+    """

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"""

whop_sdk/types/shared/__init__.py

@@ -0,0 +1,55 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .app import App as App
+from .plan import Plan as Plan
+from .entry import Entry as Entry
+from .company import Company as Company
+from .invoice import Invoice as Invoice
+from .message import Message as Message
+from .payment import Payment as Payment
+from .product import Product as Product
+from .currency import Currency as Currency
+from .reaction import Reaction as Reaction
+from .shipment import Shipment as Shipment
+from .tax_type import TaxType as TaxType
+from .transfer import Transfer as Transfer
+from .app_build import AppBuild as AppBuild
+from .direction import Direction as Direction
+from .page_info import PageInfo as PageInfo
+from .plan_type import PlanType as PlanType
+from .custom_cta import CustomCta as CustomCta
+from .experience import Experience as Experience
+from .forum_post import ForumPost as ForumPost
+from .membership import Membership as Membership
+from .promo_type import PromoType as PromoType
+from .visibility import Visibility as Visibility
+from .app_statuses import AppStatuses as AppStatuses
+from .chat_channel import ChatChannel as ChatChannel
+from .entry_status import EntryStatus as EntryStatus
+from .who_can_post import WhoCanPost as WhoCanPost
+from .app_view_type import AppViewType as AppViewType
+from .who_can_react import WhoCanReact as WhoCanReact
+from .business_types import BusinessTypes as BusinessTypes
+from .dms_post_types import DmsPostTypes as DmsPostTypes
+from .industry_types import IndustryTypes as IndustryTypes
+from .invoice_status import InvoiceStatus as InvoiceStatus
+from .receipt_status import ReceiptStatus as ReceiptStatus
+from .release_method import ReleaseMethod as ReleaseMethod
+from .shipment_status import ShipmentStatus as ShipmentStatus
+from .support_channel import SupportChannel as SupportChannel
+from .access_pass_type import AccessPassType as AccessPassType
+from .shipment_carrier import ShipmentCarrier as ShipmentCarrier
+from .collection_method import CollectionMethod as CollectionMethod
+from .invoice_list_item import InvoiceListItem as InvoiceListItem
+from .membership_status import MembershipStatus as MembershipStatus
+from .product_list_item import ProductListItem as ProductListItem
+from .visibility_filter import VisibilityFilter as VisibilityFilter
+from .app_build_statuses import AppBuildStatuses as AppBuildStatuses
+from .shipment_substatus import ShipmentSubstatus as ShipmentSubstatus
+from .app_build_platforms import AppBuildPlatforms as AppBuildPlatforms
+from .authorized_user_roles import AuthorizedUserRoles as AuthorizedUserRoles
+from .checkout_configuration import CheckoutConfiguration as CheckoutConfiguration
+from .friendly_receipt_status import FriendlyReceiptStatus as FriendlyReceiptStatus
+from .global_affiliate_status import GlobalAffiliateStatus as GlobalAffiliateStatus
+from .course_lesson_interaction import CourseLessonInteraction as CourseLessonInteraction
+from .course_lesson_interaction_list_item import CourseLessonInteractionListItem as CourseLessonInteractionListItem

whop_sdk/types/shared/access_pass_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__ = ["AccessPassType"]
+
+AccessPassType: TypeAlias = Literal["regular", "app", "experience_upsell", "api_only"]

whop_sdk/types/shared/app.py

@@ -0,0 +1,159 @@
+# 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 .app_statuses import AppStatuses
+
+__all__ = ["App", "APIKey", "Company", "Creator", "RequestedPermission", "RequestedPermissionPermissionAction", "Stats"]
+
+
+class APIKey(BaseModel):
+    id: str
+    """The ID of this API key"""
+
+    token: str
+    """This is the API key used to authenticate requests"""
+
+    created_at: datetime
+    """When this API key was created at"""
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    title: str
+    """The title of the company."""
+
+
+class Creator(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 RequestedPermissionPermissionAction(BaseModel):
+    action: str
+    """The identifier of the action."""
+
+    name: str
+    """The human readable name of the action."""
+
+
+class RequestedPermission(BaseModel):
+    is_required: bool
+    """Whether the action is required for the app to function."""
+
+    justification: str
+    """The reason for requesting the action."""
+
+    permission_action: RequestedPermissionPermissionAction
+    """The action that the app will request off of users when a user installs the app."""
+
+
+class Stats(BaseModel):
+    dau: int
+    """
+    This is the number of users that have spent time in this app in the last 24
+    hours.
+    """
+
+    mau: int
+    """
+    This is the number of users that have spent time in this app in the last 28
+    days.
+    """
+
+    time_spent_last24_hours: int
+    """
+    This how much time, in seconds, users have spent in this app in the last 24
+    hours.
+    """
+
+    wau: int
+    """
+    This is the number of users that have spent time in this app in the last 7 days.
+    """
+
+
+class App(BaseModel):
+    id: str
+    """The ID of the app"""
+
+    api_key: Optional[APIKey] = None
+    """The API key for the app"""
+
+    base_url: Optional[str] = None
+    """The base url of the app"""
+
+    company: Company
+    """The company that owns the app"""
+
+    creator: Creator
+    """The creator of the app"""
+
+    dashboard_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    description: Optional[str] = None
+    """The description of the app"""
+
+    discover_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    domain_id: str
+    """The unique part of the proxied domain for this app.
+
+    Used to generate the base url used to display the app inside the whop platform.
+    Refers to the id part in the final url: https://{domain_id}.apps.whop.com
+    """
+
+    experience_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    name: str
+    """The name of the app"""
+
+    requested_permissions: List[RequestedPermission]
+    """
+    The set of permissions that an app requests to be granted when a user installs
+    the app.
+    """
+
+    stats: Optional[Stats] = None
+    """A collection of stats for the app."""
+
+    status: AppStatuses
+    """If the status is live, the app is visible on Whop discovery.
+
+    In order to be live, you need to set the name, icon, and description. Being
+    unlisted or hidden means it's not visible on Whop but you can still install the
+    app via direct link. To remove the app from whop discovery, you should set the
+    status to unlisted.
+    """
+
+    verified: bool
+    """Whether this app has been verified by Whop.
+
+    Verified apps are endorsed by whop and are shown in the 'featured apps' section
+    of the app store.
+    """

whop_sdk/types/shared/app_build.py

@@ -0,0 +1,50 @@
+# 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 .app_view_type import AppViewType
+from .app_build_statuses import AppBuildStatuses
+from .app_build_platforms import AppBuildPlatforms
+
+__all__ = ["AppBuild"]
+
+
+class AppBuild(BaseModel):
+    id: str
+    """The ID of the app build. It will look like apbu_xxxxx."""
+
+    checksum: str
+    """
+    This is generated by the client and used to verify the integrity of the file
+    that is submitted. It is a SHA256 hash of the app build file.
+    """
+
+    created_at: datetime
+    """When this app build was created."""
+
+    file_url: str
+    """The URL to download the app build .zip file."""
+
+    is_production: bool
+    """Whether this app build is currently being used in production."""
+
+    platform: AppBuildPlatforms
+    """The platform of the app build (ios, android, web)"""
+
+    review_message: Optional[str] = None
+    """The review message for the app build, if any.
+
+    This is populated when the build is rejected and there is a reason specified by
+    the reviewer.
+    """
+
+    status: AppBuildStatuses
+    """The status of the app build (draft, approved, rejected, pending, etc)"""
+
+    supported_app_view_types: List[AppViewType]
+    """The supported app view types for the app build.
+
+    These are the views that the developer has specified that this build supports.
+    """

whop_sdk/types/shared/app_build_platforms.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__ = ["AppBuildPlatforms"]
+
+AppBuildPlatforms: TypeAlias = Literal["ios", "android", "web"]

whop_sdk/types/shared/app_build_statuses.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__ = ["AppBuildStatuses"]
+
+AppBuildStatuses: TypeAlias = Literal["draft", "pending", "approved", "rejected"]