whop-sdk 0.0.10__py3-none-any.whl

whop_sdk/types/forum_post_update_params.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+from .forum_post_visibility_type import ForumPostVisibilityType
+
+__all__ = [
+    "ForumPostUpdateParams",
+    "Attachment",
+    "AttachmentAttachmentInputWithDirectUploadID",
+    "AttachmentAttachmentInputWithID",
+]
+
+
+class ForumPostUpdateParams(TypedDict, total=False):
+    attachments: Optional[Iterable[Attachment]]
+    """The attachments for this post"""
+
+    content: Optional[str]
+    """This is the main body of the post in Markdown format.
+
+    Hidden if paywalled and user hasn't purchased access to it.
+    """
+
+    is_pinned: Optional[bool]
+    """Whether the post is pinned. You can only pin a top level posts (not comments)."""
+
+    title: Optional[str]
+    """The title of the post. Only visible if paywalled."""
+
+    visibility: Optional[ForumPostVisibilityType]
+    """The visibility types for forum posts"""
+
+
+class AttachmentAttachmentInputWithDirectUploadID(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 AttachmentAttachmentInputWithID(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.
+    """
+
+
+Attachment: TypeAlias = Union[AttachmentAttachmentInputWithDirectUploadID, AttachmentAttachmentInputWithID]

whop_sdk/types/forum_post_visibility_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__ = ["ForumPostVisibilityType"]
+
+ForumPostVisibilityType: TypeAlias = Literal["members_only", "globally_visible"]

whop_sdk/types/forum_update_params.py

@@ -0,0 +1,23 @@
+# 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 .shared.who_can_post_types import WhoCanPostTypes
+from .shared.who_can_comment_types import WhoCanCommentTypes
+from .shared.email_notification_preferences import EmailNotificationPreferences
+
+__all__ = ["ForumUpdateParams"]
+
+
+class ForumUpdateParams(TypedDict, total=False):
+    email_notification_preference: Optional[EmailNotificationPreferences]
+    """Email notification preference option for a forum feed"""
+
+    who_can_comment: Optional[WhoCanCommentTypes]
+    """Who can comment on a forum feed"""
+
+    who_can_post: Optional[WhoCanPostTypes]
+    """Who can post on a forum feed"""

whop_sdk/types/invoice_create_params.py

@@ -0,0 +1,515 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
+
+from .._utils import PropertyInfo
+from .shared.plan_type import PlanType
+from .shared.visibility import Visibility
+from .shared.release_method import ReleaseMethod
+from .shared.collection_method import CollectionMethod
+
+__all__ = [
+    "InvoiceCreateParams",
+    "CreateInvoiceInputWithProductAndMemberID",
+    "CreateInvoiceInputWithProductAndMemberIDPlan",
+    "CreateInvoiceInputWithProductAndMemberIDPlanCustomField",
+    "CreateInvoiceInputWithProductAndMemberIDProduct",
+    "CreateInvoiceInputWithProductAndEmailAddress",
+    "CreateInvoiceInputWithProductAndEmailAddressPlan",
+    "CreateInvoiceInputWithProductAndEmailAddressPlanCustomField",
+    "CreateInvoiceInputWithProductAndEmailAddressProduct",
+    "CreateInvoiceInputWithProductIDAndMemberID",
+    "CreateInvoiceInputWithProductIDAndMemberIDPlan",
+    "CreateInvoiceInputWithProductIDAndMemberIDPlanCustomField",
+    "CreateInvoiceInputWithProductIDAndEmailAddress",
+    "CreateInvoiceInputWithProductIDAndEmailAddressPlan",
+    "CreateInvoiceInputWithProductIDAndEmailAddressPlanCustomField",
+]
+
+
+class CreateInvoiceInputWithProductAndMemberID(TypedDict, total=False):
+    collection_method: Required[CollectionMethod]
+    """The method of collection for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+    company_id: Required[str]
+    """The company ID to create this invoice for."""
+
+    due_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """The date the invoice is due, if applicable."""
+
+    member_id: Required[str]
+    """The member ID to create this invoice for.
+
+    Include this if you want to create an invoice for an existing member. If you do
+    not have a member ID, you must provide an email_address and customer_name.
+    """
+
+    plan: Required[CreateInvoiceInputWithProductAndMemberIDPlan]
+    """The properties of the plan to create for this invoice."""
+
+    product: Required[CreateInvoiceInputWithProductAndMemberIDProduct]
+    """The properties of the product to create for this invoice.
+
+    Include this if you want to create an invoice for a new product.
+    """
+
+    charge_buyer_fee: Optional[bool]
+    """Whether or not to charge the customer a buyer fee."""
+
+    customer_name: Optional[str]
+    """The name of the customer to create this invoice for.
+
+    This is required if you want to create an invoice for a customer who does not
+    have a member of your company yet.
+    """
+
+    payment_token_id: Optional[str]
+    """The payment token ID to use for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+
+class CreateInvoiceInputWithProductAndMemberIDPlanCustomField(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 CreateInvoiceInputWithProductAndMemberIDPlan(TypedDict, total=False):
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    custom_fields: Optional[Iterable[CreateInvoiceInputWithProductAndMemberIDPlanCustomField]]
+    """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)."""
+
+    initial_price: Optional[float]
+    """An additional amount charged upon first purchase.
+
+    Use only if a one time payment OR you want to charge an additional amount on top
+    of the renewal price. Provided as a number in dollars. Eg: 10.43 for $10.43
+    """
+
+    internal_notes: Optional[str]
+    """A personal description or notes section for the business."""
+
+    plan_type: Optional[PlanType]
+    """The type of plan that can be attached to a product"""
+
+    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.
+
+    Use only if a recurring payment. Provided as a number in dollars. Eg: 10.43 for
+    $10.43
+    """
+
+    stock: Optional[int]
+    """The number of units available for purchase."""
+
+    trial_period_days: Optional[int]
+    """The number of free trial days added before a renewal plan."""
+
+    unlimited_stock: Optional[bool]
+    """Limits/doesn't limit the number of units available for purchase."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+class CreateInvoiceInputWithProductAndMemberIDProduct(TypedDict, total=False):
+    title: Required[str]
+    """The title of the product."""
+
+    product_tax_code_id: Optional[str]
+    """The ID of the product tax code to apply to this product."""
+
+
+class CreateInvoiceInputWithProductAndEmailAddress(TypedDict, total=False):
+    collection_method: Required[CollectionMethod]
+    """The method of collection for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+    company_id: Required[str]
+    """The company ID to create this invoice for."""
+
+    due_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """The date the invoice is due, if applicable."""
+
+    email_address: Required[str]
+    """The email address to create this invoice for.
+
+    This is required if you want to create an invoice for a user who does not have a
+    member of your company yet.
+    """
+
+    plan: Required[CreateInvoiceInputWithProductAndEmailAddressPlan]
+    """The properties of the plan to create for this invoice."""
+
+    product: Required[CreateInvoiceInputWithProductAndEmailAddressProduct]
+    """The properties of the product to create for this invoice.
+
+    Include this if you want to create an invoice for a new product.
+    """
+
+    charge_buyer_fee: Optional[bool]
+    """Whether or not to charge the customer a buyer fee."""
+
+    customer_name: Optional[str]
+    """The name of the customer to create this invoice for.
+
+    This is required if you want to create an invoice for a customer who does not
+    have a member of your company yet.
+    """
+
+    payment_token_id: Optional[str]
+    """The payment token ID to use for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+
+class CreateInvoiceInputWithProductAndEmailAddressPlanCustomField(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 CreateInvoiceInputWithProductAndEmailAddressPlan(TypedDict, total=False):
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    custom_fields: Optional[Iterable[CreateInvoiceInputWithProductAndEmailAddressPlanCustomField]]
+    """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)."""
+
+    initial_price: Optional[float]
+    """An additional amount charged upon first purchase.
+
+    Use only if a one time payment OR you want to charge an additional amount on top
+    of the renewal price. Provided as a number in dollars. Eg: 10.43 for $10.43
+    """
+
+    internal_notes: Optional[str]
+    """A personal description or notes section for the business."""
+
+    plan_type: Optional[PlanType]
+    """The type of plan that can be attached to a product"""
+
+    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.
+
+    Use only if a recurring payment. Provided as a number in dollars. Eg: 10.43 for
+    $10.43
+    """
+
+    stock: Optional[int]
+    """The number of units available for purchase."""
+
+    trial_period_days: Optional[int]
+    """The number of free trial days added before a renewal plan."""
+
+    unlimited_stock: Optional[bool]
+    """Limits/doesn't limit the number of units available for purchase."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+class CreateInvoiceInputWithProductAndEmailAddressProduct(TypedDict, total=False):
+    title: Required[str]
+    """The title of the product."""
+
+    product_tax_code_id: Optional[str]
+    """The ID of the product tax code to apply to this product."""
+
+
+class CreateInvoiceInputWithProductIDAndMemberID(TypedDict, total=False):
+    collection_method: Required[CollectionMethod]
+    """The method of collection for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+    company_id: Required[str]
+    """The company ID to create this invoice for."""
+
+    due_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """The date the invoice is due, if applicable."""
+
+    member_id: Required[str]
+    """The member ID to create this invoice for.
+
+    Include this if you want to create an invoice for an existing member. If you do
+    not have a member ID, you must provide an email_address and customer_name.
+    """
+
+    plan: Required[CreateInvoiceInputWithProductIDAndMemberIDPlan]
+    """The properties of the plan to create for this invoice."""
+
+    product_id: Required[str]
+    """The product ID to create this invoice for.
+
+    Include this if you want to create an invoice for an existing product.
+    """
+
+    charge_buyer_fee: Optional[bool]
+    """Whether or not to charge the customer a buyer fee."""
+
+    customer_name: Optional[str]
+    """The name of the customer to create this invoice for.
+
+    This is required if you want to create an invoice for a customer who does not
+    have a member of your company yet.
+    """
+
+    payment_token_id: Optional[str]
+    """The payment token ID to use for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+
+class CreateInvoiceInputWithProductIDAndMemberIDPlanCustomField(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 CreateInvoiceInputWithProductIDAndMemberIDPlan(TypedDict, total=False):
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    custom_fields: Optional[Iterable[CreateInvoiceInputWithProductIDAndMemberIDPlanCustomField]]
+    """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)."""
+
+    initial_price: Optional[float]
+    """An additional amount charged upon first purchase.
+
+    Use only if a one time payment OR you want to charge an additional amount on top
+    of the renewal price. Provided as a number in dollars. Eg: 10.43 for $10.43
+    """
+
+    internal_notes: Optional[str]
+    """A personal description or notes section for the business."""
+
+    plan_type: Optional[PlanType]
+    """The type of plan that can be attached to a product"""
+
+    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.
+
+    Use only if a recurring payment. Provided as a number in dollars. Eg: 10.43 for
+    $10.43
+    """
+
+    stock: Optional[int]
+    """The number of units available for purchase."""
+
+    trial_period_days: Optional[int]
+    """The number of free trial days added before a renewal plan."""
+
+    unlimited_stock: Optional[bool]
+    """Limits/doesn't limit the number of units available for purchase."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+class CreateInvoiceInputWithProductIDAndEmailAddress(TypedDict, total=False):
+    collection_method: Required[CollectionMethod]
+    """The method of collection for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+    company_id: Required[str]
+    """The company ID to create this invoice for."""
+
+    due_date: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """The date the invoice is due, if applicable."""
+
+    email_address: Required[str]
+    """The email address to create this invoice for.
+
+    This is required if you want to create an invoice for a user who does not have a
+    member of your company yet.
+    """
+
+    plan: Required[CreateInvoiceInputWithProductIDAndEmailAddressPlan]
+    """The properties of the plan to create for this invoice."""
+
+    product_id: Required[str]
+    """The product ID to create this invoice for.
+
+    Include this if you want to create an invoice for an existing product.
+    """
+
+    charge_buyer_fee: Optional[bool]
+    """Whether or not to charge the customer a buyer fee."""
+
+    customer_name: Optional[str]
+    """The name of the customer to create this invoice for.
+
+    This is required if you want to create an invoice for a customer who does not
+    have a member of your company yet.
+    """
+
+    payment_token_id: Optional[str]
+    """The payment token ID to use for this invoice.
+
+    If using charge_automatically, you must provide a payment_token.
+    """
+
+
+class CreateInvoiceInputWithProductIDAndEmailAddressPlanCustomField(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 CreateInvoiceInputWithProductIDAndEmailAddressPlan(TypedDict, total=False):
+    billing_period: Optional[int]
+    """The interval at which the plan charges (renewal plans)."""
+
+    custom_fields: Optional[Iterable[CreateInvoiceInputWithProductIDAndEmailAddressPlanCustomField]]
+    """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)."""
+
+    initial_price: Optional[float]
+    """An additional amount charged upon first purchase.
+
+    Use only if a one time payment OR you want to charge an additional amount on top
+    of the renewal price. Provided as a number in dollars. Eg: 10.43 for $10.43
+    """
+
+    internal_notes: Optional[str]
+    """A personal description or notes section for the business."""
+
+    plan_type: Optional[PlanType]
+    """The type of plan that can be attached to a product"""
+
+    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.
+
+    Use only if a recurring payment. Provided as a number in dollars. Eg: 10.43 for
+    $10.43
+    """
+
+    stock: Optional[int]
+    """The number of units available for purchase."""
+
+    trial_period_days: Optional[int]
+    """The number of free trial days added before a renewal plan."""
+
+    unlimited_stock: Optional[bool]
+    """Limits/doesn't limit the number of units available for purchase."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
+InvoiceCreateParams: TypeAlias = Union[
+    CreateInvoiceInputWithProductAndMemberID,
+    CreateInvoiceInputWithProductAndEmailAddress,
+    CreateInvoiceInputWithProductIDAndMemberID,
+    CreateInvoiceInputWithProductIDAndEmailAddress,
+]

whop_sdk/types/invoice_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 .._models import BaseModel
+from .shared.invoice import Invoice
+
+__all__ = ["InvoiceCreatedWebhookEvent"]
+
+
+class InvoiceCreatedWebhookEvent(BaseModel):
+    id: str
+    """A unique ID for every single webhook request"""
+
+    api_version: Literal["v1"]
+    """The API version for this webhook"""
+
+    data: Invoice
+    """A statement that defines an amount due by a customer."""
+
+    timestamp: datetime
+    """The timestamp in ISO 8601 format that the webhook was sent at on the server"""
+
+    type: Literal["invoice.created"]
+    """The webhook event type"""

whop_sdk/types/invoice_list_params.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+from .shared.direction import Direction
+from .shared.invoice_status import InvoiceStatus
+from .shared.collection_method import CollectionMethod
+
+__all__ = ["InvoiceListParams"]
+
+
+class InvoiceListParams(TypedDict, total=False):
+    company_id: Required[str]
+    """The ID of the company to list invoices 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."""
+
+    collection_methods: Optional[List[CollectionMethod]]
+    """Filter invoices by their collection method"""
+
+    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."""
+
+    order: Optional[Literal["id", "created_at", "due_date"]]
+    """Which columns can be used to sort."""
+
+    product_ids: Optional[SequenceNotStr[str]]
+    """Return only invoices created for these specific product ids"""
+
+    statuses: Optional[List[InvoiceStatus]]
+    """The statuses to filter the invoices by"""