whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/shipment_list_response.py

@@ -0,0 +1,48 @@
+# 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.shipment_status import ShipmentStatus
+from .shared.shipment_carrier import ShipmentCarrier
+from .shared.shipment_substatus import ShipmentSubstatus
+
+__all__ = ["ShipmentListResponse", "Payment"]
+
+
+class Payment(BaseModel):
+    id: str
+    """The payment ID"""
+
+
+class ShipmentListResponse(BaseModel):
+    id: str
+    """The ID of the shipment"""
+
+    carrier: ShipmentCarrier
+    """The carrier of the shipment"""
+
+    created_at: datetime
+    """The date and time the shipment was created"""
+
+    delivery_estimate: Optional[datetime] = None
+    """The delivery estimate of the shipment"""
+
+    payment: Optional[Payment] = None
+    """The payment of the shipment"""
+
+    service: Optional[str] = None
+    """The service of the shipment"""
+
+    status: ShipmentStatus
+    """The status of the shipment"""
+
+    substatus: Optional[ShipmentSubstatus] = None
+    """The substatus of a shipment"""
+
+    tracking_code: str
+    """The tracking code of the shipment"""
+
+    updated_at: datetime
+    """The date and time the shipment was last updated"""

whop_sdk/types/support_channel_create_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SupportChannelCreateParams"]
+
+
+class SupportChannelCreateParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to create the support chat in"""
+
+    user_id: Required[str]
+    """The ID of the user to create the support chat for"""

whop_sdk/types/support_channel_list_params.py

@@ -0,0 +1,40 @@
+# 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, Required, TypedDict
+
+from .shared.direction import Direction
+
+__all__ = ["SupportChannelListParams"]
+
+
+class SupportChannelListParams(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."""
+
+    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."""
+
+    open: Optional[bool]
+    """
+    Filter for tickets where customer sent the last message (needs response) AND not
+    resolved. Set to true to only return open channels, false to only return
+    resolved channels.
+    """
+
+    order: Optional[Literal["created_at", "last_post_sent_at"]]
+    """Sort options for message channels"""

whop_sdk/types/support_channel_list_response.py

@@ -0,0 +1,39 @@
+# 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
+
+__all__ = ["SupportChannelListResponse", "CustomerUser"]
+
+
+class CustomerUser(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 SupportChannelListResponse(BaseModel):
+    id: str
+    """The unique identifier for the entity"""
+
+    company_id: Optional[str] = None
+    """The bot ID if this is a support chat"""
+
+    custom_name: Optional[str] = None
+    """The custom name of the DM channel, if any"""
+
+    customer_user: Optional[CustomerUser] = None
+    """The customer user if this is a support chat"""
+
+    last_message_at: Optional[datetime] = None
+    """When the last message was sent"""
+
+    resolved_at: Optional[datetime] = None
+    """When the support ticket was resolved (null if unresolved)"""

whop_sdk/types/transfer_create_params.py

@@ -0,0 +1,39 @@
+# 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 Required, TypedDict
+
+from .shared.currency import Currency
+
+__all__ = ["TransferCreateParams"]
+
+
+class TransferCreateParams(TypedDict, total=False):
+    amount: Required[float]
+    """The amount to withdraw"""
+
+    currency: Required[Currency]
+    """The currency that is being withdrawn."""
+
+    destination_id: Required[str]
+    """
+    The ID of the destination account which will receive the funds (either a User
+    ID, Company ID, or LedgerAccount ID)
+    """
+
+    origin_id: Required[str]
+    """
+    The ID of the origin account which will send the funds (either a User ID,
+    Company ID, or LedgerAccount ID)
+    """
+
+    idempotence_key: Optional[str]
+    """A unique key to ensure idempotence. Use a UUID or similar."""
+
+    metadata: Optional[Dict[str, object]]
+    """A hash of metadata to attach to the transfer."""
+
+    notes: Optional[str]
+    """Notes for the transfer. Maximum of 50 characters."""

whop_sdk/types/transfer_list_params.py

@@ -0,0 +1,50 @@
+# 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 Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+from .shared.direction import Direction
+
+__all__ = ["TransferListParams"]
+
+
+class TransferListParams(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."""
+
+    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"""
+
+    destination_id: Optional[str]
+    """Filter transfers to only those that were sent to this destination account.
+
+    (user_xxx, biz_xxx, ldgr_xxx)
+    """
+
+    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["amount", "created_at"]]
+    """Which columns can be used to sort."""
+
+    origin_id: Optional[str]
+    """Filter transfers to only those that were sent from this origin account.
+
+    (user_xxx, biz_xxx, ldgr_xxx)
+    """

whop_sdk/types/transfer_list_response.py

@@ -0,0 +1,38 @@
+# 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
+
+__all__ = ["TransferListResponse"]
+
+
+class TransferListResponse(BaseModel):
+    id: str
+    """The unique identifier of the credit transaction transfer"""
+
+    amount: float
+    """The amount of the credit transaction transfer"""
+
+    created_at: datetime
+    """The timestamp when the credit transaction transfer was created"""
+
+    currency: Currency
+    """The currency of the credit transaction transfer"""
+
+    destination_ledger_account_id: str
+    """The ID of the destination ledger account"""
+
+    fee_amount: Optional[float] = None
+    """The decimal fee of the credit transaction transfer"""
+
+    metadata: Optional[Dict[str, object]] = None
+    """A hash of metadata attached to the transfer"""
+
+    notes: Optional[str] = None
+    """The notes of the credit transaction transfer"""
+
+    origin_ledger_account_id: str
+    """The ID of the origin ledger account"""

whop_sdk/types/unwrap_webhook_event.py

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union
+from typing_extensions import TypeAlias
+
+from .entry_denied_webhook_event import EntryDeniedWebhookEvent
+from .invoice_paid_webhook_event import InvoicePaidWebhookEvent
+from .entry_created_webhook_event import EntryCreatedWebhookEvent
+from .entry_deleted_webhook_event import EntryDeletedWebhookEvent
+from .entry_approved_webhook_event import EntryApprovedWebhookEvent
+from .invoice_voided_webhook_event import InvoiceVoidedWebhookEvent
+from .payment_failed_webhook_event import PaymentFailedWebhookEvent
+from .refund_created_webhook_event import RefundCreatedWebhookEvent
+from .refund_updated_webhook_event import RefundUpdatedWebhookEvent
+from .dispute_created_webhook_event import DisputeCreatedWebhookEvent
+from .dispute_updated_webhook_event import DisputeUpdatedWebhookEvent
+from .invoice_created_webhook_event import InvoiceCreatedWebhookEvent
+from .payment_pending_webhook_event import PaymentPendingWebhookEvent
+from .invoice_past_due_webhook_event import InvoicePastDueWebhookEvent
+from .payment_succeeded_webhook_event import PaymentSucceededWebhookEvent
+from .membership_activated_webhook_event import MembershipActivatedWebhookEvent
+from .setup_intent_canceled_webhook_event import SetupIntentCanceledWebhookEvent
+from .membership_deactivated_webhook_event import MembershipDeactivatedWebhookEvent
+from .setup_intent_succeeded_webhook_event import SetupIntentSucceededWebhookEvent
+from .setup_intent_requires_action_webhook_event import SetupIntentRequiresActionWebhookEvent
+from .course_lesson_interaction_completed_webhook_event import CourseLessonInteractionCompletedWebhookEvent
+
+__all__ = ["UnwrapWebhookEvent"]
+
+UnwrapWebhookEvent: TypeAlias = Union[
+    InvoiceCreatedWebhookEvent,
+    InvoicePaidWebhookEvent,
+    InvoicePastDueWebhookEvent,
+    InvoiceVoidedWebhookEvent,
+    MembershipActivatedWebhookEvent,
+    MembershipDeactivatedWebhookEvent,
+    EntryCreatedWebhookEvent,
+    EntryApprovedWebhookEvent,
+    EntryDeniedWebhookEvent,
+    EntryDeletedWebhookEvent,
+    SetupIntentRequiresActionWebhookEvent,
+    SetupIntentSucceededWebhookEvent,
+    SetupIntentCanceledWebhookEvent,
+    CourseLessonInteractionCompletedWebhookEvent,
+    PaymentSucceededWebhookEvent,
+    PaymentFailedWebhookEvent,
+    PaymentPendingWebhookEvent,
+    DisputeCreatedWebhookEvent,
+    DisputeUpdatedWebhookEvent,
+    RefundCreatedWebhookEvent,
+    RefundUpdatedWebhookEvent,
+]

whop_sdk/types/user_check_access_response.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+from .shared.access_level import AccessLevel
+
+__all__ = ["UserCheckAccessResponse"]
+
+
+class UserCheckAccessResponse(BaseModel):
+    access_level: AccessLevel
+    """The permission level of the user"""
+
+    has_access: bool
+    """Whether the user has access to the resource"""

whop_sdk/types/user_retrieve_response.py

@@ -0,0 +1,36 @@
+# 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
+
+__all__ = ["UserRetrieveResponse", "ProfilePicture"]
+
+
+class ProfilePicture(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 UserRetrieveResponse(BaseModel):
+    id: str
+    """The internal ID of the user."""
+
+    bio: Optional[str] = None
+    """The user's bio"""
+
+    created_at: datetime
+    """When the user was created."""
+
+    name: Optional[str] = None
+    """The name of the user from their Whop account."""
+
+    profile_picture: Optional[ProfilePicture] = None
+    """The user's profile picture"""
+
+    username: str
+    """The username of the user from their Whop account."""

