whop-sdk 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

whop_sdk/types/course_lesson_interaction_completed_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.course_lesson_interaction import CourseLessonInteraction
+
+__all__ = ["CourseLessonInteractionCompletedWebhookEvent"]
+
+
+class CourseLessonInteractionCompletedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: CourseLessonInteraction
+    """A lesson interaction tracking user progress in courses"""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["course_lesson_interaction.completed"]
+    """The webhook event type"""

whop_sdk/types/entry_approved_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.entry import Entry
+
+__all__ = ["EntryApprovedWebhookEvent"]
+
+
+class EntryApprovedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.approved"]
+    """The webhook event type"""

whop_sdk/types/entry_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.entry import Entry
+
+__all__ = ["EntryCreatedWebhookEvent"]
+
+
+class EntryCreatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.created"]
+    """The webhook event type"""

whop_sdk/types/entry_deleted_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.entry import Entry
+
+__all__ = ["EntryDeletedWebhookEvent"]
+
+
+class EntryDeletedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.deleted"]
+    """The webhook event type"""

whop_sdk/types/entry_denied_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.entry import Entry
+
+__all__ = ["EntryDeniedWebhookEvent"]
+
+
+class EntryDeniedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.denied"]
+    """The webhook event type"""

whop_sdk/types/experience_list_response.py

@@ -5,13 +5,28 @@ from datetime import datetime
 
 from .._models import BaseModel
 
-__all__ = ["ExperienceListResponse", "App", "Company"]
+__all__ = ["ExperienceListResponse", "App", "AppIcon", "Company", "Image"]
+
+
+class AppIcon(BaseModel):
+    url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
 
 
 class App(BaseModel):
     id: str
     """The ID of the app"""
 
+    icon: Optional[AppIcon] = None
+    """The icon for the app.
+
+    This icon is shown on discovery, on the product page, on checkout, and as a
+    default icon for the experiences.
+    """
+
     name: str
     """The name of the app"""
 
@@ -27,6 +42,14 @@ class Company(BaseModel):
     """The title of the company."""
 
 
+class Image(BaseModel):
+    url: Optional[str] = None
+    """This is the URL you use to render optimized attachments on the client.
+
+    This should be used for apps.
+    """
+
+
 class ExperienceListResponse(BaseModel):
     id: str
     """The unique ID representing this experience"""
@@ -40,6 +63,9 @@ class ExperienceListResponse(BaseModel):
     created_at: datetime
     """The timestamp of when this experience was created."""
 
+    image: Optional[Image] = None
+    """The logo for the experience."""
+
     name: str
     """The written name of the description."""
 

whop_sdk/types/forum_list_params.py

@@ -0,0 +1,28 @@
+# 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__ = ["ForumListParams"]
+
+
+class ForumListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list forums 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."""
+
+    product_id: Optional[str]
+    """If provided, only forums connected to this product are returned"""

whop_sdk/types/forum_list_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+from .shared.who_can_post_types import WhoCanPostTypes
+from .shared.who_can_comment_types import WhoCanCommentTypes
+from .shared.email_notification_preferences import EmailNotificationPreferences
+
+__all__ = ["ForumListResponse", "Experience"]
+
+
+class Experience(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+    name: str
+    """The written name of the description."""
+
+
+class ForumListResponse(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    email_notification_preference: EmailNotificationPreferences
+    """The email notification preference for this forum"""
+
+    experience: Experience
+    """The experience for this forum"""
+
+    who_can_comment: WhoCanCommentTypes
+    """Who can comment on this forum"""
+
+    who_can_post: WhoCanPostTypes
+    """Who can post on this forum"""

whop_sdk/types/forum_update_params.py

@@ -0,0 +1,23 @@
+# 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.who_can_post_types import WhoCanPostTypes
+from .shared.who_can_comment_types import WhoCanCommentTypes
+from .shared.email_notification_preferences import EmailNotificationPreferences
+
+__all__ = ["ForumUpdateParams"]
+
+
+class ForumUpdateParams(TypedDict, total=False):
+    email_notification_preference: Optional[EmailNotificationPreferences]
+    """Email notification preference option for a forum feed"""
+
+    who_can_comment: Optional[WhoCanCommentTypes]
+    """Who can comment on a forum feed"""
+
+    who_can_post: Optional[WhoCanPostTypes]
+    """Who can post on a forum feed"""

whop_sdk/types/invoice_create_params.py

@@ -108,7 +108,11 @@ class Plan(TypedDict, total=False):
     """The interval at which the plan charges (expiration plans)."""
 
     initial_price: Optional[float]
-    """An additional amount charged upon first purchase."""
+    """An additional amount charged upon first purchase.
+
+    Use only if a one time payment OR you want to charge an additional amount on top
+    of the renewal price. Provided as a number in dollars. Eg: 10.43 for $10.43
+    """
 
     internal_notes: Optional[str]
     """A personal description or notes section for the business."""
@@ -120,7 +124,11 @@ class Plan(TypedDict, total=False):
     """The methods of how a plan can be released."""
 
     renewal_price: Optional[float]
-    """The amount the customer is charged every billing period."""
+    """The amount the customer is charged every billing period.
+
+    Use only if a recurring payment. Provided as a number in dollars. Eg: 10.43 for
+    $10.43
+    """
 
     trial_period_days: Optional[int]
     """The number of free trial days added before a renewal plan."""

whop_sdk/types/member_list_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 List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .shared.direction import Direction
+from .shared.access_level import AccessLevel
+from .shared.member_statuses import MemberStatuses
+from .shared.member_most_recent_actions import MemberMostRecentActions
+
+__all__ = ["MemberListParams"]
+
+
+class MemberListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list members for"""
+
+    access_level: Optional[AccessLevel]
+    """The access level a given user (or company) has to an access pass or company."""
+
+    access_pass_ids: Optional[SequenceNotStr[str]]
+    """The access pass IDs to filter the members 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."""
+
+    most_recent_actions: Optional[List[MemberMostRecentActions]]
+    """The most recent actions to filter the members by"""
+
+    order: Optional[Literal["id", "usd_total_spent", "created_at", "joined_at", "most_recent_action"]]
+    """Which columns can be used to sort."""
+
+    plan_ids: Optional[SequenceNotStr[str]]
+    """The plan IDs to filter the members by"""
+
+    promo_code_ids: Optional[SequenceNotStr[str]]
+    """The promo code IDs to filter the members by"""
+
+    query: Optional[str]
+    """The name, username, or email to filter the members by.
+
+    The email filter will only apply if the current actor has the
+    `member:email:read` permission.
+    """
+
+    statuses: Optional[List[MemberStatuses]]
+    """The statuses to filter the members by"""

