whop-sdk 0.0.1__py3-none-any.whl

whop_sdk/types/app_list_response.py

@@ -0,0 +1,91 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .shared.app_statuses import AppStatuses
+
+__all__ = ["AppListResponse", "Company", "Creator"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID (tag) of the company."""
+
+    title: str
+    """The title of the company."""
+
+
+class Creator(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 AppListResponse(BaseModel):
+    id: str
+    """The ID of the app"""
+
+    base_url: Optional[str] = None
+    """The base url of the app"""
+
+    company: Company
+    """The company that owns the app"""
+
+    creator: Creator
+    """The creator of the app"""
+
+    dashboard_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    description: Optional[str] = None
+    """The description of the app"""
+
+    discover_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    domain_id: str
+    """The unique part of the proxied domain for this app.
+
+    Used to generate the base url used to display the app inside the whop platform.
+    Refers to the id part in the final url: https://{domain_id}.apps.whop.com
+    """
+
+    experience_path: Optional[str] = None
+    """The path part for a specific view of the app.
+
+    This is the template part of the url after the base domain. Eg:
+    /experiences/[experienceId]
+    """
+
+    name: str
+    """The name of the app"""
+
+    status: AppStatuses
+    """If the status is live, the app is visible on Whop discovery.
+
+    In order to be live, you need to set the name, icon, and description. Being
+    unlisted or hidden means it's not visible on Whop but you can still install the
+    app via direct link. To remove the app from whop discovery, you should set the
+    status to unlisted.
+    """
+
+    verified: bool
+    """Whether this app has been verified by Whop.
+
+    Verified apps are endorsed by whop and are shown in the 'featured apps' section
+    of the app store.
+    """

whop_sdk/types/app_update_params.py

@@ -0,0 +1,58 @@
+# 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, TypedDict
+
+from .shared.app_statuses import AppStatuses
+
+__all__ = ["AppUpdateParams", "Icon"]
+
+
+class AppUpdateParams(TypedDict, total=False):
+    app_store_description: Optional[str]
+    """The description of the app for the app store in-depth app view."""
+
+    base_url: Optional[str]
+    """The base production url of the app"""
+
+    dashboard_path: Optional[str]
+    """The path for the dashboard view of the app"""
+
+    description: Optional[str]
+    """The description of the app"""
+
+    discover_path: Optional[str]
+    """The path for the discover view of the app"""
+
+    experience_path: Optional[str]
+    """The path for the hub view of the app"""
+
+    icon: Optional[Icon]
+    """The icon for the app"""
+
+    name: Optional[str]
+    """The name of the app"""
+
+    required_scopes: Optional[List[Literal["read_user"]]]
+    """The scopes that the app will request off of users when a user installs the app."""
+
+    status: Optional[AppStatuses]
+    """The status of an experience interface"""
+
+
+class Icon(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/authorized_user_list_params.py

@@ -0,0 +1,33 @@
+# 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.authorized_user_roles import AuthorizedUserRoles
+
+__all__ = ["AuthorizedUserListParams"]
+
+
+class AuthorizedUserListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list authorized users 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."""
+
+    role: Optional[AuthorizedUserRoles]
+    """Possible roles an authorized user can have"""
+
+    user_id: Optional[str]
+    """Filter by the user ID to check if the user is an authorized user"""

whop_sdk/types/authorized_user_list_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .shared.authorized_user_roles import AuthorizedUserRoles
+
+__all__ = ["AuthorizedUserListResponse", "User"]
+
+
+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 AuthorizedUserListResponse(BaseModel):
+    id: str
+    """A unique ID representing the authorized user object."""
+
+    role: AuthorizedUserRoles
+    """The role of the authorized user in the company."""
+
+    user: User
+    """The user associated with the authorized user."""

whop_sdk/types/authorized_user_retrieve_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .shared.authorized_user_roles import AuthorizedUserRoles
+
+__all__ = ["AuthorizedUserRetrieveResponse", "User"]
+
+
+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 AuthorizedUserRetrieveResponse(BaseModel):
+    id: str
+    """A unique ID representing the authorized user object."""
+
+    role: AuthorizedUserRoles
+    """The role of the authorized user in the company."""
+
+    user: User
+    """The user associated with the authorized user."""

whop_sdk/types/chat_channel_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__ = ["ChatChannelListParams"]
+
+
+class ChatChannelListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list chat channels 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 chat channels connected to this product are returned"""

whop_sdk/types/chat_channel_list_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+from .shared.who_can_post import WhoCanPost
+from .shared.who_can_react import WhoCanReact
+
+__all__ = ["ChatChannelListResponse", "Experience"]
+
+
+class Experience(BaseModel):
+    id: str
+    """The unique ID representing this experience"""
+
+    name: str
+    """The written name of the description."""
+
+
+class ChatChannelListResponse(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    ban_media: bool
+    """Whether or not media is banned in this chat"""
+
+    ban_urls: bool
+    """Whether or not URLs are banned in this chat"""
+
+    banned_words: List[str]
+    """List of banned words in this chat"""
+
+    experience: Experience
+    """The experience for this chat"""
+
+    user_posts_cooldown_seconds: Optional[int] = None
+    """The number of seconds a user needs to wait before posting again, if any"""
+
+    who_can_post: WhoCanPost
+    """Who can post on this chat"""
+
+    who_can_react: WhoCanReact
+    """Who can react on this chat"""

whop_sdk/types/chat_channel_update_params.py

@@ -0,0 +1,32 @@
+# 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 .._types import SequenceNotStr
+from .shared.who_can_post import WhoCanPost
+from .shared.who_can_react import WhoCanReact
+
+__all__ = ["ChatChannelUpdateParams"]
+
+
+class ChatChannelUpdateParams(TypedDict, total=False):
+    ban_media: Optional[bool]
+    """Whether media uploads are banned in this chat"""
+
+    ban_urls: Optional[bool]
+    """Whether URLs are banned in this chat"""
+
+    banned_words: Optional[SequenceNotStr[str]]
+    """List of banned words for this chat"""
+
+    user_posts_cooldown_seconds: Optional[int]
+    """The cooldown period in seconds between user posts"""
+
+    who_can_post: Optional[WhoCanPost]
+    """Who can post on a chat feed"""
+
+    who_can_react: Optional[WhoCanReact]
+    """Who can react on a chat feed"""

whop_sdk/types/checkout_configuration_create_params.py

@@ -0,0 +1,129 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Iterable, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+from .shared.currency import Currency
+from .shared.tax_type import TaxType
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .shared.release_method import ReleaseMethod
+
+__all__ = ["CheckoutConfigurationCreateParams", "Plan", "PlanCustomField", "PlanImage"]
+
+
+class CheckoutConfigurationCreateParams(TypedDict, total=False):
+    affiliate_code: Optional[str]
+    """The affiliate code to use for the checkout session"""
+
+    metadata: Optional[Dict[str, object]]
+    """The metadata to use for the checkout session"""
+
+    plan: Optional[Plan]
+    """Pass this object to create a new plan for this checkout session"""
+
+    plan_id: Optional[str]
+    """The ID of the plan to use for the checkout session"""
+
+    redirect_url: Optional[str]
+    """The URL to redirect the user to after the checkout session is created"""
+
+
+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 PlanImage(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 Plan(TypedDict, total=False):
+    company_id: Required[str]
+    """The company the plan should be created for."""
+
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    currency: Optional[Currency]
+    """The available currencies on the platform"""
+
+    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)."""
+
+    force_create_new_plan: Optional[bool]
+    """
+    Whether to force the creation of a new plan even if one with the same attributes
+    already exists.
+    """
+
+    image: Optional[PlanImage]
+    """An image for the plan. This will be visible on the product page to customers."""
+
+    initial_price: Optional[float]
+    """An additional amount charged upon first purchase."""
+
+    internal_notes: Optional[str]
+    """A personal description or notes section for the business."""
+
+    override_tax_type: Optional[TaxType]
+    """
+    Whether or not the tax is included in a plan's price (or if it hasn't been set
+    up)
+    """
+
+    plan_type: Optional[PlanType]
+    """The type of plan that can be attached to an access pass"""
+
+    product_id: Optional[str]
+    """The product the plan is related to."""
+
+    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."""
+
+    title: Optional[str]
+    """The title of the plan. This will be visible on the product page to customers."""
+
+    trial_period_days: Optional[int]
+    """The number of free trial days added before a renewal plan."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""

whop_sdk/types/checkout_configuration_list_params.py

@@ -0,0 +1,33 @@
+# 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__ = ["CheckoutConfigurationListParams"]
+
+
+class CheckoutConfigurationListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list checkout configurations 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."""
+
+    plan_id: Optional[str]
+    """The ID of the plan to filter checkout configurations by"""

whop_sdk/types/checkout_configuration_list_response.py

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+
+from .._models import BaseModel
+from .shared.currency import Currency
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .shared.release_method import ReleaseMethod
+
+__all__ = ["CheckoutConfigurationListResponse", "Plan"]
+
+
+class Plan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+    billing_period: Optional[int] = None
+    """The interval at which the plan charges (renewal plans)."""
+
+    currency: Currency
+    """The respective currency identifier for the plan."""
+
+    expiration_days: Optional[int] = None
+    """The interval at which the plan charges (expiration plans)."""
+
+    initial_price: float
+    """The price a person has to pay for a plan on the initial purchase."""
+
+    plan_type: PlanType
+    """Indicates if the plan is a one time payment or recurring."""
+
+    release_method: ReleaseMethod
+    """This is the release method the business uses to sell this plan."""
+
+    renewal_price: float
+    """The price a person has to pay for a plan on the renewal purchase."""
+
+    trial_period_days: Optional[int] = None
+    """The number of free trial days added before a renewal plan."""
+
+    visibility: Visibility
+    """Shows or hides the plan from public/business view."""
+
+
+class CheckoutConfigurationListResponse(BaseModel):
+    id: str
+    """The ID of the checkout session"""
+
+    affiliate_code: str
+    """The affiliate code to use for the checkout session"""
+
+    company_id: str
+    """The ID of the company to use for the checkout session"""
+
+    metadata: Dict[str, object]
+    """The metadata to use for the checkout session"""
+
+    plan: Plan
+    """The plan to use for the checkout session"""
+
+    purchase_url: str
+    """The URL to redirect the user to after the checkout session is created"""
+
+    redirect_url: str
+    """The URL to redirect the user to after the checkout session is created"""

whop_sdk/types/course_lesson_interaction_list_params.py

@@ -0,0 +1,34 @@
+# 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__ = ["CourseLessonInteractionListParams"]
+
+
+class CourseLessonInteractionListParams(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."""
+
+    completed: Optional[bool]
+    """Whether the lesson has been completed by the user"""
+
+    course_id: Optional[str]
+    """The ID of the course to list course lesson interactions for"""
+
+    first: Optional[int]
+    """Returns the first _n_ elements from the list."""
+
+    last: Optional[int]
+    """Returns the last _n_ elements from the list."""
+
+    lesson_id: Optional[str]
+    """The ID of the lesson to list course lesson interactions for"""
+
+    user_id: Optional[str]
+    """The ID of the user to list course lesson interactions for"""

whop_sdk/types/entry_approve_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["EntryApproveResponse"]
+
+
+class EntryApproveResponse(BaseModel):
+    job_id: str
+    """The ID of the job."""

whop_sdk/types/entry_list_params.py

@@ -0,0 +1,44 @@
+# 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.entry_status import EntryStatus
+
+__all__ = ["EntryListParams"]
+
+
+class EntryListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the 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."""
+
+    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"]]
+    """Which columns can be used to sort."""
+
+    plan_ids: Optional[SequenceNotStr[str]]
+    """The plan IDs to filter the entries by"""
+
+    product_ids: Optional[SequenceNotStr[str]]
+    """The product IDs to filter the entries by"""
+
+    statuses: Optional[List[EntryStatus]]
+    """The statuses to filter the entries by"""