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
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Webhooks#retrieve
|
|
6
|
+
class WebhookRetrieveResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The ID of the webhook
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute api_version
|
|
14
|
+
# The API version for this webhook
|
|
15
|
+
#
|
|
16
|
+
# @return [Symbol, WhopSDK::Models::WebhookRetrieveResponse::APIVersion]
|
|
17
|
+
required :api_version, enum: -> { WhopSDK::Models::WebhookRetrieveResponse::APIVersion }
|
|
18
|
+
|
|
19
|
+
# @!attribute child_resource_events
|
|
20
|
+
# Whether or not to send events for child resources. For example, if the webhook
|
|
21
|
+
# is created for a Company, enabling this will only send events from the Company's
|
|
22
|
+
# sub-merchants (child companies).
|
|
23
|
+
#
|
|
24
|
+
# @return [Boolean]
|
|
25
|
+
required :child_resource_events, WhopSDK::Internal::Type::Boolean
|
|
26
|
+
|
|
27
|
+
# @!attribute created_at
|
|
28
|
+
# The timestamp of when the webhook was created
|
|
29
|
+
#
|
|
30
|
+
# @return [Time]
|
|
31
|
+
required :created_at, Time
|
|
32
|
+
|
|
33
|
+
# @!attribute enabled
|
|
34
|
+
# Whether or not this webhook is turned on or not
|
|
35
|
+
#
|
|
36
|
+
# @return [Boolean]
|
|
37
|
+
required :enabled, WhopSDK::Internal::Type::Boolean
|
|
38
|
+
|
|
39
|
+
# @!attribute events
|
|
40
|
+
# The number of events this webhooks is configured to receive
|
|
41
|
+
#
|
|
42
|
+
# @return [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::Event>]
|
|
43
|
+
required :events,
|
|
44
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookRetrieveResponse::Event] }
|
|
45
|
+
|
|
46
|
+
# @!attribute resource_id
|
|
47
|
+
# The resource ID
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
required :resource_id, String
|
|
51
|
+
|
|
52
|
+
# @!attribute testable_events
|
|
53
|
+
# The list of events that can be tested with this webhook
|
|
54
|
+
#
|
|
55
|
+
# @return [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::TestableEvent>]
|
|
56
|
+
required :testable_events,
|
|
57
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookRetrieveResponse::TestableEvent] }
|
|
58
|
+
|
|
59
|
+
# @!attribute url
|
|
60
|
+
# The URL the webhook events will be sent to
|
|
61
|
+
#
|
|
62
|
+
# @return [String]
|
|
63
|
+
required :url, String
|
|
64
|
+
|
|
65
|
+
# @!method initialize(id:, api_version:, child_resource_events:, created_at:, enabled:, events:, resource_id:, testable_events:, url:)
|
|
66
|
+
# Some parameter documentations has been truncated, see
|
|
67
|
+
# {WhopSDK::Models::WebhookRetrieveResponse} for more details.
|
|
68
|
+
#
|
|
69
|
+
# A webhook object, which can be configured to be sent updates about a company
|
|
70
|
+
#
|
|
71
|
+
# @param id [String] The ID of the webhook
|
|
72
|
+
#
|
|
73
|
+
# @param api_version [Symbol, WhopSDK::Models::WebhookRetrieveResponse::APIVersion] The API version for this webhook
|
|
74
|
+
#
|
|
75
|
+
# @param child_resource_events [Boolean] Whether or not to send events for child resources. For example, if the webhook i
|
|
76
|
+
#
|
|
77
|
+
# @param created_at [Time] The timestamp of when the webhook was created
|
|
78
|
+
#
|
|
79
|
+
# @param enabled [Boolean] Whether or not this webhook is turned on or not
|
|
80
|
+
#
|
|
81
|
+
# @param events [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::Event>] The number of events this webhooks is configured to receive
|
|
82
|
+
#
|
|
83
|
+
# @param resource_id [String] The resource ID
|
|
84
|
+
#
|
|
85
|
+
# @param testable_events [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::TestableEvent>] The list of events that can be tested with this webhook
|
|
86
|
+
#
|
|
87
|
+
# @param url [String] The URL the webhook events will be sent to
|
|
88
|
+
|
|
89
|
+
# The API version for this webhook
|
|
90
|
+
#
|
|
91
|
+
# @see WhopSDK::Models::WebhookRetrieveResponse#api_version
|
|
92
|
+
module APIVersion
|
|
93
|
+
extend WhopSDK::Internal::Type::Enum
|
|
94
|
+
|
|
95
|
+
V1 = :v1
|
|
96
|
+
V2 = :v2
|
|
97
|
+
V5 = :v5
|
|
98
|
+
|
|
99
|
+
# @!method self.values
|
|
100
|
+
# @return [Array<Symbol>]
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# The different event types available
|
|
104
|
+
module Event
|
|
105
|
+
extend WhopSDK::Internal::Type::Enum
|
|
106
|
+
|
|
107
|
+
INVOICE_CREATED = :"invoice.created"
|
|
108
|
+
INVOICE_PAID = :"invoice.paid"
|
|
109
|
+
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
110
|
+
INVOICE_VOIDED = :"invoice.voided"
|
|
111
|
+
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
112
|
+
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
113
|
+
ENTRY_CREATED = :"entry.created"
|
|
114
|
+
ENTRY_APPROVED = :"entry.approved"
|
|
115
|
+
ENTRY_DENIED = :"entry.denied"
|
|
116
|
+
ENTRY_DELETED = :"entry.deleted"
|
|
117
|
+
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
118
|
+
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
119
|
+
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
120
|
+
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
121
|
+
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
122
|
+
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
123
|
+
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
124
|
+
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
125
|
+
PAYMENT_CREATED = :"payment.created"
|
|
126
|
+
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
127
|
+
PAYMENT_FAILED = :"payment.failed"
|
|
128
|
+
PAYMENT_PENDING = :"payment.pending"
|
|
129
|
+
DISPUTE_CREATED = :"dispute.created"
|
|
130
|
+
DISPUTE_UPDATED = :"dispute.updated"
|
|
131
|
+
REFUND_CREATED = :"refund.created"
|
|
132
|
+
REFUND_UPDATED = :"refund.updated"
|
|
133
|
+
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
134
|
+
|
|
135
|
+
# @!method self.values
|
|
136
|
+
# @return [Array<Symbol>]
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# The different event types available
|
|
140
|
+
module TestableEvent
|
|
141
|
+
extend WhopSDK::Internal::Type::Enum
|
|
142
|
+
|
|
143
|
+
INVOICE_CREATED = :"invoice.created"
|
|
144
|
+
INVOICE_PAID = :"invoice.paid"
|
|
145
|
+
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
146
|
+
INVOICE_VOIDED = :"invoice.voided"
|
|
147
|
+
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
148
|
+
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
149
|
+
ENTRY_CREATED = :"entry.created"
|
|
150
|
+
ENTRY_APPROVED = :"entry.approved"
|
|
151
|
+
ENTRY_DENIED = :"entry.denied"
|
|
152
|
+
ENTRY_DELETED = :"entry.deleted"
|
|
153
|
+
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
154
|
+
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
155
|
+
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
156
|
+
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
157
|
+
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
158
|
+
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
159
|
+
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
160
|
+
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
161
|
+
PAYMENT_CREATED = :"payment.created"
|
|
162
|
+
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
163
|
+
PAYMENT_FAILED = :"payment.failed"
|
|
164
|
+
PAYMENT_PENDING = :"payment.pending"
|
|
165
|
+
DISPUTE_CREATED = :"dispute.created"
|
|
166
|
+
DISPUTE_UPDATED = :"dispute.updated"
|
|
167
|
+
REFUND_CREATED = :"refund.created"
|
|
168
|
+
REFUND_UPDATED = :"refund.updated"
|
|
169
|
+
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
170
|
+
|
|
171
|
+
# @!method self.values
|
|
172
|
+
# @return [Array<Symbol>]
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Webhooks#update
|
|
6
|
+
class WebhookUpdateParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute api_version
|
|
11
|
+
# The different API versions
|
|
12
|
+
#
|
|
13
|
+
# @return [Symbol, WhopSDK::Models::WebhookUpdateParams::APIVersion, nil]
|
|
14
|
+
optional :api_version, enum: -> { WhopSDK::WebhookUpdateParams::APIVersion }, nil?: true
|
|
15
|
+
|
|
16
|
+
# @!attribute child_resource_events
|
|
17
|
+
# Whether or not to send events for child resources.
|
|
18
|
+
#
|
|
19
|
+
# @return [Boolean, nil]
|
|
20
|
+
optional :child_resource_events, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
21
|
+
|
|
22
|
+
# @!attribute enabled
|
|
23
|
+
# Whether or not the webhook is enabled.
|
|
24
|
+
#
|
|
25
|
+
# @return [Boolean, nil]
|
|
26
|
+
optional :enabled, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute events
|
|
29
|
+
# The events to send the webhook for.
|
|
30
|
+
#
|
|
31
|
+
# @return [Array<Symbol, WhopSDK::Models::WebhookUpdateParams::Event>, nil]
|
|
32
|
+
optional :events,
|
|
33
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::WebhookUpdateParams::Event] },
|
|
34
|
+
nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute url
|
|
37
|
+
# The URL to send the webhook to.
|
|
38
|
+
#
|
|
39
|
+
# @return [String, nil]
|
|
40
|
+
optional :url, String, nil?: true
|
|
41
|
+
|
|
42
|
+
# @!method initialize(api_version: nil, child_resource_events: nil, enabled: nil, events: nil, url: nil, request_options: {})
|
|
43
|
+
# @param api_version [Symbol, WhopSDK::Models::WebhookUpdateParams::APIVersion, nil] The different API versions
|
|
44
|
+
#
|
|
45
|
+
# @param child_resource_events [Boolean, nil] Whether or not to send events for child resources.
|
|
46
|
+
#
|
|
47
|
+
# @param enabled [Boolean, nil] Whether or not the webhook is enabled.
|
|
48
|
+
#
|
|
49
|
+
# @param events [Array<Symbol, WhopSDK::Models::WebhookUpdateParams::Event>, nil] The events to send the webhook for.
|
|
50
|
+
#
|
|
51
|
+
# @param url [String, nil] The URL to send the webhook to.
|
|
52
|
+
#
|
|
53
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
54
|
+
|
|
55
|
+
# The different API versions
|
|
56
|
+
module APIVersion
|
|
57
|
+
extend WhopSDK::Internal::Type::Enum
|
|
58
|
+
|
|
59
|
+
V1 = :v1
|
|
60
|
+
V2 = :v2
|
|
61
|
+
V5 = :v5
|
|
62
|
+
|
|
63
|
+
# @!method self.values
|
|
64
|
+
# @return [Array<Symbol>]
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# The different event types available
|
|
68
|
+
module Event
|
|
69
|
+
extend WhopSDK::Internal::Type::Enum
|
|
70
|
+
|
|
71
|
+
INVOICE_CREATED = :"invoice.created"
|
|
72
|
+
INVOICE_PAID = :"invoice.paid"
|
|
73
|
+
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
74
|
+
INVOICE_VOIDED = :"invoice.voided"
|
|
75
|
+
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
76
|
+
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
77
|
+
ENTRY_CREATED = :"entry.created"
|
|
78
|
+
ENTRY_APPROVED = :"entry.approved"
|
|
79
|
+
ENTRY_DENIED = :"entry.denied"
|
|
80
|
+
ENTRY_DELETED = :"entry.deleted"
|
|
81
|
+
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
82
|
+
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
83
|
+
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
84
|
+
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
85
|
+
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
86
|
+
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
87
|
+
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
88
|
+
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
89
|
+
PAYMENT_CREATED = :"payment.created"
|
|
90
|
+
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
91
|
+
PAYMENT_FAILED = :"payment.failed"
|
|
92
|
+
PAYMENT_PENDING = :"payment.pending"
|
|
93
|
+
DISPUTE_CREATED = :"dispute.created"
|
|
94
|
+
DISPUTE_UPDATED = :"dispute.updated"
|
|
95
|
+
REFUND_CREATED = :"refund.created"
|
|
96
|
+
REFUND_UPDATED = :"refund.updated"
|
|
97
|
+
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
98
|
+
|
|
99
|
+
# @!method self.values
|
|
100
|
+
# @return [Array<Symbol>]
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Webhooks#update
|
|
6
|
+
class WebhookUpdateResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The ID of the webhook
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute api_version
|
|
14
|
+
# The API version for this webhook
|
|
15
|
+
#
|
|
16
|
+
# @return [Symbol, WhopSDK::Models::WebhookUpdateResponse::APIVersion]
|
|
17
|
+
required :api_version, enum: -> { WhopSDK::Models::WebhookUpdateResponse::APIVersion }
|
|
18
|
+
|
|
19
|
+
# @!attribute child_resource_events
|
|
20
|
+
# Whether or not to send events for child resources. For example, if the webhook
|
|
21
|
+
# is created for a Company, enabling this will only send events from the Company's
|
|
22
|
+
# sub-merchants (child companies).
|
|
23
|
+
#
|
|
24
|
+
# @return [Boolean]
|
|
25
|
+
required :child_resource_events, WhopSDK::Internal::Type::Boolean
|
|
26
|
+
|
|
27
|
+
# @!attribute created_at
|
|
28
|
+
# The timestamp of when the webhook was created
|
|
29
|
+
#
|
|
30
|
+
# @return [Time]
|
|
31
|
+
required :created_at, Time
|
|
32
|
+
|
|
33
|
+
# @!attribute enabled
|
|
34
|
+
# Whether or not this webhook is turned on or not
|
|
35
|
+
#
|
|
36
|
+
# @return [Boolean]
|
|
37
|
+
required :enabled, WhopSDK::Internal::Type::Boolean
|
|
38
|
+
|
|
39
|
+
# @!attribute events
|
|
40
|
+
# The number of events this webhooks is configured to receive
|
|
41
|
+
#
|
|
42
|
+
# @return [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::Event>]
|
|
43
|
+
required :events,
|
|
44
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookUpdateResponse::Event] }
|
|
45
|
+
|
|
46
|
+
# @!attribute resource_id
|
|
47
|
+
# The resource ID
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
required :resource_id, String
|
|
51
|
+
|
|
52
|
+
# @!attribute testable_events
|
|
53
|
+
# The list of events that can be tested with this webhook
|
|
54
|
+
#
|
|
55
|
+
# @return [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::TestableEvent>]
|
|
56
|
+
required :testable_events,
|
|
57
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookUpdateResponse::TestableEvent] }
|
|
58
|
+
|
|
59
|
+
# @!attribute url
|
|
60
|
+
# The URL the webhook events will be sent to
|
|
61
|
+
#
|
|
62
|
+
# @return [String]
|
|
63
|
+
required :url, String
|
|
64
|
+
|
|
65
|
+
# @!method initialize(id:, api_version:, child_resource_events:, created_at:, enabled:, events:, resource_id:, testable_events:, url:)
|
|
66
|
+
# Some parameter documentations has been truncated, see
|
|
67
|
+
# {WhopSDK::Models::WebhookUpdateResponse} for more details.
|
|
68
|
+
#
|
|
69
|
+
# A webhook object, which can be configured to be sent updates about a company
|
|
70
|
+
#
|
|
71
|
+
# @param id [String] The ID of the webhook
|
|
72
|
+
#
|
|
73
|
+
# @param api_version [Symbol, WhopSDK::Models::WebhookUpdateResponse::APIVersion] The API version for this webhook
|
|
74
|
+
#
|
|
75
|
+
# @param child_resource_events [Boolean] Whether or not to send events for child resources. For example, if the webhook i
|
|
76
|
+
#
|
|
77
|
+
# @param created_at [Time] The timestamp of when the webhook was created
|
|
78
|
+
#
|
|
79
|
+
# @param enabled [Boolean] Whether or not this webhook is turned on or not
|
|
80
|
+
#
|
|
81
|
+
# @param events [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::Event>] The number of events this webhooks is configured to receive
|
|
82
|
+
#
|
|
83
|
+
# @param resource_id [String] The resource ID
|
|
84
|
+
#
|
|
85
|
+
# @param testable_events [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::TestableEvent>] The list of events that can be tested with this webhook
|
|
86
|
+
#
|
|
87
|
+
# @param url [String] The URL the webhook events will be sent to
|
|
88
|
+
|
|
89
|
+
# The API version for this webhook
|
|
90
|
+
#
|
|
91
|
+
# @see WhopSDK::Models::WebhookUpdateResponse#api_version
|
|
92
|
+
module APIVersion
|
|
93
|
+
extend WhopSDK::Internal::Type::Enum
|
|
94
|
+
|
|
95
|
+
V1 = :v1
|
|
96
|
+
V2 = :v2
|
|
97
|
+
V5 = :v5
|
|
98
|
+
|
|
99
|
+
# @!method self.values
|
|
100
|
+
# @return [Array<Symbol>]
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# The different event types available
|
|
104
|
+
module Event
|
|
105
|
+
extend WhopSDK::Internal::Type::Enum
|
|
106
|
+
|
|
107
|
+
INVOICE_CREATED = :"invoice.created"
|
|
108
|
+
INVOICE_PAID = :"invoice.paid"
|
|
109
|
+
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
110
|
+
INVOICE_VOIDED = :"invoice.voided"
|
|
111
|
+
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
112
|
+
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
113
|
+
ENTRY_CREATED = :"entry.created"
|
|
114
|
+
ENTRY_APPROVED = :"entry.approved"
|
|
115
|
+
ENTRY_DENIED = :"entry.denied"
|
|
116
|
+
ENTRY_DELETED = :"entry.deleted"
|
|
117
|
+
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
118
|
+
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
119
|
+
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
120
|
+
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
121
|
+
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
122
|
+
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
123
|
+
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
124
|
+
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
125
|
+
PAYMENT_CREATED = :"payment.created"
|
|
126
|
+
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
127
|
+
PAYMENT_FAILED = :"payment.failed"
|
|
128
|
+
PAYMENT_PENDING = :"payment.pending"
|
|
129
|
+
DISPUTE_CREATED = :"dispute.created"
|
|
130
|
+
DISPUTE_UPDATED = :"dispute.updated"
|
|
131
|
+
REFUND_CREATED = :"refund.created"
|
|
132
|
+
REFUND_UPDATED = :"refund.updated"
|
|
133
|
+
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
134
|
+
|
|
135
|
+
# @!method self.values
|
|
136
|
+
# @return [Array<Symbol>]
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# The different event types available
|
|
140
|
+
module TestableEvent
|
|
141
|
+
extend WhopSDK::Internal::Type::Enum
|
|
142
|
+
|
|
143
|
+
INVOICE_CREATED = :"invoice.created"
|
|
144
|
+
INVOICE_PAID = :"invoice.paid"
|
|
145
|
+
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
146
|
+
INVOICE_VOIDED = :"invoice.voided"
|
|
147
|
+
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
148
|
+
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
149
|
+
ENTRY_CREATED = :"entry.created"
|
|
150
|
+
ENTRY_APPROVED = :"entry.approved"
|
|
151
|
+
ENTRY_DENIED = :"entry.denied"
|
|
152
|
+
ENTRY_DELETED = :"entry.deleted"
|
|
153
|
+
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
154
|
+
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
155
|
+
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
156
|
+
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
157
|
+
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
158
|
+
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
159
|
+
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
160
|
+
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
161
|
+
PAYMENT_CREATED = :"payment.created"
|
|
162
|
+
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
163
|
+
PAYMENT_FAILED = :"payment.failed"
|
|
164
|
+
PAYMENT_PENDING = :"payment.pending"
|
|
165
|
+
DISPUTE_CREATED = :"dispute.created"
|
|
166
|
+
DISPUTE_UPDATED = :"dispute.updated"
|
|
167
|
+
REFUND_CREATED = :"refund.created"
|
|
168
|
+
REFUND_UPDATED = :"refund.updated"
|
|
169
|
+
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
170
|
+
|
|
171
|
+
# @!method self.values
|
|
172
|
+
# @return [Array<Symbol>]
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
|
@@ -31,7 +31,23 @@ module WhopSDK
|
|
|
31
31
|
# @return [String, nil]
|
|
32
32
|
optional :payout_method_id, String, nil?: true
|
|
33
33
|
|
|
34
|
-
# @!
|
|
34
|
+
# @!attribute platform_covers_fees
|
|
35
|
+
# Whether the platform covers the payout fees instead of the connected account.
|
|
36
|
+
#
|
|
37
|
+
# @return [Boolean, nil]
|
|
38
|
+
optional :platform_covers_fees, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!attribute statement_descriptor
|
|
41
|
+
# Custom statement descriptor for the withdrawal. Must be between 5 and 22
|
|
42
|
+
# characters and contain only alphanumeric characters.
|
|
43
|
+
#
|
|
44
|
+
# @return [String, nil]
|
|
45
|
+
optional :statement_descriptor, String, nil?: true
|
|
46
|
+
|
|
47
|
+
# @!method initialize(amount:, company_id:, currency:, payout_method_id: nil, platform_covers_fees: nil, statement_descriptor: nil, request_options: {})
|
|
48
|
+
# Some parameter documentations has been truncated, see
|
|
49
|
+
# {WhopSDK::Models::WithdrawalCreateParams} for more details.
|
|
50
|
+
#
|
|
35
51
|
# @param amount [Float] The amount to withdraw in the specified currency
|
|
36
52
|
#
|
|
37
53
|
# @param company_id [String] The ID of the company to withdraw from.
|
|
@@ -40,6 +56,10 @@ module WhopSDK
|
|
|
40
56
|
#
|
|
41
57
|
# @param payout_method_id [String, nil] The ID of the payout method to use for the withdrawal.
|
|
42
58
|
#
|
|
59
|
+
# @param platform_covers_fees [Boolean, nil] Whether the platform covers the payout fees instead of the connected account.
|
|
60
|
+
#
|
|
61
|
+
# @param statement_descriptor [String, nil] Custom statement descriptor for the withdrawal. Must be between 5 and 22 charact
|
|
62
|
+
#
|
|
43
63
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
44
64
|
end
|
|
45
65
|
end
|
|
@@ -98,13 +98,7 @@ module WhopSDK
|
|
|
98
98
|
# @return [String, nil]
|
|
99
99
|
required :trace_code, String, nil?: true
|
|
100
100
|
|
|
101
|
-
# @!
|
|
102
|
-
# The type of withdrawal.
|
|
103
|
-
#
|
|
104
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
105
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
106
|
-
|
|
107
|
-
# @!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:)
|
|
101
|
+
# @!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:)
|
|
108
102
|
# Some parameter documentations has been truncated, see
|
|
109
103
|
# {WhopSDK::Models::WithdrawalCreateResponse} for more details.
|
|
110
104
|
#
|
|
@@ -139,8 +133,6 @@ module WhopSDK
|
|
|
139
133
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
140
134
|
#
|
|
141
135
|
# @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
|
|
142
|
-
#
|
|
143
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
144
136
|
|
|
145
137
|
# The different error codes a payout can be in.
|
|
146
138
|
#
|
|
@@ -173,6 +165,7 @@ module WhopSDK
|
|
|
173
165
|
INVALID_ACCOUNT_NUMBER = :invalid_account_number
|
|
174
166
|
INVALID_BANK_CODE = :invalid_bank_code
|
|
175
167
|
INVALID_BENEFICIARY = :invalid_beneficiary
|
|
168
|
+
INVALID_MAILING_ADDRESS = :invalid_mailing_address
|
|
176
169
|
INVALID_BRANCH_NUMBER = :invalid_branch_number
|
|
177
170
|
INVALID_BRANCH_CODE = :invalid_branch_code
|
|
178
171
|
INVALID_PHONE_NUMBER = :invalid_phone_number
|
|
@@ -33,13 +33,21 @@ module WhopSDK
|
|
|
33
33
|
# @return [Symbol, :"withdrawal.created"]
|
|
34
34
|
required :type, const: :"withdrawal.created"
|
|
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.created")
|
|
37
43
|
# @param id [String] A unique ID for every single webhook request
|
|
38
44
|
#
|
|
39
45
|
# @param data [WhopSDK::Models::WithdrawalCreatedWebhookEvent::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.created"] 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::WithdrawalCreatedWebhookEvent::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
|
|
@@ -61,13 +61,7 @@ module WhopSDK
|
|
|
61
61
|
# @return [Symbol, WhopSDK::Models::WithdrawalStatus]
|
|
62
62
|
required :status, enum: -> { WhopSDK::WithdrawalStatus }
|
|
63
63
|
|
|
64
|
-
# @!
|
|
65
|
-
# The type of withdrawal.
|
|
66
|
-
#
|
|
67
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
68
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
69
|
-
|
|
70
|
-
# @!method initialize(id:, amount:, created_at:, currency:, fee_amount:, fee_type:, markup_fee:, speed:, status:, withdrawal_type:)
|
|
64
|
+
# @!method initialize(id:, amount:, created_at:, currency:, fee_amount:, fee_type:, markup_fee:, speed:, status:)
|
|
71
65
|
# Some parameter documentations has been truncated, see
|
|
72
66
|
# {WhopSDK::Models::WithdrawalListResponse} for more details.
|
|
73
67
|
#
|
|
@@ -90,8 +84,6 @@ module WhopSDK
|
|
|
90
84
|
# @param speed [Symbol, WhopSDK::Models::WithdrawalSpeeds] The speed of the withdrawal.
|
|
91
85
|
#
|
|
92
86
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
93
|
-
#
|
|
94
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
95
87
|
end
|
|
96
88
|
end
|
|
97
89
|
end
|
|
@@ -98,13 +98,7 @@ module WhopSDK
|
|
|
98
98
|
# @return [String, nil]
|
|
99
99
|
required :trace_code, String, nil?: true
|
|
100
100
|
|
|
101
|
-
# @!
|
|
102
|
-
# The type of withdrawal.
|
|
103
|
-
#
|
|
104
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
105
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
106
|
-
|
|
107
|
-
# @!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:)
|
|
101
|
+
# @!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:)
|
|
108
102
|
# Some parameter documentations has been truncated, see
|
|
109
103
|
# {WhopSDK::Models::WithdrawalRetrieveResponse} for more details.
|
|
110
104
|
#
|
|
@@ -139,8 +133,6 @@ module WhopSDK
|
|
|
139
133
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
140
134
|
#
|
|
141
135
|
# @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
|
|
142
|
-
#
|
|
143
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
144
136
|
|
|
145
137
|
# The different error codes a payout can be in.
|
|
146
138
|
#
|
|
@@ -173,6 +165,7 @@ module WhopSDK
|
|
|
173
165
|
INVALID_ACCOUNT_NUMBER = :invalid_account_number
|
|
174
166
|
INVALID_BANK_CODE = :invalid_bank_code
|
|
175
167
|
INVALID_BENEFICIARY = :invalid_beneficiary
|
|
168
|
+
INVALID_MAILING_ADDRESS = :invalid_mailing_address
|
|
176
169
|
INVALID_BRANCH_NUMBER = :invalid_branch_number
|
|
177
170
|
INVALID_BRANCH_CODE = :invalid_branch_code
|
|
178
171
|
INVALID_PHONE_NUMBER = :invalid_phone_number
|