whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/membership_activated_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 .shared.membership import Membership
+
+__all__ = ["MembershipActivatedWebhookEvent"]
+
+
+class MembershipActivatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Membership
+    """
+    A membership represents a purchase between a User and a Company for a specific
+    Product.
+    """
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["membership.activated"]
+    """The webhook event type"""

whop_sdk/types/membership_cancel_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 Literal, TypedDict
+
+__all__ = ["MembershipCancelParams"]
+
+
+class MembershipCancelParams(TypedDict, total=False):
+    cancellation_mode: Optional[Literal["at_period_end", "immediate"]]
+    """The mode of cancellation for a membership"""

whop_sdk/types/membership_deactivated_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 .shared.membership import Membership
+
+__all__ = ["MembershipDeactivatedWebhookEvent"]
+
+
+class MembershipDeactivatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Membership
+    """
+    A membership represents a purchase between a User and a Company for a specific
+    Product.
+    """
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["membership.deactivated"]
+    """The webhook event type"""

whop_sdk/types/membership_list_params.py

@@ -0,0 +1,73 @@
+# 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, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .shared.direction import Direction
+from .shared.membership_status import MembershipStatus
+
+__all__ = ["MembershipListParams"]
+
+
+class MembershipListParams(TypedDict, total=False):
+    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."""
+
+    cancel_options: Optional[
+        List[
+            Literal[
+                "too_expensive",
+                "switching",
+                "missing_features",
+                "technical_issues",
+                "bad_experience",
+                "other",
+                "testing",
+            ]
+        ]
+    ]
+    """The cancel options to filter the memberships by"""
+
+    company_id: Optional[str]
+    """The ID of the company to list memberships for"""
+
+    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["id", "created_at", "status", "canceled_at", "date_joined", "total_spend"]]
+    """Which columns can be used to sort."""
+
+    plan_ids: Optional[SequenceNotStr[str]]
+    """The plan IDs to filter the memberships by"""
+
+    product_ids: Optional[SequenceNotStr[str]]
+    """The product IDs to filter the memberships by"""
+
+    promo_code_ids: Optional[SequenceNotStr[str]]
+    """The promo code IDs to filter the memberships by"""
+
+    statuses: Optional[List[MembershipStatus]]
+    """The membership status to filter the memberships by"""
+
+    user_ids: Optional[SequenceNotStr[str]]
+    """Only return memberships from these whop user ids"""

whop_sdk/types/membership_list_response.py

@@ -0,0 +1,128 @@
+# 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 .shared.currency import Currency
+from .shared.membership_status import MembershipStatus
+
+__all__ = ["MembershipListResponse", "Company", "Member", "Plan", "Product", "PromoCode", "User"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    title: str
+    """The title of the company."""
+
+
+class Member(BaseModel):
+    id: str
+    """The ID of the member"""
+
+
+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 PromoCode(BaseModel):
+    id: str
+    """The ID of the promo."""
+
+
+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 MembershipListResponse(BaseModel):
+    id: str
+    """The ID of the membership"""
+
+    cancel_at_period_end: bool
+    """Whether this Membership is set to cancel at the end of the current billing
+    cycle.
+
+    Only applies for memberships that have a renewal plan.
+    """
+
+    canceled_at: Optional[datetime] = None
+    """The epoch timestamp of when the customer initiated a cancellation."""
+
+    cancellation_reason: Optional[str] = None
+    """The reason that the member canceled the membership (filled out by the member)."""
+
+    company: Company
+    """The Company this Membership belongs to."""
+
+    created_at: datetime
+    """The timestamp, in seconds, that this Membership was created at."""
+
+    currency: Optional[Currency] = None
+    """The available currencies on the platform"""
+
+    license_key: Optional[str] = None
+    """The license key for this Membership.
+
+    This is only present if the membership grants access to an instance of the Whop
+    Software app.
+    """
+
+    manage_url: Optional[str] = None
+    """The URL for the customer to manage their membership."""
+
+    member: Optional[Member] = None
+    """The Member that this Membership belongs to."""
+
+    metadata: Dict[str, object]
+    """A JSON object used to store software licensing information. Ex. HWID"""
+
+    payment_collection_paused: bool
+    """Whether the membership's payments are currently paused."""
+
+    plan: Plan
+    """The Plan this Membership is for."""
+
+    product: Product
+    """The Product this Membership grants access to."""
+
+    promo_code: Optional[PromoCode] = None
+    """The Promo Code that is currently applied to this Membership."""
+
+    renewal_period_end: Optional[datetime] = None
+    """
+    The timestamp in seconds at which the current billing cycle for this
+    subscription ends. Only applies for memberships that have a renewal plan.
+    """
+
+    renewal_period_start: Optional[datetime] = None
+    """
+    The timestamp in seconds at which the current billing cycle for this
+    subscription start. Only applies for memberships that have a renewal plan.
+    """
+
+    status: MembershipStatus
+    """The status of the membership."""
+
+    updated_at: datetime
+    """A timestamp of when the membership was last updated"""
+
+    user: Optional[User] = None
+    """The user this membership belongs to"""