whop_sdk/types/member_list_response.py

@@ -0,0 +1,65 @@
+# 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.access_level import AccessLevel
+from .shared.member_statuses import MemberStatuses
+from .shared.member_most_recent_actions import MemberMostRecentActions
+
+__all__ = ["MemberListResponse", "User"]
+
+
+class User(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 MemberListResponse(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    access_level: AccessLevel
+    """The access level of the product member.
+
+    If its admin, the member is an authorized user of the access pass. If its
+    customer, the member has a valid membership to the access pass. If its
+    no_access, the member does not have access to the access pass.
+    """
+
+    created_at: datetime
+    """When the member was created"""
+
+    joined_at: datetime
+    """When the member joined the company"""
+
+    most_recent_action: Optional[MemberMostRecentActions] = None
+    """The different most recent actions a member can have."""
+
+    most_recent_action_at: Optional[datetime] = None
+    """The time for the most recent action, if applicable."""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+    status: MemberStatuses
+    """The status of the member"""
+
+    updated_at: datetime
+    """The timestamp of when this member was last updated"""
+
+    usd_total_spent: float
+    """How much money this customer has spent on the company's products and plans"""
+
+    user: Optional[User] = None
+    """The user for this member, if any."""

whop_sdk/types/member_retrieve_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 .shared.access_level import AccessLevel
+from .shared.member_statuses import MemberStatuses
+from .shared.member_most_recent_actions import MemberMostRecentActions
+
+__all__ = ["MemberRetrieveResponse", "Company", "User"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID of the company"""
+
+    route: str
+    """The slug/route of the company on the Whop site."""
+
+    title: str
+    """The written name of the company."""
+
+
+class User(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 MemberRetrieveResponse(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    access_level: AccessLevel
+    """The access level of the product member.
+
+    If its admin, the member is an authorized user of the access pass. If its
+    customer, the member has a valid membership to the access pass. If its
+    no_access, the member does not have access to the access pass.
+    """
+
+    company: Company
+    """The company for the member."""
+
+    created_at: datetime
+    """When the member was created"""
+
+    joined_at: datetime
+    """When the member joined the company"""
+
+    most_recent_action: Optional[MemberMostRecentActions] = None
+    """The different most recent actions a member can have."""
+
+    most_recent_action_at: Optional[datetime] = None
+    """The time for the most recent action, if applicable."""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+    status: MemberStatuses
+    """The status of the member"""
+
+    updated_at: datetime
+    """The timestamp of when this member was last updated"""
+
+    usd_total_spent: float
+    """How much money this customer has spent on the company's products and plans"""
+
+    user: Optional[User] = None
+    """The user for this member, if any."""

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_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/payment_failed_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.payment import Payment
+
+__all__ = ["PaymentFailedWebhookEvent"]
+
+
+class PaymentFailedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Payment
+    """An object representing a receipt for a membership."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["payment.failed"]
+    """The webhook event type"""

whop_sdk/types/payment_pending_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.payment import Payment
+
+__all__ = ["PaymentPendingWebhookEvent"]
+
+
+class PaymentPendingWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Payment
+    """An object representing a receipt for a membership."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["payment.pending"]
+    """The webhook event type"""

whop_sdk/types/payment_succeeded_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.payment import Payment
+
+__all__ = ["PaymentSucceededWebhookEvent"]
+
+
+class PaymentSucceededWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Payment
+    """An object representing a receipt for a membership."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["payment.succeeded"]
+    """The webhook event type"""