whop-sdk 0.0.1__py3-none-any.whl

whop_sdk/types/entry_list_response.py

@@ -0,0 +1,56 @@
+# 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.entry_status import EntryStatus
+
+__all__ = ["EntryListResponse", "Plan", "Product", "User"]
+
+
+class Plan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+
+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."""
+
+    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 EntryListResponse(BaseModel):
+    id: str
+    """The internal ID of the entry."""
+
+    created_at: Optional[datetime] = None
+    """When the entry was created."""
+
+    plan: Optional[Plan] = None
+    """The waitlist plan the entry if for."""
+
+    product: Optional[Product] = None
+    """The access pass tied to this entry, if there is one."""
+
+    status: EntryStatus
+    """The status of the entry."""
+
+    user: User
+    """The user who created the entry."""

whop_sdk/types/experience_attach_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__ = ["ExperienceAttachParams"]
+
+
+class ExperienceAttachParams(TypedDict, total=False):
+    product_id: Required[str]
+    """The ID of the Access Pass to add the Experience to."""

whop_sdk/types/experience_create_params.py

@@ -0,0 +1,22 @@
+# 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__ = ["ExperienceCreateParams"]
+
+
+class ExperienceCreateParams(TypedDict, total=False):
+    app_id: Required[str]
+    """The ID of the app to create the experience for"""
+
+    company_id: Required[str]
+    """The ID of the company to create the experience for"""
+
+    name: Optional[str]
+    """The name of the experience"""
+
+    section_id: Optional[str]
+    """The ID of the section to create the experience in"""

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

whop_sdk/types/experience_detach_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__ = ["ExperienceDetachParams"]
+
+
+class ExperienceDetachParams(TypedDict, total=False):
+    product_id: Required[str]
+    """The ID of the Access Pass to add the Experience to."""

whop_sdk/types/experience_list_params.py

@@ -0,0 +1,31 @@
+# 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__ = ["ExperienceListParams"]
+
+
+class ExperienceListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to filter experiences by"""
+
+    after: Optional[str]
+    """Returns the elements in the list that come after the specified cursor."""
+
+    app_id: Optional[str]
+    """The ID of the app to filter experiences by"""
+
+    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."""
+
+    product_id: Optional[str]
+    """The ID of the product to filter experiences by"""

whop_sdk/types/experience_list_response.py

@@ -0,0 +1,47 @@
+# 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
+
+__all__ = ["ExperienceListResponse", "App", "Company"]
+
+
+class App(BaseModel):
+    id: str
+    """The ID of the app"""
+
+    name: str
+    """The name of the app"""
+
+
+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 ExperienceListResponse(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+    app: App
+    """The experience interface for this experience."""
+
+    company: Company
+    """The company that owns this experience."""
+
+    created_at: datetime
+    """The timestamp of when this experience was created."""
+
+    name: str
+    """The written name of the description."""
+
+    order: Optional[str] = None
+    """The order of the experience in the section"""

whop_sdk/types/experience_update_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 Optional
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["ExperienceUpdateParams", "Logo"]
+
+
+class ExperienceUpdateParams(TypedDict, total=False):
+    access_level: Optional[Literal["public", "private"]]
+    """The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE)."""
+
+    logo: Optional[Logo]
+    """The logo for the experience"""
+
+    name: Optional[str]
+    """The name of the experience."""
+
+    order: Optional[str]
+    """The order of the experience in the section."""
+
+    section_id: Optional[str]
+    """The ID of the section to update."""
+
+
+class Logo(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/forum_post_create_params.py

@@ -0,0 +1,85 @@
+# 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 Required, TypedDict
+
+from .shared.currency import Currency
+
+__all__ = ["ForumPostCreateParams", "Attachment", "Poll", "PollOption"]
+
+
+class ForumPostCreateParams(TypedDict, total=False):
+    experience_id: Required[str]
+    """The experience to create this post in"""
+
+    attachments: Optional[Iterable[Attachment]]
+    """The attachments for this post"""
+
+    content: Optional[str]
+    """This is the main body of the post in Markdown format.
+
+    Hidden if paywalled and user hasn't purchased access to it.
+    """
+
+    is_mention: Optional[bool]
+    """
+    This is used to determine if the post should be sent as a 'mention' notification
+    to all of the users who are in the experience. This means that anyone with
+    'mentions' enabled will receive a notification about this post.
+    """
+
+    parent_id: Optional[str]
+    """The ID of the parent post.
+
+    Set it to the ID of the post you want to comment on or don't include it if its a
+    top level post.
+    """
+
+    paywall_amount: Optional[float]
+    """The amount to paywall this post by.
+
+    A paywalled post requires the user to purchase it in order to view its content.
+    """
+
+    paywall_currency: Optional[Currency]
+    """The available currencies on the platform"""
+
+    pinned: Optional[bool]
+    """Whether the post should be pinned"""
+
+    poll: Optional[Poll]
+    """The poll for this post"""
+
+    title: Optional[str]
+    """The title of the post. Only visible if paywalled."""
+
+
+class Attachment(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 PollOption(TypedDict, total=False):
+    id: Required[str]
+    """Sequential ID for the poll option (starting from '1')"""
+
+    text: Required[str]
+    """The text of the poll option"""
+
+
+class Poll(TypedDict, total=False):
+    options: Required[Iterable[PollOption]]
+    """The options for the poll. Must have sequential IDs starting from 1"""

whop_sdk/types/forum_post_list_params.py

@@ -0,0 +1,31 @@
+# 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__ = ["ForumPostListParams"]
+
+
+class ForumPostListParams(TypedDict, total=False):
+    experience_id: Required[str]
+    """The ID of the experience to list forum posts 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."""
+
+    parent_id: Optional[str]
+    """The ID of the parent post to list forum post comments for"""
+
+    pinned: Optional[bool]
+    """Set to true to only return pinned posts"""

whop_sdk/types/forum_post_list_response.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["ForumPostListResponse", "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 ForumPostListResponse(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    comment_count: int
+    """The amount of comments on this post"""
+
+    content: Optional[str] = None
+    """The content of the forum post in Markdown format"""
+
+    is_edited: bool
+    """Whether the forum post has been edited"""
+
+    is_pinned: bool
+    """Whether this forum post is pinned"""
+
+    is_poster_admin: bool
+    """Whether the user that sent the post is an admin of the company"""
+
+    like_count: Optional[int] = None
+    """The number of likes this post has received"""
+
+    parent_id: Optional[str] = None
+    """The ID of the parent forum post, if applicable"""
+
+    title: Optional[str] = None
+    """The title of the forum post"""
+
+    user: User
+    """The user who created this forum post"""
+
+    view_count: Optional[int] = None
+    """The number of times this message has been viewed"""

whop_sdk/types/invoice_create_params.py

@@ -0,0 +1,137 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .shared.release_method import ReleaseMethod
+from .shared.collection_method import CollectionMethod
+
+__all__ = ["InvoiceCreateParams", "Plan", "PlanCustomField", "Product"]
+
+
+class InvoiceCreateParams(TypedDict, total=False):
+    collection_method: Required[CollectionMethod]
+    """The method of collection for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+    company_id: Required[str]
+    """The company ID to create this invoice for."""
+
+    due_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """The date the invoice is due, if applicable."""
+
+    plan: Required[Plan]
+    """The properties of the plan to create for this invoice."""
+
+    charge_buyer_fee: Optional[bool]
+    """Whether or not to charge the customer a buyer fee."""
+
+    customer_name: Optional[str]
+    """The name of the customer to create this invoice for.
+
+    This is required if you want to create an invoice for a customer who does not
+    have a member of your company yet.
+    """
+
+    email_address: Optional[str]
+    """The email address to create this invoice for.
+
+    This is required if you want to create an invoice for a user who does not have a
+    member of your company yet.
+    """
+
+    member_id: Optional[str]
+    """The member ID to create this invoice for.
+
+    Include this if you want to create an invoice for an existing member. If you do
+    not have a member ID, you must provide an email_address and customer_name.
+    """
+
+    payment_token_id: Optional[str]
+    """The payment token ID to use for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+    product: Optional[Product]
+    """The properties of the product to create for this invoice.
+
+    Include this if you want to create an invoice for a new product.
+    """
+
+    product_id: Optional[str]
+    """The product ID to create this invoice for.
+
+    Include this if you want to create an invoice for an existing product.
+    """
+
+
+class PlanCustomField(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 Plan(TypedDict, total=False):
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    custom_fields: Optional[Iterable[PlanCustomField]]
+    """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)."""
+
+    initial_price: Optional[float]
+    """An additional amount charged upon first purchase."""
+
+    internal_notes: Optional[str]
+    """A personal description or notes section for the business."""
+
+    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."""
+
+    trial_period_days: Optional[int]
+    """The number of free trial days added before a renewal plan."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+class Product(TypedDict, total=False):
+    title: Required[str]
+    """The title of the product."""
+
+    product_tax_code_id: Optional[str]
+    """The ID of the product tax code to apply to this product."""

whop_sdk/types/invoice_create_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .shared.invoice import Invoice
+
+__all__ = ["InvoiceCreateResponse"]
+
+
+class InvoiceCreateResponse(BaseModel):
+    checkout_job_id: Optional[str] = None
+    """The ID of the checkout job that was created for this invoice."""
+
+    invoice: Invoice
+    """The invoice that was created for this invoice."""

whop_sdk/types/invoice_created_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.invoice import Invoice
+
+__all__ = ["InvoiceCreatedWebhookEvent"]
+
+
+class InvoiceCreatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Invoice
+    """A statement that defines an amount due by a customer."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["invoice.created"]
+    """The webhook event type"""

whop_sdk/types/invoice_list_params.py

@@ -0,0 +1,50 @@
+# 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.invoice_status import InvoiceStatus
+from .shared.collection_method import CollectionMethod
+
+__all__ = ["InvoiceListParams", "Filters"]
+
+
+class InvoiceListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list invoices 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."""
+
+    direction: Optional[Direction]
+    """The direction of the sort."""
+
+    filters: Optional[Filters]
+    """The filters to apply to the invoices"""
+
+    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", "created_at", "due_date"]]
+    """Which columns can be used to sort."""
+
+
+class Filters(TypedDict, total=False):
+    access_pass_ids: Optional[SequenceNotStr[str]]
+    """The access pass IDs to filter the invoices by"""
+
+    collection_methods: Optional[List[CollectionMethod]]
+    """The collection methods to filter the invoices by"""
+
+    statuses: Optional[List[InvoiceStatus]]
+    """The statuses to filter the invoices by"""

whop_sdk/types/invoice_paid_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.invoice import Invoice
+
+__all__ = ["InvoicePaidWebhookEvent"]
+
+
+class InvoicePaidWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Invoice
+    """A statement that defines an amount due by a customer."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["invoice.paid"]
+    """The webhook event type"""