whop_sdk/types/membership_pause_params.py

@@ -0,0 +1,16 @@
+# 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__ = ["MembershipPauseParams"]
+
+
+class MembershipPauseParams(TypedDict, total=False):
+    void_payments: Optional[bool]
+    """
+    Whether to void past_due payments associated with the membership to prevent
+    future payment attempts.
+    """

whop_sdk/types/membership_update_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 Dict, Optional
+from typing_extensions import TypedDict
+
+__all__ = ["MembershipUpdateParams"]
+
+
+class MembershipUpdateParams(TypedDict, total=False):
+    metadata: Optional[Dict[str, object]]
+    """The metadata to update the membership with."""

whop_sdk/types/message_create_params.py

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+__all__ = [
+    "MessageCreateParams",
+    "Attachment",
+    "AttachmentAttachmentInputWithDirectUploadID",
+    "AttachmentAttachmentInputWithID",
+    "Poll",
+    "PollOption",
+]
+
+
+class MessageCreateParams(TypedDict, total=False):
+    channel_id: Required[str]
+    """The ID of the channel or experience to send to."""
+
+    content: Required[str]
+    """The content of the message in Markdown format."""
+
+    attachments: Optional[Iterable[Attachment]]
+    """The attachments for this message, such as videos or images."""
+
+    poll: Optional[Poll]
+    """The poll for this message"""
+
+
+class AttachmentAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[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 AttachmentAttachmentInputWithID(TypedDict, total=False):
+    id: Required[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.
+    """
+
+
+Attachment: TypeAlias = Union[AttachmentAttachmentInputWithDirectUploadID, AttachmentAttachmentInputWithID]
+
+
+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/message_list_params.py

@@ -0,0 +1,30 @@
+# 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
+
+from .shared.direction import Direction
+
+__all__ = ["MessageListParams"]
+
+
+class MessageListParams(TypedDict, total=False):
+    channel_id: Required[str]
+    """The ID of the channel or the experience ID to list messages 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."""
+
+    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/message_list_response.py

@@ -0,0 +1,90 @@
+# 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 .shared.dms_post_types import DmsPostTypes
+
+__all__ = ["MessageListResponse", "Poll", "PollOption", "PollVote", "ReactionCount", "User"]
+
+
+class PollOption(BaseModel):
+    id: str
+    """The ID of the poll option"""
+
+    text: str
+    """The text of the poll option"""
+
+
+class Poll(BaseModel):
+    options: Optional[List[PollOption]] = None
+    """The options for the poll"""
+
+
+class PollVote(BaseModel):
+    count: int
+    """The number of users who reacted"""
+
+    option_id: Optional[str] = None
+    """The reaction that was used"""
+
+
+class ReactionCount(BaseModel):
+    count: int
+    """The number of users who reacted"""
+
+    emoji: Optional[str] = None
+    """The emoji that was used in shortcode format (:heart:)"""
+
+
+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 MessageListResponse(BaseModel):
+    id: str
+    """The unique identifier of the resource."""
+
+    content: Optional[str] = None
+    """The content of the message in Markdown format"""
+
+    created_at: datetime
+    """The timestamp when the post was created"""
+
+    is_edited: bool
+    """Whether the message has been edited"""
+
+    is_pinned: bool
+    """Whether this message is pinned"""
+
+    message_type: DmsPostTypes
+    """The type of post"""
+
+    poll: Optional[Poll] = None
+    """The poll for this message"""
+
+    poll_votes: List[PollVote]
+    """The reaction counts for this message"""
+
+    reaction_counts: List[ReactionCount]
+    """The reaction counts for this message"""
+
+    replying_to_message_id: Optional[str] = None
+    """The ID of the message this is replying to, if applicable"""
+
+    updated_at: datetime
+    """The timestamp when the post was last updated"""
+
+    user: User
+    """The user who sent this message"""
+
+    view_count: Optional[int] = None
+    """The number of times this message has been viewed"""

whop_sdk/types/message_update_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, Iterable, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+__all__ = [
+    "MessageUpdateParams",
+    "Attachment",
+    "AttachmentAttachmentInputWithDirectUploadID",
+    "AttachmentAttachmentInputWithID",
+]
+
+
+class MessageUpdateParams(TypedDict, total=False):
+    attachments: Optional[Iterable[Attachment]]
+    """The attachments for this message"""
+
+    content: Optional[str]
+    """The content of the message in Markdown format"""
+
+    is_pinned: Optional[bool]
+    """Whether this message is pinned"""
+
+
+class AttachmentAttachmentInputWithDirectUploadID(TypedDict, total=False):
+    direct_upload_id: Required[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 AttachmentAttachmentInputWithID(TypedDict, total=False):
+    id: Required[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.
+    """
+
+
+Attachment: TypeAlias = Union[AttachmentAttachmentInputWithDirectUploadID, AttachmentAttachmentInputWithID]

whop_sdk/types/notification_create_params.py

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = [
+    "NotificationCreateParams",
+    "SendNotificationV2InputWithCompanyID",
+    "SendNotificationV2InputWithExperienceID",
+]
+
+
+class SendNotificationV2InputWithCompanyID(TypedDict, total=False):
+    company_id: Required[str]
+    """The id of the company to target.
+
+    Only team members of this company will receive the notification. When clicked
+    will take the user to your dashboard app view.
+    """
+
+    content: Required[str]
+    """The content of the notification"""
+
+    title: Required[str]
+    """The title of the notification"""
+
+    icon_user_id: Optional[str]
+    """
+    Optional: ID of a Whop user whose profile picture will be used as the
+    notification icon. If not provided, defaults to the experience or company
+    avatar.
+    """
+
+    rest_path: Optional[str]
+    """The rest path to append to the generated deep link that opens your app.
+
+    Use [restPath] in your app path in the dashboard to read this parameter.
+    """
+
+    subtitle: Optional[str]
+    """The subtitle of the notification"""
+
+    user_ids: Optional[SequenceNotStr[str]]
+    """
+    If provided, this will only send to these users if they are also in the main
+    scope (experience or company)
+    """
+
+
+class SendNotificationV2InputWithExperienceID(TypedDict, total=False):
+    content: Required[str]
+    """The content of the notification"""
+
+    experience_id: Required[str]
+    """The id of the experience to target.
+
+    All users with access to this experience (customers and admins) will receive the
+    notification. When clicked, open your experience view.
+    """
+
+    title: Required[str]
+    """The title of the notification"""
+
+    icon_user_id: Optional[str]
+    """
+    Optional: ID of a Whop user whose profile picture will be used as the
+    notification icon. If not provided, defaults to the experience or company
+    avatar.
+    """
+
+    rest_path: Optional[str]
+    """The rest path to append to the generated deep link that opens your app.
+
+    Use [restPath] in your app path in the dashboard to read this parameter.
+    """
+
+    subtitle: Optional[str]
+    """The subtitle of the notification"""
+
+    user_ids: Optional[SequenceNotStr[str]]
+    """
+    If provided, this will only send to these users if they are also in the main
+    scope (experience or company)
+    """
+
+
+NotificationCreateParams: TypeAlias = Union[
+    SendNotificationV2InputWithCompanyID, SendNotificationV2InputWithExperienceID
+]

whop_sdk/types/notification_create_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["NotificationCreateResponse"]
+
+
+class NotificationCreateResponse(BaseModel):
+    success: bool
+    """Whether the notification was successfully queued for delivery"""