whop_sdk 0.0.7 → 0.0.9
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +7 -7
- data/lib/whop_sdk/client.rb +12 -0
- data/lib/whop_sdk/internal/type/base_model.rb +1 -1
- data/lib/whop_sdk/models/account_link_create_params.rb +62 -0
- data/lib/whop_sdk/models/account_link_create_response.rb +28 -0
- data/lib/whop_sdk/models/app.rb +9 -1
- data/lib/whop_sdk/models/app_build_list_params.rb +17 -1
- data/lib/whop_sdk/models/app_list_params.rb +10 -1
- data/lib/whop_sdk/models/app_list_response.rb +9 -1
- data/lib/whop_sdk/models/app_type.rb +18 -0
- data/lib/whop_sdk/models/app_update_params.rb +9 -1
- data/lib/whop_sdk/models/authorized_user_list_params.rb +17 -1
- data/lib/whop_sdk/models/checkout_configuration.rb +69 -7
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +73 -1
- data/lib/whop_sdk/models/checkout_configuration_list_params.rb +17 -1
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +69 -7
- data/lib/whop_sdk/models/checkout_modes.rb +16 -0
- data/lib/whop_sdk/models/company_list_params.rb +17 -1
- data/lib/whop_sdk/models/course.rb +9 -1
- data/lib/whop_sdk/models/course_lesson_list_response.rb +9 -1
- data/lib/whop_sdk/models/course_lesson_mark_as_completed_params.rb +14 -0
- data/lib/whop_sdk/models/course_lesson_mark_as_completed_response.rb +8 -0
- data/lib/whop_sdk/models/course_lesson_start_params.rb +14 -0
- data/lib/whop_sdk/models/course_lesson_start_response.rb +8 -0
- data/lib/whop_sdk/models/course_lesson_submit_assessment_params.rb +52 -0
- data/lib/whop_sdk/models/course_lesson_submit_assessment_response.rb +151 -0
- data/lib/whop_sdk/models/course_list_response.rb +9 -1
- data/lib/whop_sdk/models/dispute_list_params.rb +17 -1
- data/lib/whop_sdk/models/entry_list_params.rb +17 -1
- data/lib/whop_sdk/models/experience_list_params.rb +17 -1
- data/lib/whop_sdk/models/forum_post_create_params.rb +3 -14
- data/lib/whop_sdk/models/forum_post_update_params.rb +3 -14
- data/lib/whop_sdk/models/forum_post_visibility_type.rb +16 -0
- data/lib/whop_sdk/models/invoice_list_params.rb +17 -1
- data/lib/whop_sdk/models/lesson.rb +104 -2
- data/lib/whop_sdk/models/payment_method_types.rb +1 -0
- data/lib/whop_sdk/models/payment_provider.rb +22 -0
- data/lib/whop_sdk/models/plan_create_params.rb +3 -21
- data/lib/whop_sdk/models/plan_list_params.rb +17 -1
- data/lib/whop_sdk/models/product_list_params.rb +17 -1
- data/lib/whop_sdk/models/product_update_params.rb +1 -61
- data/lib/whop_sdk/models/promo_code_list_params.rb +17 -1
- data/lib/whop_sdk/models/refund_created_webhook_event.rb +354 -0
- data/lib/whop_sdk/models/refund_list_params.rb +78 -0
- data/lib/whop_sdk/models/refund_list_response.rb +113 -0
- data/lib/whop_sdk/models/refund_reference_status.rb +17 -0
- data/lib/whop_sdk/models/refund_reference_type.rb +17 -0
- data/lib/whop_sdk/models/refund_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/refund_retrieve_response.rb +307 -0
- data/lib/whop_sdk/models/refund_status.rb +19 -0
- data/lib/whop_sdk/models/refund_updated_webhook_event.rb +354 -0
- data/lib/whop_sdk/models/review_list_params.rb +17 -1
- data/lib/whop_sdk/models/transfer_list_params.rb +17 -1
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +5 -1
- data/lib/whop_sdk/models/withdrawal_fee_types.rb +16 -0
- data/lib/whop_sdk/models/withdrawal_list_params.rb +78 -0
- data/lib/whop_sdk/models/withdrawal_list_response.rb +87 -0
- data/lib/whop_sdk/models/withdrawal_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +320 -0
- data/lib/whop_sdk/models/withdrawal_speeds.rb +16 -0
- data/lib/whop_sdk/models/withdrawal_status.rb +21 -0
- data/lib/whop_sdk/models/withdrawal_types.rb +16 -0
- data/lib/whop_sdk/models.rb +42 -0
- data/lib/whop_sdk/resources/account_links.rb +47 -0
- data/lib/whop_sdk/resources/app_builds.rb +5 -1
- data/lib/whop_sdk/resources/apps.rb +6 -2
- data/lib/whop_sdk/resources/authorized_users.rb +5 -1
- data/lib/whop_sdk/resources/checkout_configurations.rb +16 -2
- data/lib/whop_sdk/resources/companies.rb +5 -1
- data/lib/whop_sdk/resources/course_lessons.rb +64 -0
- data/lib/whop_sdk/resources/disputes.rb +5 -1
- data/lib/whop_sdk/resources/entries.rb +5 -1
- data/lib/whop_sdk/resources/experiences.rb +5 -1
- data/lib/whop_sdk/resources/forum_posts.rb +2 -2
- data/lib/whop_sdk/resources/invoices.rb +5 -1
- data/lib/whop_sdk/resources/plans.rb +7 -7
- data/lib/whop_sdk/resources/products.rb +6 -4
- data/lib/whop_sdk/resources/promo_codes.rb +5 -1
- data/lib/whop_sdk/resources/refunds.rb +82 -0
- data/lib/whop_sdk/resources/reviews.rb +5 -1
- data/lib/whop_sdk/resources/transfers.rb +5 -1
- data/lib/whop_sdk/resources/webhooks.rb +1 -1
- data/lib/whop_sdk/resources/withdrawals.rb +79 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +33 -0
- data/manifest.yaml +1 -0
- data/rbi/whop_sdk/client.rbi +9 -0
- data/rbi/whop_sdk/models/account_link_create_params.rbi +101 -0
- data/rbi/whop_sdk/models/account_link_create_response.rbi +38 -0
- data/rbi/whop_sdk/models/app.rbi +8 -0
- data/rbi/whop_sdk/models/app_build_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/app_list_params.rbi +13 -0
- data/rbi/whop_sdk/models/app_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/app_type.rbi +22 -0
- data/rbi/whop_sdk/models/app_update_params.rbi +8 -0
- data/rbi/whop_sdk/models/authorized_user_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +117 -7
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +116 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +127 -7
- data/rbi/whop_sdk/models/checkout_modes.rbi +20 -0
- data/rbi/whop_sdk/models/company_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/course.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_mark_as_completed_params.rbi +30 -0
- data/rbi/whop_sdk/models/course_lesson_mark_as_completed_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_start_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_lesson_start_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_submit_assessment_params.rbi +104 -0
- data/rbi/whop_sdk/models/course_lesson_submit_assessment_response.rbi +222 -0
- data/rbi/whop_sdk/models/course_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/dispute_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/entry_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/experience_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/forum_post_create_params.rbi +3 -37
- data/rbi/whop_sdk/models/forum_post_update_params.rbi +3 -37
- data/rbi/whop_sdk/models/forum_post_visibility_type.rbi +27 -0
- data/rbi/whop_sdk/models/invoice_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/lesson.rbi +115 -3
- data/rbi/whop_sdk/models/payment_method_types.rbi +1 -0
- data/rbi/whop_sdk/models/payment_provider.rbi +27 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +2 -22
- data/rbi/whop_sdk/models/plan_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/product_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/product_update_params.rbi +0 -110
- data/rbi/whop_sdk/models/promo_code_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +561 -0
- data/rbi/whop_sdk/models/refund_list_params.rbi +99 -0
- data/rbi/whop_sdk/models/refund_list_response.rbi +155 -0
- data/rbi/whop_sdk/models/refund_reference_status.rbi +26 -0
- data/rbi/whop_sdk/models/refund_reference_type.rbi +36 -0
- data/rbi/whop_sdk/models/refund_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/refund_retrieve_response.rbi +484 -0
- data/rbi/whop_sdk/models/refund_status.rbi +24 -0
- data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +561 -0
- data/rbi/whop_sdk/models/review_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/transfer_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +3 -1
- data/rbi/whop_sdk/models/withdrawal_fee_types.rbi +22 -0
- data/rbi/whop_sdk/models/withdrawal_list_params.rbi +99 -0
- data/rbi/whop_sdk/models/withdrawal_list_response.rbi +107 -0
- data/rbi/whop_sdk/models/withdrawal_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +713 -0
- data/rbi/whop_sdk/models/withdrawal_speeds.rbi +22 -0
- data/rbi/whop_sdk/models/withdrawal_status.rbi +28 -0
- data/rbi/whop_sdk/models/withdrawal_types.rbi +20 -0
- data/rbi/whop_sdk/models.rbi +44 -0
- data/rbi/whop_sdk/resources/account_links.rbi +39 -0
- data/rbi/whop_sdk/resources/app_builds.rbi +6 -0
- data/rbi/whop_sdk/resources/apps.rbi +6 -0
- data/rbi/whop_sdk/resources/authorized_users.rbi +6 -0
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +21 -0
- data/rbi/whop_sdk/resources/companies.rbi +6 -0
- data/rbi/whop_sdk/resources/course_lessons.rbi +48 -0
- data/rbi/whop_sdk/resources/disputes.rbi +6 -0
- data/rbi/whop_sdk/resources/entries.rbi +6 -0
- data/rbi/whop_sdk/resources/experiences.rbi +6 -0
- data/rbi/whop_sdk/resources/forum_posts.rbi +2 -4
- data/rbi/whop_sdk/resources/invoices.rbi +6 -0
- data/rbi/whop_sdk/resources/plans.rbi +7 -9
- data/rbi/whop_sdk/resources/products.rbi +6 -9
- data/rbi/whop_sdk/resources/promo_codes.rbi +6 -0
- data/rbi/whop_sdk/resources/refunds.rbi +74 -0
- data/rbi/whop_sdk/resources/reviews.rbi +6 -0
- data/rbi/whop_sdk/resources/transfers.rbi +6 -0
- data/rbi/whop_sdk/resources/webhooks.rbi +3 -1
- data/rbi/whop_sdk/resources/withdrawals.rbi +71 -0
- data/sig/whop_sdk/client.rbs +6 -0
- data/sig/whop_sdk/models/account_link_create_params.rbs +52 -0
- data/sig/whop_sdk/models/account_link_create_response.rbs +15 -0
- data/sig/whop_sdk/models/app.rbs +5 -0
- data/sig/whop_sdk/models/app_build_list_params.rbs +10 -0
- data/sig/whop_sdk/models/app_list_params.rbs +7 -0
- data/sig/whop_sdk/models/app_list_response.rbs +5 -0
- data/sig/whop_sdk/models/app_type.rbs +16 -0
- data/sig/whop_sdk/models/app_update_params.rbs +5 -0
- data/sig/whop_sdk/models/authorized_user_list_params.rbs +10 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +45 -8
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +43 -1
- data/sig/whop_sdk/models/checkout_configuration_list_params.rbs +10 -0
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +45 -8
- data/sig/whop_sdk/models/checkout_modes.rbs +14 -0
- data/sig/whop_sdk/models/company_list_params.rbs +10 -0
- data/sig/whop_sdk/models/course.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_list_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_mark_as_completed_params.rbs +15 -0
- data/sig/whop_sdk/models/course_lesson_mark_as_completed_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_start_params.rbs +15 -0
- data/sig/whop_sdk/models/course_lesson_start_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_submit_assessment_params.rbs +51 -0
- data/sig/whop_sdk/models/course_lesson_submit_assessment_response.rbs +96 -0
- data/sig/whop_sdk/models/course_list_response.rbs +5 -0
- data/sig/whop_sdk/models/dispute_list_params.rbs +10 -0
- data/sig/whop_sdk/models/entry_list_params.rbs +10 -0
- data/sig/whop_sdk/models/experience_list_params.rbs +10 -0
- data/sig/whop_sdk/models/forum_post_create_params.rbs +4 -15
- data/sig/whop_sdk/models/forum_post_update_params.rbs +4 -15
- data/sig/whop_sdk/models/forum_post_visibility_type.rbs +14 -0
- data/sig/whop_sdk/models/invoice_list_params.rbs +10 -0
- data/sig/whop_sdk/models/lesson.rbs +79 -3
- data/sig/whop_sdk/models/payment_method_types.rbs +2 -0
- data/sig/whop_sdk/models/payment_provider.rbs +28 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +0 -10
- data/sig/whop_sdk/models/plan_list_params.rbs +10 -0
- data/sig/whop_sdk/models/product_list_params.rbs +10 -0
- data/sig/whop_sdk/models/product_update_params.rbs +0 -36
- data/sig/whop_sdk/models/promo_code_list_params.rbs +10 -0
- data/sig/whop_sdk/models/refund_created_webhook_event.rbs +252 -0
- data/sig/whop_sdk/models/refund_list_params.rbs +61 -0
- data/sig/whop_sdk/models/refund_list_response.rbs +80 -0
- data/sig/whop_sdk/models/refund_reference_status.rbs +15 -0
- data/sig/whop_sdk/models/refund_reference_type.rbs +18 -0
- data/sig/whop_sdk/models/refund_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/refund_retrieve_response.rbs +215 -0
- data/sig/whop_sdk/models/refund_status.rbs +18 -0
- data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +252 -0
- data/sig/whop_sdk/models/review_list_params.rbs +10 -0
- data/sig/whop_sdk/models/transfer_list_params.rbs +10 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +2 -0
- data/sig/whop_sdk/models/withdrawal_fee_types.rbs +14 -0
- data/sig/whop_sdk/models/withdrawal_list_params.rbs +61 -0
- data/sig/whop_sdk/models/withdrawal_list_response.rbs +60 -0
- data/sig/whop_sdk/models/withdrawal_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +297 -0
- data/sig/whop_sdk/models/withdrawal_speeds.rbs +14 -0
- data/sig/whop_sdk/models/withdrawal_status.rbs +26 -0
- data/sig/whop_sdk/models/withdrawal_types.rbs +14 -0
- data/sig/whop_sdk/models.rbs +42 -0
- data/sig/whop_sdk/resources/account_links.rbs +15 -0
- data/sig/whop_sdk/resources/app_builds.rbs +2 -0
- data/sig/whop_sdk/resources/apps.rbs +2 -0
- data/sig/whop_sdk/resources/authorized_users.rbs +2 -0
- data/sig/whop_sdk/resources/checkout_configurations.rbs +5 -0
- data/sig/whop_sdk/resources/companies.rbs +2 -0
- data/sig/whop_sdk/resources/course_lessons.rbs +16 -0
- data/sig/whop_sdk/resources/disputes.rbs +2 -0
- data/sig/whop_sdk/resources/entries.rbs +2 -0
- data/sig/whop_sdk/resources/experiences.rbs +2 -0
- data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
- data/sig/whop_sdk/resources/invoices.rbs +2 -0
- data/sig/whop_sdk/resources/plans.rbs +2 -2
- data/sig/whop_sdk/resources/products.rbs +2 -1
- data/sig/whop_sdk/resources/promo_codes.rbs +2 -0
- data/sig/whop_sdk/resources/refunds.rbs +24 -0
- data/sig/whop_sdk/resources/reviews.rbs +2 -0
- data/sig/whop_sdk/resources/transfers.rbs +2 -0
- data/sig/whop_sdk/resources/webhooks.rbs +3 -1
- data/sig/whop_sdk/resources/withdrawals.rbs +24 -0
- metadata +98 -2
data/lib/whop_sdk/models.rb
CHANGED
|
@@ -45,6 +45,8 @@ module WhopSDK
|
|
|
45
45
|
|
|
46
46
|
AccessTokenCreateParams = WhopSDK::Models::AccessTokenCreateParams
|
|
47
47
|
|
|
48
|
+
AccountLinkCreateParams = WhopSDK::Models::AccountLinkCreateParams
|
|
49
|
+
|
|
48
50
|
App = WhopSDK::Models::App
|
|
49
51
|
|
|
50
52
|
AppBuild = WhopSDK::Models::AppBuild
|
|
@@ -69,6 +71,8 @@ module WhopSDK
|
|
|
69
71
|
|
|
70
72
|
AppStatuses = WhopSDK::Models::AppStatuses
|
|
71
73
|
|
|
74
|
+
AppType = WhopSDK::Models::AppType
|
|
75
|
+
|
|
72
76
|
AppUpdateParams = WhopSDK::Models::AppUpdateParams
|
|
73
77
|
|
|
74
78
|
AppViewType = WhopSDK::Models::AppViewType
|
|
@@ -103,6 +107,8 @@ module WhopSDK
|
|
|
103
107
|
|
|
104
108
|
CheckoutConfigurationRetrieveParams = WhopSDK::Models::CheckoutConfigurationRetrieveParams
|
|
105
109
|
|
|
110
|
+
CheckoutModes = WhopSDK::Models::CheckoutModes
|
|
111
|
+
|
|
106
112
|
CollectionMethod = WhopSDK::Models::CollectionMethod
|
|
107
113
|
|
|
108
114
|
Company = WhopSDK::Models::Company
|
|
@@ -148,8 +154,14 @@ module WhopSDK
|
|
|
148
154
|
|
|
149
155
|
CourseLessonListParams = WhopSDK::Models::CourseLessonListParams
|
|
150
156
|
|
|
157
|
+
CourseLessonMarkAsCompletedParams = WhopSDK::Models::CourseLessonMarkAsCompletedParams
|
|
158
|
+
|
|
151
159
|
CourseLessonRetrieveParams = WhopSDK::Models::CourseLessonRetrieveParams
|
|
152
160
|
|
|
161
|
+
CourseLessonStartParams = WhopSDK::Models::CourseLessonStartParams
|
|
162
|
+
|
|
163
|
+
CourseLessonSubmitAssessmentParams = WhopSDK::Models::CourseLessonSubmitAssessmentParams
|
|
164
|
+
|
|
153
165
|
CourseLessonUpdateParams = WhopSDK::Models::CourseLessonUpdateParams
|
|
154
166
|
|
|
155
167
|
CourseListParams = WhopSDK::Models::CourseListParams
|
|
@@ -244,6 +256,8 @@ module WhopSDK
|
|
|
244
256
|
|
|
245
257
|
ForumPostUpdateParams = WhopSDK::Models::ForumPostUpdateParams
|
|
246
258
|
|
|
259
|
+
ForumPostVisibilityType = WhopSDK::Models::ForumPostVisibilityType
|
|
260
|
+
|
|
247
261
|
ForumRetrieveParams = WhopSDK::Models::ForumRetrieveParams
|
|
248
262
|
|
|
249
263
|
ForumUpdateParams = WhopSDK::Models::ForumUpdateParams
|
|
@@ -338,6 +352,8 @@ module WhopSDK
|
|
|
338
352
|
|
|
339
353
|
PaymentPendingWebhookEvent = WhopSDK::Models::PaymentPendingWebhookEvent
|
|
340
354
|
|
|
355
|
+
PaymentProvider = WhopSDK::Models::PaymentProvider
|
|
356
|
+
|
|
341
357
|
PaymentRefundParams = WhopSDK::Models::PaymentRefundParams
|
|
342
358
|
|
|
343
359
|
PaymentRetrieveParams = WhopSDK::Models::PaymentRetrieveParams
|
|
@@ -402,6 +418,20 @@ module WhopSDK
|
|
|
402
418
|
|
|
403
419
|
ReceiptStatus = WhopSDK::Models::ReceiptStatus
|
|
404
420
|
|
|
421
|
+
RefundCreatedWebhookEvent = WhopSDK::Models::RefundCreatedWebhookEvent
|
|
422
|
+
|
|
423
|
+
RefundListParams = WhopSDK::Models::RefundListParams
|
|
424
|
+
|
|
425
|
+
RefundReferenceStatus = WhopSDK::Models::RefundReferenceStatus
|
|
426
|
+
|
|
427
|
+
RefundReferenceType = WhopSDK::Models::RefundReferenceType
|
|
428
|
+
|
|
429
|
+
RefundRetrieveParams = WhopSDK::Models::RefundRetrieveParams
|
|
430
|
+
|
|
431
|
+
RefundStatus = WhopSDK::Models::RefundStatus
|
|
432
|
+
|
|
433
|
+
RefundUpdatedWebhookEvent = WhopSDK::Models::RefundUpdatedWebhookEvent
|
|
434
|
+
|
|
405
435
|
ReleaseMethod = WhopSDK::Models::ReleaseMethod
|
|
406
436
|
|
|
407
437
|
ReviewListParams = WhopSDK::Models::ReviewListParams
|
|
@@ -461,4 +491,16 @@ module WhopSDK
|
|
|
461
491
|
WhoCanPostTypes = WhopSDK::Models::WhoCanPostTypes
|
|
462
492
|
|
|
463
493
|
WhoCanReact = WhopSDK::Models::WhoCanReact
|
|
494
|
+
|
|
495
|
+
WithdrawalFeeTypes = WhopSDK::Models::WithdrawalFeeTypes
|
|
496
|
+
|
|
497
|
+
WithdrawalListParams = WhopSDK::Models::WithdrawalListParams
|
|
498
|
+
|
|
499
|
+
WithdrawalRetrieveParams = WhopSDK::Models::WithdrawalRetrieveParams
|
|
500
|
+
|
|
501
|
+
WithdrawalSpeeds = WhopSDK::Models::WithdrawalSpeeds
|
|
502
|
+
|
|
503
|
+
WithdrawalStatus = WhopSDK::Models::WithdrawalStatus
|
|
504
|
+
|
|
505
|
+
WithdrawalTypes = WhopSDK::Models::WithdrawalTypes
|
|
464
506
|
end
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class AccountLinks
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {WhopSDK::Models::AccountLinkCreateParams} for more details.
|
|
8
|
+
#
|
|
9
|
+
# Generates a url that a user can be directed to in order to access their
|
|
10
|
+
# sub-merchant account. For example, they can visit the hosted payouts portal or
|
|
11
|
+
# the hosted KYC onboarding flow.
|
|
12
|
+
#
|
|
13
|
+
# @overload create(company_id:, refresh_url:, return_url:, use_case:, request_options: {})
|
|
14
|
+
#
|
|
15
|
+
# @param company_id [String] The ID of the Company to generate the url for. The company must be a sub-merchan
|
|
16
|
+
#
|
|
17
|
+
# @param refresh_url [String] The URL to redirect to if the session expires and needs to be re-authenticated d
|
|
18
|
+
#
|
|
19
|
+
# @param return_url [String] The URL to redirect to when the customer wants to return to your site.
|
|
20
|
+
#
|
|
21
|
+
# @param use_case [Symbol, WhopSDK::Models::AccountLinkCreateParams::UseCase] The use case for which the link will be used.
|
|
22
|
+
#
|
|
23
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
|
+
#
|
|
25
|
+
# @return [WhopSDK::Models::AccountLinkCreateResponse]
|
|
26
|
+
#
|
|
27
|
+
# @see WhopSDK::Models::AccountLinkCreateParams
|
|
28
|
+
def create(params)
|
|
29
|
+
parsed, options = WhopSDK::AccountLinkCreateParams.dump_request(params)
|
|
30
|
+
@client.request(
|
|
31
|
+
method: :post,
|
|
32
|
+
path: "account_links",
|
|
33
|
+
body: parsed,
|
|
34
|
+
model: WhopSDK::Models::AccountLinkCreateResponse,
|
|
35
|
+
options: options
|
|
36
|
+
)
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# @api private
|
|
40
|
+
#
|
|
41
|
+
# @param client [WhopSDK::Client]
|
|
42
|
+
def initialize(client:)
|
|
43
|
+
@client = client
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
|
@@ -70,7 +70,7 @@ module WhopSDK
|
|
|
70
70
|
#
|
|
71
71
|
# - `developer:manage_builds`
|
|
72
72
|
#
|
|
73
|
-
# @overload list(app_id:, after: nil, before: nil, first: nil, last: nil, platform: nil, status: nil, request_options: {})
|
|
73
|
+
# @overload list(app_id:, after: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, platform: nil, status: nil, request_options: {})
|
|
74
74
|
#
|
|
75
75
|
# @param app_id [String] The ID of the app to filter app builds by
|
|
76
76
|
#
|
|
@@ -78,6 +78,10 @@ module WhopSDK
|
|
|
78
78
|
#
|
|
79
79
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
80
80
|
#
|
|
81
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
82
|
+
#
|
|
83
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
84
|
+
#
|
|
81
85
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
82
86
|
#
|
|
83
87
|
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
@@ -59,12 +59,14 @@ module WhopSDK
|
|
|
59
59
|
# - `developer:update_app`
|
|
60
60
|
# - `developer:manage_api_key`
|
|
61
61
|
#
|
|
62
|
-
# @overload update(id, app_store_description: nil, base_url: nil, dashboard_path: nil, description: nil, discover_path: nil, experience_path: nil, icon: nil, name: nil, required_scopes: nil, status: nil, request_options: {})
|
|
62
|
+
# @overload update(id, app_store_description: nil, app_type: nil, base_url: nil, dashboard_path: nil, description: nil, discover_path: nil, experience_path: nil, icon: nil, name: nil, required_scopes: nil, status: nil, request_options: {})
|
|
63
63
|
#
|
|
64
64
|
# @param id [String] The ID of the app
|
|
65
65
|
#
|
|
66
66
|
# @param app_store_description [String, nil] The description of the app for the app store in-depth app view.
|
|
67
67
|
#
|
|
68
|
+
# @param app_type [Symbol, WhopSDK::Models::AppType, nil] The type of end-user an app is built for
|
|
69
|
+
#
|
|
68
70
|
# @param base_url [String, nil] The base production url of the app
|
|
69
71
|
#
|
|
70
72
|
# @param dashboard_path [String, nil] The path for the dashboard view of the app
|
|
@@ -104,10 +106,12 @@ module WhopSDK
|
|
|
104
106
|
#
|
|
105
107
|
# Fetches a list of apps
|
|
106
108
|
#
|
|
107
|
-
# @overload list(after: nil, before: nil, company_id: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, verified_apps_only: nil, view_type: nil, request_options: {})
|
|
109
|
+
# @overload list(after: nil, app_type: nil, before: nil, company_id: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, verified_apps_only: nil, view_type: nil, request_options: {})
|
|
108
110
|
#
|
|
109
111
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
110
112
|
#
|
|
113
|
+
# @param app_type [Symbol, WhopSDK::Models::AppType, nil] The type of end-user an app is built for
|
|
114
|
+
#
|
|
111
115
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
112
116
|
#
|
|
113
117
|
# @param company_id [String, nil] The ID of the company to filter apps by
|
|
@@ -35,7 +35,7 @@ module WhopSDK
|
|
|
35
35
|
# - `company:authorized_user:read`
|
|
36
36
|
# - `member:email:read`
|
|
37
37
|
#
|
|
38
|
-
# @overload list(company_id:, after: nil, before: nil, first: nil, last: nil, role: nil, user_id: nil, request_options: {})
|
|
38
|
+
# @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, role: nil, user_id: nil, request_options: {})
|
|
39
39
|
#
|
|
40
40
|
# @param company_id [String] The ID of the company to list authorized users for
|
|
41
41
|
#
|
|
@@ -43,6 +43,10 @@ module WhopSDK
|
|
|
43
43
|
#
|
|
44
44
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
45
45
|
#
|
|
46
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
47
|
+
#
|
|
48
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
49
|
+
#
|
|
46
50
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
47
51
|
#
|
|
48
52
|
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
@@ -3,6 +3,9 @@
|
|
|
3
3
|
module WhopSDK
|
|
4
4
|
module Resources
|
|
5
5
|
class CheckoutConfigurations
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {WhopSDK::Models::CheckoutConfigurationCreateParams} for more details.
|
|
8
|
+
#
|
|
6
9
|
# Creates a new checkout configuration
|
|
7
10
|
#
|
|
8
11
|
# Required permissions:
|
|
@@ -11,19 +14,26 @@ module WhopSDK
|
|
|
11
14
|
# - `plan:create`
|
|
12
15
|
# - `access_pass:create`
|
|
13
16
|
# - `access_pass:update`
|
|
17
|
+
# - `checkout_configuration:basic:read`
|
|
14
18
|
#
|
|
15
|
-
# @overload create(plan:, plan_id:, affiliate_code: nil, metadata: nil, redirect_url: nil, request_options: {})
|
|
19
|
+
# @overload create(plan:, plan_id:, company_id:, affiliate_code: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, mode: :setup, request_options: {})
|
|
16
20
|
#
|
|
17
21
|
# @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan] Pass this object to create a new plan for this checkout configuration
|
|
18
22
|
#
|
|
19
23
|
# @param plan_id [String] The ID of the plan to use for the checkout configuration
|
|
20
24
|
#
|
|
25
|
+
# @param company_id [String] The ID of the company for which to generate the checkout configuration. Only req
|
|
26
|
+
#
|
|
21
27
|
# @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
|
|
22
28
|
#
|
|
23
29
|
# @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
|
|
24
30
|
#
|
|
31
|
+
# @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::PaymentMethodConfiguration, nil] This currently only works for configurations made in 'setup' mode. The explicit
|
|
32
|
+
#
|
|
25
33
|
# @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
|
|
26
34
|
#
|
|
35
|
+
# @param mode [Symbol, :setup]
|
|
36
|
+
#
|
|
27
37
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
38
|
#
|
|
29
39
|
# @return [WhopSDK::Models::CheckoutConfiguration]
|
|
@@ -70,7 +80,7 @@ module WhopSDK
|
|
|
70
80
|
#
|
|
71
81
|
# - `checkout_configuration:basic:read`
|
|
72
82
|
#
|
|
73
|
-
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, plan_id: nil, request_options: {})
|
|
83
|
+
# @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, plan_id: nil, request_options: {})
|
|
74
84
|
#
|
|
75
85
|
# @param company_id [String] The ID of the company to list checkout configurations for
|
|
76
86
|
#
|
|
@@ -78,6 +88,10 @@ module WhopSDK
|
|
|
78
88
|
#
|
|
79
89
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
80
90
|
#
|
|
91
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
92
|
+
#
|
|
93
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
94
|
+
#
|
|
81
95
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
82
96
|
#
|
|
83
97
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -66,7 +66,7 @@ module WhopSDK
|
|
|
66
66
|
#
|
|
67
67
|
# - `company:basic:read`
|
|
68
68
|
#
|
|
69
|
-
# @overload list(parent_company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
69
|
+
# @overload list(parent_company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
70
70
|
#
|
|
71
71
|
# @param parent_company_id [String] The ID of the parent company to list sub companies for
|
|
72
72
|
#
|
|
@@ -74,6 +74,10 @@ module WhopSDK
|
|
|
74
74
|
#
|
|
75
75
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
76
76
|
#
|
|
77
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
78
|
+
#
|
|
79
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
80
|
+
#
|
|
77
81
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
78
82
|
#
|
|
79
83
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -185,6 +185,70 @@ module WhopSDK
|
|
|
185
185
|
)
|
|
186
186
|
end
|
|
187
187
|
|
|
188
|
+
# Marks a course lesson as completed
|
|
189
|
+
#
|
|
190
|
+
# @overload mark_as_completed(lesson_id, request_options: {})
|
|
191
|
+
#
|
|
192
|
+
# @param lesson_id [String] The ID of the lesson to mark as completed
|
|
193
|
+
#
|
|
194
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
195
|
+
#
|
|
196
|
+
# @return [Boolean]
|
|
197
|
+
#
|
|
198
|
+
# @see WhopSDK::Models::CourseLessonMarkAsCompletedParams
|
|
199
|
+
def mark_as_completed(lesson_id, params = {})
|
|
200
|
+
@client.request(
|
|
201
|
+
method: :post,
|
|
202
|
+
path: ["course_lessons/%1$s/mark_as_completed", lesson_id],
|
|
203
|
+
model: WhopSDK::Internal::Type::Boolean,
|
|
204
|
+
options: params[:request_options]
|
|
205
|
+
)
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
# Starts a course lesson
|
|
209
|
+
#
|
|
210
|
+
# @overload start(lesson_id, request_options: {})
|
|
211
|
+
#
|
|
212
|
+
# @param lesson_id [String] The ID of the lesson being started
|
|
213
|
+
#
|
|
214
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
215
|
+
#
|
|
216
|
+
# @return [Boolean]
|
|
217
|
+
#
|
|
218
|
+
# @see WhopSDK::Models::CourseLessonStartParams
|
|
219
|
+
def start(lesson_id, params = {})
|
|
220
|
+
@client.request(
|
|
221
|
+
method: :post,
|
|
222
|
+
path: ["course_lessons/%1$s/start", lesson_id],
|
|
223
|
+
model: WhopSDK::Internal::Type::Boolean,
|
|
224
|
+
options: params[:request_options]
|
|
225
|
+
)
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
# Submits answers for a course assessment
|
|
229
|
+
#
|
|
230
|
+
# @overload submit_assessment(lesson_id, answers:, request_options: {})
|
|
231
|
+
#
|
|
232
|
+
# @param lesson_id [String] The ID of the lesson (quiz or knowledge check) to submit answers for
|
|
233
|
+
#
|
|
234
|
+
# @param answers [Array<WhopSDK::Models::CourseLessonSubmitAssessmentParams::Answer>] The answers to the assessment questions
|
|
235
|
+
#
|
|
236
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
237
|
+
#
|
|
238
|
+
# @return [WhopSDK::Models::CourseLessonSubmitAssessmentResponse]
|
|
239
|
+
#
|
|
240
|
+
# @see WhopSDK::Models::CourseLessonSubmitAssessmentParams
|
|
241
|
+
def submit_assessment(lesson_id, params)
|
|
242
|
+
parsed, options = WhopSDK::CourseLessonSubmitAssessmentParams.dump_request(params)
|
|
243
|
+
@client.request(
|
|
244
|
+
method: :post,
|
|
245
|
+
path: ["course_lessons/%1$s/submit_assessment", lesson_id],
|
|
246
|
+
body: parsed,
|
|
247
|
+
model: WhopSDK::Models::CourseLessonSubmitAssessmentResponse,
|
|
248
|
+
options: options
|
|
249
|
+
)
|
|
250
|
+
end
|
|
251
|
+
|
|
188
252
|
# @api private
|
|
189
253
|
#
|
|
190
254
|
# @param client [WhopSDK::Client]
|
|
@@ -44,7 +44,7 @@ module WhopSDK
|
|
|
44
44
|
# - `company:basic:read`
|
|
45
45
|
# - `payment:basic:read`
|
|
46
46
|
#
|
|
47
|
-
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
47
|
+
# @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
48
48
|
#
|
|
49
49
|
# @param company_id [String] The ID of the company to list disputes for
|
|
50
50
|
#
|
|
@@ -52,6 +52,10 @@ module WhopSDK
|
|
|
52
52
|
#
|
|
53
53
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
54
54
|
#
|
|
55
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
56
|
+
#
|
|
57
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
58
|
+
#
|
|
55
59
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
56
60
|
#
|
|
57
61
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -35,7 +35,7 @@ module WhopSDK
|
|
|
35
35
|
# - `plan:waitlist:read`
|
|
36
36
|
# - `member:email:read`
|
|
37
37
|
#
|
|
38
|
-
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, request_options: {})
|
|
38
|
+
# @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, request_options: {})
|
|
39
39
|
#
|
|
40
40
|
# @param company_id [String] The ID of the company
|
|
41
41
|
#
|
|
@@ -43,6 +43,10 @@ module WhopSDK
|
|
|
43
43
|
#
|
|
44
44
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
45
45
|
#
|
|
46
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
47
|
+
#
|
|
48
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
49
|
+
#
|
|
46
50
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
47
51
|
#
|
|
48
52
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -93,7 +93,7 @@ module WhopSDK
|
|
|
93
93
|
#
|
|
94
94
|
# - `experience:hidden_experience:read`
|
|
95
95
|
#
|
|
96
|
-
# @overload list(company_id:, after: nil, app_id: nil, before: nil, first: nil, last: nil, product_id: nil, request_options: {})
|
|
96
|
+
# @overload list(company_id:, after: nil, app_id: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, product_id: nil, request_options: {})
|
|
97
97
|
#
|
|
98
98
|
# @param company_id [String] The ID of the company to filter experiences by
|
|
99
99
|
#
|
|
@@ -103,6 +103,10 @@ module WhopSDK
|
|
|
103
103
|
#
|
|
104
104
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
105
105
|
#
|
|
106
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
107
|
+
#
|
|
108
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
109
|
+
#
|
|
106
110
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
107
111
|
#
|
|
108
112
|
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
@@ -34,7 +34,7 @@ module WhopSDK
|
|
|
34
34
|
#
|
|
35
35
|
# @param title [String, nil] The title of the post. Only visible if paywalled.
|
|
36
36
|
#
|
|
37
|
-
# @param visibility [Symbol, WhopSDK::Models::
|
|
37
|
+
# @param visibility [Symbol, WhopSDK::Models::ForumPostVisibilityType, nil] The visibility types for forum posts
|
|
38
38
|
#
|
|
39
39
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
40
40
|
#
|
|
@@ -93,7 +93,7 @@ module WhopSDK
|
|
|
93
93
|
#
|
|
94
94
|
# @param title [String, nil] The title of the post. Only visible if paywalled.
|
|
95
95
|
#
|
|
96
|
-
# @param visibility [Symbol, WhopSDK::Models::
|
|
96
|
+
# @param visibility [Symbol, WhopSDK::Models::ForumPostVisibilityType, nil] The visibility types for forum posts
|
|
97
97
|
#
|
|
98
98
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
99
99
|
#
|
|
@@ -85,7 +85,7 @@ module WhopSDK
|
|
|
85
85
|
# - `invoice:basic:read`
|
|
86
86
|
# - `plan:basic:read`
|
|
87
87
|
#
|
|
88
|
-
# @overload list(company_id:, after: nil, before: nil, collection_methods: nil, direction: nil, first: nil, last: nil, order: nil, product_ids: nil, statuses: nil, request_options: {})
|
|
88
|
+
# @overload list(company_id:, after: nil, before: nil, collection_methods: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, product_ids: nil, statuses: nil, request_options: {})
|
|
89
89
|
#
|
|
90
90
|
# @param company_id [String] The ID of the company to list invoices for
|
|
91
91
|
#
|
|
@@ -95,6 +95,10 @@ module WhopSDK
|
|
|
95
95
|
#
|
|
96
96
|
# @param collection_methods [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil] Filter invoices by their collection method
|
|
97
97
|
#
|
|
98
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
99
|
+
#
|
|
100
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
101
|
+
#
|
|
98
102
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
99
103
|
#
|
|
100
104
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -14,7 +14,7 @@ module WhopSDK
|
|
|
14
14
|
# - `access_pass:basic:read`
|
|
15
15
|
# - `plan:basic:read`
|
|
16
16
|
#
|
|
17
|
-
# @overload create(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil,
|
|
17
|
+
# @overload create(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
18
18
|
#
|
|
19
19
|
# @param company_id [String] The company the plan should be created for.
|
|
20
20
|
#
|
|
@@ -28,7 +28,7 @@ module WhopSDK
|
|
|
28
28
|
#
|
|
29
29
|
# @param description [String, nil] The description of the plan.
|
|
30
30
|
#
|
|
31
|
-
# @param expiration_days [Integer, nil] The interval at which the plan
|
|
31
|
+
# @param expiration_days [Integer, nil] The interval at which the plan expires and revokes access (expiration plans).
|
|
32
32
|
#
|
|
33
33
|
# @param image [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
|
|
34
34
|
#
|
|
@@ -48,10 +48,6 @@ module WhopSDK
|
|
|
48
48
|
#
|
|
49
49
|
# @param stock [Integer, nil] The number of units available for purchase.
|
|
50
50
|
#
|
|
51
|
-
# @param strike_through_initial_price [Float, nil] The price to display with a strikethrough for the initial price. Provided as a n
|
|
52
|
-
#
|
|
53
|
-
# @param strike_through_renewal_price [Float, nil] The price to display with a strikethrough for the renewal price. Provided as a n
|
|
54
|
-
#
|
|
55
51
|
# @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
|
|
56
52
|
#
|
|
57
53
|
# @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
|
|
@@ -169,7 +165,7 @@ module WhopSDK
|
|
|
169
165
|
#
|
|
170
166
|
# - `plan:basic:read`
|
|
171
167
|
#
|
|
172
|
-
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, plan_types: nil, product_ids: nil, release_methods: nil, visibilities: nil, request_options: {})
|
|
168
|
+
# @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_types: nil, product_ids: nil, release_methods: nil, visibilities: nil, request_options: {})
|
|
173
169
|
#
|
|
174
170
|
# @param company_id [String] The ID of the company
|
|
175
171
|
#
|
|
@@ -177,6 +173,10 @@ module WhopSDK
|
|
|
177
173
|
#
|
|
178
174
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
179
175
|
#
|
|
176
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
177
|
+
#
|
|
178
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
179
|
+
#
|
|
180
180
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
181
181
|
#
|
|
182
182
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -108,12 +108,10 @@ module WhopSDK
|
|
|
108
108
|
# - `access_pass:update`
|
|
109
109
|
# - `access_pass:basic:read`
|
|
110
110
|
#
|
|
111
|
-
# @overload update(id,
|
|
111
|
+
# @overload update(id, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
|
|
112
112
|
#
|
|
113
113
|
# @param id [String] The ID (tag) of the product
|
|
114
114
|
#
|
|
115
|
-
# @param banner_image [WhopSDK::Models::ProductUpdateParams::BannerImage::AttachmentInputWithDirectUploadID, WhopSDK::Models::ProductUpdateParams::BannerImage::AttachmentInputWithID, nil] A banner image for the product in png, jpeg format
|
|
116
|
-
#
|
|
117
115
|
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
118
116
|
#
|
|
119
117
|
# @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
|
|
@@ -173,7 +171,7 @@ module WhopSDK
|
|
|
173
171
|
#
|
|
174
172
|
# - `access_pass:basic:read`
|
|
175
173
|
#
|
|
176
|
-
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, product_types: nil, visibilities: nil, request_options: {})
|
|
174
|
+
# @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, product_types: nil, visibilities: nil, request_options: {})
|
|
177
175
|
#
|
|
178
176
|
# @param company_id [String] The ID of the company to filter products by
|
|
179
177
|
#
|
|
@@ -181,6 +179,10 @@ module WhopSDK
|
|
|
181
179
|
#
|
|
182
180
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
183
181
|
#
|
|
182
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
183
|
+
#
|
|
184
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
185
|
+
#
|
|
184
186
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
185
187
|
#
|
|
186
188
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -93,7 +93,7 @@ module WhopSDK
|
|
|
93
93
|
# - `promo_code:basic:read`
|
|
94
94
|
# - `access_pass:basic:read`
|
|
95
95
|
#
|
|
96
|
-
# @overload list(company_id:, after: nil, before: nil, first: nil, last: nil, plan_ids: nil, product_ids: nil, status: nil, request_options: {})
|
|
96
|
+
# @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, plan_ids: nil, product_ids: nil, status: nil, request_options: {})
|
|
97
97
|
#
|
|
98
98
|
# @param company_id [String] The ID of the company to list promo codes for
|
|
99
99
|
#
|
|
@@ -101,6 +101,10 @@ module WhopSDK
|
|
|
101
101
|
#
|
|
102
102
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
103
103
|
#
|
|
104
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
105
|
+
#
|
|
106
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
107
|
+
#
|
|
104
108
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
105
109
|
#
|
|
106
110
|
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Refunds
|
|
6
|
+
# Retrieves a Refund by ID
|
|
7
|
+
#
|
|
8
|
+
# Required permissions:
|
|
9
|
+
#
|
|
10
|
+
# - `payment:basic:read`
|
|
11
|
+
# - `member:email:read`
|
|
12
|
+
# - `member:basic:read`
|
|
13
|
+
# - `member:phone:read`
|
|
14
|
+
#
|
|
15
|
+
# @overload retrieve(id, request_options: {})
|
|
16
|
+
#
|
|
17
|
+
# @param id [String] The ID of the refund
|
|
18
|
+
#
|
|
19
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
20
|
+
#
|
|
21
|
+
# @return [WhopSDK::Models::RefundRetrieveResponse]
|
|
22
|
+
#
|
|
23
|
+
# @see WhopSDK::Models::RefundRetrieveParams
|
|
24
|
+
def retrieve(id, params = {})
|
|
25
|
+
@client.request(
|
|
26
|
+
method: :get,
|
|
27
|
+
path: ["refunds/%1$s", id],
|
|
28
|
+
model: WhopSDK::Models::RefundRetrieveResponse,
|
|
29
|
+
options: params[:request_options]
|
|
30
|
+
)
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Lists Refunds for a payment.
|
|
34
|
+
#
|
|
35
|
+
# Required permissions:
|
|
36
|
+
#
|
|
37
|
+
# - `payment:basic:read`
|
|
38
|
+
#
|
|
39
|
+
# @overload list(payment_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
40
|
+
#
|
|
41
|
+
# @param payment_id [String] The ID of the payment to list refunds for
|
|
42
|
+
#
|
|
43
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
44
|
+
#
|
|
45
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
46
|
+
#
|
|
47
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
48
|
+
#
|
|
49
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
50
|
+
#
|
|
51
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
52
|
+
#
|
|
53
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
54
|
+
#
|
|
55
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
56
|
+
#
|
|
57
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
58
|
+
#
|
|
59
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::RefundListResponse>]
|
|
60
|
+
#
|
|
61
|
+
# @see WhopSDK::Models::RefundListParams
|
|
62
|
+
def list(params)
|
|
63
|
+
parsed, options = WhopSDK::RefundListParams.dump_request(params)
|
|
64
|
+
@client.request(
|
|
65
|
+
method: :get,
|
|
66
|
+
path: "refunds",
|
|
67
|
+
query: parsed,
|
|
68
|
+
page: WhopSDK::Internal::CursorPage,
|
|
69
|
+
model: WhopSDK::Models::RefundListResponse,
|
|
70
|
+
options: options
|
|
71
|
+
)
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# @api private
|
|
75
|
+
#
|
|
76
|
+
# @param client [WhopSDK::Client]
|
|
77
|
+
def initialize(client:)
|
|
78
|
+
@client = client
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
end
|