whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/dispute.py

@@ -0,0 +1,284 @@
+# 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 .billing_reasons import BillingReasons
+from .shared.currency import Currency
+from .dispute_statuses import DisputeStatuses
+from .payment_method_types import PaymentMethodTypes
+from .shared.membership_status import MembershipStatus
+
+__all__ = [
+    "Dispute",
+    "CancellationPolicyAttachment",
+    "Company",
+    "CustomerCommunicationAttachment",
+    "Payment",
+    "PaymentMember",
+    "PaymentMembership",
+    "PaymentUser",
+    "Plan",
+    "Product",
+    "RefundPolicyAttachment",
+    "UncategorizedAttachment",
+]
+
+
+class CancellationPolicyAttachment(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 Company(BaseModel):
+    id: str
+    """The ID of the company"""
+
+    title: str
+    """The written name of the company."""
+
+
+class CustomerCommunicationAttachment(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 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 Plan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+
+class Product(BaseModel):
+    id: str
+    """The internal ID of the public product."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+
+class RefundPolicyAttachment(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 UncategorizedAttachment(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 Dispute(BaseModel):
+    id: str
+    """The internal ID of the dispute."""
+
+    access_activity_log: Optional[str] = None
+    """An IP access log for the user from Whop."""
+
+    amount: float
+    """The amount of the dispute (formatted)."""
+
+    billing_address: Optional[str] = None
+    """The billing address of the user from their payment details."""
+
+    cancellation_policy_attachment: Optional[CancellationPolicyAttachment] = None
+    """The cancellation policy for this dispute"""
+
+    cancellation_policy_disclosure: Optional[str] = None
+    """A cancellation policy disclosure from the company."""
+
+    company: Optional[Company] = None
+    """The company the dispute is against."""
+
+    created_at: Optional[datetime] = None
+    """When it was made."""
+
+    currency: Currency
+    """The currency of the dispute."""
+
+    customer_communication_attachment: Optional[CustomerCommunicationAttachment] = None
+    """The customer communication for this dispute"""
+
+    customer_email_address: Optional[str] = None
+    """The email of the customer from their payment details.
+
+    This is submitted in the evidence packet to the payment processor. You can
+    change it before submitting the dispute.
+    """
+
+    customer_name: Optional[str] = None
+    """The name of the customer from their payment details.
+
+    This is submitted in the evidence packet to the payment processor. You can
+    change it before submitting the dispute.
+    """
+
+    editable: Optional[bool] = None
+    """Whether or not the dispute data can be edited."""
+
+    needs_response_by: Optional[datetime] = None
+    """The last date the dispute is allow to be submitted by."""
+
+    notes: Optional[str] = None
+    """Additional notes the company chooses to submit regarding the dispute."""
+
+    payment: Optional[Payment] = None
+    """The payment that got disputed"""
+
+    plan: Optional[Plan] = None
+    """The plan that got disputed"""
+
+    product: Optional[Product] = None
+    """The product that got disputed"""
+
+    product_description: Optional[str] = None
+    """The description of the product from the company."""
+
+    reason: Optional[str] = None
+    """The reason for the dispute"""
+
+    refund_policy_attachment: Optional[RefundPolicyAttachment] = None
+    """The refund policy for this dispute"""
+
+    refund_policy_disclosure: Optional[str] = None
+    """A refund policy disclosure from the company."""
+
+    refund_refusal_explanation: Optional[str] = None
+    """A description on why the refund is being refused by the company."""
+
+    service_date: Optional[str] = None
+    """When the product was delivered by the company."""
+
+    status: DisputeStatuses
+    """The status of the dispute (mimics stripe's dispute status)."""
+
+    uncategorized_attachment: Optional[UncategorizedAttachment] = None
+    """An attachment that did not fit into the other categories"""
+
+    visa_rdr: bool
+    """Whether or not the dispute is a Visa Rapid Dispute Resolution."""

whop_sdk/types/dispute_created_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 .dispute import Dispute
+from .._models import BaseModel
+
+__all__ = ["DisputeCreatedWebhookEvent"]
+
+
+class DisputeCreatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Dispute
+    """An object representing a dispute against a company."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["dispute.created"]
+    """The webhook event type"""

whop_sdk/types/dispute_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__ = ["DisputeListParams"]
+
+
+class DisputeListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list disputes 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/dispute_list_response.py

@@ -0,0 +1,77 @@
+# 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 .dispute_statuses import DisputeStatuses
+
+__all__ = ["DisputeListResponse", "Company", "Payment", "Plan", "Product"]
+
+
+class Company(BaseModel):
+    id: str
+    """The ID of the company"""
+
+    title: str
+    """The written name of the company."""
+
+
+class Payment(BaseModel):
+    id: str
+    """The payment ID"""
+
+
+class Plan(BaseModel):
+    id: str
+    """The internal ID of the plan."""
+
+
+class Product(BaseModel):
+    id: str
+    """The internal ID of the public product."""
+
+    title: str
+    """The title of the product. Use for Whop 4.0."""
+
+
+class DisputeListResponse(BaseModel):
+    id: str
+    """The internal ID of the dispute."""
+
+    amount: float
+    """The amount of the dispute (formatted)."""
+
+    company: Optional[Company] = None
+    """The company the dispute is against."""
+
+    created_at: Optional[datetime] = None
+    """When it was made."""
+
+    currency: Currency
+    """The currency of the dispute."""
+
+    editable: Optional[bool] = None
+    """Whether or not the dispute data can be edited."""
+
+    needs_response_by: Optional[datetime] = None
+    """The last date the dispute is allow to be submitted by."""
+
+    payment: Optional[Payment] = None
+    """The payment that got disputed"""
+
+    plan: Optional[Plan] = None
+    """The plan that got disputed"""
+
+    product: Optional[Product] = None
+    """The product that got disputed"""
+
+    reason: Optional[str] = None
+    """The reason for the dispute"""
+
+    status: DisputeStatuses
+    """The status of the dispute (mimics stripe's dispute status)."""
+
+    visa_rdr: bool
+    """Whether or not the dispute is a Visa Rapid Dispute Resolution."""

whop_sdk/types/dispute_statuses.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["DisputeStatuses"]
+
+DisputeStatuses: TypeAlias = Literal[
+    "warning_needs_response",
+    "warning_under_review",
+    "warning_closed",
+    "needs_response",
+    "under_review",
+    "won",
+    "lost",
+    "closed",
+    "other",
+]

whop_sdk/types/dispute_update_evidence_params.py

@@ -0,0 +1,159 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+__all__ = [
+    "DisputeUpdateEvidenceParams",
+    "CancellationPolicyAttachment",
+    "CancellationPolicyAttachmentAttachmentInputWithDirectUploadID",
+    "CancellationPolicyAttachmentAttachmentInputWithID",
+    "CustomerCommunicationAttachment",
+    "CustomerCommunicationAttachmentAttachmentInputWithDirectUploadID",
+    "CustomerCommunicationAttachmentAttachmentInputWithID",
+    "RefundPolicyAttachment",
+    "RefundPolicyAttachmentAttachmentInputWithDirectUploadID",
+    "RefundPolicyAttachmentAttachmentInputWithID",
+    "UncategorizedAttachment",
+    "UncategorizedAttachmentAttachmentInputWithDirectUploadID",
+    "UncategorizedAttachmentAttachmentInputWithID",
+]
+
+
+class DisputeUpdateEvidenceParams(TypedDict, total=False):
+    access_activity_log: Optional[str]
+    """An IP access log for the user from Whop."""
+
+    billing_address: Optional[str]
+    """The billing address of the user from their payment details."""
+
+    cancellation_policy_attachment: Optional[CancellationPolicyAttachment]
+    """A file containing the cancellation policy from the company."""
+
+    cancellation_policy_disclosure: Optional[str]
+    """A cancellation policy disclosure from the company."""
+
+    customer_communication_attachment: Optional[CustomerCommunicationAttachment]
+    """A file containing the customer communication from the company (An image)."""
+
+    customer_email_address: Optional[str]
+    """The email of the customer from their payment details."""
+
+    customer_name: Optional[str]
+    """The name of the customer from their payment details."""
+
+    notes: Optional[str]
+    """Additional notes the company chooses to submit regarding the dispute."""
+
+    product_description: Optional[str]
+    """The description of the product from the company."""
+
+    refund_policy_attachment: Optional[RefundPolicyAttachment]
+    """A file containing the refund policy from the company."""
+
+    refund_policy_disclosure: Optional[str]
+    """A refund policy disclosure from the company."""
+
+    refund_refusal_explanation: Optional[str]
+    """A description on why the refund is being refused by the company."""
+
+    service_date: Optional[str]
+    """When the product was delivered by the company."""
+
+    uncategorized_attachment: Optional[UncategorizedAttachment]
+    """A file that does not fit in the other categories."""
+
+
+class CancellationPolicyAttachmentAttachmentInputWithDirectUploadID(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 CancellationPolicyAttachmentAttachmentInputWithID(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.
+    """
+
+
+CancellationPolicyAttachment: TypeAlias = Union[
+    CancellationPolicyAttachmentAttachmentInputWithDirectUploadID, CancellationPolicyAttachmentAttachmentInputWithID
+]
+
+
+class CustomerCommunicationAttachmentAttachmentInputWithDirectUploadID(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 CustomerCommunicationAttachmentAttachmentInputWithID(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.
+    """
+
+
+CustomerCommunicationAttachment: TypeAlias = Union[
+    CustomerCommunicationAttachmentAttachmentInputWithDirectUploadID,
+    CustomerCommunicationAttachmentAttachmentInputWithID,
+]
+
+
+class RefundPolicyAttachmentAttachmentInputWithDirectUploadID(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 RefundPolicyAttachmentAttachmentInputWithID(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.
+    """
+
+
+RefundPolicyAttachment: TypeAlias = Union[
+    RefundPolicyAttachmentAttachmentInputWithDirectUploadID, RefundPolicyAttachmentAttachmentInputWithID
+]
+
+
+class UncategorizedAttachmentAttachmentInputWithDirectUploadID(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 UncategorizedAttachmentAttachmentInputWithID(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.
+    """
+
+
+UncategorizedAttachment: TypeAlias = Union[
+    UncategorizedAttachmentAttachmentInputWithDirectUploadID, UncategorizedAttachmentAttachmentInputWithID
+]

whop_sdk/types/dispute_updated_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 .dispute import Dispute
+from .._models import BaseModel
+
+__all__ = ["DisputeUpdatedWebhookEvent"]
+
+
+class DisputeUpdatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Dispute
+    """An object representing a dispute against a company."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["dispute.updated"]
+    """The webhook event type"""

whop_sdk/types/embed_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__ = ["EmbedType"]
+
+EmbedType: TypeAlias = Literal["youtube", "loom"]

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_approved_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.entry import Entry
+
+__all__ = ["EntryApprovedWebhookEvent"]
+
+
+class EntryApprovedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Entry
+    """An object representing an entry in a waitlist."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["entry.approved"]
+    """The webhook event type"""