whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/refund_created_webhook_event.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 .card_brands import CardBrands
+from .refund_status import RefundStatus
+from .billing_reasons import BillingReasons
+from .shared.currency import Currency
+from .payment_provider import PaymentProvider
+from .payment_method_types import PaymentMethodTypes
+from .refund_reference_type import RefundReferenceType
+from .refund_reference_status import RefundReferenceStatus
+from .shared.membership_status import MembershipStatus
+
+__all__ = [
+    "RefundCreatedWebhookEvent",
+    "Data",
+    "DataPayment",
+    "DataPaymentMember",
+    "DataPaymentMembership",
+    "DataPaymentUser",
+]
+
+
+class DataPaymentMember(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+
+class DataPaymentMembership(BaseModel):
+    id: str
+    """The internal ID of the membership."""
+
+    status: MembershipStatus
+    """The state of the membership."""
+
+
+class DataPaymentUser(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 DataPayment(BaseModel):
+    id: str
+    """The payment ID"""
+
+    billing_reason: Optional[BillingReasons] = None
+    """The reason why a specific payment was billed"""
+
+    card_brand: Optional[CardBrands] = None
+    """Possible card brands that a payment token can have"""
+
+    card_last4: Optional[str] = None
+    """The last 4 digits of the card used to make the payment."""
+
+    created_at: datetime
+    """The datetime the payment was created"""
+
+    currency: Optional[Currency] = None
+    """The available currencies on the platform"""
+
+    dispute_alerted_at: Optional[datetime] = None
+    """When an alert came in that this transaction will be disputed"""
+
+    member: Optional[DataPaymentMember] = None
+    """The member attached to this payment."""
+
+    membership: Optional[DataPaymentMembership] = None
+    """The membership attached to this payment."""
+
+    paid_at: Optional[datetime] = None
+    """The datetime the payment was paid"""
+
+    payment_method_type: Optional[PaymentMethodTypes] = None
+    """The different types of payment methods that can be used."""
+
+    subtotal: Optional[float] = None
+    """The subtotal to show to the creator (excluding buyer fees)."""
+
+    total: Optional[float] = None
+    """The total to show to the creator (excluding buyer fees)."""
+
+    usd_total: Optional[float] = None
+    """The total in USD to show to the creator (excluding buyer fees)."""
+
+    user: Optional[DataPaymentUser] = None
+    """The user that made this payment."""
+
+
+class Data(BaseModel):
+    id: str
+    """The ID of the refund."""
+
+    amount: float
+    """The amount of the refund."""
+
+    created_at: datetime
+    """The time the refund was created."""
+
+    currency: Currency
+    """The currency of the refund."""
+
+    payment: Optional[DataPayment] = None
+    """The payment associated with the refund."""
+
+    provider: PaymentProvider
+    """The provider of the refund."""
+
+    provider_created_at: Optional[datetime] = None
+    """The time the refund was created by the provider."""
+
+    reference_status: Optional[RefundReferenceStatus] = None
+    """The status of the refund reference."""
+
+    reference_type: Optional[RefundReferenceType] = None
+    """The type of refund reference that was made available by the payment provider."""
+
+    reference_value: Optional[str] = None
+    """The value of the reference."""
+
+    status: RefundStatus
+    """The status of the refund."""
+
+
+class RefundCreatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Data
+    """An object representing a refund made on a payment."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["refund.created"]
+    """The webhook event type"""

whop_sdk/types/refund_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__ = ["RefundListParams"]
+
+
+class RefundListParams(TypedDict, total=False):
+    payment_id: Required[str]
+    """The ID of the payment to list refunds 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/refund_list_response.py

@@ -0,0 +1,53 @@
+# 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 .refund_status import RefundStatus
+from .shared.currency import Currency
+from .payment_provider import PaymentProvider
+from .refund_reference_type import RefundReferenceType
+from .refund_reference_status import RefundReferenceStatus
+
+__all__ = ["RefundListResponse", "Payment"]
+
+
+class Payment(BaseModel):
+    id: str
+    """The payment ID"""
+
+
+class RefundListResponse(BaseModel):
+    id: str
+    """The ID of the refund."""
+
+    amount: float
+    """The amount of the refund."""
+
+    created_at: datetime
+    """The time the refund was created."""
+
+    currency: Currency
+    """The currency of the refund."""
+
+    payment: Optional[Payment] = None
+    """The payment associated with the refund."""
+
+    provider: PaymentProvider
+    """The provider of the refund."""
+
+    provider_created_at: Optional[datetime] = None
+    """The time the refund was created by the provider."""
+
+    reference_status: Optional[RefundReferenceStatus] = None
+    """The status of the refund reference."""
+
+    reference_type: Optional[RefundReferenceType] = None
+    """The type of refund reference that was made available by the payment provider."""
+
+    reference_value: Optional[str] = None
+    """The value of the reference."""
+
+    status: RefundStatus
+    """The status of the refund."""

whop_sdk/types/refund_reference_status.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__ = ["RefundReferenceStatus"]
+
+RefundReferenceStatus: TypeAlias = Literal["available", "pending", "unavailable"]

whop_sdk/types/refund_reference_type.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__ = ["RefundReferenceType"]
+
+RefundReferenceType: TypeAlias = Literal[
+    "acquirer_reference_number", "retrieval_reference_number", "system_trace_audit_number"
+]

whop_sdk/types/refund_retrieve_response.py

@@ -0,0 +1,129 @@
+# 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 .card_brands import CardBrands
+from .refund_status import RefundStatus
+from .billing_reasons import BillingReasons
+from .shared.currency import Currency
+from .payment_provider import PaymentProvider
+from .payment_method_types import PaymentMethodTypes
+from .refund_reference_type import RefundReferenceType
+from .refund_reference_status import RefundReferenceStatus
+from .shared.membership_status import MembershipStatus
+
+__all__ = ["RefundRetrieveResponse", "Payment", "PaymentMember", "PaymentMembership", "PaymentUser"]
+
+
+class PaymentMember(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+
+class PaymentMembership(BaseModel):
+    id: str
+    """The internal ID of the membership."""
+
+    status: MembershipStatus
+    """The state of the membership."""
+
+
+class PaymentUser(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 Payment(BaseModel):
+    id: str
+    """The payment ID"""
+
+    billing_reason: Optional[BillingReasons] = None
+    """The reason why a specific payment was billed"""
+
+    card_brand: Optional[CardBrands] = None
+    """Possible card brands that a payment token can have"""
+
+    card_last4: Optional[str] = None
+    """The last 4 digits of the card used to make the payment."""
+
+    created_at: datetime
+    """The datetime the payment was created"""
+
+    currency: Optional[Currency] = None
+    """The available currencies on the platform"""
+
+    dispute_alerted_at: Optional[datetime] = None
+    """When an alert came in that this transaction will be disputed"""
+
+    member: Optional[PaymentMember] = None
+    """The member attached to this payment."""
+
+    membership: Optional[PaymentMembership] = None
+    """The membership attached to this payment."""
+
+    paid_at: Optional[datetime] = None
+    """The datetime the payment was paid"""
+
+    payment_method_type: Optional[PaymentMethodTypes] = None
+    """The different types of payment methods that can be used."""
+
+    subtotal: Optional[float] = None
+    """The subtotal to show to the creator (excluding buyer fees)."""
+
+    total: Optional[float] = None
+    """The total to show to the creator (excluding buyer fees)."""
+
+    usd_total: Optional[float] = None
+    """The total in USD to show to the creator (excluding buyer fees)."""
+
+    user: Optional[PaymentUser] = None
+    """The user that made this payment."""
+
+
+class RefundRetrieveResponse(BaseModel):
+    id: str
+    """The ID of the refund."""
+
+    amount: float
+    """The amount of the refund."""
+
+    created_at: datetime
+    """The time the refund was created."""
+
+    currency: Currency
+    """The currency of the refund."""
+
+    payment: Optional[Payment] = None
+    """The payment associated with the refund."""
+
+    provider: PaymentProvider
+    """The provider of the refund."""
+
+    provider_created_at: Optional[datetime] = None
+    """The time the refund was created by the provider."""
+
+    reference_status: Optional[RefundReferenceStatus] = None
+    """The status of the refund reference."""
+
+    reference_type: Optional[RefundReferenceType] = None
+    """The type of refund reference that was made available by the payment provider."""
+
+    reference_value: Optional[str] = None
+    """The value of the reference."""
+
+    status: RefundStatus
+    """The status of the refund."""

whop_sdk/types/refund_status.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__ = ["RefundStatus"]
+
+RefundStatus: TypeAlias = Literal["pending", "requires_action", "succeeded", "failed", "canceled"]

whop_sdk/types/refund_updated_webhook_event.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 .card_brands import CardBrands
+from .refund_status import RefundStatus
+from .billing_reasons import BillingReasons
+from .shared.currency import Currency
+from .payment_provider import PaymentProvider
+from .payment_method_types import PaymentMethodTypes
+from .refund_reference_type import RefundReferenceType
+from .refund_reference_status import RefundReferenceStatus
+from .shared.membership_status import MembershipStatus
+
+__all__ = [
+    "RefundUpdatedWebhookEvent",
+    "Data",
+    "DataPayment",
+    "DataPaymentMember",
+    "DataPaymentMembership",
+    "DataPaymentUser",
+]
+
+
+class DataPaymentMember(BaseModel):
+    id: str
+    """The ID of the member"""
+
+    phone: Optional[str] = None
+    """The phone number for the member, if available."""
+
+
+class DataPaymentMembership(BaseModel):
+    id: str
+    """The internal ID of the membership."""
+
+    status: MembershipStatus
+    """The state of the membership."""
+
+
+class DataPaymentUser(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 DataPayment(BaseModel):
+    id: str
+    """The payment ID"""
+
+    billing_reason: Optional[BillingReasons] = None
+    """The reason why a specific payment was billed"""
+
+    card_brand: Optional[CardBrands] = None
+    """Possible card brands that a payment token can have"""
+
+    card_last4: Optional[str] = None
+    """The last 4 digits of the card used to make the payment."""
+
+    created_at: datetime
+    """The datetime the payment was created"""
+
+    currency: Optional[Currency] = None
+    """The available currencies on the platform"""
+
+    dispute_alerted_at: Optional[datetime] = None
+    """When an alert came in that this transaction will be disputed"""
+
+    member: Optional[DataPaymentMember] = None
+    """The member attached to this payment."""
+
+    membership: Optional[DataPaymentMembership] = None
+    """The membership attached to this payment."""
+
+    paid_at: Optional[datetime] = None
+    """The datetime the payment was paid"""
+
+    payment_method_type: Optional[PaymentMethodTypes] = None
+    """The different types of payment methods that can be used."""
+
+    subtotal: Optional[float] = None
+    """The subtotal to show to the creator (excluding buyer fees)."""
+
+    total: Optional[float] = None
+    """The total to show to the creator (excluding buyer fees)."""
+
+    usd_total: Optional[float] = None
+    """The total in USD to show to the creator (excluding buyer fees)."""
+
+    user: Optional[DataPaymentUser] = None
+    """The user that made this payment."""
+
+
+class Data(BaseModel):
+    id: str
+    """The ID of the refund."""
+
+    amount: float
+    """The amount of the refund."""
+
+    created_at: datetime
+    """The time the refund was created."""
+
+    currency: Currency
+    """The currency of the refund."""
+
+    payment: Optional[DataPayment] = None
+    """The payment associated with the refund."""
+
+    provider: PaymentProvider
+    """The provider of the refund."""
+
+    provider_created_at: Optional[datetime] = None
+    """The time the refund was created by the provider."""
+
+    reference_status: Optional[RefundReferenceStatus] = None
+    """The status of the refund reference."""
+
+    reference_type: Optional[RefundReferenceType] = None
+    """The type of refund reference that was made available by the payment provider."""
+
+    reference_value: Optional[str] = None
+    """The value of the reference."""
+
+    status: RefundStatus
+    """The status of the refund."""
+
+
+class RefundUpdatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Data
+    """An object representing a refund made on a payment."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["refund.updated"]
+    """The webhook event type"""

whop_sdk/types/review_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 Union, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["ReviewListParams"]
+
+
+class ReviewListParams(TypedDict, total=False):
+    product_id: Required[str]
+    """The ID of the product"""
+
+    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."""
+
+    max_stars: Optional[int]
+    """The maximum star rating of the review (inclusive)"""
+
+    min_stars: Optional[int]
+    """The minimum star rating of the review (inclusive)"""

whop_sdk/types/review_list_response.py

@@ -0,0 +1,78 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+from .review_status import ReviewStatus
+
+__all__ = ["ReviewListResponse", "Attachment", "User"]
+
+
+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 User(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 ReviewListResponse(BaseModel):
+    id: str
+    """The internal ID of the review."""
+
+    attachments: List[Attachment]
+    """The attachments attached to the review."""
+
+    created_at: datetime
+    """The timestamp of when the review was created."""
+
+    description: Optional[str] = None
+    """The description of the review."""
+
+    joined_at: Optional[datetime] = None
+    """The timestamp of when the user joined the product."""
+
+    paid_for_product: Optional[bool] = None
+    """Whether or not the user paid for the product.
+
+    If null, the payment status is unknown.
+    """
+
+    published_at: Optional[datetime] = None
+    """The timestamp of when the review was published."""
+
+    stars: int
+    """The number of stars the user gave the product."""
+
+    status: ReviewStatus
+    """The status of the review."""
+
+    title: Optional[str] = None
+    """The title of the review."""
+
+    updated_at: datetime
+    """The timestamp of when the review was last updated."""
+
+    user: User
+    """The user account that performed the action."""