whop_sdk/types/withdrawal_fee_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__ = ["WithdrawalFeeTypes"]
+
+WithdrawalFeeTypes: TypeAlias = Literal["exclusive", "inclusive"]

whop_sdk/types/withdrawal_list_params.py

@@ -0,0 +1,38 @@
+# 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.direction import Direction
+
+__all__ = ["WithdrawalListParams"]
+
+
+class WithdrawalListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list withdrawals 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"""
+
+    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/withdrawal_list_response.py

@@ -0,0 +1,45 @@
+# 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.currency import Currency
+from .withdrawal_types import WithdrawalTypes
+from .withdrawal_speeds import WithdrawalSpeeds
+from .withdrawal_status import WithdrawalStatus
+from .withdrawal_fee_types import WithdrawalFeeTypes
+
+__all__ = ["WithdrawalListResponse"]
+
+
+class WithdrawalListResponse(BaseModel):
+    id: str
+    """Internal ID of the withdrawal request."""
+
+    amount: float
+    """How much money was attempted to be withdrawn, in a float type."""
+
+    created_at: datetime
+    """When the withdrawal request was created."""
+
+    currency: Currency
+    """The currency of the withdrawal request."""
+
+    fee_amount: float
+    """The fee amount that was charged for the withdrawal.
+
+    This is in the same currency as the withdrawal amount.
+    """
+
+    fee_type: Optional[WithdrawalFeeTypes] = None
+    """The different fee types for a withdrawal."""
+
+    speed: WithdrawalSpeeds
+    """The speed of the withdrawal."""
+
+    status: WithdrawalStatus
+    """Status of the withdrawal."""
+
+    withdrawal_type: WithdrawalTypes
+    """The type of withdrawal."""

whop_sdk/types/withdrawal_retrieve_response.py

@@ -0,0 +1,154 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .shared.currency import Currency
+from .withdrawal_types import WithdrawalTypes
+from .withdrawal_speeds import WithdrawalSpeeds
+from .withdrawal_status import WithdrawalStatus
+from .withdrawal_fee_types import WithdrawalFeeTypes
+
+__all__ = ["WithdrawalRetrieveResponse", "LatestPayout", "PayoutToken"]
+
+
+class LatestPayout(BaseModel):
+    id: str
+    """The internal ID of the payout."""
+
+    created_at: datetime
+    """The date and time the payout was created."""
+
+    error_code: Optional[
+        Literal[
+            "account_closed",
+            "account_does_not_exist",
+            "account_information_invalid",
+            "account_number_invalid_region",
+            "account_frozen",
+            "account_lookup_failed",
+            "account_not_found",
+            "amount_out_of_bounds",
+            "attributes_not_validated",
+            "b2b_payments_prohibited",
+            "bank_statement_required",
+            "compliance_review",
+            "currency_not_supported",
+            "deposit_canceled",
+            "deposit_failed",
+            "deposit_rejected",
+            "destination_unavailable",
+            "exceeded_account_limit",
+            "expired_quote",
+            "generic_payout_error",
+            "technical_problem",
+            "identification_number_invalid",
+            "invalid_account_number",
+            "invalid_bank_code",
+            "invalid_beneficiary",
+            "invalid_branch_number",
+            "invalid_branch_code",
+            "invalid_phone_number",
+            "invalid_routing_number",
+            "invalid_swift_code",
+            "invalid_company_details",
+            "manual_cancelation",
+            "misc_error",
+            "missing_city_and_country",
+            "missing_phone_number",
+            "missing_remittance_info",
+            "payee_name_invalid",
+            "receiving_account_locked",
+            "rejected_by_compliance",
+            "rtp_not_supported",
+            "non_transaction_account",
+            "source_token_insufficient_funds",
+            "ssn_invalid",
+            "wallet_screenshot_required",
+            "unsupported_region",
+        ]
+    ] = None
+    """The different error codes a payout can be in."""
+
+    error_message: Optional[str] = None
+    """The error message for the payout."""
+
+    estimated_availability: Optional[datetime] = None
+    """The estimated availability date of the payout."""
+
+    payer_name: Optional[str] = None
+    """The name of the payer for the payout."""
+
+    status: Literal[
+        "scheduled", "pending", "processing", "completed", "canceled", "ready_for_pickup", "hold", "error", "expired"
+    ]
+    """The status of the payout."""
+
+    trace_code: Optional[str] = None
+    """The trace code for the payout, if applicable.
+
+    Provided on ACH transactions when available.
+    """
+
+
+class PayoutToken(BaseModel):
+    id: str
+    """The ID of the payout token"""
+
+    created_at: datetime
+    """The date and time the payout token was created"""
+
+    destination_currency_code: str
+    """The currency code of the payout destination.
+
+    This is the currency that payouts will be made in for this token.
+    """
+
+    nickname: Optional[str] = None
+    """An optional nickname for the payout token to help the user identify it.
+
+    This is not used by the provider and is only for the user's reference.
+    """
+
+    status: Literal["created", "active", "broken"]
+    """The status of the payout token."""
+
+
+class WithdrawalRetrieveResponse(BaseModel):
+    id: str
+    """Internal ID of the withdrawal request."""
+
+    amount: float
+    """How much money was attempted to be withdrawn, in a float type."""
+
+    created_at: datetime
+    """When the withdrawal request was created."""
+
+    currency: Currency
+    """The currency of the withdrawal request."""
+
+    fee_amount: float
+    """The fee amount that was charged for the withdrawal.
+
+    This is in the same currency as the withdrawal amount.
+    """
+
+    fee_type: Optional[WithdrawalFeeTypes] = None
+    """The different fee types for a withdrawal."""
+
+    latest_payout: Optional[LatestPayout] = None
+    """The latest payout associated with this withdrawal, if any."""
+
+    payout_token: Optional[PayoutToken] = None
+    """The payout token used for the withdrawal, if applicable."""
+
+    speed: WithdrawalSpeeds
+    """The speed of the withdrawal."""
+
+    status: WithdrawalStatus
+    """Status of the withdrawal."""
+
+    withdrawal_type: WithdrawalTypes
+    """The type of withdrawal."""

whop_sdk/types/withdrawal_speeds.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__ = ["WithdrawalSpeeds"]
+
+WithdrawalSpeeds: TypeAlias = Literal["standard", "instant"]

whop_sdk/types/withdrawal_status.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__ = ["WithdrawalStatus"]
+
+WithdrawalStatus: TypeAlias = Literal[
+    "requested", "awaiting_payment", "in_transit", "completed", "failed", "canceled", "denied"
+]

whop_sdk/types/withdrawal_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__ = ["WithdrawalTypes"]
+
+WithdrawalTypes: TypeAlias = Literal["regular", "clawback"]