whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/review_retrieve_response.py

@@ -0,0 +1,103 @@
+# 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 .review_status import ReviewStatus
+
+__all__ = ["ReviewRetrieveResponse", "Attachment", "Company", "Product", "User"]
+
+
+class Attachment(BaseModel):
+    id: str
+    """The ID of the attachment"""
+
+    content_type: Optional[str] = None
+    """The attachment's content type (e.g., image/jpg, video/mp4)"""
+
+    filename: Optional[str] = None
+    """The name of the file"""
+
+    url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    route: str
+    """The slug/route of the company on the Whop site."""
+
+    title: str
+    """The title 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 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 ReviewRetrieveResponse(BaseModel):
+    id: str
+    """The internal ID of the review."""
+
+    attachments: List[Attachment]
+    """The attachments attached to the review."""
+
+    company: Company
+    """The company the review is for."""
+
+    created_at: datetime
+    """The timestamp of when the review was created."""
+
+    description: Optional[str] = None
+    """The description of the review."""
+
+    joined_at: Optional[datetime] = None
+    """The timestamp of when the user joined the product."""
+
+    paid_for_product: Optional[bool] = None
+    """Whether or not the user paid for the product.
+
+    If null, the payment status is unknown.
+    """
+
+    product: Product
+    """The product the review is for."""
+
+    published_at: Optional[datetime] = None
+    """The timestamp of when the review was published."""
+
+    stars: int
+    """The number of stars the user gave the product."""
+
+    status: ReviewStatus
+    """The status of the review."""
+
+    title: Optional[str] = None
+    """The title of the review."""
+
+    updated_at: datetime
+    """The timestamp of when the review was last updated."""
+
+    user: User
+    """The user account that performed the action."""

whop_sdk/types/review_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__ = ["ReviewStatus"]
+
+ReviewStatus: TypeAlias = Literal["pending", "published", "removed"]

whop_sdk/types/setup_intent.py

@@ -0,0 +1,111 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+from .card_brands import CardBrands
+from .setup_intent_status import SetupIntentStatus
+from .payment_method_types import PaymentMethodTypes
+
+__all__ = [
+    "SetupIntent",
+    "CheckoutConfiguration",
+    "Company",
+    "Member",
+    "MemberUser",
+    "PaymentToken",
+    "PaymentTokenCard",
+]
+
+
+class CheckoutConfiguration(BaseModel):
+    id: str
+    """The ID of the checkout configuration"""
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+
+class MemberUser(BaseModel):
+    id: str
+    """The internal ID of the user account."""
+
+    email: Optional[str] = None
+    """The digital mailing address of the user."""
+
+    name: Optional[str] = None
+    """The user's full name."""
+
+    username: str
+    """The whop username."""
+
+
+class Member(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    user: Optional[MemberUser] = None
+    """The user for this member, if any."""
+
+
+class PaymentTokenCard(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 PaymentToken(BaseModel):
+    id: str
+    """The ID of the payment token"""
+
+    card: Optional[PaymentTokenCard] = 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"""
+
+
+class SetupIntent(BaseModel):
+    id: str
+    """The setup intent ID"""
+
+    checkout_configuration: Optional[CheckoutConfiguration] = None
+    """The checkout configuration associated with the setup intent"""
+
+    company: Optional[Company] = None
+    """The company of the setup intent"""
+
+    created_at: datetime
+    """The datetime the payment was created"""
+
+    error_message: Optional[str] = None
+    """The error message, if any."""
+
+    member: Optional[Member] = None
+    """The member connected to the setup intent"""
+
+    metadata: Optional[Dict[str, object]] = None
+    """The metadata associated with the setup intent"""
+
+    payment_token: Optional[PaymentToken] = None
+    """The payment token created during the setup, if available."""
+
+    status: SetupIntentStatus
+    """The status of the setup intent"""

whop_sdk/types/setup_intent_canceled_webhook_event.py

@@ -0,0 +1,29 @@
+# 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 .setup_intent import SetupIntent
+
+__all__ = ["SetupIntentCanceledWebhookEvent"]
+
+
+class SetupIntentCanceledWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: SetupIntent
+    """
+    An object representing a setup intent, which is a flow for allowing a customer
+    to add a payment method to their account without making a purchase.
+    """
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["setup_intent.canceled"]
+    """The webhook event type"""

whop_sdk/types/setup_intent_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__ = ["SetupIntentListParams"]
+
+
+class SetupIntentListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list setup intents 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/setup_intent_list_response.py

@@ -0,0 +1,111 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+from .card_brands import CardBrands
+from .setup_intent_status import SetupIntentStatus
+from .payment_method_types import PaymentMethodTypes
+
+__all__ = [
+    "SetupIntentListResponse",
+    "CheckoutConfiguration",
+    "Company",
+    "Member",
+    "MemberUser",
+    "PaymentToken",
+    "PaymentTokenCard",
+]
+
+
+class CheckoutConfiguration(BaseModel):
+    id: str
+    """The ID of the checkout configuration"""
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+
+class MemberUser(BaseModel):
+    id: str
+    """The internal ID of the user account."""
+
+    email: Optional[str] = None
+    """The digital mailing address of the user."""
+
+    name: Optional[str] = None
+    """The user's full name."""
+
+    username: str
+    """The whop username."""
+
+
+class Member(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    user: Optional[MemberUser] = None
+    """The user for this member, if any."""
+
+
+class PaymentTokenCard(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 PaymentToken(BaseModel):
+    id: str
+    """The ID of the payment token"""
+
+    card: Optional[PaymentTokenCard] = 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"""
+
+
+class SetupIntentListResponse(BaseModel):
+    id: str
+    """The setup intent ID"""
+
+    checkout_configuration: Optional[CheckoutConfiguration] = None
+    """The checkout configuration associated with the setup intent"""
+
+    company: Optional[Company] = None
+    """The company of the setup intent"""
+
+    created_at: datetime
+    """The datetime the payment was created"""
+
+    error_message: Optional[str] = None
+    """The error message, if any."""
+
+    member: Optional[Member] = None
+    """The member connected to the setup intent"""
+
+    metadata: Optional[Dict[str, object]] = None
+    """The metadata associated with the setup intent"""
+
+    payment_token: Optional[PaymentToken] = None
+    """The payment token created during the setup, if available."""
+
+    status: SetupIntentStatus
+    """The status of the setup intent"""

whop_sdk/types/setup_intent_requires_action_webhook_event.py

@@ -0,0 +1,29 @@
+# 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 .setup_intent import SetupIntent
+
+__all__ = ["SetupIntentRequiresActionWebhookEvent"]
+
+
+class SetupIntentRequiresActionWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: SetupIntent
+    """
+    An object representing a setup intent, which is a flow for allowing a customer
+    to add a payment method to their account without making a purchase.
+    """
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["setup_intent.requires_action"]
+    """The webhook event type"""

whop_sdk/types/setup_intent_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__ = ["SetupIntentStatus"]
+
+SetupIntentStatus: TypeAlias = Literal["processing", "succeeded", "canceled", "requires_action"]

whop_sdk/types/setup_intent_succeeded_webhook_event.py

@@ -0,0 +1,29 @@
+# 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 .setup_intent import SetupIntent
+
+__all__ = ["SetupIntentSucceededWebhookEvent"]
+
+
+class SetupIntentSucceededWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: SetupIntent
+    """
+    An object representing a setup intent, which is a flow for allowing a customer
+    to add a payment method to their account without making a purchase.
+    """
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["setup_intent.succeeded"]
+    """The webhook event type"""

whop_sdk/types/shared/__init__.py

@@ -0,0 +1,62 @@
+# 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 .forum import Forum as Forum
+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 .access_level import AccessLevel as AccessLevel
+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 .member_statuses import MemberStatuses as MemberStatuses
+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 .who_can_post_types import WhoCanPostTypes as WhoCanPostTypes
+from .app_build_platforms import AppBuildPlatforms as AppBuildPlatforms
+from .authorized_user_roles import AuthorizedUserRoles as AuthorizedUserRoles
+from .who_can_comment_types import WhoCanCommentTypes as WhoCanCommentTypes
+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 .member_most_recent_actions import MemberMostRecentActions as MemberMostRecentActions
+from .email_notification_preferences import EmailNotificationPreferences as EmailNotificationPreferences
+from .course_lesson_interaction_list_item import CourseLessonInteractionListItem as CourseLessonInteractionListItem

whop_sdk/types/shared/access_level.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__ = ["AccessLevel"]
+
+AccessLevel: TypeAlias = Literal["no_access", "admin", "customer"]

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