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,347 @@
|
|
|
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 Union, Optional
|
|
6
|
+
from datetime import datetime
|
|
7
|
+
|
|
8
|
+
import httpx
|
|
9
|
+
|
|
10
|
+
from ..types import refund_list_params
|
|
11
|
+
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
|
|
12
|
+
from .._utils import maybe_transform
|
|
13
|
+
from .._compat import cached_property
|
|
14
|
+
from .._resource import SyncAPIResource, AsyncAPIResource
|
|
15
|
+
from .._response import (
|
|
16
|
+
to_raw_response_wrapper,
|
|
17
|
+
to_streamed_response_wrapper,
|
|
18
|
+
async_to_raw_response_wrapper,
|
|
19
|
+
async_to_streamed_response_wrapper,
|
|
20
|
+
)
|
|
21
|
+
from ..pagination import SyncCursorPage, AsyncCursorPage
|
|
22
|
+
from .._base_client import AsyncPaginator, make_request_options
|
|
23
|
+
from ..types.shared.direction import Direction
|
|
24
|
+
from ..types.refund_list_response import RefundListResponse
|
|
25
|
+
from ..types.refund_retrieve_response import RefundRetrieveResponse
|
|
26
|
+
|
|
27
|
+
__all__ = ["RefundsResource", "AsyncRefundsResource"]
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
class RefundsResource(SyncAPIResource):
|
|
31
|
+
@cached_property
|
|
32
|
+
def with_raw_response(self) -> RefundsResourceWithRawResponse:
|
|
33
|
+
"""
|
|
34
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
35
|
+
the raw response object instead of the parsed content.
|
|
36
|
+
|
|
37
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
|
|
38
|
+
"""
|
|
39
|
+
return RefundsResourceWithRawResponse(self)
|
|
40
|
+
|
|
41
|
+
@cached_property
|
|
42
|
+
def with_streaming_response(self) -> RefundsResourceWithStreamingResponse:
|
|
43
|
+
"""
|
|
44
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
45
|
+
|
|
46
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
|
|
47
|
+
"""
|
|
48
|
+
return RefundsResourceWithStreamingResponse(self)
|
|
49
|
+
|
|
50
|
+
def retrieve(
|
|
51
|
+
self,
|
|
52
|
+
id: str,
|
|
53
|
+
*,
|
|
54
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
55
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
56
|
+
extra_headers: Headers | None = None,
|
|
57
|
+
extra_query: Query | None = None,
|
|
58
|
+
extra_body: Body | None = None,
|
|
59
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
60
|
+
) -> RefundRetrieveResponse:
|
|
61
|
+
"""
|
|
62
|
+
Retrieves a Refund by ID
|
|
63
|
+
|
|
64
|
+
Required permissions:
|
|
65
|
+
|
|
66
|
+
- `payment:basic:read`
|
|
67
|
+
- `member:email:read`
|
|
68
|
+
- `member:basic:read`
|
|
69
|
+
- `member:phone:read`
|
|
70
|
+
|
|
71
|
+
Args:
|
|
72
|
+
extra_headers: Send extra headers
|
|
73
|
+
|
|
74
|
+
extra_query: Add additional query parameters to the request
|
|
75
|
+
|
|
76
|
+
extra_body: Add additional JSON properties to the request
|
|
77
|
+
|
|
78
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
79
|
+
"""
|
|
80
|
+
if not id:
|
|
81
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
82
|
+
return self._get(
|
|
83
|
+
f"/refunds/{id}",
|
|
84
|
+
options=make_request_options(
|
|
85
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
86
|
+
),
|
|
87
|
+
cast_to=RefundRetrieveResponse,
|
|
88
|
+
)
|
|
89
|
+
|
|
90
|
+
def list(
|
|
91
|
+
self,
|
|
92
|
+
*,
|
|
93
|
+
payment_id: str,
|
|
94
|
+
after: Optional[str] | Omit = omit,
|
|
95
|
+
before: Optional[str] | Omit = omit,
|
|
96
|
+
created_after: Union[str, datetime, None] | Omit = omit,
|
|
97
|
+
created_before: Union[str, datetime, None] | Omit = omit,
|
|
98
|
+
direction: Optional[Direction] | Omit = omit,
|
|
99
|
+
first: Optional[int] | Omit = omit,
|
|
100
|
+
last: Optional[int] | Omit = omit,
|
|
101
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
102
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
103
|
+
extra_headers: Headers | None = None,
|
|
104
|
+
extra_query: Query | None = None,
|
|
105
|
+
extra_body: Body | None = None,
|
|
106
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
107
|
+
) -> SyncCursorPage[RefundListResponse]:
|
|
108
|
+
"""
|
|
109
|
+
Lists Refunds for a payment.
|
|
110
|
+
|
|
111
|
+
Required permissions:
|
|
112
|
+
|
|
113
|
+
- `payment:basic:read`
|
|
114
|
+
|
|
115
|
+
Args:
|
|
116
|
+
payment_id: The ID of the payment to list refunds for
|
|
117
|
+
|
|
118
|
+
after: Returns the elements in the list that come after the specified cursor.
|
|
119
|
+
|
|
120
|
+
before: Returns the elements in the list that come before the specified cursor.
|
|
121
|
+
|
|
122
|
+
created_after: The minimum creation date to filter by
|
|
123
|
+
|
|
124
|
+
created_before: The maximum creation date to filter by
|
|
125
|
+
|
|
126
|
+
direction: The direction of the sort.
|
|
127
|
+
|
|
128
|
+
first: Returns the first _n_ elements from the list.
|
|
129
|
+
|
|
130
|
+
last: Returns the last _n_ elements from the list.
|
|
131
|
+
|
|
132
|
+
extra_headers: Send extra headers
|
|
133
|
+
|
|
134
|
+
extra_query: Add additional query parameters to the request
|
|
135
|
+
|
|
136
|
+
extra_body: Add additional JSON properties to the request
|
|
137
|
+
|
|
138
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
139
|
+
"""
|
|
140
|
+
return self._get_api_list(
|
|
141
|
+
"/refunds",
|
|
142
|
+
page=SyncCursorPage[RefundListResponse],
|
|
143
|
+
options=make_request_options(
|
|
144
|
+
extra_headers=extra_headers,
|
|
145
|
+
extra_query=extra_query,
|
|
146
|
+
extra_body=extra_body,
|
|
147
|
+
timeout=timeout,
|
|
148
|
+
query=maybe_transform(
|
|
149
|
+
{
|
|
150
|
+
"payment_id": payment_id,
|
|
151
|
+
"after": after,
|
|
152
|
+
"before": before,
|
|
153
|
+
"created_after": created_after,
|
|
154
|
+
"created_before": created_before,
|
|
155
|
+
"direction": direction,
|
|
156
|
+
"first": first,
|
|
157
|
+
"last": last,
|
|
158
|
+
},
|
|
159
|
+
refund_list_params.RefundListParams,
|
|
160
|
+
),
|
|
161
|
+
),
|
|
162
|
+
model=RefundListResponse,
|
|
163
|
+
)
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
class AsyncRefundsResource(AsyncAPIResource):
|
|
167
|
+
@cached_property
|
|
168
|
+
def with_raw_response(self) -> AsyncRefundsResourceWithRawResponse:
|
|
169
|
+
"""
|
|
170
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
171
|
+
the raw response object instead of the parsed content.
|
|
172
|
+
|
|
173
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
|
|
174
|
+
"""
|
|
175
|
+
return AsyncRefundsResourceWithRawResponse(self)
|
|
176
|
+
|
|
177
|
+
@cached_property
|
|
178
|
+
def with_streaming_response(self) -> AsyncRefundsResourceWithStreamingResponse:
|
|
179
|
+
"""
|
|
180
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
181
|
+
|
|
182
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
|
|
183
|
+
"""
|
|
184
|
+
return AsyncRefundsResourceWithStreamingResponse(self)
|
|
185
|
+
|
|
186
|
+
async def retrieve(
|
|
187
|
+
self,
|
|
188
|
+
id: str,
|
|
189
|
+
*,
|
|
190
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
191
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
192
|
+
extra_headers: Headers | None = None,
|
|
193
|
+
extra_query: Query | None = None,
|
|
194
|
+
extra_body: Body | None = None,
|
|
195
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
196
|
+
) -> RefundRetrieveResponse:
|
|
197
|
+
"""
|
|
198
|
+
Retrieves a Refund by ID
|
|
199
|
+
|
|
200
|
+
Required permissions:
|
|
201
|
+
|
|
202
|
+
- `payment:basic:read`
|
|
203
|
+
- `member:email:read`
|
|
204
|
+
- `member:basic:read`
|
|
205
|
+
- `member:phone:read`
|
|
206
|
+
|
|
207
|
+
Args:
|
|
208
|
+
extra_headers: Send extra headers
|
|
209
|
+
|
|
210
|
+
extra_query: Add additional query parameters to the request
|
|
211
|
+
|
|
212
|
+
extra_body: Add additional JSON properties to the request
|
|
213
|
+
|
|
214
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
215
|
+
"""
|
|
216
|
+
if not id:
|
|
217
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
218
|
+
return await self._get(
|
|
219
|
+
f"/refunds/{id}",
|
|
220
|
+
options=make_request_options(
|
|
221
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
222
|
+
),
|
|
223
|
+
cast_to=RefundRetrieveResponse,
|
|
224
|
+
)
|
|
225
|
+
|
|
226
|
+
def list(
|
|
227
|
+
self,
|
|
228
|
+
*,
|
|
229
|
+
payment_id: str,
|
|
230
|
+
after: Optional[str] | Omit = omit,
|
|
231
|
+
before: Optional[str] | Omit = omit,
|
|
232
|
+
created_after: Union[str, datetime, None] | Omit = omit,
|
|
233
|
+
created_before: Union[str, datetime, None] | Omit = omit,
|
|
234
|
+
direction: Optional[Direction] | Omit = omit,
|
|
235
|
+
first: Optional[int] | Omit = omit,
|
|
236
|
+
last: Optional[int] | Omit = omit,
|
|
237
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
238
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
239
|
+
extra_headers: Headers | None = None,
|
|
240
|
+
extra_query: Query | None = None,
|
|
241
|
+
extra_body: Body | None = None,
|
|
242
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
243
|
+
) -> AsyncPaginator[RefundListResponse, AsyncCursorPage[RefundListResponse]]:
|
|
244
|
+
"""
|
|
245
|
+
Lists Refunds for a payment.
|
|
246
|
+
|
|
247
|
+
Required permissions:
|
|
248
|
+
|
|
249
|
+
- `payment:basic:read`
|
|
250
|
+
|
|
251
|
+
Args:
|
|
252
|
+
payment_id: The ID of the payment to list refunds for
|
|
253
|
+
|
|
254
|
+
after: Returns the elements in the list that come after the specified cursor.
|
|
255
|
+
|
|
256
|
+
before: Returns the elements in the list that come before the specified cursor.
|
|
257
|
+
|
|
258
|
+
created_after: The minimum creation date to filter by
|
|
259
|
+
|
|
260
|
+
created_before: The maximum creation date to filter by
|
|
261
|
+
|
|
262
|
+
direction: The direction of the sort.
|
|
263
|
+
|
|
264
|
+
first: Returns the first _n_ elements from the list.
|
|
265
|
+
|
|
266
|
+
last: Returns the last _n_ elements from the list.
|
|
267
|
+
|
|
268
|
+
extra_headers: Send extra headers
|
|
269
|
+
|
|
270
|
+
extra_query: Add additional query parameters to the request
|
|
271
|
+
|
|
272
|
+
extra_body: Add additional JSON properties to the request
|
|
273
|
+
|
|
274
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
275
|
+
"""
|
|
276
|
+
return self._get_api_list(
|
|
277
|
+
"/refunds",
|
|
278
|
+
page=AsyncCursorPage[RefundListResponse],
|
|
279
|
+
options=make_request_options(
|
|
280
|
+
extra_headers=extra_headers,
|
|
281
|
+
extra_query=extra_query,
|
|
282
|
+
extra_body=extra_body,
|
|
283
|
+
timeout=timeout,
|
|
284
|
+
query=maybe_transform(
|
|
285
|
+
{
|
|
286
|
+
"payment_id": payment_id,
|
|
287
|
+
"after": after,
|
|
288
|
+
"before": before,
|
|
289
|
+
"created_after": created_after,
|
|
290
|
+
"created_before": created_before,
|
|
291
|
+
"direction": direction,
|
|
292
|
+
"first": first,
|
|
293
|
+
"last": last,
|
|
294
|
+
},
|
|
295
|
+
refund_list_params.RefundListParams,
|
|
296
|
+
),
|
|
297
|
+
),
|
|
298
|
+
model=RefundListResponse,
|
|
299
|
+
)
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
class RefundsResourceWithRawResponse:
|
|
303
|
+
def __init__(self, refunds: RefundsResource) -> None:
|
|
304
|
+
self._refunds = refunds
|
|
305
|
+
|
|
306
|
+
self.retrieve = to_raw_response_wrapper(
|
|
307
|
+
refunds.retrieve,
|
|
308
|
+
)
|
|
309
|
+
self.list = to_raw_response_wrapper(
|
|
310
|
+
refunds.list,
|
|
311
|
+
)
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
class AsyncRefundsResourceWithRawResponse:
|
|
315
|
+
def __init__(self, refunds: AsyncRefundsResource) -> None:
|
|
316
|
+
self._refunds = refunds
|
|
317
|
+
|
|
318
|
+
self.retrieve = async_to_raw_response_wrapper(
|
|
319
|
+
refunds.retrieve,
|
|
320
|
+
)
|
|
321
|
+
self.list = async_to_raw_response_wrapper(
|
|
322
|
+
refunds.list,
|
|
323
|
+
)
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
class RefundsResourceWithStreamingResponse:
|
|
327
|
+
def __init__(self, refunds: RefundsResource) -> None:
|
|
328
|
+
self._refunds = refunds
|
|
329
|
+
|
|
330
|
+
self.retrieve = to_streamed_response_wrapper(
|
|
331
|
+
refunds.retrieve,
|
|
332
|
+
)
|
|
333
|
+
self.list = to_streamed_response_wrapper(
|
|
334
|
+
refunds.list,
|
|
335
|
+
)
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
class AsyncRefundsResourceWithStreamingResponse:
|
|
339
|
+
def __init__(self, refunds: AsyncRefundsResource) -> None:
|
|
340
|
+
self._refunds = refunds
|
|
341
|
+
|
|
342
|
+
self.retrieve = async_to_streamed_response_wrapper(
|
|
343
|
+
refunds.retrieve,
|
|
344
|
+
)
|
|
345
|
+
self.list = async_to_streamed_response_wrapper(
|
|
346
|
+
refunds.list,
|
|
347
|
+
)
|
|
@@ -0,0 +1,332 @@
|
|
|
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 Union, Optional
|
|
6
|
+
from datetime import datetime
|
|
7
|
+
|
|
8
|
+
import httpx
|
|
9
|
+
|
|
10
|
+
from ..types import review_list_params
|
|
11
|
+
from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
|
|
12
|
+
from .._utils import maybe_transform
|
|
13
|
+
from .._compat import cached_property
|
|
14
|
+
from .._resource import SyncAPIResource, AsyncAPIResource
|
|
15
|
+
from .._response import (
|
|
16
|
+
to_raw_response_wrapper,
|
|
17
|
+
to_streamed_response_wrapper,
|
|
18
|
+
async_to_raw_response_wrapper,
|
|
19
|
+
async_to_streamed_response_wrapper,
|
|
20
|
+
)
|
|
21
|
+
from ..pagination import SyncCursorPage, AsyncCursorPage
|
|
22
|
+
from .._base_client import AsyncPaginator, make_request_options
|
|
23
|
+
from ..types.review_list_response import ReviewListResponse
|
|
24
|
+
from ..types.review_retrieve_response import ReviewRetrieveResponse
|
|
25
|
+
|
|
26
|
+
__all__ = ["ReviewsResource", "AsyncReviewsResource"]
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
class ReviewsResource(SyncAPIResource):
|
|
30
|
+
@cached_property
|
|
31
|
+
def with_raw_response(self) -> ReviewsResourceWithRawResponse:
|
|
32
|
+
"""
|
|
33
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
34
|
+
the raw response object instead of the parsed content.
|
|
35
|
+
|
|
36
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
|
|
37
|
+
"""
|
|
38
|
+
return ReviewsResourceWithRawResponse(self)
|
|
39
|
+
|
|
40
|
+
@cached_property
|
|
41
|
+
def with_streaming_response(self) -> ReviewsResourceWithStreamingResponse:
|
|
42
|
+
"""
|
|
43
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
44
|
+
|
|
45
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
|
|
46
|
+
"""
|
|
47
|
+
return ReviewsResourceWithStreamingResponse(self)
|
|
48
|
+
|
|
49
|
+
def retrieve(
|
|
50
|
+
self,
|
|
51
|
+
id: str,
|
|
52
|
+
*,
|
|
53
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
54
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
55
|
+
extra_headers: Headers | None = None,
|
|
56
|
+
extra_query: Query | None = None,
|
|
57
|
+
extra_body: Body | None = None,
|
|
58
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
59
|
+
) -> ReviewRetrieveResponse:
|
|
60
|
+
"""
|
|
61
|
+
Retrieve a review by its ID
|
|
62
|
+
|
|
63
|
+
Args:
|
|
64
|
+
extra_headers: Send extra headers
|
|
65
|
+
|
|
66
|
+
extra_query: Add additional query parameters to the request
|
|
67
|
+
|
|
68
|
+
extra_body: Add additional JSON properties to the request
|
|
69
|
+
|
|
70
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
71
|
+
"""
|
|
72
|
+
if not id:
|
|
73
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
74
|
+
return self._get(
|
|
75
|
+
f"/reviews/{id}",
|
|
76
|
+
options=make_request_options(
|
|
77
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
78
|
+
),
|
|
79
|
+
cast_to=ReviewRetrieveResponse,
|
|
80
|
+
)
|
|
81
|
+
|
|
82
|
+
def list(
|
|
83
|
+
self,
|
|
84
|
+
*,
|
|
85
|
+
product_id: str,
|
|
86
|
+
after: Optional[str] | Omit = omit,
|
|
87
|
+
before: Optional[str] | Omit = omit,
|
|
88
|
+
created_after: Union[str, datetime, None] | Omit = omit,
|
|
89
|
+
created_before: Union[str, datetime, None] | Omit = omit,
|
|
90
|
+
first: Optional[int] | Omit = omit,
|
|
91
|
+
last: Optional[int] | Omit = omit,
|
|
92
|
+
max_stars: Optional[int] | Omit = omit,
|
|
93
|
+
min_stars: Optional[int] | Omit = omit,
|
|
94
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
95
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
96
|
+
extra_headers: Headers | None = None,
|
|
97
|
+
extra_query: Query | None = None,
|
|
98
|
+
extra_body: Body | None = None,
|
|
99
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
100
|
+
) -> SyncCursorPage[ReviewListResponse]:
|
|
101
|
+
"""
|
|
102
|
+
List all reviews
|
|
103
|
+
|
|
104
|
+
Args:
|
|
105
|
+
product_id: The ID of the product
|
|
106
|
+
|
|
107
|
+
after: Returns the elements in the list that come after the specified cursor.
|
|
108
|
+
|
|
109
|
+
before: Returns the elements in the list that come before the specified cursor.
|
|
110
|
+
|
|
111
|
+
created_after: The minimum creation date to filter by
|
|
112
|
+
|
|
113
|
+
created_before: The maximum creation date to filter by
|
|
114
|
+
|
|
115
|
+
first: Returns the first _n_ elements from the list.
|
|
116
|
+
|
|
117
|
+
last: Returns the last _n_ elements from the list.
|
|
118
|
+
|
|
119
|
+
max_stars: The maximum star rating of the review (inclusive)
|
|
120
|
+
|
|
121
|
+
min_stars: The minimum star rating of the review (inclusive)
|
|
122
|
+
|
|
123
|
+
extra_headers: Send extra headers
|
|
124
|
+
|
|
125
|
+
extra_query: Add additional query parameters to the request
|
|
126
|
+
|
|
127
|
+
extra_body: Add additional JSON properties to the request
|
|
128
|
+
|
|
129
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
130
|
+
"""
|
|
131
|
+
return self._get_api_list(
|
|
132
|
+
"/reviews",
|
|
133
|
+
page=SyncCursorPage[ReviewListResponse],
|
|
134
|
+
options=make_request_options(
|
|
135
|
+
extra_headers=extra_headers,
|
|
136
|
+
extra_query=extra_query,
|
|
137
|
+
extra_body=extra_body,
|
|
138
|
+
timeout=timeout,
|
|
139
|
+
query=maybe_transform(
|
|
140
|
+
{
|
|
141
|
+
"product_id": product_id,
|
|
142
|
+
"after": after,
|
|
143
|
+
"before": before,
|
|
144
|
+
"created_after": created_after,
|
|
145
|
+
"created_before": created_before,
|
|
146
|
+
"first": first,
|
|
147
|
+
"last": last,
|
|
148
|
+
"max_stars": max_stars,
|
|
149
|
+
"min_stars": min_stars,
|
|
150
|
+
},
|
|
151
|
+
review_list_params.ReviewListParams,
|
|
152
|
+
),
|
|
153
|
+
),
|
|
154
|
+
model=ReviewListResponse,
|
|
155
|
+
)
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
class AsyncReviewsResource(AsyncAPIResource):
|
|
159
|
+
@cached_property
|
|
160
|
+
def with_raw_response(self) -> AsyncReviewsResourceWithRawResponse:
|
|
161
|
+
"""
|
|
162
|
+
This property can be used as a prefix for any HTTP method call to return
|
|
163
|
+
the raw response object instead of the parsed content.
|
|
164
|
+
|
|
165
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
|
|
166
|
+
"""
|
|
167
|
+
return AsyncReviewsResourceWithRawResponse(self)
|
|
168
|
+
|
|
169
|
+
@cached_property
|
|
170
|
+
def with_streaming_response(self) -> AsyncReviewsResourceWithStreamingResponse:
|
|
171
|
+
"""
|
|
172
|
+
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
173
|
+
|
|
174
|
+
For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
|
|
175
|
+
"""
|
|
176
|
+
return AsyncReviewsResourceWithStreamingResponse(self)
|
|
177
|
+
|
|
178
|
+
async def retrieve(
|
|
179
|
+
self,
|
|
180
|
+
id: str,
|
|
181
|
+
*,
|
|
182
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
183
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
184
|
+
extra_headers: Headers | None = None,
|
|
185
|
+
extra_query: Query | None = None,
|
|
186
|
+
extra_body: Body | None = None,
|
|
187
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
188
|
+
) -> ReviewRetrieveResponse:
|
|
189
|
+
"""
|
|
190
|
+
Retrieve a review by its ID
|
|
191
|
+
|
|
192
|
+
Args:
|
|
193
|
+
extra_headers: Send extra headers
|
|
194
|
+
|
|
195
|
+
extra_query: Add additional query parameters to the request
|
|
196
|
+
|
|
197
|
+
extra_body: Add additional JSON properties to the request
|
|
198
|
+
|
|
199
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
200
|
+
"""
|
|
201
|
+
if not id:
|
|
202
|
+
raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
|
|
203
|
+
return await self._get(
|
|
204
|
+
f"/reviews/{id}",
|
|
205
|
+
options=make_request_options(
|
|
206
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
207
|
+
),
|
|
208
|
+
cast_to=ReviewRetrieveResponse,
|
|
209
|
+
)
|
|
210
|
+
|
|
211
|
+
def list(
|
|
212
|
+
self,
|
|
213
|
+
*,
|
|
214
|
+
product_id: str,
|
|
215
|
+
after: Optional[str] | Omit = omit,
|
|
216
|
+
before: Optional[str] | Omit = omit,
|
|
217
|
+
created_after: Union[str, datetime, None] | Omit = omit,
|
|
218
|
+
created_before: Union[str, datetime, None] | Omit = omit,
|
|
219
|
+
first: Optional[int] | Omit = omit,
|
|
220
|
+
last: Optional[int] | Omit = omit,
|
|
221
|
+
max_stars: Optional[int] | Omit = omit,
|
|
222
|
+
min_stars: Optional[int] | Omit = omit,
|
|
223
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
224
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
225
|
+
extra_headers: Headers | None = None,
|
|
226
|
+
extra_query: Query | None = None,
|
|
227
|
+
extra_body: Body | None = None,
|
|
228
|
+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
|
|
229
|
+
) -> AsyncPaginator[ReviewListResponse, AsyncCursorPage[ReviewListResponse]]:
|
|
230
|
+
"""
|
|
231
|
+
List all reviews
|
|
232
|
+
|
|
233
|
+
Args:
|
|
234
|
+
product_id: The ID of the product
|
|
235
|
+
|
|
236
|
+
after: Returns the elements in the list that come after the specified cursor.
|
|
237
|
+
|
|
238
|
+
before: Returns the elements in the list that come before the specified cursor.
|
|
239
|
+
|
|
240
|
+
created_after: The minimum creation date to filter by
|
|
241
|
+
|
|
242
|
+
created_before: The maximum creation date to filter by
|
|
243
|
+
|
|
244
|
+
first: Returns the first _n_ elements from the list.
|
|
245
|
+
|
|
246
|
+
last: Returns the last _n_ elements from the list.
|
|
247
|
+
|
|
248
|
+
max_stars: The maximum star rating of the review (inclusive)
|
|
249
|
+
|
|
250
|
+
min_stars: The minimum star rating of the review (inclusive)
|
|
251
|
+
|
|
252
|
+
extra_headers: Send extra headers
|
|
253
|
+
|
|
254
|
+
extra_query: Add additional query parameters to the request
|
|
255
|
+
|
|
256
|
+
extra_body: Add additional JSON properties to the request
|
|
257
|
+
|
|
258
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
259
|
+
"""
|
|
260
|
+
return self._get_api_list(
|
|
261
|
+
"/reviews",
|
|
262
|
+
page=AsyncCursorPage[ReviewListResponse],
|
|
263
|
+
options=make_request_options(
|
|
264
|
+
extra_headers=extra_headers,
|
|
265
|
+
extra_query=extra_query,
|
|
266
|
+
extra_body=extra_body,
|
|
267
|
+
timeout=timeout,
|
|
268
|
+
query=maybe_transform(
|
|
269
|
+
{
|
|
270
|
+
"product_id": product_id,
|
|
271
|
+
"after": after,
|
|
272
|
+
"before": before,
|
|
273
|
+
"created_after": created_after,
|
|
274
|
+
"created_before": created_before,
|
|
275
|
+
"first": first,
|
|
276
|
+
"last": last,
|
|
277
|
+
"max_stars": max_stars,
|
|
278
|
+
"min_stars": min_stars,
|
|
279
|
+
},
|
|
280
|
+
review_list_params.ReviewListParams,
|
|
281
|
+
),
|
|
282
|
+
),
|
|
283
|
+
model=ReviewListResponse,
|
|
284
|
+
)
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
class ReviewsResourceWithRawResponse:
|
|
288
|
+
def __init__(self, reviews: ReviewsResource) -> None:
|
|
289
|
+
self._reviews = reviews
|
|
290
|
+
|
|
291
|
+
self.retrieve = to_raw_response_wrapper(
|
|
292
|
+
reviews.retrieve,
|
|
293
|
+
)
|
|
294
|
+
self.list = to_raw_response_wrapper(
|
|
295
|
+
reviews.list,
|
|
296
|
+
)
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
class AsyncReviewsResourceWithRawResponse:
|
|
300
|
+
def __init__(self, reviews: AsyncReviewsResource) -> None:
|
|
301
|
+
self._reviews = reviews
|
|
302
|
+
|
|
303
|
+
self.retrieve = async_to_raw_response_wrapper(
|
|
304
|
+
reviews.retrieve,
|
|
305
|
+
)
|
|
306
|
+
self.list = async_to_raw_response_wrapper(
|
|
307
|
+
reviews.list,
|
|
308
|
+
)
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
class ReviewsResourceWithStreamingResponse:
|
|
312
|
+
def __init__(self, reviews: ReviewsResource) -> None:
|
|
313
|
+
self._reviews = reviews
|
|
314
|
+
|
|
315
|
+
self.retrieve = to_streamed_response_wrapper(
|
|
316
|
+
reviews.retrieve,
|
|
317
|
+
)
|
|
318
|
+
self.list = to_streamed_response_wrapper(
|
|
319
|
+
reviews.list,
|
|
320
|
+
)
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
class AsyncReviewsResourceWithStreamingResponse:
|
|
324
|
+
def __init__(self, reviews: AsyncReviewsResource) -> None:
|
|
325
|
+
self._reviews = reviews
|
|
326
|
+
|
|
327
|
+
self.retrieve = async_to_streamed_response_wrapper(
|
|
328
|
+
reviews.retrieve,
|
|
329
|
+
)
|
|
330
|
+
self.list = async_to_streamed_response_wrapper(
|
|
331
|
+
reviews.list,
|
|
332
|
+
)
|