whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/app_list_response.py

@@ -0,0 +1,110 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+from .app_type import AppType
+from .shared.app_statuses import AppStatuses
+
+__all__ = ["AppListResponse", "Company", "Creator", "Icon"]
+
+
+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 Icon(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 AppListResponse(BaseModel):
+    id: str
+    """The ID of the app"""
+
+    app_type: AppType
+    """The type of end-user an app is built for"""
+
+    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]
+    """
+
+    icon: Optional[Icon] = 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"""
+
+    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_type.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__ = ["AppType"]
+
+AppType: TypeAlias = Literal["b2b_app", "b2c_app", "company_app", "component"]

whop_sdk/types/app_update_params.py

@@ -0,0 +1,67 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .app_type import AppType
+from .shared.app_statuses import AppStatuses
+
+__all__ = ["AppUpdateParams", "Icon", "IconAttachmentInputWithDirectUploadID", "IconAttachmentInputWithID"]
+
+
+class AppUpdateParams(TypedDict, total=False):
+    app_store_description: Optional[str]
+    """The description of the app for the app store in-depth app view."""
+
+    app_type: Optional[AppType]
+    """The type of end-user an app is built for"""
+
+    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 IconAttachmentInputWithDirectUploadID(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 IconAttachmentInputWithID(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.
+    """
+
+
+Icon: TypeAlias = Union[IconAttachmentInputWithDirectUploadID, IconAttachmentInputWithID]

whop_sdk/types/assessment_question_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__ = ["AssessmentQuestionTypes"]
+
+AssessmentQuestionTypes: TypeAlias = Literal["short_answer", "true_false", "multiple_choice", "multiple_select"]

whop_sdk/types/authorized_user_list_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 Union, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+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."""
+
+    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"""
+
+    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/billing_reasons.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["BillingReasons"]
+
+BillingReasons: TypeAlias = Literal[
+    "subscription_create", "subscription_cycle", "subscription_update", "one_time", "manual", "subscription"
+]

whop_sdk/types/card_brands.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["CardBrands"]
+
+CardBrands: TypeAlias = Literal[
+    "mastercard",
+    "visa",
+    "amex",
+    "discover",
+    "unionpay",
+    "jcb",
+    "diners",
+    "link",
+    "troy",
+    "visadankort",
+    "visabancontact",
+    "china_union_pay",
+    "rupay",
+    "jcbrupay",
+    "elo",
+    "maestro",
+    "unknown",
+]

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