whop-sdk 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

whop_sdk/resources/reviews.py

@@ -0,0 +1,315 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+
+import httpx
+
+from ..types import review_list_params
+from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from .._utils import maybe_transform
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ..pagination import SyncCursorPage, AsyncCursorPage
+from .._base_client import AsyncPaginator, make_request_options
+from ..types.review_list_response import ReviewListResponse
+from ..types.review_retrieve_response import ReviewRetrieveResponse
+
+__all__ = ["ReviewsResource", "AsyncReviewsResource"]
+
+
+class ReviewsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> ReviewsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
+        """
+        return ReviewsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> ReviewsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
+        """
+        return ReviewsResourceWithStreamingResponse(self)
+
+    def retrieve(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> ReviewRetrieveResponse:
+        """
+        Retrieve a review by its ID
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/reviews/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ReviewRetrieveResponse,
+        )
+
+    def list(
+        self,
+        *,
+        product_id: str,
+        after: Optional[str] | Omit = omit,
+        before: Optional[str] | Omit = omit,
+        first: Optional[int] | Omit = omit,
+        last: Optional[int] | Omit = omit,
+        max_stars: Optional[int] | Omit = omit,
+        min_stars: Optional[int] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> SyncCursorPage[ReviewListResponse]:
+        """
+        List all reviews
+
+        Args:
+          product_id: The ID of the product
+
+          after: Returns the elements in the list that come after the specified cursor.
+
+          before: Returns the elements in the list that come before the specified cursor.
+
+          first: Returns the first _n_ elements from the list.
+
+          last: Returns the last _n_ elements from the list.
+
+          max_stars: The maximum star rating of the review (inclusive)
+
+          min_stars: The minimum star rating of the review (inclusive)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/reviews",
+            page=SyncCursorPage[ReviewListResponse],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "product_id": product_id,
+                        "after": after,
+                        "before": before,
+                        "first": first,
+                        "last": last,
+                        "max_stars": max_stars,
+                        "min_stars": min_stars,
+                    },
+                    review_list_params.ReviewListParams,
+                ),
+            ),
+            model=ReviewListResponse,
+        )
+
+
+class AsyncReviewsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncReviewsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncReviewsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncReviewsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
+        """
+        return AsyncReviewsResourceWithStreamingResponse(self)
+
+    async def retrieve(
+        self,
+        id: str,
+        *,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> ReviewRetrieveResponse:
+        """
+        Retrieve a review by its ID
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/reviews/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ReviewRetrieveResponse,
+        )
+
+    def list(
+        self,
+        *,
+        product_id: str,
+        after: Optional[str] | Omit = omit,
+        before: Optional[str] | Omit = omit,
+        first: Optional[int] | Omit = omit,
+        last: Optional[int] | Omit = omit,
+        max_stars: Optional[int] | Omit = omit,
+        min_stars: Optional[int] | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> AsyncPaginator[ReviewListResponse, AsyncCursorPage[ReviewListResponse]]:
+        """
+        List all reviews
+
+        Args:
+          product_id: The ID of the product
+
+          after: Returns the elements in the list that come after the specified cursor.
+
+          before: Returns the elements in the list that come before the specified cursor.
+
+          first: Returns the first _n_ elements from the list.
+
+          last: Returns the last _n_ elements from the list.
+
+          max_stars: The maximum star rating of the review (inclusive)
+
+          min_stars: The minimum star rating of the review (inclusive)
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._get_api_list(
+            "/reviews",
+            page=AsyncCursorPage[ReviewListResponse],
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform(
+                    {
+                        "product_id": product_id,
+                        "after": after,
+                        "before": before,
+                        "first": first,
+                        "last": last,
+                        "max_stars": max_stars,
+                        "min_stars": min_stars,
+                    },
+                    review_list_params.ReviewListParams,
+                ),
+            ),
+            model=ReviewListResponse,
+        )
+
+
+class ReviewsResourceWithRawResponse:
+    def __init__(self, reviews: ReviewsResource) -> None:
+        self._reviews = reviews
+
+        self.retrieve = to_raw_response_wrapper(
+            reviews.retrieve,
+        )
+        self.list = to_raw_response_wrapper(
+            reviews.list,
+        )
+
+
+class AsyncReviewsResourceWithRawResponse:
+    def __init__(self, reviews: AsyncReviewsResource) -> None:
+        self._reviews = reviews
+
+        self.retrieve = async_to_raw_response_wrapper(
+            reviews.retrieve,
+        )
+        self.list = async_to_raw_response_wrapper(
+            reviews.list,
+        )
+
+
+class ReviewsResourceWithStreamingResponse:
+    def __init__(self, reviews: ReviewsResource) -> None:
+        self._reviews = reviews
+
+        self.retrieve = to_streamed_response_wrapper(
+            reviews.retrieve,
+        )
+        self.list = to_streamed_response_wrapper(
+            reviews.list,
+        )
+
+
+class AsyncReviewsResourceWithStreamingResponse:
+    def __init__(self, reviews: AsyncReviewsResource) -> None:
+        self._reviews = reviews
+
+        self.retrieve = async_to_streamed_response_wrapper(
+            reviews.retrieve,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            reviews.list,
+        )

whop_sdk/types/__init__.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from .course import Course as Course
+from .lesson import Lesson as Lesson
 from .shared import (
     App as App,
     Plan as Plan,
@@ -64,27 +66,44 @@ from .shared import (
     EmailNotificationPreferences as EmailNotificationPreferences,
     CourseLessonInteractionListItem as CourseLessonInteractionListItem,
 )
+from .languages import Languages as Languages
+from .promo_code import PromoCode as PromoCode
+from .card_brands import CardBrands as CardBrands
+from .lesson_types import LessonTypes as LessonTypes
+from .review_status import ReviewStatus as ReviewStatus
+from .course_chapter import CourseChapter as CourseChapter
+from .promo_duration import PromoDuration as PromoDuration
 from .app_list_params import AppListParams as AppListParams
+from .billing_reasons import BillingReasons as BillingReasons
 from .plan_list_params import PlanListParams as PlanListParams
 from .app_create_params import AppCreateParams as AppCreateParams
 from .app_list_response import AppListResponse as AppListResponse
 from .app_update_params import AppUpdateParams as AppUpdateParams
 from .entry_list_params import EntryListParams as EntryListParams
 from .forum_list_params import ForumListParams as ForumListParams
+from .promo_code_status import PromoCodeStatus as PromoCodeStatus
+from .course_list_params import CourseListParams as CourseListParams
 from .member_list_params import MemberListParams as MemberListParams
 from .plan_create_params import PlanCreateParams as PlanCreateParams
 from .plan_list_response import PlanListResponse as PlanListResponse
 from .plan_update_params import PlanUpdateParams as PlanUpdateParams
+from .review_list_params import ReviewListParams as ReviewListParams
 from .entry_list_response import EntryListResponse as EntryListResponse
 from .forum_list_response import ForumListResponse as ForumListResponse
 from .forum_update_params import ForumUpdateParams as ForumUpdateParams
 from .invoice_list_params import InvoiceListParams as InvoiceListParams
+from .lesson_visibilities import LessonVisibilities as LessonVisibilities
 from .message_list_params import MessageListParams as MessageListParams
 from .payment_list_params import PaymentListParams as PaymentListParams
 from .product_list_params import ProductListParams as ProductListParams
+from .course_create_params import CourseCreateParams as CourseCreateParams
+from .course_list_response import CourseListResponse as CourseListResponse
+from .course_update_params import CourseUpdateParams as CourseUpdateParams
 from .member_list_response import MemberListResponse as MemberListResponse
+from .payment_method_types import PaymentMethodTypes as PaymentMethodTypes
 from .plan_delete_response import PlanDeleteResponse as PlanDeleteResponse
 from .reaction_list_params import ReactionListParams as ReactionListParams
+from .review_list_response import ReviewListResponse as ReviewListResponse
 from .shipment_list_params import ShipmentListParams as ShipmentListParams
 from .transfer_list_params import TransferListParams as TransferListParams
 from .unwrap_webhook_event import UnwrapWebhookEvent as UnwrapWebhookEvent
@@ -93,14 +112,17 @@ from .invoice_create_params import InvoiceCreateParams as InvoiceCreateParams
 from .invoice_void_response import InvoiceVoidResponse as InvoiceVoidResponse
 from .message_create_params import MessageCreateParams as MessageCreateParams
 from .message_list_response import MessageListResponse as MessageListResponse
+from .message_update_params import MessageUpdateParams as MessageUpdateParams
 from .payment_list_response import PaymentListResponse as PaymentListResponse
 from .payment_refund_params import PaymentRefundParams as PaymentRefundParams
 from .product_create_params import ProductCreateParams as ProductCreateParams
 from .product_update_params import ProductUpdateParams as ProductUpdateParams
+from .course_delete_response import CourseDeleteResponse as CourseDeleteResponse
 from .entry_approve_response import EntryApproveResponse as EntryApproveResponse
 from .experience_list_params import ExperienceListParams as ExperienceListParams
 from .forum_post_list_params import ForumPostListParams as ForumPostListParams
 from .membership_list_params import MembershipListParams as MembershipListParams
+from .promo_code_list_params import PromoCodeListParams as PromoCodeListParams
 from .reaction_create_params import ReactionCreateParams as ReactionCreateParams
 from .reaction_list_response import ReactionListResponse as ReactionListResponse
 from .shipment_create_params import ShipmentCreateParams as ShipmentCreateParams
@@ -121,28 +143,45 @@ from .experience_list_response import ExperienceListResponse as ExperienceListRe
 from .experience_update_params import ExperienceUpdateParams as ExperienceUpdateParams
 from .forum_post_create_params import ForumPostCreateParams as ForumPostCreateParams
 from .forum_post_list_response import ForumPostListResponse as ForumPostListResponse
+from .forum_post_update_params import ForumPostUpdateParams as ForumPostUpdateParams
 from .member_retrieve_response import MemberRetrieveResponse as MemberRetrieveResponse
 from .membership_cancel_params import MembershipCancelParams as MembershipCancelParams
 from .membership_list_response import MembershipListResponse as MembershipListResponse
 from .membership_update_params import MembershipUpdateParams as MembershipUpdateParams
+from .promo_code_create_params import PromoCodeCreateParams as PromoCodeCreateParams
+from .promo_code_list_response import PromoCodeListResponse as PromoCodeListResponse
+from .review_retrieve_response import ReviewRetrieveResponse as ReviewRetrieveResponse
+from .assessment_question_types import AssessmentQuestionTypes as AssessmentQuestionTypes
+from .course_lesson_list_params import CourseLessonListParams as CourseLessonListParams
 from .chat_channel_list_response import ChatChannelListResponse as ChatChannelListResponse
 from .chat_channel_update_params import ChatChannelUpdateParams as ChatChannelUpdateParams
+from .course_chapter_list_params import CourseChapterListParams as CourseChapterListParams
 from .entry_denied_webhook_event import EntryDeniedWebhookEvent as EntryDeniedWebhookEvent
 from .experience_delete_response import ExperienceDeleteResponse as ExperienceDeleteResponse
 from .invoice_paid_webhook_event import InvoicePaidWebhookEvent as InvoicePaidWebhookEvent
+from .promo_code_delete_response import PromoCodeDeleteResponse as PromoCodeDeleteResponse
 from .user_check_access_response import UserCheckAccessResponse as UserCheckAccessResponse
 from .authorized_user_list_params import AuthorizedUserListParams as AuthorizedUserListParams
+from .course_lesson_create_params import CourseLessonCreateParams as CourseLessonCreateParams
+from .course_lesson_list_response import CourseLessonListResponse as CourseLessonListResponse
+from .course_lesson_update_params import CourseLessonUpdateParams as CourseLessonUpdateParams
 from .entry_created_webhook_event import EntryCreatedWebhookEvent as EntryCreatedWebhookEvent
 from .entry_deleted_webhook_event import EntryDeletedWebhookEvent as EntryDeletedWebhookEvent
+from .experience_duplicate_params import ExperienceDuplicateParams as ExperienceDuplicateParams
 from .support_channel_list_params import SupportChannelListParams as SupportChannelListParams
+from .course_chapter_create_params import CourseChapterCreateParams as CourseChapterCreateParams
+from .course_chapter_list_response import CourseChapterListResponse as CourseChapterListResponse
+from .course_chapter_update_params import CourseChapterUpdateParams as CourseChapterUpdateParams
 from .entry_approved_webhook_event import EntryApprovedWebhookEvent as EntryApprovedWebhookEvent
 from .invoice_voided_webhook_event import InvoiceVoidedWebhookEvent as InvoiceVoidedWebhookEvent
 from .payment_failed_webhook_event import PaymentFailedWebhookEvent as PaymentFailedWebhookEvent
 from .authorized_user_list_response import AuthorizedUserListResponse as AuthorizedUserListResponse
+from .course_lesson_delete_response import CourseLessonDeleteResponse as CourseLessonDeleteResponse
 from .invoice_created_webhook_event import InvoiceCreatedWebhookEvent as InvoiceCreatedWebhookEvent
 from .payment_pending_webhook_event import PaymentPendingWebhookEvent as PaymentPendingWebhookEvent
 from .support_channel_create_params import SupportChannelCreateParams as SupportChannelCreateParams
 from .support_channel_list_response import SupportChannelListResponse as SupportChannelListResponse
+from .course_chapter_delete_response import CourseChapterDeleteResponse as CourseChapterDeleteResponse
 from .invoice_past_due_webhook_event import InvoicePastDueWebhookEvent as InvoicePastDueWebhookEvent
 from .payment_succeeded_webhook_event import PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent
 from .ledger_account_retrieve_response import LedgerAccountRetrieveResponse as LedgerAccountRetrieveResponse

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/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,24 @@
+# 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",
+    "unknown",
+]

whop_sdk/types/checkout_configuration_create_params.py

@@ -9,9 +9,12 @@ from .shared.currency import Currency
 from .shared.tax_type import TaxType
 from .shared.plan_type import PlanType
 from .shared.visibility import Visibility
+from .shared.business_types import BusinessTypes
+from .shared.industry_types import IndustryTypes
 from .shared.release_method import ReleaseMethod
+from .shared.global_affiliate_status import GlobalAffiliateStatus
 
-__all__ = ["CheckoutConfigurationCreateParams", "Plan", "PlanCustomField", "PlanImage"]
+__all__ = ["CheckoutConfigurationCreateParams", "Plan", "PlanCustomField", "PlanImage", "PlanProduct"]
 
 
 class CheckoutConfigurationCreateParams(TypedDict, total=False):
@@ -67,6 +70,59 @@ class PlanImage(TypedDict, total=False):
     """
 
 
+class PlanProduct(TypedDict, total=False):
+    external_identifier: Required[str]
+    """A unique ID used to find or create a product.
+
+    When provided during creation, we will look for an existing product with this
+    external identifier — if found, it will be updated; otherwise, a new product
+    will be created.
+    """
+
+    title: Required[str]
+    """The title of the product."""
+
+    business_type: Optional[BusinessTypes]
+    """The different business types a company can be."""
+
+    collect_shipping_address: Optional[bool]
+    """Whether or not to collect shipping information at checkout from the customer."""
+
+    custom_statement_descriptor: Optional[str]
+    """The custom statement descriptor for the product i.e.
+
+    WHOP\\**SPORTS, must be between 5 and 22 characters, contain at least one letter,
+    and not contain any of the following characters: <, >, \\,, ', "
+    """
+
+    description: Optional[str]
+    """A written description of the product."""
+
+    global_affiliate_percentage: Optional[float]
+    """The percentage of the revenue that goes to the global affiliate program."""
+
+    global_affiliate_status: Optional[GlobalAffiliateStatus]
+    """The different statuses of the global affiliate program for an access pass."""
+
+    headline: Optional[str]
+    """The headline of the product."""
+
+    industry_type: Optional[IndustryTypes]
+    """The different industry types a company can be in."""
+
+    product_tax_code_id: Optional[str]
+    """The ID of the product tax code to apply to this product."""
+
+    redirect_purchase_url: Optional[str]
+    """The URL to redirect the customer to after a purchase."""
+
+    route: Optional[str]
+    """The route of the product."""
+
+    visibility: Optional[Visibility]
+    """Visibility of a resource"""
+
+
 class Plan(TypedDict, total=False):
     company_id: Required[str]
     """The company the plan should be created for."""
@@ -110,8 +166,15 @@ class Plan(TypedDict, total=False):
     plan_type: Optional[PlanType]
     """The type of plan that can be attached to an access pass"""
 
+    product: Optional[PlanProduct]
+    """Pass this object to create a new product for this plan.
+
+    We will use the product external identifier to find or create an existing
+    product.
+    """
+
     product_id: Optional[str]
-    """The product the plan is related to."""
+    """The product the plan is related to. Either this or product is required."""
 
     release_method: Optional[ReleaseMethod]
     """The methods of how a plan can be released."""

whop_sdk/types/checkout_configuration_list_response.py

@@ -60,7 +60,10 @@ class CheckoutConfigurationListResponse(BaseModel):
     """The plan to use for the checkout configuration"""
 
     purchase_url: str
-    """The URL to redirect the user to after the checkout configuration is created"""
+    """A URL you can send to customers to complete a checkout.
+
+    It looks like `/checkout/plan_xxxx?session={id}`
+    """
 
     redirect_url: Optional[str] = None
     """The URL to redirect the user to after the checkout configuration is created"""