whop_sdk 0.0.22 → 0.0.24
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 +45 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +4 -0
- data/lib/whop_sdk/models/app_build_create_params.rb +16 -55
- data/lib/whop_sdk/models/app_create_params.rb +22 -1
- data/lib/whop_sdk/models/app_list_params.rb +5 -0
- data/lib/whop_sdk/models/app_update_params.rb +14 -53
- data/lib/whop_sdk/models/card_brands.rb +16 -0
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +32 -56
- data/lib/whop_sdk/models/company_create_params.rb +22 -1
- data/lib/whop_sdk/models/company_update_params.rb +28 -106
- data/lib/whop_sdk/models/course_create_params.rb +15 -62
- data/lib/whop_sdk/models/course_lesson_create_params.rb +14 -53
- data/lib/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/course_lesson_update_params.rb +53 -214
- data/lib/whop_sdk/models/course_update_params.rb +14 -61
- data/lib/whop_sdk/models/dispute_created_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/dispute_update_evidence_params.rb +56 -212
- data/lib/whop_sdk/models/dispute_updated_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/entry_approved_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/entry_created_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/entry_deleted_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/entry_denied_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/experience_create_params.rb +22 -1
- data/lib/whop_sdk/models/experience_update_params.rb +14 -53
- data/lib/whop_sdk/models/file_create_params.rb +22 -0
- data/lib/whop_sdk/models/file_create_response.rb +90 -0
- data/lib/whop_sdk/models/file_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/file_retrieve_response.rb +74 -0
- data/lib/whop_sdk/models/forum_post_create_params.rb +13 -52
- data/lib/whop_sdk/models/forum_post_update_params.rb +13 -52
- data/lib/whop_sdk/models/friendly_receipt_status.rb +23 -11
- data/lib/whop_sdk/models/invoice_created_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/invoice_paid_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/invoice_past_due_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/invoice_voided_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +1 -34
- data/lib/whop_sdk/models/member_list_response.rb +9 -1
- data/lib/whop_sdk/models/member_retrieve_response.rb +9 -1
- data/lib/whop_sdk/models/membership.rb +76 -2
- data/lib/whop_sdk/models/membership_activated_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/membership_cancel_at_period_end_changed_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/membership_deactivated_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/membership_list_response.rb +38 -2
- data/lib/whop_sdk/models/membership_uncancel_params.rb +14 -0
- data/lib/whop_sdk/models/message_create_params.rb +13 -52
- data/lib/whop_sdk/models/message_update_params.rb +14 -53
- data/lib/whop_sdk/models/payment.rb +17 -1
- data/lib/whop_sdk/models/payment_created_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/payment_failed_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/payment_list_response.rb +17 -1
- data/lib/whop_sdk/models/payment_method_types.rb +38 -37
- data/lib/whop_sdk/models/payment_pending_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/payment_provider.rb +1 -0
- data/lib/whop_sdk/models/payment_succeeded_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +35 -2
- data/lib/whop_sdk/models/payout_method_list_response.rb +26 -1
- data/lib/whop_sdk/models/payout_method_retrieve_response.rb +26 -1
- data/lib/whop_sdk/models/plan_create_params.rb +23 -54
- data/lib/whop_sdk/models/plan_update_params.rb +23 -54
- data/lib/whop_sdk/models/refund_created_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/refund_updated_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/setup_intent_canceled_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/setup_intent_requires_action_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/setup_intent_succeeded_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/verification_succeeded_webhook_event.rb +9 -1
- data/lib/whop_sdk/models/webhook_create_params.rb +117 -0
- data/lib/whop_sdk/models/webhook_create_response.rb +184 -0
- data/lib/whop_sdk/models/webhook_delete_params.rb +14 -0
- data/lib/whop_sdk/models/webhook_delete_response.rb +8 -0
- data/lib/whop_sdk/models/webhook_list_params.rb +54 -0
- data/lib/whop_sdk/models/webhook_list_response.rb +123 -0
- data/lib/whop_sdk/models/webhook_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/webhook_retrieve_response.rb +176 -0
- data/lib/whop_sdk/models/webhook_update_params.rb +104 -0
- data/lib/whop_sdk/models/webhook_update_response.rb +176 -0
- data/lib/whop_sdk/models/withdrawal_create_params.rb +21 -1
- data/lib/whop_sdk/models/withdrawal_create_response.rb +2 -9
- data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +11 -10
- data/lib/whop_sdk/models/withdrawal_list_response.rb +1 -9
- data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +2 -9
- data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +11 -10
- data/lib/whop_sdk/models.rb +16 -2
- data/lib/whop_sdk/resources/app_builds.rb +1 -1
- data/lib/whop_sdk/resources/apps.rb +4 -2
- data/lib/whop_sdk/resources/checkout_configurations.rb +3 -1
- data/lib/whop_sdk/resources/companies.rb +5 -3
- data/lib/whop_sdk/resources/course_lessons.rb +4 -4
- data/lib/whop_sdk/resources/courses.rb +4 -8
- data/lib/whop_sdk/resources/disputes.rb +4 -4
- data/lib/whop_sdk/resources/experiences.rb +4 -2
- data/lib/whop_sdk/resources/files.rb +56 -0
- data/lib/whop_sdk/resources/forum_posts.rb +2 -2
- data/lib/whop_sdk/resources/memberships.rb +32 -0
- data/lib/whop_sdk/resources/messages.rb +2 -2
- data/lib/whop_sdk/resources/notifications.rb +4 -0
- data/lib/whop_sdk/resources/plans.rb +8 -4
- data/lib/whop_sdk/resources/webhooks.rb +158 -0
- data/lib/whop_sdk/resources/withdrawals.rb +8 -1
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +16 -1
- data/rbi/whop_sdk/client.rbi +3 -0
- data/rbi/whop_sdk/models/app_build_create_params.rbi +26 -89
- data/rbi/whop_sdk/models/app_create_params.rbi +36 -0
- data/rbi/whop_sdk/models/app_list_params.rbi +10 -0
- data/rbi/whop_sdk/models/app_update_params.rbi +21 -93
- data/rbi/whop_sdk/models/card_brands.rbi +17 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +45 -87
- data/rbi/whop_sdk/models/company_create_params.rbi +39 -0
- data/rbi/whop_sdk/models/company_update_params.rbi +47 -185
- data/rbi/whop_sdk/models/course_create_params.rbi +24 -101
- data/rbi/whop_sdk/models/course_lesson_create_params.rbi +25 -92
- data/rbi/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/course_lesson_update_params.rbi +97 -359
- data/rbi/whop_sdk/models/course_update_params.rbi +24 -101
- data/rbi/whop_sdk/models/dispute_created_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/dispute_update_evidence_params.rbi +116 -340
- data/rbi/whop_sdk/models/dispute_updated_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/entry_approved_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/entry_created_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/entry_deleted_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/entry_denied_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/experience_create_params.rbi +41 -0
- data/rbi/whop_sdk/models/experience_update_params.rbi +24 -93
- data/rbi/whop_sdk/models/file_create_params.rbi +40 -0
- data/rbi/whop_sdk/models/file_create_response.rbi +140 -0
- data/rbi/whop_sdk/models/file_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/file_retrieve_response.rbi +129 -0
- data/rbi/whop_sdk/models/forum_post_create_params.rbi +18 -94
- data/rbi/whop_sdk/models/forum_post_update_params.rbi +18 -94
- data/rbi/whop_sdk/models/friendly_receipt_status.rbi +62 -17
- data/rbi/whop_sdk/models/invoice_created_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/invoice_paid_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/invoice_past_due_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/invoice_voided_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +0 -105
- data/rbi/whop_sdk/models/member_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +8 -0
- data/rbi/whop_sdk/models/membership.rbi +126 -4
- data/rbi/whop_sdk/models/membership_activated_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/membership_cancel_at_period_end_changed_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/membership_deactivated_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/membership_list_response.rbi +98 -4
- data/rbi/whop_sdk/models/membership_uncancel_params.rbi +27 -0
- data/rbi/whop_sdk/models/message_create_params.rbi +18 -94
- data/rbi/whop_sdk/models/message_update_params.rbi +18 -94
- data/rbi/whop_sdk/models/payment.rbi +16 -0
- data/rbi/whop_sdk/models/payment_created_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/payment_failed_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/payment_list_response.rbi +16 -0
- data/rbi/whop_sdk/models/payment_method_types.rbi +45 -43
- data/rbi/whop_sdk/models/payment_pending_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/payment_provider.rbi +1 -0
- data/rbi/whop_sdk/models/payment_succeeded_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +35 -1
- data/rbi/whop_sdk/models/payout_method_list_response.rbi +26 -0
- data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +26 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +29 -93
- data/rbi/whop_sdk/models/plan_update_params.rbi +29 -93
- data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/setup_intent_canceled_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/setup_intent_requires_action_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/setup_intent_succeeded_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/verification_succeeded_webhook_event.rbi +9 -1
- data/rbi/whop_sdk/models/webhook_create_params.rbi +275 -0
- data/rbi/whop_sdk/models/webhook_create_response.rbi +494 -0
- data/rbi/whop_sdk/models/webhook_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/webhook_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/webhook_list_params.rbi +75 -0
- data/rbi/whop_sdk/models/webhook_list_response.rbi +297 -0
- data/rbi/whop_sdk/models/webhook_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/webhook_retrieve_response.rbi +491 -0
- data/rbi/whop_sdk/models/webhook_update_params.rbi +263 -0
- data/rbi/whop_sdk/models/webhook_update_response.rbi +486 -0
- data/rbi/whop_sdk/models/withdrawal_create_params.rbi +18 -0
- data/rbi/whop_sdk/models/withdrawal_create_response.rbi +8 -11
- data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +17 -12
- data/rbi/whop_sdk/models/withdrawal_list_response.rbi +3 -11
- data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +8 -11
- data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +17 -12
- data/rbi/whop_sdk/models.rbi +16 -2
- data/rbi/whop_sdk/resources/app_builds.rbi +1 -5
- data/rbi/whop_sdk/resources/apps.rbi +4 -7
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +3 -0
- data/rbi/whop_sdk/resources/companies.rbi +5 -13
- data/rbi/whop_sdk/resources/course_lessons.rbi +4 -24
- data/rbi/whop_sdk/resources/courses.rbi +2 -20
- data/rbi/whop_sdk/resources/disputes.rbi +4 -16
- data/rbi/whop_sdk/resources/experiences.rbi +4 -7
- data/rbi/whop_sdk/resources/files.rbi +40 -0
- data/rbi/whop_sdk/resources/forum_posts.rbi +2 -12
- data/rbi/whop_sdk/resources/memberships.rbi +26 -0
- data/rbi/whop_sdk/resources/messages.rbi +2 -12
- data/rbi/whop_sdk/resources/notifications.rbi +4 -0
- data/rbi/whop_sdk/resources/plans.rbi +8 -14
- data/rbi/whop_sdk/resources/webhooks.rbi +140 -0
- data/rbi/whop_sdk/resources/withdrawals.rbi +7 -0
- data/sig/whop_sdk/client.rbs +2 -0
- data/sig/whop_sdk/models/app_build_create_params.rbs +9 -30
- data/sig/whop_sdk/models/app_create_params.rbs +20 -1
- data/sig/whop_sdk/models/app_list_params.rbs +10 -0
- data/sig/whop_sdk/models/app_update_params.rbs +9 -30
- data/sig/whop_sdk/models/card_brands.rbs +32 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +19 -30
- data/sig/whop_sdk/models/company_create_params.rbs +15 -0
- data/sig/whop_sdk/models/company_update_params.rbs +18 -60
- data/sig/whop_sdk/models/course_create_params.rbs +9 -35
- data/sig/whop_sdk/models/course_lesson_create_params.rbs +9 -30
- data/sig/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/course_lesson_update_params.rbs +36 -120
- data/sig/whop_sdk/models/course_update_params.rbs +9 -35
- data/sig/whop_sdk/models/dispute_created_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/dispute_update_evidence_params.rbs +36 -120
- data/sig/whop_sdk/models/dispute_updated_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/entry_approved_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/entry_created_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/entry_deleted_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/entry_denied_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/experience_create_params.rbs +15 -0
- data/sig/whop_sdk/models/experience_update_params.rbs +9 -30
- data/sig/whop_sdk/models/file_create_params.rbs +23 -0
- data/sig/whop_sdk/models/file_create_response.rbs +68 -0
- data/sig/whop_sdk/models/file_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/file_retrieve_response.rbs +58 -0
- data/sig/whop_sdk/models/forum_post_create_params.rbs +9 -30
- data/sig/whop_sdk/models/forum_post_update_params.rbs +9 -30
- data/sig/whop_sdk/models/friendly_receipt_status.rbs +46 -22
- data/sig/whop_sdk/models/invoice_created_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/invoice_paid_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/invoice_past_due_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/invoice_voided_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +0 -38
- data/sig/whop_sdk/models/member_list_response.rbs +5 -0
- data/sig/whop_sdk/models/member_retrieve_response.rbs +5 -0
- data/sig/whop_sdk/models/membership.rbs +65 -4
- data/sig/whop_sdk/models/membership_activated_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/membership_cancel_at_period_end_changed_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/membership_deactivated_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/membership_list_response.rbs +45 -4
- data/sig/whop_sdk/models/membership_uncancel_params.rbs +15 -0
- data/sig/whop_sdk/models/message_create_params.rbs +9 -30
- data/sig/whop_sdk/models/message_update_params.rbs +9 -30
- data/sig/whop_sdk/models/payment.rbs +10 -0
- data/sig/whop_sdk/models/payment_created_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/payment_failed_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/payment_list_response.rbs +10 -0
- data/sig/whop_sdk/models/payment_method_types.rbs +76 -74
- data/sig/whop_sdk/models/payment_pending_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/payment_provider.rbs +2 -0
- data/sig/whop_sdk/models/payment_succeeded_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +22 -2
- data/sig/whop_sdk/models/payout_method_list_response.rbs +15 -0
- data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +15 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +14 -30
- data/sig/whop_sdk/models/plan_update_params.rbs +14 -30
- data/sig/whop_sdk/models/refund_created_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/setup_intent_canceled_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/setup_intent_requires_action_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/setup_intent_succeeded_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/verification_succeeded_webhook_event.rbs +7 -2
- data/sig/whop_sdk/models/webhook_create_params.rbs +126 -0
- data/sig/whop_sdk/models/webhook_create_response.rbs +203 -0
- data/sig/whop_sdk/models/webhook_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/webhook_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/webhook_list_params.rbs +46 -0
- data/sig/whop_sdk/models/webhook_list_response.rbs +125 -0
- data/sig/whop_sdk/models/webhook_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/webhook_retrieve_response.rbs +198 -0
- data/sig/whop_sdk/models/webhook_update_params.rbs +121 -0
- data/sig/whop_sdk/models/webhook_update_response.rbs +198 -0
- data/sig/whop_sdk/models/withdrawal_create_params.rbs +11 -1
- data/sig/whop_sdk/models/withdrawal_create_response.rbs +5 -8
- data/sig/whop_sdk/models/withdrawal_created_webhook_event.rbs +12 -10
- data/sig/whop_sdk/models/withdrawal_list_response.rbs +3 -8
- data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +5 -8
- data/sig/whop_sdk/models/withdrawal_updated_webhook_event.rbs +12 -10
- data/sig/whop_sdk/models.rbs +16 -2
- data/sig/whop_sdk/resources/app_builds.rbs +1 -1
- data/sig/whop_sdk/resources/apps.rbs +2 -1
- data/sig/whop_sdk/resources/checkout_configurations.rbs +1 -0
- data/sig/whop_sdk/resources/companies.rbs +3 -2
- data/sig/whop_sdk/resources/course_lessons.rbs +4 -4
- data/sig/whop_sdk/resources/courses.rbs +2 -4
- data/sig/whop_sdk/resources/disputes.rbs +4 -4
- data/sig/whop_sdk/resources/experiences.rbs +2 -1
- data/sig/whop_sdk/resources/files.rbs +17 -0
- data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
- data/sig/whop_sdk/resources/memberships.rbs +5 -0
- data/sig/whop_sdk/resources/messages.rbs +2 -2
- data/sig/whop_sdk/resources/plans.rbs +4 -2
- data/sig/whop_sdk/resources/webhooks.rbs +36 -0
- data/sig/whop_sdk/resources/withdrawals.rbs +2 -0
- metadata +64 -5
- data/lib/whop_sdk/models/withdrawal_types.rb +0 -16
- data/rbi/whop_sdk/models/withdrawal_types.rbi +0 -20
- data/sig/whop_sdk/models/withdrawal_types.rbs +0 -14
|
@@ -33,13 +33,21 @@ module WhopSDK
|
|
|
33
33
|
# @return [Symbol, :"withdrawal.updated"]
|
|
34
34
|
required :type, const: :"withdrawal.updated"
|
|
35
35
|
|
|
36
|
-
# @!
|
|
36
|
+
# @!attribute company_id
|
|
37
|
+
# The company ID that this webhook event is associated with
|
|
38
|
+
#
|
|
39
|
+
# @return [String, nil]
|
|
40
|
+
optional :company_id, String, nil?: true
|
|
41
|
+
|
|
42
|
+
# @!method initialize(id:, data:, timestamp:, company_id: nil, api_version: :v1, type: :"withdrawal.updated")
|
|
37
43
|
# @param id [String] A unique ID for every single webhook request
|
|
38
44
|
#
|
|
39
45
|
# @param data [WhopSDK::Models::WithdrawalUpdatedWebhookEvent::Data] A withdrawal request.
|
|
40
46
|
#
|
|
41
47
|
# @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
42
48
|
#
|
|
49
|
+
# @param company_id [String, nil] The company ID that this webhook event is associated with
|
|
50
|
+
#
|
|
43
51
|
# @param api_version [Symbol, :v1] The API version for this webhook
|
|
44
52
|
#
|
|
45
53
|
# @param type [Symbol, :"withdrawal.updated"] The webhook event type
|
|
@@ -140,13 +148,7 @@ module WhopSDK
|
|
|
140
148
|
# @return [String, nil]
|
|
141
149
|
required :trace_code, String, nil?: true
|
|
142
150
|
|
|
143
|
-
# @!
|
|
144
|
-
# The type of withdrawal.
|
|
145
|
-
#
|
|
146
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
147
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
148
|
-
|
|
149
|
-
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:, withdrawal_type:)
|
|
151
|
+
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:)
|
|
150
152
|
# Some parameter documentations has been truncated, see
|
|
151
153
|
# {WhopSDK::Models::WithdrawalUpdatedWebhookEvent::Data} for more details.
|
|
152
154
|
#
|
|
@@ -181,8 +183,6 @@ module WhopSDK
|
|
|
181
183
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
182
184
|
#
|
|
183
185
|
# @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
|
|
184
|
-
#
|
|
185
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
186
186
|
|
|
187
187
|
# The different error codes a payout can be in.
|
|
188
188
|
#
|
|
@@ -215,6 +215,7 @@ module WhopSDK
|
|
|
215
215
|
INVALID_ACCOUNT_NUMBER = :invalid_account_number
|
|
216
216
|
INVALID_BANK_CODE = :invalid_bank_code
|
|
217
217
|
INVALID_BENEFICIARY = :invalid_beneficiary
|
|
218
|
+
INVALID_MAILING_ADDRESS = :invalid_mailing_address
|
|
218
219
|
INVALID_BRANCH_NUMBER = :invalid_branch_number
|
|
219
220
|
INVALID_BRANCH_CODE = :invalid_branch_code
|
|
220
221
|
INVALID_PHONE_NUMBER = :invalid_phone_number
|
data/lib/whop_sdk/models.rb
CHANGED
|
@@ -252,6 +252,10 @@ module WhopSDK
|
|
|
252
252
|
|
|
253
253
|
FeeMarkupType = WhopSDK::Models::FeeMarkupType
|
|
254
254
|
|
|
255
|
+
FileCreateParams = WhopSDK::Models::FileCreateParams
|
|
256
|
+
|
|
257
|
+
FileRetrieveParams = WhopSDK::Models::FileRetrieveParams
|
|
258
|
+
|
|
255
259
|
Forum = WhopSDK::Models::Forum
|
|
256
260
|
|
|
257
261
|
ForumListParams = WhopSDK::Models::ForumListParams
|
|
@@ -345,6 +349,8 @@ module WhopSDK
|
|
|
345
349
|
|
|
346
350
|
MembershipStatus = WhopSDK::Models::MembershipStatus
|
|
347
351
|
|
|
352
|
+
MembershipUncancelParams = WhopSDK::Models::MembershipUncancelParams
|
|
353
|
+
|
|
348
354
|
MembershipUpdateParams = WhopSDK::Models::MembershipUpdateParams
|
|
349
355
|
|
|
350
356
|
MemberStatuses = WhopSDK::Models::MemberStatuses
|
|
@@ -539,8 +545,18 @@ module WhopSDK
|
|
|
539
545
|
|
|
540
546
|
VisibilityFilter = WhopSDK::Models::VisibilityFilter
|
|
541
547
|
|
|
548
|
+
WebhookCreateParams = WhopSDK::Models::WebhookCreateParams
|
|
549
|
+
|
|
550
|
+
WebhookDeleteParams = WhopSDK::Models::WebhookDeleteParams
|
|
551
|
+
|
|
552
|
+
WebhookListParams = WhopSDK::Models::WebhookListParams
|
|
553
|
+
|
|
554
|
+
WebhookRetrieveParams = WhopSDK::Models::WebhookRetrieveParams
|
|
555
|
+
|
|
542
556
|
WebhookUnwrapParams = WhopSDK::Models::WebhookUnwrapParams
|
|
543
557
|
|
|
558
|
+
WebhookUpdateParams = WhopSDK::Models::WebhookUpdateParams
|
|
559
|
+
|
|
544
560
|
WhoCanCommentTypes = WhopSDK::Models::WhoCanCommentTypes
|
|
545
561
|
|
|
546
562
|
WhoCanPost = WhopSDK::Models::WhoCanPost
|
|
@@ -563,7 +579,5 @@ module WhopSDK
|
|
|
563
579
|
|
|
564
580
|
WithdrawalStatus = WhopSDK::Models::WithdrawalStatus
|
|
565
581
|
|
|
566
|
-
WithdrawalTypes = WhopSDK::Models::WithdrawalTypes
|
|
567
|
-
|
|
568
582
|
WithdrawalUpdatedWebhookEvent = WhopSDK::Models::WithdrawalUpdatedWebhookEvent
|
|
569
583
|
end
|
|
@@ -14,7 +14,7 @@ module WhopSDK
|
|
|
14
14
|
#
|
|
15
15
|
# @overload create(attachment:, checksum:, platform:, ai_prompt_id: nil, app_id: nil, supported_app_view_types: nil, request_options: {})
|
|
16
16
|
#
|
|
17
|
-
# @param attachment [WhopSDK::Models::AppBuildCreateParams::Attachment
|
|
17
|
+
# @param attachment [WhopSDK::Models::AppBuildCreateParams::Attachment] Attachment input for the app build file. This should be an upload in .zip format
|
|
18
18
|
#
|
|
19
19
|
# @param checksum [String] Checksum of the app build file. This is generated by the client and used to veri
|
|
20
20
|
#
|
|
@@ -10,7 +10,7 @@ module WhopSDK
|
|
|
10
10
|
# - `developer:create_app`
|
|
11
11
|
# - `developer:manage_api_key`
|
|
12
12
|
#
|
|
13
|
-
# @overload create(company_id:, name:, base_url: nil, request_options: {})
|
|
13
|
+
# @overload create(company_id:, name:, base_url: nil, icon: nil, request_options: {})
|
|
14
14
|
#
|
|
15
15
|
# @param company_id [String] The ID of the company to create the app for
|
|
16
16
|
#
|
|
@@ -18,6 +18,8 @@ module WhopSDK
|
|
|
18
18
|
#
|
|
19
19
|
# @param base_url [String, nil] The base URL of the app to be created
|
|
20
20
|
#
|
|
21
|
+
# @param icon [WhopSDK::Models::AppCreateParams::Icon, nil] The icon for the app in png, jpeg, or gif format
|
|
22
|
+
#
|
|
21
23
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
24
|
#
|
|
23
25
|
# @return [WhopSDK::Models::App]
|
|
@@ -77,7 +79,7 @@ module WhopSDK
|
|
|
77
79
|
#
|
|
78
80
|
# @param experience_path [String, nil] The path for the hub view of the app
|
|
79
81
|
#
|
|
80
|
-
# @param icon [WhopSDK::Models::AppUpdateParams::Icon
|
|
82
|
+
# @param icon [WhopSDK::Models::AppUpdateParams::Icon, nil] The icon for the app
|
|
81
83
|
#
|
|
82
84
|
# @param name [String, nil] The name of the app
|
|
83
85
|
#
|
|
@@ -16,7 +16,7 @@ module WhopSDK
|
|
|
16
16
|
# - `access_pass:update`
|
|
17
17
|
# - `checkout_configuration:basic:read`
|
|
18
18
|
#
|
|
19
|
-
# @overload create(plan:, plan_id:, company_id:, affiliate_code: nil, currency: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, mode: :setup, request_options: {})
|
|
19
|
+
# @overload create(plan:, plan_id:, company_id:, affiliate_code: nil, currency: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, source_url: nil, mode: :setup, request_options: {})
|
|
20
20
|
#
|
|
21
21
|
# @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan] Pass this object to create a new plan for this checkout configuration
|
|
22
22
|
#
|
|
@@ -34,6 +34,8 @@ module WhopSDK
|
|
|
34
34
|
#
|
|
35
35
|
# @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
|
|
36
36
|
#
|
|
37
|
+
# @param source_url [String, nil] The URL of the page where the checkout is being initiated from.
|
|
38
|
+
#
|
|
37
39
|
# @param mode [Symbol, :setup]
|
|
38
40
|
#
|
|
39
41
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -13,7 +13,7 @@ module WhopSDK
|
|
|
13
13
|
# - `company:create_child`
|
|
14
14
|
# - `company:basic:read`
|
|
15
15
|
#
|
|
16
|
-
# @overload create(email:, parent_company_id:, title:, business_type: nil, industry_type: nil, metadata: nil, send_customer_emails: nil, request_options: {})
|
|
16
|
+
# @overload create(email:, parent_company_id:, title:, business_type: nil, industry_type: nil, logo: nil, metadata: nil, send_customer_emails: nil, request_options: {})
|
|
17
17
|
#
|
|
18
18
|
# @param email [String] The email of the user who the company will belong to.
|
|
19
19
|
#
|
|
@@ -25,6 +25,8 @@ module WhopSDK
|
|
|
25
25
|
#
|
|
26
26
|
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
27
27
|
#
|
|
28
|
+
# @param logo [WhopSDK::Models::CompanyCreateParams::Logo, nil] The logo for the company in png, jpeg, or gif format
|
|
29
|
+
#
|
|
28
30
|
# @param metadata [Hash{Symbol=>Object}, nil] Additional metadata for the account
|
|
29
31
|
#
|
|
30
32
|
# @param send_customer_emails [Boolean, nil] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
@@ -84,13 +86,13 @@ module WhopSDK
|
|
|
84
86
|
#
|
|
85
87
|
# @param id [String] The ID of the company to update
|
|
86
88
|
#
|
|
87
|
-
# @param banner_image [WhopSDK::Models::CompanyUpdateParams::BannerImage
|
|
89
|
+
# @param banner_image [WhopSDK::Models::CompanyUpdateParams::BannerImage, nil] The banner image for the company in png or jpeg format
|
|
88
90
|
#
|
|
89
91
|
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
90
92
|
#
|
|
91
93
|
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
92
94
|
#
|
|
93
|
-
# @param logo [WhopSDK::Models::CompanyUpdateParams::Logo
|
|
95
|
+
# @param logo [WhopSDK::Models::CompanyUpdateParams::Logo, nil] The logo for the company in png, jpeg, or gif format
|
|
94
96
|
#
|
|
95
97
|
# @param send_customer_emails [Boolean, nil] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
96
98
|
#
|
|
@@ -23,7 +23,7 @@ module WhopSDK
|
|
|
23
23
|
#
|
|
24
24
|
# @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
|
|
25
25
|
#
|
|
26
|
-
# @param thumbnail [WhopSDK::Models::CourseLessonCreateParams::Thumbnail
|
|
26
|
+
# @param thumbnail [WhopSDK::Models::CourseLessonCreateParams::Thumbnail, nil] The thumbnail for the lesson in png, jpeg, or gif format
|
|
27
27
|
#
|
|
28
28
|
# @param title [String, nil] The title of the lesson
|
|
29
29
|
#
|
|
@@ -84,7 +84,7 @@ module WhopSDK
|
|
|
84
84
|
#
|
|
85
85
|
# @param assessment_questions [Array<WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion>, nil] Assessment questions for quiz/knowledge check lessons. Replaces all existing que
|
|
86
86
|
#
|
|
87
|
-
# @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment
|
|
87
|
+
# @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment>, nil] General attachments for the lesson (PDFs, files, etc). Replaces all existing att
|
|
88
88
|
#
|
|
89
89
|
# @param content [String, nil] The content of the lesson
|
|
90
90
|
#
|
|
@@ -96,13 +96,13 @@ module WhopSDK
|
|
|
96
96
|
#
|
|
97
97
|
# @param lesson_type [Symbol, WhopSDK::Models::LessonTypes, nil] The available types for a lesson
|
|
98
98
|
#
|
|
99
|
-
# @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf
|
|
99
|
+
# @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf, nil] The main PDF file for this lesson
|
|
100
100
|
#
|
|
101
101
|
# @param max_attempts [Integer, nil] Maximum number of attempts allowed for assessments
|
|
102
102
|
#
|
|
103
103
|
# @param mux_asset_id [String, nil] The ID of the Mux asset to attach to this lesson for video lessons
|
|
104
104
|
#
|
|
105
|
-
# @param thumbnail [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail
|
|
105
|
+
# @param thumbnail [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail, nil] The thumbnail for the lesson in png, jpeg, or gif format
|
|
106
106
|
#
|
|
107
107
|
# @param title [String, nil] The title of the lesson
|
|
108
108
|
#
|
|
@@ -12,7 +12,7 @@ module WhopSDK
|
|
|
12
12
|
#
|
|
13
13
|
# - `courses:update`
|
|
14
14
|
#
|
|
15
|
-
# @overload create(experience_id:, title:, certificate_after_completion_enabled: nil,
|
|
15
|
+
# @overload create(experience_id:, title:, certificate_after_completion_enabled: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, visibility: nil, request_options: {})
|
|
16
16
|
#
|
|
17
17
|
# @param experience_id [String] The ID of the experience to create the course in
|
|
18
18
|
#
|
|
@@ -20,15 +20,13 @@ module WhopSDK
|
|
|
20
20
|
#
|
|
21
21
|
# @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
|
|
22
22
|
#
|
|
23
|
-
# @param cover_image [String, nil] The cover image URL of the course
|
|
24
|
-
#
|
|
25
23
|
# @param order [String, nil] The decimal order position of the course within its experience. If not provided,
|
|
26
24
|
#
|
|
27
25
|
# @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
|
|
28
26
|
#
|
|
29
27
|
# @param tagline [String, nil] The tagline of the course
|
|
30
28
|
#
|
|
31
|
-
# @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail
|
|
29
|
+
# @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
|
|
32
30
|
#
|
|
33
31
|
# @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
|
|
34
32
|
#
|
|
@@ -81,7 +79,7 @@ module WhopSDK
|
|
|
81
79
|
#
|
|
82
80
|
# - `courses:update`
|
|
83
81
|
#
|
|
84
|
-
# @overload update(id, certificate_after_completion_enabled: nil, chapters: nil,
|
|
82
|
+
# @overload update(id, certificate_after_completion_enabled: nil, chapters: nil, description: nil, language: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
|
|
85
83
|
#
|
|
86
84
|
# @param id [String] The ID of the course to update
|
|
87
85
|
#
|
|
@@ -89,8 +87,6 @@ module WhopSDK
|
|
|
89
87
|
#
|
|
90
88
|
# @param chapters [Array<WhopSDK::Models::CourseUpdateParams::Chapter>, nil] The chapters and lessons to update
|
|
91
89
|
#
|
|
92
|
-
# @param cover_image [String, nil] The cover image URL of the course
|
|
93
|
-
#
|
|
94
90
|
# @param description [String, nil] A short description of the course
|
|
95
91
|
#
|
|
96
92
|
# @param language [Symbol, WhopSDK::Models::Languages, nil] The available languages for a course
|
|
@@ -101,7 +97,7 @@ module WhopSDK
|
|
|
101
97
|
#
|
|
102
98
|
# @param tagline [String, nil] A short tagline for the course
|
|
103
99
|
#
|
|
104
|
-
# @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail
|
|
100
|
+
# @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
|
|
105
101
|
#
|
|
106
102
|
# @param title [String, nil] The title of the course
|
|
107
103
|
#
|
|
@@ -135,11 +135,11 @@ module WhopSDK
|
|
|
135
135
|
#
|
|
136
136
|
# @param billing_address [String, nil] The billing address of the user from their payment details.
|
|
137
137
|
#
|
|
138
|
-
# @param cancellation_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CancellationPolicyAttachment
|
|
138
|
+
# @param cancellation_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CancellationPolicyAttachment, nil] A file containing the cancellation policy from the company.
|
|
139
139
|
#
|
|
140
140
|
# @param cancellation_policy_disclosure [String, nil] A cancellation policy disclosure from the company.
|
|
141
141
|
#
|
|
142
|
-
# @param customer_communication_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment
|
|
142
|
+
# @param customer_communication_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment, nil] A file containing the customer communication from the company (An image).
|
|
143
143
|
#
|
|
144
144
|
# @param customer_email_address [String, nil] The email of the customer from their payment details.
|
|
145
145
|
#
|
|
@@ -149,7 +149,7 @@ module WhopSDK
|
|
|
149
149
|
#
|
|
150
150
|
# @param product_description [String, nil] The description of the product from the company.
|
|
151
151
|
#
|
|
152
|
-
# @param refund_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::RefundPolicyAttachment
|
|
152
|
+
# @param refund_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::RefundPolicyAttachment, nil] A file containing the refund policy from the company.
|
|
153
153
|
#
|
|
154
154
|
# @param refund_policy_disclosure [String, nil] A refund policy disclosure from the company.
|
|
155
155
|
#
|
|
@@ -157,7 +157,7 @@ module WhopSDK
|
|
|
157
157
|
#
|
|
158
158
|
# @param service_date [String, nil] When the product was delivered by the company.
|
|
159
159
|
#
|
|
160
|
-
# @param uncategorized_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::UncategorizedAttachment
|
|
160
|
+
# @param uncategorized_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::UncategorizedAttachment, nil] A file that does not fit in the other categories.
|
|
161
161
|
#
|
|
162
162
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
163
163
|
#
|
|
@@ -7,7 +7,7 @@ module WhopSDK
|
|
|
7
7
|
#
|
|
8
8
|
# - `experience:create`
|
|
9
9
|
#
|
|
10
|
-
# @overload create(app_id:, company_id:, is_public: nil, name: nil, section_id: nil, request_options: {})
|
|
10
|
+
# @overload create(app_id:, company_id:, is_public: nil, logo: nil, name: nil, section_id: nil, request_options: {})
|
|
11
11
|
#
|
|
12
12
|
# @param app_id [String] The ID of the app to create the experience for
|
|
13
13
|
#
|
|
@@ -15,6 +15,8 @@ module WhopSDK
|
|
|
15
15
|
#
|
|
16
16
|
# @param is_public [Boolean, nil] Whether the experience is publicly accessible
|
|
17
17
|
#
|
|
18
|
+
# @param logo [WhopSDK::Models::ExperienceCreateParams::Logo, nil] The logo for the experience
|
|
19
|
+
#
|
|
18
20
|
# @param name [String, nil] The name of the experience
|
|
19
21
|
#
|
|
20
22
|
# @param section_id [String, nil] The ID of the section to create the experience in
|
|
@@ -67,7 +69,7 @@ module WhopSDK
|
|
|
67
69
|
#
|
|
68
70
|
# @param is_public [Boolean, nil] Whether the experience is publicly accessible.
|
|
69
71
|
#
|
|
70
|
-
# @param logo [WhopSDK::Models::ExperienceUpdateParams::Logo
|
|
72
|
+
# @param logo [WhopSDK::Models::ExperienceUpdateParams::Logo, nil] The logo for the experience
|
|
71
73
|
#
|
|
72
74
|
# @param name [String, nil] The name of the experience.
|
|
73
75
|
#
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Files
|
|
6
|
+
# Creates a file and returns a presigned URL for upload
|
|
7
|
+
#
|
|
8
|
+
# @overload create(filename:, request_options: {})
|
|
9
|
+
#
|
|
10
|
+
# @param filename [String] The filename of the file
|
|
11
|
+
#
|
|
12
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
13
|
+
#
|
|
14
|
+
# @return [WhopSDK::Models::FileCreateResponse]
|
|
15
|
+
#
|
|
16
|
+
# @see WhopSDK::Models::FileCreateParams
|
|
17
|
+
def create(params)
|
|
18
|
+
parsed, options = WhopSDK::FileCreateParams.dump_request(params)
|
|
19
|
+
@client.request(
|
|
20
|
+
method: :post,
|
|
21
|
+
path: "files",
|
|
22
|
+
body: parsed,
|
|
23
|
+
model: WhopSDK::Models::FileCreateResponse,
|
|
24
|
+
options: options
|
|
25
|
+
)
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
# Retrieves a file by its ID
|
|
29
|
+
#
|
|
30
|
+
# @overload retrieve(id, request_options: {})
|
|
31
|
+
#
|
|
32
|
+
# @param id [String] The ID of the file (e.g., file_xxxxx)
|
|
33
|
+
#
|
|
34
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
35
|
+
#
|
|
36
|
+
# @return [WhopSDK::Models::FileRetrieveResponse]
|
|
37
|
+
#
|
|
38
|
+
# @see WhopSDK::Models::FileRetrieveParams
|
|
39
|
+
def retrieve(id, params = {})
|
|
40
|
+
@client.request(
|
|
41
|
+
method: :get,
|
|
42
|
+
path: ["files/%1$s", id],
|
|
43
|
+
model: WhopSDK::Models::FileRetrieveResponse,
|
|
44
|
+
options: params[:request_options]
|
|
45
|
+
)
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
# @api private
|
|
49
|
+
#
|
|
50
|
+
# @param client [WhopSDK::Client]
|
|
51
|
+
def initialize(client:)
|
|
52
|
+
@client = client
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
@@ -16,7 +16,7 @@ module WhopSDK
|
|
|
16
16
|
#
|
|
17
17
|
# @param experience_id [String] The experience to create this post in
|
|
18
18
|
#
|
|
19
|
-
# @param attachments [Array<WhopSDK::Models::ForumPostCreateParams::Attachment
|
|
19
|
+
# @param attachments [Array<WhopSDK::Models::ForumPostCreateParams::Attachment>, nil] The attachments for this post
|
|
20
20
|
#
|
|
21
21
|
# @param content [String, nil] This is the main body of the post in Markdown format. Hidden if paywalled and us
|
|
22
22
|
#
|
|
@@ -85,7 +85,7 @@ module WhopSDK
|
|
|
85
85
|
#
|
|
86
86
|
# @param id [String] The ID of the forum post to update
|
|
87
87
|
#
|
|
88
|
-
# @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment
|
|
88
|
+
# @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment>, nil] The attachments for this post
|
|
89
89
|
#
|
|
90
90
|
# @param content [String, nil] This is the main body of the post in Markdown format. Hidden if paywalled and us
|
|
91
91
|
#
|
|
@@ -8,6 +8,7 @@ module WhopSDK
|
|
|
8
8
|
# Required permissions:
|
|
9
9
|
#
|
|
10
10
|
# - `member:basic:read`
|
|
11
|
+
# - `member:email:read`
|
|
11
12
|
#
|
|
12
13
|
# @overload retrieve(id, request_options: {})
|
|
13
14
|
#
|
|
@@ -32,6 +33,7 @@ module WhopSDK
|
|
|
32
33
|
# Required permissions:
|
|
33
34
|
#
|
|
34
35
|
# - `member:manage`
|
|
36
|
+
# - `member:email:read`
|
|
35
37
|
# - `member:basic:read`
|
|
36
38
|
#
|
|
37
39
|
# @overload update(id, metadata: nil, request_options: {})
|
|
@@ -61,6 +63,7 @@ module WhopSDK
|
|
|
61
63
|
# Required permissions:
|
|
62
64
|
#
|
|
63
65
|
# - `member:basic:read`
|
|
66
|
+
# - `member:email:read`
|
|
64
67
|
#
|
|
65
68
|
# @overload list(after: nil, before: nil, cancel_options: nil, company_id: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, promo_code_ids: nil, statuses: nil, user_ids: nil, request_options: {})
|
|
66
69
|
#
|
|
@@ -117,6 +120,7 @@ module WhopSDK
|
|
|
117
120
|
# Required permissions:
|
|
118
121
|
#
|
|
119
122
|
# - `member:manage`
|
|
123
|
+
# - `member:email:read`
|
|
120
124
|
# - `member:basic:read`
|
|
121
125
|
#
|
|
122
126
|
# @overload cancel(id, cancellation_mode: nil, request_options: {})
|
|
@@ -149,6 +153,7 @@ module WhopSDK
|
|
|
149
153
|
# Required permissions:
|
|
150
154
|
#
|
|
151
155
|
# - `member:manage`
|
|
156
|
+
# - `member:email:read`
|
|
152
157
|
# - `member:basic:read`
|
|
153
158
|
#
|
|
154
159
|
# @overload pause(id, void_payments: nil, request_options: {})
|
|
@@ -178,6 +183,7 @@ module WhopSDK
|
|
|
178
183
|
# Required permissions:
|
|
179
184
|
#
|
|
180
185
|
# - `member:manage`
|
|
186
|
+
# - `member:email:read`
|
|
181
187
|
# - `member:basic:read`
|
|
182
188
|
#
|
|
183
189
|
# @overload resume(id, request_options: {})
|
|
@@ -198,6 +204,32 @@ module WhopSDK
|
|
|
198
204
|
)
|
|
199
205
|
end
|
|
200
206
|
|
|
207
|
+
# Uncancels a membership that was scheduled to cancel at period end
|
|
208
|
+
#
|
|
209
|
+
# Required permissions:
|
|
210
|
+
#
|
|
211
|
+
# - `member:manage`
|
|
212
|
+
# - `member:email:read`
|
|
213
|
+
# - `member:basic:read`
|
|
214
|
+
#
|
|
215
|
+
# @overload uncancel(id, request_options: {})
|
|
216
|
+
#
|
|
217
|
+
# @param id [String] The ID of the membership.
|
|
218
|
+
#
|
|
219
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
220
|
+
#
|
|
221
|
+
# @return [WhopSDK::Models::Membership]
|
|
222
|
+
#
|
|
223
|
+
# @see WhopSDK::Models::MembershipUncancelParams
|
|
224
|
+
def uncancel(id, params = {})
|
|
225
|
+
@client.request(
|
|
226
|
+
method: :post,
|
|
227
|
+
path: ["memberships/%1$s/uncancel", id],
|
|
228
|
+
model: WhopSDK::Membership,
|
|
229
|
+
options: params[:request_options]
|
|
230
|
+
)
|
|
231
|
+
end
|
|
232
|
+
|
|
201
233
|
# @api private
|
|
202
234
|
#
|
|
203
235
|
# @param client [WhopSDK::Client]
|
|
@@ -15,7 +15,7 @@ module WhopSDK
|
|
|
15
15
|
#
|
|
16
16
|
# @param content [String] The content of the message in Markdown format.
|
|
17
17
|
#
|
|
18
|
-
# @param attachments [Array<WhopSDK::Models::MessageCreateParams::Attachment
|
|
18
|
+
# @param attachments [Array<WhopSDK::Models::MessageCreateParams::Attachment>, nil] The attachments for this message, such as videos or images.
|
|
19
19
|
#
|
|
20
20
|
# @param poll [WhopSDK::Models::MessageCreateParams::Poll, nil] The poll for this message
|
|
21
21
|
#
|
|
@@ -65,7 +65,7 @@ module WhopSDK
|
|
|
65
65
|
#
|
|
66
66
|
# @param id [String] The ID of the message to update
|
|
67
67
|
#
|
|
68
|
-
# @param attachments [Array<WhopSDK::Models::MessageUpdateParams::Attachment
|
|
68
|
+
# @param attachments [Array<WhopSDK::Models::MessageUpdateParams::Attachment>, nil] The attachments for this message
|
|
69
69
|
#
|
|
70
70
|
# @param content [String, nil] The content of the message in Markdown format
|
|
71
71
|
#
|
|
@@ -8,6 +8,10 @@ module WhopSDK
|
|
|
8
8
|
#
|
|
9
9
|
# Queues a notification to be sent to users in an experience or company team
|
|
10
10
|
#
|
|
11
|
+
# Required permissions:
|
|
12
|
+
#
|
|
13
|
+
# - `notification:create`
|
|
14
|
+
#
|
|
11
15
|
# @overload create(company_id:, content:, title:, experience_id:, icon_user_id: nil, rest_path: nil, subtitle: nil, user_ids: nil, request_options: {})
|
|
12
16
|
#
|
|
13
17
|
# @param company_id [String] The id of the company to target. Only team members of this company will receive
|
|
@@ -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, split_pay_required_payments: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
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, legacy_payment_method_controls: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: 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
|
#
|
|
@@ -30,12 +30,14 @@ module WhopSDK
|
|
|
30
30
|
#
|
|
31
31
|
# @param expiration_days [Integer, nil] The interval at which the plan expires and revokes access (expiration plans).
|
|
32
32
|
#
|
|
33
|
-
# @param image [WhopSDK::Models::PlanCreateParams::Image
|
|
33
|
+
# @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
|
|
34
34
|
#
|
|
35
35
|
# @param initial_price [Float, nil] An additional amount charged upon first purchase. Use only if a one time payment
|
|
36
36
|
#
|
|
37
37
|
# @param internal_notes [String, nil] A personal description or notes section for the business.
|
|
38
38
|
#
|
|
39
|
+
# @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls
|
|
40
|
+
#
|
|
39
41
|
# @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
|
|
40
42
|
#
|
|
41
43
|
# @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
|
|
@@ -103,7 +105,7 @@ module WhopSDK
|
|
|
103
105
|
# - `access_pass:basic:read`
|
|
104
106
|
# - `plan:basic:read`
|
|
105
107
|
#
|
|
106
|
-
# @overload update(id, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
108
|
+
# @overload update(id, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
107
109
|
#
|
|
108
110
|
# @param id [String] The ID
|
|
109
111
|
#
|
|
@@ -117,12 +119,14 @@ module WhopSDK
|
|
|
117
119
|
#
|
|
118
120
|
# @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
|
|
119
121
|
#
|
|
120
|
-
# @param image [WhopSDK::Models::PlanUpdateParams::Image
|
|
122
|
+
# @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
|
|
121
123
|
#
|
|
122
124
|
# @param initial_price [Float, nil] An additional amount charged upon first purchase.
|
|
123
125
|
#
|
|
124
126
|
# @param internal_notes [String, nil] A personal description or notes section for the business.
|
|
125
127
|
#
|
|
128
|
+
# @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls
|
|
129
|
+
#
|
|
126
130
|
# @param offer_cancel_discount [Boolean, nil] Whether or not to offer a discount to cancel a subscription.
|
|
127
131
|
#
|
|
128
132
|
# @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
|