whop-sdk 0.0.10__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- whop_sdk/__init__.py +94 -0
- whop_sdk/_base_client.py +1995 -0
- whop_sdk/_client.py +800 -0
- whop_sdk/_compat.py +219 -0
- whop_sdk/_constants.py +14 -0
- whop_sdk/_exceptions.py +112 -0
- whop_sdk/_files.py +123 -0
- whop_sdk/_models.py +857 -0
- whop_sdk/_qs.py +150 -0
- whop_sdk/_resource.py +43 -0
- whop_sdk/_response.py +830 -0
- whop_sdk/_streaming.py +333 -0
- whop_sdk/_types.py +260 -0
- whop_sdk/_utils/__init__.py +64 -0
- whop_sdk/_utils/_compat.py +45 -0
- whop_sdk/_utils/_datetime_parse.py +136 -0
- whop_sdk/_utils/_logs.py +25 -0
- whop_sdk/_utils/_proxy.py +65 -0
- whop_sdk/_utils/_reflection.py +42 -0
- whop_sdk/_utils/_resources_proxy.py +24 -0
- whop_sdk/_utils/_streams.py +12 -0
- whop_sdk/_utils/_sync.py +58 -0
- whop_sdk/_utils/_transform.py +457 -0
- whop_sdk/_utils/_typing.py +156 -0
- whop_sdk/_utils/_utils.py +421 -0
- whop_sdk/_version.py +4 -0
- whop_sdk/lib/.keep +4 -0
- whop_sdk/pagination.py +61 -0
- whop_sdk/py.typed +0 -0
- whop_sdk/resources/__init__.py +540 -0
- whop_sdk/resources/access_tokens.py +341 -0
- whop_sdk/resources/account_links.py +211 -0
- whop_sdk/resources/app_builds.py +587 -0
- whop_sdk/resources/apps.py +684 -0
- whop_sdk/resources/authorized_users.py +353 -0
- whop_sdk/resources/chat_channels.py +469 -0
- whop_sdk/resources/checkout_configurations.py +776 -0
- whop_sdk/resources/companies.py +465 -0
- whop_sdk/resources/course_chapters.py +602 -0
- whop_sdk/resources/course_lesson_interactions.py +343 -0
- whop_sdk/resources/course_lessons.py +1040 -0
- whop_sdk/resources/course_students.py +327 -0
- whop_sdk/resources/courses.py +776 -0
- whop_sdk/resources/disputes.py +693 -0
- whop_sdk/resources/entries.py +556 -0
- whop_sdk/resources/experiences.py +983 -0
- whop_sdk/resources/forum_posts.py +656 -0
- whop_sdk/resources/forums.py +446 -0
- whop_sdk/resources/invoices.py +1099 -0
- whop_sdk/resources/ledger_accounts.py +171 -0
- whop_sdk/resources/members.py +429 -0
- whop_sdk/resources/memberships.py +818 -0
- whop_sdk/resources/messages.py +558 -0
- whop_sdk/resources/notifications.py +388 -0
- whop_sdk/resources/payment_tokens.py +359 -0
- whop_sdk/resources/payments.py +1040 -0
- whop_sdk/resources/plans.py +1001 -0
- whop_sdk/resources/products.py +970 -0
- whop_sdk/resources/promo_codes.py +668 -0
- whop_sdk/resources/reactions.py +423 -0
- whop_sdk/resources/refunds.py +347 -0
- whop_sdk/resources/reviews.py +332 -0
- whop_sdk/resources/setup_intents.py +349 -0
- whop_sdk/resources/shipments.py +451 -0
- whop_sdk/resources/support_channels.py +455 -0
- whop_sdk/resources/transfers.py +513 -0
- whop_sdk/resources/users.py +248 -0
- whop_sdk/resources/webhooks.py +69 -0
- whop_sdk/resources/withdrawals.py +341 -0
- whop_sdk/types/__init__.py +262 -0
- whop_sdk/types/access_token_create_params.py +64 -0
- whop_sdk/types/access_token_create_response.py +15 -0
- whop_sdk/types/account_link_create_params.py +27 -0
- whop_sdk/types/account_link_create_response.py +15 -0
- whop_sdk/types/app_build_create_params.py +72 -0
- whop_sdk/types/app_build_list_params.py +42 -0
- whop_sdk/types/app_build_list_response.py +50 -0
- whop_sdk/types/app_create_params.py +19 -0
- whop_sdk/types/app_list_params.py +59 -0
- whop_sdk/types/app_list_response.py +110 -0
- whop_sdk/types/app_type.py +7 -0
- whop_sdk/types/app_update_params.py +67 -0
- whop_sdk/types/assessment_question_types.py +7 -0
- whop_sdk/types/authorized_user_list_params.py +41 -0
- whop_sdk/types/authorized_user_list_response.py +33 -0
- whop_sdk/types/authorized_user_retrieve_response.py +33 -0
- whop_sdk/types/billing_reasons.py +9 -0
- whop_sdk/types/card_brands.py +25 -0
- whop_sdk/types/chat_channel_list_params.py +28 -0
- whop_sdk/types/chat_channel_list_response.py +43 -0
- whop_sdk/types/chat_channel_update_params.py +32 -0
- whop_sdk/types/checkout_configuration_create_params.py +373 -0
- whop_sdk/types/checkout_configuration_list_params.py +41 -0
- whop_sdk/types/checkout_configuration_list_response.py +104 -0
- whop_sdk/types/checkout_modes.py +7 -0
- whop_sdk/types/company_create_params.py +22 -0
- whop_sdk/types/company_list_params.py +38 -0
- whop_sdk/types/company_list_response.py +76 -0
- whop_sdk/types/course.py +122 -0
- whop_sdk/types/course_chapter.py +32 -0
- whop_sdk/types/course_chapter_create_params.py +16 -0
- whop_sdk/types/course_chapter_delete_response.py +7 -0
- whop_sdk/types/course_chapter_list_params.py +25 -0
- whop_sdk/types/course_chapter_list_response.py +16 -0
- whop_sdk/types/course_chapter_update_params.py +12 -0
- whop_sdk/types/course_create_params.py +78 -0
- whop_sdk/types/course_delete_response.py +7 -0
- whop_sdk/types/course_lesson_create_params.py +63 -0
- whop_sdk/types/course_lesson_delete_response.py +7 -0
- whop_sdk/types/course_lesson_interaction_completed_webhook_event.py +26 -0
- whop_sdk/types/course_lesson_interaction_list_params.py +34 -0
- whop_sdk/types/course_lesson_list_params.py +28 -0
- whop_sdk/types/course_lesson_list_response.py +57 -0
- whop_sdk/types/course_lesson_mark_as_completed_response.py +7 -0
- whop_sdk/types/course_lesson_start_response.py +7 -0
- whop_sdk/types/course_lesson_submit_assessment_params.py +26 -0
- whop_sdk/types/course_lesson_submit_assessment_response.py +62 -0
- whop_sdk/types/course_lesson_update_params.py +222 -0
- whop_sdk/types/course_list_params.py +28 -0
- whop_sdk/types/course_list_response.py +90 -0
- whop_sdk/types/course_student_list_params.py +28 -0
- whop_sdk/types/course_student_list_response.py +42 -0
- whop_sdk/types/course_student_retrieve_response.py +61 -0
- whop_sdk/types/course_update_params.py +114 -0
- whop_sdk/types/course_visibilities.py +7 -0
- whop_sdk/types/dispute.py +284 -0
- whop_sdk/types/dispute_created_webhook_event.py +26 -0
- whop_sdk/types/dispute_list_params.py +38 -0
- whop_sdk/types/dispute_list_response.py +77 -0
- whop_sdk/types/dispute_statuses.py +17 -0
- whop_sdk/types/dispute_update_evidence_params.py +159 -0
- whop_sdk/types/dispute_updated_webhook_event.py +26 -0
- whop_sdk/types/embed_type.py +7 -0
- whop_sdk/types/entry_approve_response.py +10 -0
- whop_sdk/types/entry_approved_webhook_event.py +26 -0
- whop_sdk/types/entry_created_webhook_event.py +26 -0
- whop_sdk/types/entry_deleted_webhook_event.py +26 -0
- whop_sdk/types/entry_denied_webhook_event.py +26 -0
- whop_sdk/types/entry_list_params.py +52 -0
- whop_sdk/types/entry_list_response.py +56 -0
- whop_sdk/types/experience_attach_params.py +12 -0
- whop_sdk/types/experience_create_params.py +22 -0
- whop_sdk/types/experience_delete_response.py +7 -0
- whop_sdk/types/experience_detach_params.py +12 -0
- whop_sdk/types/experience_duplicate_params.py +13 -0
- whop_sdk/types/experience_list_params.py +40 -0
- whop_sdk/types/experience_list_response.py +73 -0
- whop_sdk/types/experience_update_params.py +46 -0
- whop_sdk/types/forum_list_params.py +28 -0
- whop_sdk/types/forum_list_response.py +33 -0
- whop_sdk/types/forum_post_create_params.py +101 -0
- whop_sdk/types/forum_post_list_params.py +31 -0
- whop_sdk/types/forum_post_list_response.py +60 -0
- whop_sdk/types/forum_post_update_params.py +56 -0
- whop_sdk/types/forum_post_visibility_type.py +7 -0
- whop_sdk/types/forum_update_params.py +23 -0
- whop_sdk/types/invoice_create_params.py +515 -0
- whop_sdk/types/invoice_created_webhook_event.py +26 -0
- whop_sdk/types/invoice_list_params.py +53 -0
- whop_sdk/types/invoice_paid_webhook_event.py +26 -0
- whop_sdk/types/invoice_past_due_webhook_event.py +26 -0
- whop_sdk/types/invoice_void_response.py +7 -0
- whop_sdk/types/invoice_voided_webhook_event.py +26 -0
- whop_sdk/types/languages.py +30 -0
- whop_sdk/types/ledger_account_retrieve_response.py +93 -0
- whop_sdk/types/lesson.py +219 -0
- whop_sdk/types/lesson_types.py +7 -0
- whop_sdk/types/lesson_visibilities.py +7 -0
- whop_sdk/types/member_list_params.py +73 -0
- whop_sdk/types/member_list_response.py +65 -0
- whop_sdk/types/member_retrieve_response.py +79 -0
- whop_sdk/types/membership_activated_webhook_event.py +29 -0
- whop_sdk/types/membership_cancel_params.py +13 -0
- whop_sdk/types/membership_deactivated_webhook_event.py +29 -0
- whop_sdk/types/membership_list_params.py +73 -0
- whop_sdk/types/membership_list_response.py +128 -0
- whop_sdk/types/membership_pause_params.py +16 -0
- whop_sdk/types/membership_update_params.py +13 -0
- whop_sdk/types/message_create_params.py +63 -0
- whop_sdk/types/message_list_params.py +30 -0
- whop_sdk/types/message_list_response.py +90 -0
- whop_sdk/types/message_update_params.py +45 -0
- whop_sdk/types/notification_create_params.py +93 -0
- whop_sdk/types/notification_create_response.py +10 -0
- whop_sdk/types/payment_create_params.py +162 -0
- whop_sdk/types/payment_failed_webhook_event.py +26 -0
- whop_sdk/types/payment_list_params.py +67 -0
- whop_sdk/types/payment_list_response.py +273 -0
- whop_sdk/types/payment_method_types.py +94 -0
- whop_sdk/types/payment_pending_webhook_event.py +26 -0
- whop_sdk/types/payment_provider.py +9 -0
- whop_sdk/types/payment_refund_params.py +13 -0
- whop_sdk/types/payment_succeeded_webhook_event.py +26 -0
- whop_sdk/types/payment_token_list_params.py +38 -0
- whop_sdk/types/payment_token_list_response.py +41 -0
- whop_sdk/types/payment_token_retrieve_params.py +12 -0
- whop_sdk/types/payment_token_retrieve_response.py +41 -0
- whop_sdk/types/plan_create_params.py +162 -0
- whop_sdk/types/plan_delete_response.py +7 -0
- whop_sdk/types/plan_list_params.py +57 -0
- whop_sdk/types/plan_list_response.py +128 -0
- whop_sdk/types/plan_update_params.py +155 -0
- whop_sdk/types/product_create_params.py +147 -0
- whop_sdk/types/product_delete_response.py +7 -0
- whop_sdk/types/product_list_params.py +49 -0
- whop_sdk/types/product_update_params.py +82 -0
- whop_sdk/types/promo_code.py +90 -0
- whop_sdk/types/promo_code_create_params.py +70 -0
- whop_sdk/types/promo_code_delete_response.py +7 -0
- whop_sdk/types/promo_code_list_params.py +45 -0
- whop_sdk/types/promo_code_list_response.py +79 -0
- whop_sdk/types/promo_code_status.py +7 -0
- whop_sdk/types/promo_duration.py +7 -0
- whop_sdk/types/reaction_create_params.py +19 -0
- whop_sdk/types/reaction_list_params.py +25 -0
- whop_sdk/types/reaction_list_response.py +32 -0
- whop_sdk/types/refund_created_webhook_event.py +154 -0
- whop_sdk/types/refund_list_params.py +38 -0
- whop_sdk/types/refund_list_response.py +53 -0
- whop_sdk/types/refund_reference_status.py +7 -0
- whop_sdk/types/refund_reference_type.py +9 -0
- whop_sdk/types/refund_retrieve_response.py +129 -0
- whop_sdk/types/refund_status.py +7 -0
- whop_sdk/types/refund_updated_webhook_event.py +154 -0
- whop_sdk/types/review_list_params.py +40 -0
- whop_sdk/types/review_list_response.py +78 -0
- whop_sdk/types/review_retrieve_response.py +103 -0
- whop_sdk/types/review_status.py +7 -0
- whop_sdk/types/setup_intent.py +111 -0
- whop_sdk/types/setup_intent_canceled_webhook_event.py +29 -0
- whop_sdk/types/setup_intent_list_params.py +38 -0
- whop_sdk/types/setup_intent_list_response.py +111 -0
- whop_sdk/types/setup_intent_requires_action_webhook_event.py +29 -0
- whop_sdk/types/setup_intent_status.py +7 -0
- whop_sdk/types/setup_intent_succeeded_webhook_event.py +29 -0
- whop_sdk/types/shared/__init__.py +62 -0
- whop_sdk/types/shared/access_level.py +7 -0
- whop_sdk/types/shared/access_pass_type.py +7 -0
- whop_sdk/types/shared/app.py +187 -0
- whop_sdk/types/shared/app_build.py +50 -0
- whop_sdk/types/shared/app_build_platforms.py +7 -0
- whop_sdk/types/shared/app_build_statuses.py +7 -0
- whop_sdk/types/shared/app_statuses.py +7 -0
- whop_sdk/types/shared/app_view_type.py +7 -0
- whop_sdk/types/shared/authorized_user_roles.py +9 -0
- whop_sdk/types/shared/business_types.py +22 -0
- whop_sdk/types/shared/chat_channel.py +43 -0
- whop_sdk/types/shared/checkout_configuration.py +104 -0
- whop_sdk/types/shared/collection_method.py +7 -0
- whop_sdk/types/shared/company.py +91 -0
- whop_sdk/types/shared/course_lesson_interaction.py +63 -0
- whop_sdk/types/shared/course_lesson_interaction_list_item.py +44 -0
- whop_sdk/types/shared/currency.py +93 -0
- whop_sdk/types/shared/custom_cta.py +21 -0
- whop_sdk/types/shared/direction.py +7 -0
- whop_sdk/types/shared/dms_post_types.py +7 -0
- whop_sdk/types/shared/email_notification_preferences.py +7 -0
- whop_sdk/types/shared/entry.py +70 -0
- whop_sdk/types/shared/entry_status.py +7 -0
- whop_sdk/types/shared/experience.py +91 -0
- whop_sdk/types/shared/forum.py +33 -0
- whop_sdk/types/shared/forum_post.py +60 -0
- whop_sdk/types/shared/friendly_receipt_status.py +24 -0
- whop_sdk/types/shared/global_affiliate_status.py +7 -0
- whop_sdk/types/shared/industry_types.py +67 -0
- whop_sdk/types/shared/invoice.py +64 -0
- whop_sdk/types/shared/invoice_list_item.py +64 -0
- whop_sdk/types/shared/invoice_status.py +7 -0
- whop_sdk/types/shared/member_most_recent_actions.py +22 -0
- whop_sdk/types/shared/member_statuses.py +7 -0
- whop_sdk/types/shared/membership.py +128 -0
- whop_sdk/types/shared/membership_status.py +9 -0
- whop_sdk/types/shared/message.py +90 -0
- whop_sdk/types/shared/page_info.py +21 -0
- whop_sdk/types/shared/payment.py +273 -0
- whop_sdk/types/shared/plan.py +159 -0
- whop_sdk/types/shared/plan_type.py +7 -0
- whop_sdk/types/shared/product.py +132 -0
- whop_sdk/types/shared/product_list_item.py +57 -0
- whop_sdk/types/shared/promo_type.py +7 -0
- whop_sdk/types/shared/reaction.py +32 -0
- whop_sdk/types/shared/receipt_status.py +7 -0
- whop_sdk/types/shared/release_method.py +7 -0
- whop_sdk/types/shared/shipment.py +48 -0
- whop_sdk/types/shared/shipment_carrier.py +84 -0
- whop_sdk/types/shared/shipment_status.py +18 -0
- whop_sdk/types/shared/shipment_substatus.py +36 -0
- whop_sdk/types/shared/support_channel.py +39 -0
- whop_sdk/types/shared/tax_type.py +7 -0
- whop_sdk/types/shared/transfer.py +112 -0
- whop_sdk/types/shared/visibility.py +7 -0
- whop_sdk/types/shared/visibility_filter.py +9 -0
- whop_sdk/types/shared/who_can_comment_types.py +7 -0
- whop_sdk/types/shared/who_can_post.py +7 -0
- whop_sdk/types/shared/who_can_post_types.py +7 -0
- whop_sdk/types/shared/who_can_react.py +7 -0
- whop_sdk/types/shared_params/__init__.py +34 -0
- whop_sdk/types/shared_params/access_level.py +9 -0
- whop_sdk/types/shared_params/access_pass_type.py +9 -0
- whop_sdk/types/shared_params/app_build_platforms.py +9 -0
- whop_sdk/types/shared_params/app_build_statuses.py +9 -0
- whop_sdk/types/shared_params/app_statuses.py +9 -0
- whop_sdk/types/shared_params/app_view_type.py +9 -0
- whop_sdk/types/shared_params/authorized_user_roles.py +11 -0
- whop_sdk/types/shared_params/business_types.py +24 -0
- whop_sdk/types/shared_params/collection_method.py +9 -0
- whop_sdk/types/shared_params/currency.py +95 -0
- whop_sdk/types/shared_params/custom_cta.py +23 -0
- whop_sdk/types/shared_params/direction.py +9 -0
- whop_sdk/types/shared_params/email_notification_preferences.py +9 -0
- whop_sdk/types/shared_params/entry_status.py +9 -0
- whop_sdk/types/shared_params/friendly_receipt_status.py +26 -0
- whop_sdk/types/shared_params/global_affiliate_status.py +9 -0
- whop_sdk/types/shared_params/industry_types.py +69 -0
- whop_sdk/types/shared_params/invoice_status.py +9 -0
- whop_sdk/types/shared_params/member_most_recent_actions.py +24 -0
- whop_sdk/types/shared_params/member_statuses.py +9 -0
- whop_sdk/types/shared_params/membership_status.py +11 -0
- whop_sdk/types/shared_params/plan_type.py +9 -0
- whop_sdk/types/shared_params/promo_type.py +9 -0
- whop_sdk/types/shared_params/receipt_status.py +9 -0
- whop_sdk/types/shared_params/release_method.py +9 -0
- whop_sdk/types/shared_params/tax_type.py +9 -0
- whop_sdk/types/shared_params/visibility.py +9 -0
- whop_sdk/types/shared_params/visibility_filter.py +11 -0
- whop_sdk/types/shared_params/who_can_comment_types.py +9 -0
- whop_sdk/types/shared_params/who_can_post.py +9 -0
- whop_sdk/types/shared_params/who_can_post_types.py +9 -0
- whop_sdk/types/shared_params/who_can_react.py +9 -0
- whop_sdk/types/shipment_create_params.py +18 -0
- whop_sdk/types/shipment_list_params.py +31 -0
- whop_sdk/types/shipment_list_response.py +48 -0
- whop_sdk/types/support_channel_create_params.py +15 -0
- whop_sdk/types/support_channel_list_params.py +40 -0
- whop_sdk/types/support_channel_list_response.py +39 -0
- whop_sdk/types/transfer_create_params.py +39 -0
- whop_sdk/types/transfer_list_params.py +50 -0
- whop_sdk/types/transfer_list_response.py +38 -0
- whop_sdk/types/unwrap_webhook_event.py +52 -0
- whop_sdk/types/user_check_access_response.py +14 -0
- whop_sdk/types/user_retrieve_response.py +36 -0
- whop_sdk/types/withdrawal_fee_types.py +7 -0
- whop_sdk/types/withdrawal_list_params.py +38 -0
- whop_sdk/types/withdrawal_list_response.py +45 -0
- whop_sdk/types/withdrawal_retrieve_response.py +154 -0
- whop_sdk/types/withdrawal_speeds.py +7 -0
- whop_sdk/types/withdrawal_status.py +9 -0
- whop_sdk/types/withdrawal_types.py +7 -0
- whop_sdk-0.0.10.dist-info/METADATA +509 -0
- whop_sdk-0.0.10.dist-info/RECORD +352 -0
- whop_sdk-0.0.10.dist-info/WHEEL +4 -0
- whop_sdk-0.0.10.dist-info/licenses/LICENSE +201 -0
|
@@ -0,0 +1,818 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import Dict, List, Union, Optional
|
|
6
|
+
from datetime import datetime
|
|
7
|
+
from typing_extensions import Literal
|
|
8
|
+
|
|
9
|
+
import httpx
|
|
10
|
+
|
|
11
|
+
from ..types import (
|
|
12
|
+
membership_list_params,
|
|
13
|
+
membership_pause_params,
|
|
14
|
+
membership_cancel_params,
|
|
15
|
+
membership_update_params,
|
|
16
|
+
)
|
|
17
|
+
from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
|
|
18
|
+
from .._utils import maybe_transform, async_maybe_transform
|
|
19
|
+
from .._compat import cached_property
|
|
20
|
+
from .._resource import SyncAPIResource, AsyncAPIResource
|
|
21
|
+
from .._response import (
|
|
22
|
+
to_raw_response_wrapper,
|
|
23
|
+
to_streamed_response_wrapper,
|
|
24
|
+
async_to_raw_response_wrapper,
|
|
25
|
+
async_to_streamed_response_wrapper,
|
|
26
|
+
)
|
|
27
|
+
from ..pagination import SyncCursorPage, AsyncCursorPage
|
|
28
|
+
from .._base_client import AsyncPaginator, make_request_options
|
|
29
|
+
from ..types.shared.direction import Direction
|
|
30
|
+
from ..types.shared.membership import Membership
|
|
31
|
+
from ..types.membership_list_response import MembershipListResponse
|
|
32
|
+
from ..types.shared.membership_status import MembershipStatus
|
|
33
|
+
|
|
34
|
+
__all__ = ["MembershipsResource", "AsyncMembershipsResource"]
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class MembershipsResource(SyncAPIResource):
|
|
38
|
+
@cached_property
|
|
39
|
+
def with_raw_response(self) -> MembershipsResourceWithRawResponse:
|
|
40
|
+
"""
|
|
41
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
42
|
+
the raw response object instead of the parsed content.
|
|
43
|
+
|
|
44
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
|
|
45
|
+
"""
|
|
46
|
+
return MembershipsResourceWithRawResponse(self)
|
|
47
|
+
|
|
48
|
+
@cached_property
|
|
49
|
+
def with_streaming_response(self) -> MembershipsResourceWithStreamingResponse:
|
|
50
|
+
"""
|
|
51
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
52
|
+
|
|
53
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
|
|
54
|
+
"""
|
|
55
|
+
return MembershipsResourceWithStreamingResponse(self)
|
|
56
|
+
|
|
57
|
+
def retrieve(
|
|
58
|
+
self,
|
|
59
|
+
id: str,
|
|
60
|
+
*,
|
|
61
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
62
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
63
|
+
extra_headers: Headers | None = None,
|
|
64
|
+
extra_query: Query | None = None,
|
|
65
|
+
extra_body: Body | None = None,
|
|
66
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
67
|
+
) -> Membership:
|
|
68
|
+
"""
|
|
69
|
+
Retrieves a membership by ID or license key
|
|
70
|
+
|
|
71
|
+
Required permissions:
|
|
72
|
+
|
|
73
|
+
- `member:basic:read`
|
|
74
|
+
|
|
75
|
+
Args:
|
|
76
|
+
extra_headers: Send extra headers
|
|
77
|
+
|
|
78
|
+
extra_query: Add additional query parameters to the request
|
|
79
|
+
|
|
80
|
+
extra_body: Add additional JSON properties to the request
|
|
81
|
+
|
|
82
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
83
|
+
"""
|
|
84
|
+
if not id:
|
|
85
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
86
|
+
return self._get(
|
|
87
|
+
f"/memberships/{id}",
|
|
88
|
+
options=make_request_options(
|
|
89
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
90
|
+
),
|
|
91
|
+
cast_to=Membership,
|
|
92
|
+
)
|
|
93
|
+
|
|
94
|
+
def update(
|
|
95
|
+
self,
|
|
96
|
+
id: str,
|
|
97
|
+
*,
|
|
98
|
+
metadata: Optional[Dict[str, object]] | Omit = omit,
|
|
99
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
100
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
101
|
+
extra_headers: Headers | None = None,
|
|
102
|
+
extra_query: Query | None = None,
|
|
103
|
+
extra_body: Body | None = None,
|
|
104
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
105
|
+
) -> Membership:
|
|
106
|
+
"""
|
|
107
|
+
Update a membership
|
|
108
|
+
|
|
109
|
+
Required permissions:
|
|
110
|
+
|
|
111
|
+
- `member:manage`
|
|
112
|
+
- `member:basic:read`
|
|
113
|
+
|
|
114
|
+
Args:
|
|
115
|
+
metadata: The metadata to update the membership with.
|
|
116
|
+
|
|
117
|
+
extra_headers: Send extra headers
|
|
118
|
+
|
|
119
|
+
extra_query: Add additional query parameters to the request
|
|
120
|
+
|
|
121
|
+
extra_body: Add additional JSON properties to the request
|
|
122
|
+
|
|
123
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
124
|
+
"""
|
|
125
|
+
if not id:
|
|
126
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
127
|
+
return self._patch(
|
|
128
|
+
f"/memberships/{id}",
|
|
129
|
+
body=maybe_transform({"metadata": metadata}, membership_update_params.MembershipUpdateParams),
|
|
130
|
+
options=make_request_options(
|
|
131
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
132
|
+
),
|
|
133
|
+
cast_to=Membership,
|
|
134
|
+
)
|
|
135
|
+
|
|
136
|
+
def list(
|
|
137
|
+
self,
|
|
138
|
+
*,
|
|
139
|
+
after: Optional[str] | Omit = omit,
|
|
140
|
+
before: Optional[str] | Omit = omit,
|
|
141
|
+
cancel_options: Optional[
|
|
142
|
+
List[
|
|
143
|
+
Literal[
|
|
144
|
+
"too_expensive",
|
|
145
|
+
"switching",
|
|
146
|
+
"missing_features",
|
|
147
|
+
"technical_issues",
|
|
148
|
+
"bad_experience",
|
|
149
|
+
"other",
|
|
150
|
+
"testing",
|
|
151
|
+
]
|
|
152
|
+
]
|
|
153
|
+
]
|
|
154
|
+
| Omit = omit,
|
|
155
|
+
company_id: Optional[str] | Omit = omit,
|
|
156
|
+
created_after: Union[str, datetime, None] | Omit = omit,
|
|
157
|
+
created_before: Union[str, datetime, None] | Omit = omit,
|
|
158
|
+
direction: Optional[Direction] | Omit = omit,
|
|
159
|
+
first: Optional[int] | Omit = omit,
|
|
160
|
+
last: Optional[int] | Omit = omit,
|
|
161
|
+
order: Optional[Literal["id", "created_at", "status", "canceled_at", "date_joined", "total_spend"]]
|
|
162
|
+
| Omit = omit,
|
|
163
|
+
plan_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
164
|
+
product_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
165
|
+
promo_code_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
166
|
+
statuses: Optional[List[MembershipStatus]] | Omit = omit,
|
|
167
|
+
user_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
168
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
169
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
170
|
+
extra_headers: Headers | None = None,
|
|
171
|
+
extra_query: Query | None = None,
|
|
172
|
+
extra_body: Body | None = None,
|
|
173
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
174
|
+
) -> SyncCursorPage[MembershipListResponse]:
|
|
175
|
+
"""
|
|
176
|
+
Lists memberships
|
|
177
|
+
|
|
178
|
+
Required permissions:
|
|
179
|
+
|
|
180
|
+
- `member:basic:read`
|
|
181
|
+
|
|
182
|
+
Args:
|
|
183
|
+
after: Returns the elements in the list that come after the specified cursor.
|
|
184
|
+
|
|
185
|
+
before: Returns the elements in the list that come before the specified cursor.
|
|
186
|
+
|
|
187
|
+
cancel_options: The cancel options to filter the memberships by
|
|
188
|
+
|
|
189
|
+
company_id: The ID of the company to list memberships for
|
|
190
|
+
|
|
191
|
+
created_after: The minimum creation date to filter by
|
|
192
|
+
|
|
193
|
+
created_before: The maximum creation date to filter by
|
|
194
|
+
|
|
195
|
+
direction: The direction of the sort.
|
|
196
|
+
|
|
197
|
+
first: Returns the first _n_ elements from the list.
|
|
198
|
+
|
|
199
|
+
last: Returns the last _n_ elements from the list.
|
|
200
|
+
|
|
201
|
+
order: Which columns can be used to sort.
|
|
202
|
+
|
|
203
|
+
plan_ids: The plan IDs to filter the memberships by
|
|
204
|
+
|
|
205
|
+
product_ids: The product IDs to filter the memberships by
|
|
206
|
+
|
|
207
|
+
promo_code_ids: The promo code IDs to filter the memberships by
|
|
208
|
+
|
|
209
|
+
statuses: The membership status to filter the memberships by
|
|
210
|
+
|
|
211
|
+
user_ids: Only return memberships from these whop user ids
|
|
212
|
+
|
|
213
|
+
extra_headers: Send extra headers
|
|
214
|
+
|
|
215
|
+
extra_query: Add additional query parameters to the request
|
|
216
|
+
|
|
217
|
+
extra_body: Add additional JSON properties to the request
|
|
218
|
+
|
|
219
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
220
|
+
"""
|
|
221
|
+
return self._get_api_list(
|
|
222
|
+
"/memberships",
|
|
223
|
+
page=SyncCursorPage[MembershipListResponse],
|
|
224
|
+
options=make_request_options(
|
|
225
|
+
extra_headers=extra_headers,
|
|
226
|
+
extra_query=extra_query,
|
|
227
|
+
extra_body=extra_body,
|
|
228
|
+
timeout=timeout,
|
|
229
|
+
query=maybe_transform(
|
|
230
|
+
{
|
|
231
|
+
"after": after,
|
|
232
|
+
"before": before,
|
|
233
|
+
"cancel_options": cancel_options,
|
|
234
|
+
"company_id": company_id,
|
|
235
|
+
"created_after": created_after,
|
|
236
|
+
"created_before": created_before,
|
|
237
|
+
"direction": direction,
|
|
238
|
+
"first": first,
|
|
239
|
+
"last": last,
|
|
240
|
+
"order": order,
|
|
241
|
+
"plan_ids": plan_ids,
|
|
242
|
+
"product_ids": product_ids,
|
|
243
|
+
"promo_code_ids": promo_code_ids,
|
|
244
|
+
"statuses": statuses,
|
|
245
|
+
"user_ids": user_ids,
|
|
246
|
+
},
|
|
247
|
+
membership_list_params.MembershipListParams,
|
|
248
|
+
),
|
|
249
|
+
),
|
|
250
|
+
model=MembershipListResponse,
|
|
251
|
+
)
|
|
252
|
+
|
|
253
|
+
def cancel(
|
|
254
|
+
self,
|
|
255
|
+
id: str,
|
|
256
|
+
*,
|
|
257
|
+
cancellation_mode: Optional[Literal["at_period_end", "immediate"]] | Omit = omit,
|
|
258
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
259
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
260
|
+
extra_headers: Headers | None = None,
|
|
261
|
+
extra_query: Query | None = None,
|
|
262
|
+
extra_body: Body | None = None,
|
|
263
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
264
|
+
) -> Membership:
|
|
265
|
+
"""
|
|
266
|
+
Cancels a membership either immediately or at the end of the current billing
|
|
267
|
+
period
|
|
268
|
+
|
|
269
|
+
Required permissions:
|
|
270
|
+
|
|
271
|
+
- `member:manage`
|
|
272
|
+
- `member:basic:read`
|
|
273
|
+
|
|
274
|
+
Args:
|
|
275
|
+
cancellation_mode: The mode of cancellation for a membership
|
|
276
|
+
|
|
277
|
+
extra_headers: Send extra headers
|
|
278
|
+
|
|
279
|
+
extra_query: Add additional query parameters to the request
|
|
280
|
+
|
|
281
|
+
extra_body: Add additional JSON properties to the request
|
|
282
|
+
|
|
283
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
284
|
+
"""
|
|
285
|
+
if not id:
|
|
286
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
287
|
+
return self._post(
|
|
288
|
+
f"/memberships/{id}/cancel",
|
|
289
|
+
body=maybe_transform(
|
|
290
|
+
{"cancellation_mode": cancellation_mode}, membership_cancel_params.MembershipCancelParams
|
|
291
|
+
),
|
|
292
|
+
options=make_request_options(
|
|
293
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
294
|
+
),
|
|
295
|
+
cast_to=Membership,
|
|
296
|
+
)
|
|
297
|
+
|
|
298
|
+
def pause(
|
|
299
|
+
self,
|
|
300
|
+
id: str,
|
|
301
|
+
*,
|
|
302
|
+
void_payments: Optional[bool] | Omit = omit,
|
|
303
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
304
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
305
|
+
extra_headers: Headers | None = None,
|
|
306
|
+
extra_query: Query | None = None,
|
|
307
|
+
extra_body: Body | None = None,
|
|
308
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
309
|
+
) -> Membership:
|
|
310
|
+
"""
|
|
311
|
+
Pauses a membership's payments
|
|
312
|
+
|
|
313
|
+
Required permissions:
|
|
314
|
+
|
|
315
|
+
- `member:manage`
|
|
316
|
+
- `member:basic:read`
|
|
317
|
+
|
|
318
|
+
Args:
|
|
319
|
+
void_payments: Whether to void past_due payments associated with the membership to prevent
|
|
320
|
+
future payment attempts.
|
|
321
|
+
|
|
322
|
+
extra_headers: Send extra headers
|
|
323
|
+
|
|
324
|
+
extra_query: Add additional query parameters to the request
|
|
325
|
+
|
|
326
|
+
extra_body: Add additional JSON properties to the request
|
|
327
|
+
|
|
328
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
329
|
+
"""
|
|
330
|
+
if not id:
|
|
331
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
332
|
+
return self._post(
|
|
333
|
+
f"/memberships/{id}/pause",
|
|
334
|
+
body=maybe_transform({"void_payments": void_payments}, membership_pause_params.MembershipPauseParams),
|
|
335
|
+
options=make_request_options(
|
|
336
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
337
|
+
),
|
|
338
|
+
cast_to=Membership,
|
|
339
|
+
)
|
|
340
|
+
|
|
341
|
+
def resume(
|
|
342
|
+
self,
|
|
343
|
+
id: str,
|
|
344
|
+
*,
|
|
345
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
346
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
347
|
+
extra_headers: Headers | None = None,
|
|
348
|
+
extra_query: Query | None = None,
|
|
349
|
+
extra_body: Body | None = None,
|
|
350
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
351
|
+
) -> Membership:
|
|
352
|
+
"""
|
|
353
|
+
Resumes a membership's payments
|
|
354
|
+
|
|
355
|
+
Required permissions:
|
|
356
|
+
|
|
357
|
+
- `member:manage`
|
|
358
|
+
- `member:basic:read`
|
|
359
|
+
|
|
360
|
+
Args:
|
|
361
|
+
extra_headers: Send extra headers
|
|
362
|
+
|
|
363
|
+
extra_query: Add additional query parameters to the request
|
|
364
|
+
|
|
365
|
+
extra_body: Add additional JSON properties to the request
|
|
366
|
+
|
|
367
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
368
|
+
"""
|
|
369
|
+
if not id:
|
|
370
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
371
|
+
return self._post(
|
|
372
|
+
f"/memberships/{id}/resume",
|
|
373
|
+
options=make_request_options(
|
|
374
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
375
|
+
),
|
|
376
|
+
cast_to=Membership,
|
|
377
|
+
)
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
class AsyncMembershipsResource(AsyncAPIResource):
|
|
381
|
+
@cached_property
|
|
382
|
+
def with_raw_response(self) -> AsyncMembershipsResourceWithRawResponse:
|
|
383
|
+
"""
|
|
384
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
385
|
+
the raw response object instead of the parsed content.
|
|
386
|
+
|
|
387
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
|
|
388
|
+
"""
|
|
389
|
+
return AsyncMembershipsResourceWithRawResponse(self)
|
|
390
|
+
|
|
391
|
+
@cached_property
|
|
392
|
+
def with_streaming_response(self) -> AsyncMembershipsResourceWithStreamingResponse:
|
|
393
|
+
"""
|
|
394
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
395
|
+
|
|
396
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
|
|
397
|
+
"""
|
|
398
|
+
return AsyncMembershipsResourceWithStreamingResponse(self)
|
|
399
|
+
|
|
400
|
+
async def retrieve(
|
|
401
|
+
self,
|
|
402
|
+
id: str,
|
|
403
|
+
*,
|
|
404
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
405
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
406
|
+
extra_headers: Headers | None = None,
|
|
407
|
+
extra_query: Query | None = None,
|
|
408
|
+
extra_body: Body | None = None,
|
|
409
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
410
|
+
) -> Membership:
|
|
411
|
+
"""
|
|
412
|
+
Retrieves a membership by ID or license key
|
|
413
|
+
|
|
414
|
+
Required permissions:
|
|
415
|
+
|
|
416
|
+
- `member:basic:read`
|
|
417
|
+
|
|
418
|
+
Args:
|
|
419
|
+
extra_headers: Send extra headers
|
|
420
|
+
|
|
421
|
+
extra_query: Add additional query parameters to the request
|
|
422
|
+
|
|
423
|
+
extra_body: Add additional JSON properties to the request
|
|
424
|
+
|
|
425
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
426
|
+
"""
|
|
427
|
+
if not id:
|
|
428
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
429
|
+
return await self._get(
|
|
430
|
+
f"/memberships/{id}",
|
|
431
|
+
options=make_request_options(
|
|
432
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
433
|
+
),
|
|
434
|
+
cast_to=Membership,
|
|
435
|
+
)
|
|
436
|
+
|
|
437
|
+
async def update(
|
|
438
|
+
self,
|
|
439
|
+
id: str,
|
|
440
|
+
*,
|
|
441
|
+
metadata: Optional[Dict[str, object]] | Omit = omit,
|
|
442
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
443
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
444
|
+
extra_headers: Headers | None = None,
|
|
445
|
+
extra_query: Query | None = None,
|
|
446
|
+
extra_body: Body | None = None,
|
|
447
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
448
|
+
) -> Membership:
|
|
449
|
+
"""
|
|
450
|
+
Update a membership
|
|
451
|
+
|
|
452
|
+
Required permissions:
|
|
453
|
+
|
|
454
|
+
- `member:manage`
|
|
455
|
+
- `member:basic:read`
|
|
456
|
+
|
|
457
|
+
Args:
|
|
458
|
+
metadata: The metadata to update the membership with.
|
|
459
|
+
|
|
460
|
+
extra_headers: Send extra headers
|
|
461
|
+
|
|
462
|
+
extra_query: Add additional query parameters to the request
|
|
463
|
+
|
|
464
|
+
extra_body: Add additional JSON properties to the request
|
|
465
|
+
|
|
466
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
467
|
+
"""
|
|
468
|
+
if not id:
|
|
469
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
470
|
+
return await self._patch(
|
|
471
|
+
f"/memberships/{id}",
|
|
472
|
+
body=await async_maybe_transform({"metadata": metadata}, membership_update_params.MembershipUpdateParams),
|
|
473
|
+
options=make_request_options(
|
|
474
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
475
|
+
),
|
|
476
|
+
cast_to=Membership,
|
|
477
|
+
)
|
|
478
|
+
|
|
479
|
+
def list(
|
|
480
|
+
self,
|
|
481
|
+
*,
|
|
482
|
+
after: Optional[str] | Omit = omit,
|
|
483
|
+
before: Optional[str] | Omit = omit,
|
|
484
|
+
cancel_options: Optional[
|
|
485
|
+
List[
|
|
486
|
+
Literal[
|
|
487
|
+
"too_expensive",
|
|
488
|
+
"switching",
|
|
489
|
+
"missing_features",
|
|
490
|
+
"technical_issues",
|
|
491
|
+
"bad_experience",
|
|
492
|
+
"other",
|
|
493
|
+
"testing",
|
|
494
|
+
]
|
|
495
|
+
]
|
|
496
|
+
]
|
|
497
|
+
| Omit = omit,
|
|
498
|
+
company_id: Optional[str] | Omit = omit,
|
|
499
|
+
created_after: Union[str, datetime, None] | Omit = omit,
|
|
500
|
+
created_before: Union[str, datetime, None] | Omit = omit,
|
|
501
|
+
direction: Optional[Direction] | Omit = omit,
|
|
502
|
+
first: Optional[int] | Omit = omit,
|
|
503
|
+
last: Optional[int] | Omit = omit,
|
|
504
|
+
order: Optional[Literal["id", "created_at", "status", "canceled_at", "date_joined", "total_spend"]]
|
|
505
|
+
| Omit = omit,
|
|
506
|
+
plan_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
507
|
+
product_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
508
|
+
promo_code_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
509
|
+
statuses: Optional[List[MembershipStatus]] | Omit = omit,
|
|
510
|
+
user_ids: Optional[SequenceNotStr[str]] | Omit = omit,
|
|
511
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
512
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
513
|
+
extra_headers: Headers | None = None,
|
|
514
|
+
extra_query: Query | None = None,
|
|
515
|
+
extra_body: Body | None = None,
|
|
516
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
517
|
+
) -> AsyncPaginator[MembershipListResponse, AsyncCursorPage[MembershipListResponse]]:
|
|
518
|
+
"""
|
|
519
|
+
Lists memberships
|
|
520
|
+
|
|
521
|
+
Required permissions:
|
|
522
|
+
|
|
523
|
+
- `member:basic:read`
|
|
524
|
+
|
|
525
|
+
Args:
|
|
526
|
+
after: Returns the elements in the list that come after the specified cursor.
|
|
527
|
+
|
|
528
|
+
before: Returns the elements in the list that come before the specified cursor.
|
|
529
|
+
|
|
530
|
+
cancel_options: The cancel options to filter the memberships by
|
|
531
|
+
|
|
532
|
+
company_id: The ID of the company to list memberships for
|
|
533
|
+
|
|
534
|
+
created_after: The minimum creation date to filter by
|
|
535
|
+
|
|
536
|
+
created_before: The maximum creation date to filter by
|
|
537
|
+
|
|
538
|
+
direction: The direction of the sort.
|
|
539
|
+
|
|
540
|
+
first: Returns the first _n_ elements from the list.
|
|
541
|
+
|
|
542
|
+
last: Returns the last _n_ elements from the list.
|
|
543
|
+
|
|
544
|
+
order: Which columns can be used to sort.
|
|
545
|
+
|
|
546
|
+
plan_ids: The plan IDs to filter the memberships by
|
|
547
|
+
|
|
548
|
+
product_ids: The product IDs to filter the memberships by
|
|
549
|
+
|
|
550
|
+
promo_code_ids: The promo code IDs to filter the memberships by
|
|
551
|
+
|
|
552
|
+
statuses: The membership status to filter the memberships by
|
|
553
|
+
|
|
554
|
+
user_ids: Only return memberships from these whop user ids
|
|
555
|
+
|
|
556
|
+
extra_headers: Send extra headers
|
|
557
|
+
|
|
558
|
+
extra_query: Add additional query parameters to the request
|
|
559
|
+
|
|
560
|
+
extra_body: Add additional JSON properties to the request
|
|
561
|
+
|
|
562
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
563
|
+
"""
|
|
564
|
+
return self._get_api_list(
|
|
565
|
+
"/memberships",
|
|
566
|
+
page=AsyncCursorPage[MembershipListResponse],
|
|
567
|
+
options=make_request_options(
|
|
568
|
+
extra_headers=extra_headers,
|
|
569
|
+
extra_query=extra_query,
|
|
570
|
+
extra_body=extra_body,
|
|
571
|
+
timeout=timeout,
|
|
572
|
+
query=maybe_transform(
|
|
573
|
+
{
|
|
574
|
+
"after": after,
|
|
575
|
+
"before": before,
|
|
576
|
+
"cancel_options": cancel_options,
|
|
577
|
+
"company_id": company_id,
|
|
578
|
+
"created_after": created_after,
|
|
579
|
+
"created_before": created_before,
|
|
580
|
+
"direction": direction,
|
|
581
|
+
"first": first,
|
|
582
|
+
"last": last,
|
|
583
|
+
"order": order,
|
|
584
|
+
"plan_ids": plan_ids,
|
|
585
|
+
"product_ids": product_ids,
|
|
586
|
+
"promo_code_ids": promo_code_ids,
|
|
587
|
+
"statuses": statuses,
|
|
588
|
+
"user_ids": user_ids,
|
|
589
|
+
},
|
|
590
|
+
membership_list_params.MembershipListParams,
|
|
591
|
+
),
|
|
592
|
+
),
|
|
593
|
+
model=MembershipListResponse,
|
|
594
|
+
)
|
|
595
|
+
|
|
596
|
+
async def cancel(
|
|
597
|
+
self,
|
|
598
|
+
id: str,
|
|
599
|
+
*,
|
|
600
|
+
cancellation_mode: Optional[Literal["at_period_end", "immediate"]] | Omit = omit,
|
|
601
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
602
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
603
|
+
extra_headers: Headers | None = None,
|
|
604
|
+
extra_query: Query | None = None,
|
|
605
|
+
extra_body: Body | None = None,
|
|
606
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
607
|
+
) -> Membership:
|
|
608
|
+
"""
|
|
609
|
+
Cancels a membership either immediately or at the end of the current billing
|
|
610
|
+
period
|
|
611
|
+
|
|
612
|
+
Required permissions:
|
|
613
|
+
|
|
614
|
+
- `member:manage`
|
|
615
|
+
- `member:basic:read`
|
|
616
|
+
|
|
617
|
+
Args:
|
|
618
|
+
cancellation_mode: The mode of cancellation for a membership
|
|
619
|
+
|
|
620
|
+
extra_headers: Send extra headers
|
|
621
|
+
|
|
622
|
+
extra_query: Add additional query parameters to the request
|
|
623
|
+
|
|
624
|
+
extra_body: Add additional JSON properties to the request
|
|
625
|
+
|
|
626
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
627
|
+
"""
|
|
628
|
+
if not id:
|
|
629
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
630
|
+
return await self._post(
|
|
631
|
+
f"/memberships/{id}/cancel",
|
|
632
|
+
body=await async_maybe_transform(
|
|
633
|
+
{"cancellation_mode": cancellation_mode}, membership_cancel_params.MembershipCancelParams
|
|
634
|
+
),
|
|
635
|
+
options=make_request_options(
|
|
636
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
637
|
+
),
|
|
638
|
+
cast_to=Membership,
|
|
639
|
+
)
|
|
640
|
+
|
|
641
|
+
async def pause(
|
|
642
|
+
self,
|
|
643
|
+
id: str,
|
|
644
|
+
*,
|
|
645
|
+
void_payments: Optional[bool] | Omit = omit,
|
|
646
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
647
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
648
|
+
extra_headers: Headers | None = None,
|
|
649
|
+
extra_query: Query | None = None,
|
|
650
|
+
extra_body: Body | None = None,
|
|
651
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
652
|
+
) -> Membership:
|
|
653
|
+
"""
|
|
654
|
+
Pauses a membership's payments
|
|
655
|
+
|
|
656
|
+
Required permissions:
|
|
657
|
+
|
|
658
|
+
- `member:manage`
|
|
659
|
+
- `member:basic:read`
|
|
660
|
+
|
|
661
|
+
Args:
|
|
662
|
+
void_payments: Whether to void past_due payments associated with the membership to prevent
|
|
663
|
+
future payment attempts.
|
|
664
|
+
|
|
665
|
+
extra_headers: Send extra headers
|
|
666
|
+
|
|
667
|
+
extra_query: Add additional query parameters to the request
|
|
668
|
+
|
|
669
|
+
extra_body: Add additional JSON properties to the request
|
|
670
|
+
|
|
671
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
672
|
+
"""
|
|
673
|
+
if not id:
|
|
674
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
675
|
+
return await self._post(
|
|
676
|
+
f"/memberships/{id}/pause",
|
|
677
|
+
body=await async_maybe_transform(
|
|
678
|
+
{"void_payments": void_payments}, membership_pause_params.MembershipPauseParams
|
|
679
|
+
),
|
|
680
|
+
options=make_request_options(
|
|
681
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
682
|
+
),
|
|
683
|
+
cast_to=Membership,
|
|
684
|
+
)
|
|
685
|
+
|
|
686
|
+
async def resume(
|
|
687
|
+
self,
|
|
688
|
+
id: str,
|
|
689
|
+
*,
|
|
690
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
691
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
692
|
+
extra_headers: Headers | None = None,
|
|
693
|
+
extra_query: Query | None = None,
|
|
694
|
+
extra_body: Body | None = None,
|
|
695
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
696
|
+
) -> Membership:
|
|
697
|
+
"""
|
|
698
|
+
Resumes a membership's payments
|
|
699
|
+
|
|
700
|
+
Required permissions:
|
|
701
|
+
|
|
702
|
+
- `member:manage`
|
|
703
|
+
- `member:basic:read`
|
|
704
|
+
|
|
705
|
+
Args:
|
|
706
|
+
extra_headers: Send extra headers
|
|
707
|
+
|
|
708
|
+
extra_query: Add additional query parameters to the request
|
|
709
|
+
|
|
710
|
+
extra_body: Add additional JSON properties to the request
|
|
711
|
+
|
|
712
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
713
|
+
"""
|
|
714
|
+
if not id:
|
|
715
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
716
|
+
return await self._post(
|
|
717
|
+
f"/memberships/{id}/resume",
|
|
718
|
+
options=make_request_options(
|
|
719
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
720
|
+
),
|
|
721
|
+
cast_to=Membership,
|
|
722
|
+
)
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
class MembershipsResourceWithRawResponse:
|
|
726
|
+
def __init__(self, memberships: MembershipsResource) -> None:
|
|
727
|
+
self._memberships = memberships
|
|
728
|
+
|
|
729
|
+
self.retrieve = to_raw_response_wrapper(
|
|
730
|
+
memberships.retrieve,
|
|
731
|
+
)
|
|
732
|
+
self.update = to_raw_response_wrapper(
|
|
733
|
+
memberships.update,
|
|
734
|
+
)
|
|
735
|
+
self.list = to_raw_response_wrapper(
|
|
736
|
+
memberships.list,
|
|
737
|
+
)
|
|
738
|
+
self.cancel = to_raw_response_wrapper(
|
|
739
|
+
memberships.cancel,
|
|
740
|
+
)
|
|
741
|
+
self.pause = to_raw_response_wrapper(
|
|
742
|
+
memberships.pause,
|
|
743
|
+
)
|
|
744
|
+
self.resume = to_raw_response_wrapper(
|
|
745
|
+
memberships.resume,
|
|
746
|
+
)
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
class AsyncMembershipsResourceWithRawResponse:
|
|
750
|
+
def __init__(self, memberships: AsyncMembershipsResource) -> None:
|
|
751
|
+
self._memberships = memberships
|
|
752
|
+
|
|
753
|
+
self.retrieve = async_to_raw_response_wrapper(
|
|
754
|
+
memberships.retrieve,
|
|
755
|
+
)
|
|
756
|
+
self.update = async_to_raw_response_wrapper(
|
|
757
|
+
memberships.update,
|
|
758
|
+
)
|
|
759
|
+
self.list = async_to_raw_response_wrapper(
|
|
760
|
+
memberships.list,
|
|
761
|
+
)
|
|
762
|
+
self.cancel = async_to_raw_response_wrapper(
|
|
763
|
+
memberships.cancel,
|
|
764
|
+
)
|
|
765
|
+
self.pause = async_to_raw_response_wrapper(
|
|
766
|
+
memberships.pause,
|
|
767
|
+
)
|
|
768
|
+
self.resume = async_to_raw_response_wrapper(
|
|
769
|
+
memberships.resume,
|
|
770
|
+
)
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
class MembershipsResourceWithStreamingResponse:
|
|
774
|
+
def __init__(self, memberships: MembershipsResource) -> None:
|
|
775
|
+
self._memberships = memberships
|
|
776
|
+
|
|
777
|
+
self.retrieve = to_streamed_response_wrapper(
|
|
778
|
+
memberships.retrieve,
|
|
779
|
+
)
|
|
780
|
+
self.update = to_streamed_response_wrapper(
|
|
781
|
+
memberships.update,
|
|
782
|
+
)
|
|
783
|
+
self.list = to_streamed_response_wrapper(
|
|
784
|
+
memberships.list,
|
|
785
|
+
)
|
|
786
|
+
self.cancel = to_streamed_response_wrapper(
|
|
787
|
+
memberships.cancel,
|
|
788
|
+
)
|
|
789
|
+
self.pause = to_streamed_response_wrapper(
|
|
790
|
+
memberships.pause,
|
|
791
|
+
)
|
|
792
|
+
self.resume = to_streamed_response_wrapper(
|
|
793
|
+
memberships.resume,
|
|
794
|
+
)
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
class AsyncMembershipsResourceWithStreamingResponse:
|
|
798
|
+
def __init__(self, memberships: AsyncMembershipsResource) -> None:
|
|
799
|
+
self._memberships = memberships
|
|
800
|
+
|
|
801
|
+
self.retrieve = async_to_streamed_response_wrapper(
|
|
802
|
+
memberships.retrieve,
|
|
803
|
+
)
|
|
804
|
+
self.update = async_to_streamed_response_wrapper(
|
|
805
|
+
memberships.update,
|
|
806
|
+
)
|
|
807
|
+
self.list = async_to_streamed_response_wrapper(
|
|
808
|
+
memberships.list,
|
|
809
|
+
)
|
|
810
|
+
self.cancel = async_to_streamed_response_wrapper(
|
|
811
|
+
memberships.cancel,
|
|
812
|
+
)
|
|
813
|
+
self.pause = async_to_streamed_response_wrapper(
|
|
814
|
+
memberships.pause,
|
|
815
|
+
)
|
|
816
|
+
self.resume = async_to_streamed_response_wrapper(
|
|
817
|
+
memberships.resume,
|
|
818
|
+
)
|