whop-sdk 0.0.10__py3-none-any.whl

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

whop_sdk/types/invoice_past_due_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__ = ["InvoicePastDueWebhookEvent"]
+
+
+class InvoicePastDueWebhookEvent(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.past_due"]
+    """The webhook event type"""

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

whop_sdk/types/invoice_voided_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__ = ["InvoiceVoidedWebhookEvent"]
+
+
+class InvoiceVoidedWebhookEvent(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.voided"]
+    """The webhook event type"""

whop_sdk/types/languages.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["Languages"]
+
+Languages: TypeAlias = Literal[
+    "en",
+    "es",
+    "it",
+    "pt",
+    "de",
+    "fr",
+    "pl",
+    "ru",
+    "nl",
+    "ca",
+    "tr",
+    "sv",
+    "uk",
+    "no",
+    "fi",
+    "sk",
+    "el",
+    "cs",
+    "hr",
+    "da",
+    "ro",
+    "bg",
+]

whop_sdk/types/ledger_account_retrieve_response.py

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from .._utils import PropertyInfo
+from .._models import BaseModel
+from .shared.currency import Currency
+
+__all__ = ["LedgerAccountRetrieveResponse", "Balance", "Owner", "OwnerUser", "OwnerCompany"]
+
+
+class Balance(BaseModel):
+    balance: float
+    """The amount of the balance."""
+
+    currency: Currency
+    """The currency of the balance."""
+
+    pending_balance: float
+    """The amount of the balance that is pending."""
+
+    reserve_balance: float
+    """The amount of the balance that is reserved."""
+
+
+class OwnerUser(BaseModel):
+    id: str
+    """The internal ID of the user."""
+
+    name: Optional[str] = None
+    """The name of the user from their Whop account."""
+
+    typename: Literal["User"]
+    """The typename of this object"""
+
+    username: str
+    """The username of the user from their Whop account."""
+
+
+class OwnerCompany(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."""
+
+    typename: Literal["Company"]
+    """The typename of this object"""
+
+
+Owner: TypeAlias = Annotated[Union[Optional[OwnerUser], Optional[OwnerCompany]], PropertyInfo(discriminator="typename")]
+
+
+class LedgerAccountRetrieveResponse(BaseModel):
+    id: str
+    """The ID of the LedgerAccount."""
+
+    balances: List[Balance]
+    """The balances associated with the account."""
+
+    ledger_account_audit_status: Optional[
+        Literal[
+            "pending",
+            "pending_ai_review",
+            "approved",
+            "reserves_imposed",
+            "suspended",
+            "ignored",
+            "rejected",
+            "requested_more_information",
+            "information_submitted",
+            "requested_tos_violation_correction",
+            "clawback_attempted",
+            "awaiting_sales_review",
+        ]
+    ] = None
+    """The different statuses a LedgerAccountAudit can be"""
+
+    ledger_type: Literal["primary", "pool"]
+    """The type of ledger account."""
+
+    owner: Owner
+    """The owner of the ledger account."""
+
+    payments_approval_status: Optional[Literal["pending", "approved", "monitoring", "rejected"]] = None
+    """The different approval statuses an account can have."""
+
+    transfer_fee: Optional[float] = None
+    """The fee for transfers, if applicable."""

whop_sdk/types/lesson.py

@@ -0,0 +1,219 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .embed_type import EmbedType
+from .lesson_types import LessonTypes
+from .lesson_visibilities import LessonVisibilities
+from .assessment_question_types import AssessmentQuestionTypes
+
+__all__ = [
+    "Lesson",
+    "AssessmentQuestion",
+    "AssessmentQuestionImage",
+    "AssessmentQuestionOption",
+    "Attachment",
+    "MainPdf",
+    "Thumbnail",
+    "VideoAsset",
+]
+
+
+class AssessmentQuestionImage(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 AssessmentQuestionOption(BaseModel):
+    id: str
+    """The ID of the assessment question option"""
+
+    is_correct: Optional[bool] = None
+    """Whether this option is a correct answer.
+
+    Only visible to admins (users with courses:update permission)
+    """
+
+    option_text: str
+    """The text of the answer option"""
+
+    order: int
+    """The order of this option within the question"""
+
+
+class AssessmentQuestion(BaseModel):
+    id: str
+    """The ID of the assessment question"""
+
+    correct_answer: Optional[str] = None
+    """The correct answer for the question.
+
+    Used for short answer questions. Only visible to admins (users with
+    courses:update permission)
+    """
+
+    created_at: datetime
+    """When the question was created"""
+
+    image: Optional[AssessmentQuestionImage] = None
+    """Optional image attachment for the question"""
+
+    options: List[AssessmentQuestionOption]
+    """The answer options for multiple choice/select questions"""
+
+    order: int
+    """The order of the question within its lesson"""
+
+    question_text: str
+    """The text of the question"""
+
+    question_type: AssessmentQuestionTypes
+    """The type of the question"""
+
+
+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 MainPdf(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 Thumbnail(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 VideoAsset(BaseModel):
+    id: str
+    """The ID of the Mux asset"""
+
+    asset_id: Optional[str] = None
+    """The Mux-provided ID of the asset"""
+
+    audio_only: bool
+    """Whether this asset contains only audio"""
+
+    created_at: datetime
+    """The time at which the Mux asset was created"""
+
+    duration_seconds: Optional[int] = None
+    """The duration of the video in seconds"""
+
+    finished_uploading_at: Optional[datetime] = None
+    """The time at which the video finished uploading"""
+
+    playback_id: Optional[str] = None
+    """The public playback ID of the Mux asset"""
+
+    signed_playback_id: Optional[str] = None
+    """The signed playback ID of the Mux asset"""
+
+    signed_storyboard_playback_token: Optional[str] = None
+    """The signed storyboard playback token of the Mux asset"""
+
+    signed_thumbnail_playback_token: Optional[str] = None
+    """The signed thumbnail playback token of the Mux asset"""
+
+    signed_video_playback_token: Optional[str] = None
+    """The signed video playback token of the Mux asset"""
+
+    status: Literal["uploading", "created", "ready"]
+    """The status of the Mux asset"""
+
+    updated_at: datetime
+    """The time at which the Mux asset was last updated"""
+
+
+class Lesson(BaseModel):
+    id: str
+    """The ID of the lesson"""
+
+    assessment_questions: List[AssessmentQuestion]
+    """Assessment questions for quiz/knowledge check lessons"""
+
+    attachments: List[Attachment]
+    """The attached files in this lesson as a flat array"""
+
+    content: Optional[str] = None
+    """The content of the lesson"""
+
+    created_at: datetime
+    """The timestamp of when the lesson was created"""
+
+    days_from_course_start_until_unlock: Optional[int] = None
+    """Number of days from course start until the lesson is unlocked"""
+
+    embed_id: Optional[str] = None
+    """ID for the embed (YouTube video ID or Loom share ID)"""
+
+    embed_type: Optional[EmbedType] = None
+    """The type of embed for a lesson"""
+
+    lesson_type: LessonTypes
+    """The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)"""
+
+    main_pdf: Optional[MainPdf] = None
+    """The main PDF file for this lesson"""
+
+    order: int
+    """The order of the lesson within its chapter"""
+
+    thumbnail: Optional[Thumbnail] = None
+    """The thumbnail for the lesson"""
+
+    title: str
+    """The title of the lesson"""
+
+    video_asset: Optional[VideoAsset] = None
+    """The associated Mux asset for video lessons"""
+
+    visibility: LessonVisibilities
+    """The visibility of the lesson.
+
+    Determines how / whether this lesson is visible to users.
+    """

whop_sdk/types/lesson_types.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__ = ["LessonTypes"]
+
+LessonTypes: TypeAlias = Literal["text", "video", "pdf", "multi", "quiz", "knowledge_check"]

whop_sdk/types/lesson_visibilities.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__ = ["LessonVisibilities"]
+
+LessonVisibilities: TypeAlias = Literal["visible", "hidden"]

whop_sdk/types/member_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, 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 a product or company."""
+
+    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"""
+
+    product_ids: Optional[SequenceNotStr[str]]
+    """The product 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"""
+
+    user_ids: Optional[SequenceNotStr[str]]
+    """The user IDs 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 company. If its customer,
+    the member has a valid membership to any product on the company. If its
+    no_access, the member does not have access to the product.
+    """
+
+    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 company. If its customer,
+    the member has a valid membership to any product on the company. If its
+    no_access, the member does not have access to the product.
+    """
+
+    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."""