whop-sdk 0.0.1__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.

Potentially problematic release.


This version of whop-sdk might be problematic. Click here for more details.

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