whop_sdk 0.0.39 → 0.0.40
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 +7 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +18 -2
- data/lib/whop_sdk/internal/transport/base_client.rb +2 -0
- data/lib/whop_sdk/internal/type/union.rb +6 -6
- data/lib/whop_sdk/models/account.rb +144 -0
- data/lib/whop_sdk/models/account_create_params.rb +34 -0
- data/lib/whop_sdk/models/account_list_params.rb +34 -0
- data/lib/whop_sdk/models/account_list_response.rb +66 -0
- data/lib/whop_sdk/models/account_me_params.rb +14 -0
- data/lib/whop_sdk/models/account_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/account_social_link.rb +60 -0
- data/lib/whop_sdk/models/account_update_params.rb +146 -0
- data/lib/whop_sdk/models/account_wallet.rb +46 -0
- data/lib/whop_sdk/models/{ad_retrieve_response.rb → ad.rb} +15 -45
- data/lib/whop_sdk/models/ad_budget_type.rb +16 -0
- data/lib/whop_sdk/models/{ad_campaign_pause_response.rb → ad_campaign.rb} +37 -86
- data/lib/whop_sdk/models/ad_campaign_list_params.rb +12 -27
- data/lib/whop_sdk/models/ad_campaign_list_response.rb +9 -52
- data/lib/whop_sdk/models/ad_campaign_platform.rb +16 -0
- data/lib/whop_sdk/models/ad_campaign_status.rb +20 -0
- data/lib/whop_sdk/models/ad_group.rb +97 -0
- data/lib/whop_sdk/models/ad_group_list_params.rb +16 -19
- data/lib/whop_sdk/models/ad_group_list_response.rb +30 -51
- data/lib/whop_sdk/models/ad_group_pause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_status.rb +20 -0
- data/lib/whop_sdk/models/ad_group_unpause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_update_params.rb +8 -32
- data/lib/whop_sdk/models/ad_list_params.rb +57 -12
- data/lib/whop_sdk/models/ad_list_response.rb +45 -31
- data/lib/whop_sdk/models/ad_pause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_report_retrieve_params.rb +45 -15
- data/lib/whop_sdk/models/ad_report_retrieve_response.rb +378 -105
- data/lib/whop_sdk/models/ad_unpause_params.rb +20 -0
- data/lib/whop_sdk/models/checkout_configuration.rb +22 -1
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +26 -1
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +24 -1
- data/lib/whop_sdk/models/currency.rb +3 -0
- data/lib/whop_sdk/models/deposit_create_params.rb +85 -0
- data/lib/whop_sdk/models/deposit_create_response.rb +102 -0
- data/lib/whop_sdk/models/dispute.rb +6 -7
- data/lib/whop_sdk/models/dispute_alert_created_webhook_event.rb +4 -4
- data/lib/whop_sdk/models/dispute_alert_retrieve_response.rb +4 -4
- data/lib/whop_sdk/models/dispute_list_response.rb +2 -3
- data/lib/whop_sdk/models/external_ad_status.rb +20 -0
- data/lib/whop_sdk/models/file_create_params.rb +3 -15
- data/lib/whop_sdk/models/file_create_response.rb +3 -16
- data/lib/whop_sdk/models/file_retrieve_response.rb +3 -16
- data/lib/whop_sdk/models/file_visibility.rb +17 -0
- data/lib/whop_sdk/models/granularities.rb +16 -0
- data/lib/whop_sdk/models/identity_profile_approved_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb +432 -0
- data/lib/whop_sdk/models/identity_profile_rejected_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/identity_profile_updated_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +65 -1
- data/lib/whop_sdk/models/member_list_response.rb +3 -2
- data/lib/whop_sdk/models/member_retrieve_response.rb +3 -2
- data/lib/whop_sdk/models/membership.rb +23 -2
- data/lib/whop_sdk/models/membership_list_response.rb +23 -2
- data/lib/whop_sdk/models/payment.rb +47 -22
- data/lib/whop_sdk/models/payment_list_params.rb +9 -1
- data/lib/whop_sdk/models/payment_list_response.rb +40 -13
- data/lib/whop_sdk/models/plan.rb +31 -1
- data/lib/whop_sdk/models/plan_create_params.rb +30 -1
- data/lib/whop_sdk/models/plan_list_response.rb +31 -1
- data/lib/whop_sdk/models/plan_update_params.rb +30 -1
- data/lib/whop_sdk/models/product.rb +10 -1
- data/lib/whop_sdk/models/product_create_params.rb +11 -1
- data/lib/whop_sdk/models/product_list_item.rb +10 -1
- data/lib/whop_sdk/models/product_update_params.rb +11 -1
- data/lib/whop_sdk/models/refund_created_webhook_event.rb +84 -5
- data/lib/whop_sdk/models/refund_retrieve_response.rb +82 -5
- data/lib/whop_sdk/models/refund_updated_webhook_event.rb +84 -5
- data/lib/whop_sdk/models/resolution_center_case_platform_response.rb +0 -1
- data/lib/whop_sdk/models/result_label_keys.rb +38 -0
- data/lib/whop_sdk/models/swap_create_quote_params.rb +102 -0
- data/lib/whop_sdk/models/swap_create_quote_response.rb +104 -0
- data/lib/whop_sdk/models/transfer_create_params.rb +3 -1
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +41 -33
- data/lib/whop_sdk/models/wallet_balance_params.rb +20 -0
- data/lib/whop_sdk/models/wallet_balance_response.rb +84 -0
- data/lib/whop_sdk/models/wallet_list_params.rb +14 -0
- data/lib/whop_sdk/models/wallet_list_response.rb +38 -0
- data/lib/whop_sdk/models/wallet_send_params.rb +37 -0
- data/lib/whop_sdk/models/wallet_send_response.rb +90 -0
- data/lib/whop_sdk/models/webhook_event.rb +4 -0
- data/lib/whop_sdk/models.rb +64 -0
- data/lib/whop_sdk/resources/accounts.rb +168 -0
- data/lib/whop_sdk/resources/ad_campaigns.rb +13 -13
- data/lib/whop_sdk/resources/ad_groups.rb +63 -8
- data/lib/whop_sdk/resources/ad_reports.rb +14 -8
- data/lib/whop_sdk/resources/ads.rb +66 -4
- data/lib/whop_sdk/resources/deposits.rb +46 -0
- data/lib/whop_sdk/resources/files.rb +1 -1
- data/lib/whop_sdk/resources/payments.rb +3 -1
- data/lib/whop_sdk/resources/plans.rb +10 -2
- data/lib/whop_sdk/resources/products.rb +6 -2
- data/lib/whop_sdk/resources/refunds.rb +2 -0
- data/lib/whop_sdk/resources/swaps.rb +52 -0
- data/lib/whop_sdk/resources/wallets.rb +78 -0
- data/lib/whop_sdk/resources/webhooks.rb +1 -1
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +42 -7
- data/rbi/whop_sdk/client.rbi +14 -2
- data/rbi/whop_sdk/models/account.rbi +164 -0
- data/rbi/whop_sdk/models/account_create_params.rbi +59 -0
- data/rbi/whop_sdk/models/account_list_params.rbi +59 -0
- data/rbi/whop_sdk/models/account_list_response.rbi +115 -0
- data/rbi/whop_sdk/models/account_me_params.rbi +27 -0
- data/rbi/whop_sdk/models/account_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/account_social_link.rbi +96 -0
- data/rbi/whop_sdk/models/account_update_params.rbi +175 -0
- data/rbi/whop_sdk/models/account_wallet.rbi +75 -0
- data/rbi/whop_sdk/models/ad.rbi +143 -0
- data/rbi/whop_sdk/models/ad_budget_type.rbi +20 -0
- data/rbi/whop_sdk/models/{ad_campaign_pause_response.rbi → ad_campaign.rbi} +57 -245
- data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +11 -46
- data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +9 -143
- data/rbi/whop_sdk/models/ad_campaign_platform.rbi +22 -0
- data/rbi/whop_sdk/models/ad_campaign_status.rbi +27 -0
- data/rbi/whop_sdk/models/ad_group.rbi +126 -0
- data/rbi/whop_sdk/models/ad_group_list_params.rbi +13 -33
- data/rbi/whop_sdk/models/ad_group_list_response.rbi +41 -131
- data/rbi/whop_sdk/models/ad_group_pause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_status.rbi +24 -0
- data/rbi/whop_sdk/models/ad_group_unpause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_update_params.rbi +16 -67
- data/rbi/whop_sdk/models/ad_list_params.rbi +59 -14
- data/rbi/whop_sdk/models/ad_list_response.rbi +74 -62
- data/rbi/whop_sdk/models/ad_pause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +75 -19
- data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +537 -349
- data/rbi/whop_sdk/models/ad_unpause_params.rbi +35 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +52 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +56 -1
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +55 -0
- data/rbi/whop_sdk/models/currency.rbi +3 -0
- data/rbi/whop_sdk/models/deposit_create_params.rbi +152 -0
- data/rbi/whop_sdk/models/deposit_create_response.rbi +185 -0
- data/rbi/whop_sdk/models/dispute.rbi +7 -9
- data/rbi/whop_sdk/models/dispute_alert_created_webhook_event.rbi +5 -5
- data/rbi/whop_sdk/models/dispute_alert_retrieve_response.rbi +5 -5
- data/rbi/whop_sdk/models/dispute_list_response.rbi +2 -4
- data/rbi/whop_sdk/models/external_ad_status.rbi +26 -0
- data/rbi/whop_sdk/models/file_create_params.rbi +3 -30
- data/rbi/whop_sdk/models/file_create_response.rbi +3 -38
- data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -39
- data/rbi/whop_sdk/models/file_visibility.rbi +21 -0
- data/rbi/whop_sdk/models/granularities.rbi +20 -0
- data/rbi/whop_sdk/models/identity_profile_approved_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_needs_action_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_rejected_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_updated_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +109 -3
- data/rbi/whop_sdk/models/member_list_response.rbi +4 -2
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +4 -2
- data/rbi/whop_sdk/models/membership.rbi +44 -5
- data/rbi/whop_sdk/models/membership_list_response.rbi +44 -5
- data/rbi/whop_sdk/models/payment.rbi +75 -36
- data/rbi/whop_sdk/models/payment_list_params.rbi +8 -0
- data/rbi/whop_sdk/models/payment_list_response.rbi +67 -24
- data/rbi/whop_sdk/models/plan.rbi +39 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +54 -0
- data/rbi/whop_sdk/models/plan_list_response.rbi +62 -0
- data/rbi/whop_sdk/models/plan_update_params.rbi +54 -0
- data/rbi/whop_sdk/models/product.rbi +10 -0
- data/rbi/whop_sdk/models/product_create_params.rbi +12 -0
- data/rbi/whop_sdk/models/product_list_item.rbi +10 -0
- data/rbi/whop_sdk/models/product_update_params.rbi +12 -0
- data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +159 -5
- data/rbi/whop_sdk/models/refund_retrieve_response.rbi +157 -5
- data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +159 -5
- data/rbi/whop_sdk/models/resolution_center_case_platform_response.rbi +0 -5
- data/rbi/whop_sdk/models/result_label_keys.rbi +64 -0
- data/rbi/whop_sdk/models/swap_create_quote_params.rbi +134 -0
- data/rbi/whop_sdk/models/swap_create_quote_response.rbi +148 -0
- data/rbi/whop_sdk/models/transfer_create_params.rbi +6 -2
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +25 -21
- data/rbi/whop_sdk/models/wallet_balance_params.rbi +35 -0
- data/rbi/whop_sdk/models/wallet_balance_response.rbi +145 -0
- data/rbi/whop_sdk/models/wallet_list_params.rbi +27 -0
- data/rbi/whop_sdk/models/wallet_list_response.rbi +66 -0
- data/rbi/whop_sdk/models/wallet_send_params.rbi +57 -0
- data/rbi/whop_sdk/models/wallet_send_response.rbi +146 -0
- data/rbi/whop_sdk/models/webhook_event.rbi +11 -0
- data/rbi/whop_sdk/models.rbi +68 -0
- data/rbi/whop_sdk/resources/accounts.rbi +137 -0
- data/rbi/whop_sdk/resources/ad_campaigns.rbi +8 -8
- data/rbi/whop_sdk/resources/ad_groups.rbi +47 -6
- data/rbi/whop_sdk/resources/ad_reports.rbi +23 -12
- data/rbi/whop_sdk/resources/ads.rbi +59 -2
- data/rbi/whop_sdk/resources/deposits.rbi +41 -0
- data/rbi/whop_sdk/resources/files.rbi +1 -2
- data/rbi/whop_sdk/resources/payments.rbi +3 -0
- data/rbi/whop_sdk/resources/plans.rbi +18 -0
- data/rbi/whop_sdk/resources/products.rbi +10 -0
- data/rbi/whop_sdk/resources/refunds.rbi +2 -0
- data/rbi/whop_sdk/resources/swaps.rbi +46 -0
- data/rbi/whop_sdk/resources/transfers.rbi +3 -1
- data/rbi/whop_sdk/resources/wallets.rbi +55 -0
- data/rbi/whop_sdk/resources/webhooks.rbi +25 -21
- data/sig/whop_sdk/client.rbs +8 -0
- data/sig/whop_sdk/models/account.rbs +100 -0
- data/sig/whop_sdk/models/account_create_params.rbs +32 -0
- data/sig/whop_sdk/models/account_list_params.rbs +32 -0
- data/sig/whop_sdk/models/account_list_response.rbs +62 -0
- data/sig/whop_sdk/models/account_me_params.rbs +14 -0
- data/sig/whop_sdk/models/account_retrieve_params.rbs +23 -0
- data/sig/whop_sdk/models/account_social_link.rbs +62 -0
- data/sig/whop_sdk/models/account_update_params.rbs +111 -0
- data/sig/whop_sdk/models/account_wallet.rbs +42 -0
- data/sig/whop_sdk/models/ad.rbs +75 -0
- data/sig/whop_sdk/models/ad_budget_type.rbs +14 -0
- data/sig/whop_sdk/models/ad_campaign.rbs +194 -0
- data/sig/whop_sdk/models/ad_campaign_list_params.rbs +9 -25
- data/sig/whop_sdk/models/ad_campaign_list_response.rbs +12 -50
- data/sig/whop_sdk/models/ad_campaign_platform.rbs +14 -0
- data/sig/whop_sdk/models/ad_campaign_status.rbs +19 -0
- data/sig/whop_sdk/models/ad_group.rbs +70 -0
- data/sig/whop_sdk/models/ad_group_list_params.rbs +9 -20
- data/sig/whop_sdk/models/ad_group_list_response.rbs +22 -45
- data/sig/whop_sdk/models/ad_group_pause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_status.rbs +19 -0
- data/sig/whop_sdk/models/ad_group_unpause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_update_params.rbs +18 -36
- data/sig/whop_sdk/models/ad_list_params.rbs +39 -14
- data/sig/whop_sdk/models/ad_list_response.rbs +28 -25
- data/sig/whop_sdk/models/ad_pause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +26 -4
- data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +240 -131
- data/sig/whop_sdk/models/ad_unpause_params.rbs +20 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +16 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +18 -2
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +16 -0
- data/sig/whop_sdk/models/currency.rbs +6 -0
- data/sig/whop_sdk/models/deposit_create_params.rbs +81 -0
- data/sig/whop_sdk/models/deposit_create_response.rbs +99 -0
- data/sig/whop_sdk/models/dispute.rbs +4 -4
- data/sig/whop_sdk/models/dispute_alert_created_webhook_event.rbs +4 -4
- data/sig/whop_sdk/models/dispute_alert_retrieve_response.rbs +4 -4
- data/sig/whop_sdk/models/external_ad_status.rbs +19 -0
- data/sig/whop_sdk/models/file_create_params.rbs +4 -18
- data/sig/whop_sdk/models/file_create_response.rbs +4 -15
- data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -15
- data/sig/whop_sdk/models/file_visibility.rbs +14 -0
- data/sig/whop_sdk/models/granularities.rbs +14 -0
- data/sig/whop_sdk/models/identity_profile_approved_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_needs_action_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_rejected_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_updated_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +50 -3
- data/sig/whop_sdk/models/membership.rbs +19 -6
- data/sig/whop_sdk/models/membership_list_response.rbs +19 -6
- data/sig/whop_sdk/models/payment.rbs +52 -15
- data/sig/whop_sdk/models/payment_list_params.rbs +5 -0
- data/sig/whop_sdk/models/payment_list_response.rbs +52 -15
- data/sig/whop_sdk/models/plan.rbs +21 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +21 -0
- data/sig/whop_sdk/models/plan_list_response.rbs +21 -0
- data/sig/whop_sdk/models/plan_update_params.rbs +21 -0
- data/sig/whop_sdk/models/product.rbs +5 -0
- data/sig/whop_sdk/models/product_create_params.rbs +5 -0
- data/sig/whop_sdk/models/product_list_item.rbs +5 -0
- data/sig/whop_sdk/models/product_update_params.rbs +5 -0
- data/sig/whop_sdk/models/refund_created_webhook_event.rbs +43 -4
- data/sig/whop_sdk/models/refund_retrieve_response.rbs +43 -4
- data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +43 -4
- data/sig/whop_sdk/models/resolution_center_case_platform_response.rbs +0 -2
- data/sig/whop_sdk/models/result_label_keys.rbs +60 -0
- data/sig/whop_sdk/models/swap_create_quote_params.rbs +84 -0
- data/sig/whop_sdk/models/swap_create_quote_response.rbs +97 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +26 -22
- data/sig/whop_sdk/models/wallet_balance_params.rbs +23 -0
- data/sig/whop_sdk/models/wallet_balance_response.rbs +87 -0
- data/sig/whop_sdk/models/wallet_list_params.rbs +14 -0
- data/sig/whop_sdk/models/wallet_list_response.rbs +40 -0
- data/sig/whop_sdk/models/wallet_send_params.rbs +32 -0
- data/sig/whop_sdk/models/wallet_send_response.rbs +79 -0
- data/sig/whop_sdk/models/webhook_event.rbs +8 -0
- data/sig/whop_sdk/models.rbs +64 -0
- data/sig/whop_sdk/resources/accounts.rbs +46 -0
- data/sig/whop_sdk/resources/ad_campaigns.rbs +6 -6
- data/sig/whop_sdk/resources/ad_groups.rbs +16 -5
- data/sig/whop_sdk/resources/ad_reports.rbs +3 -1
- data/sig/whop_sdk/resources/ads.rbs +18 -2
- data/sig/whop_sdk/resources/deposits.rbs +15 -0
- data/sig/whop_sdk/resources/files.rbs +1 -1
- data/sig/whop_sdk/resources/payments.rbs +1 -0
- data/sig/whop_sdk/resources/plans.rbs +4 -0
- data/sig/whop_sdk/resources/products.rbs +2 -0
- data/sig/whop_sdk/resources/swaps.rbs +20 -0
- data/sig/whop_sdk/resources/wallets.rbs +23 -0
- data/sig/whop_sdk/resources/webhooks.rbs +26 -22
- metadata +128 -23
- data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +0 -328
- data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +0 -328
- data/lib/whop_sdk/models/ad_campaign_update_response.rb +0 -328
- data/lib/whop_sdk/models/ad_group_retrieve_response.rb +0 -140
- data/lib/whop_sdk/models/ad_group_update_response.rb +0 -140
- data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +0 -679
- data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +0 -675
- data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +0 -670
- data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +0 -277
- data/rbi/whop_sdk/models/ad_group_update_response.rbi +0 -274
- data/rbi/whop_sdk/models/ad_retrieve_response.rbi +0 -245
- data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_update_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +0 -108
- data/sig/whop_sdk/models/ad_group_update_response.rbs +0 -108
- data/sig/whop_sdk/models/ad_retrieve_response.rbs +0 -102
|
@@ -72,10 +72,10 @@ module WhopSDK
|
|
|
72
72
|
required :created_at, Time
|
|
73
73
|
|
|
74
74
|
# @!attribute currency
|
|
75
|
-
# The
|
|
75
|
+
# The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
76
76
|
#
|
|
77
|
-
# @return [Symbol, WhopSDK::Models::Currency
|
|
78
|
-
required :currency, enum: -> { WhopSDK::Currency }
|
|
77
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
78
|
+
required :currency, enum: -> { WhopSDK::Currency }
|
|
79
79
|
|
|
80
80
|
# @!attribute dispute_alerted_at
|
|
81
81
|
# When an alert came in that this transaction will be disputed
|
|
@@ -222,23 +222,20 @@ module WhopSDK
|
|
|
222
222
|
required :retryable, WhopSDK::Internal::Type::Boolean
|
|
223
223
|
|
|
224
224
|
# @!attribute settlement_amount
|
|
225
|
-
# The
|
|
226
|
-
#
|
|
225
|
+
# The total amount charged to the customer for this payment, including taxes and
|
|
226
|
+
# after any discounts. In the currency specified by the currency field.
|
|
227
227
|
#
|
|
228
228
|
# @return [Float]
|
|
229
229
|
required :settlement_amount, Float
|
|
230
230
|
|
|
231
231
|
# @!attribute settlement_currency
|
|
232
|
-
# The
|
|
233
|
-
# 'usd', 'eur'). For multi-currency payments this differs from the payment
|
|
234
|
-
# currency.
|
|
232
|
+
# The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
235
233
|
#
|
|
236
|
-
# @return [
|
|
237
|
-
required :settlement_currency,
|
|
234
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
235
|
+
required :settlement_currency, enum: -> { WhopSDK::Currency }
|
|
238
236
|
|
|
239
237
|
# @!attribute settlement_exchange_rate
|
|
240
|
-
#
|
|
241
|
-
# the creator's settlement currency. Null for single-currency payments.
|
|
238
|
+
# Deprecated. Always returns null.
|
|
242
239
|
#
|
|
243
240
|
# @return [Float, nil]
|
|
244
241
|
required :settlement_exchange_rate, Float, nil?: true
|
|
@@ -340,7 +337,7 @@ module WhopSDK
|
|
|
340
337
|
#
|
|
341
338
|
# @param created_at [Time] The datetime the payment was created.
|
|
342
339
|
#
|
|
343
|
-
# @param currency [Symbol, WhopSDK::Models::Currency
|
|
340
|
+
# @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
344
341
|
#
|
|
345
342
|
# @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
|
|
346
343
|
#
|
|
@@ -386,11 +383,11 @@ module WhopSDK
|
|
|
386
383
|
#
|
|
387
384
|
# @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
|
|
388
385
|
#
|
|
389
|
-
# @param settlement_amount [Float] The
|
|
386
|
+
# @param settlement_amount [Float] The total amount charged to the customer for this payment, including taxes and a
|
|
390
387
|
#
|
|
391
|
-
# @param settlement_currency [
|
|
388
|
+
# @param settlement_currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
392
389
|
#
|
|
393
|
-
# @param settlement_exchange_rate [Float, nil]
|
|
390
|
+
# @param settlement_exchange_rate [Float, nil] Deprecated. Always returns null.
|
|
394
391
|
#
|
|
395
392
|
# @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
|
|
396
393
|
#
|
|
@@ -580,8 +577,7 @@ module WhopSDK
|
|
|
580
577
|
required :currency, enum: -> { WhopSDK::Currency }
|
|
581
578
|
|
|
582
579
|
# @!attribute editable
|
|
583
|
-
# Whether the dispute evidence can still be edited and submitted.
|
|
584
|
-
# only when the dispute status requires a response.
|
|
580
|
+
# Whether the dispute evidence can still be edited and submitted.
|
|
585
581
|
#
|
|
586
582
|
# @return [Boolean, nil]
|
|
587
583
|
required :editable, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
@@ -626,7 +622,7 @@ module WhopSDK
|
|
|
626
622
|
#
|
|
627
623
|
# @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for the disputed amount.
|
|
628
624
|
#
|
|
629
|
-
# @param editable [Boolean, nil] Whether the dispute evidence can still be edited and submitted.
|
|
625
|
+
# @param editable [Boolean, nil] Whether the dispute evidence can still be edited and submitted.
|
|
630
626
|
#
|
|
631
627
|
# @param needs_response_by [Time, nil] The deadline by which dispute evidence must be submitted. Null if no response de
|
|
632
628
|
#
|
|
@@ -757,17 +753,25 @@ module WhopSDK
|
|
|
757
753
|
# @return [String]
|
|
758
754
|
required :id, String
|
|
759
755
|
|
|
756
|
+
# @!attribute phone_number
|
|
757
|
+
# The phone number associated with this membership.
|
|
758
|
+
#
|
|
759
|
+
# @return [String, nil]
|
|
760
|
+
required :phone_number, String, nil?: true
|
|
761
|
+
|
|
760
762
|
# @!attribute status
|
|
761
763
|
# The state of the membership.
|
|
762
764
|
#
|
|
763
765
|
# @return [Symbol, WhopSDK::Models::MembershipStatus]
|
|
764
766
|
required :status, enum: -> { WhopSDK::MembershipStatus }
|
|
765
767
|
|
|
766
|
-
# @!method initialize(id:, status:)
|
|
768
|
+
# @!method initialize(id:, phone_number:, status:)
|
|
767
769
|
# The membership attached to this payment.
|
|
768
770
|
#
|
|
769
771
|
# @param id [String] The unique identifier for the membership.
|
|
770
772
|
#
|
|
773
|
+
# @param phone_number [String, nil] The phone number associated with this membership.
|
|
774
|
+
#
|
|
771
775
|
# @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
|
|
772
776
|
end
|
|
773
777
|
|
|
@@ -869,12 +873,24 @@ module WhopSDK
|
|
|
869
873
|
# @return [String, nil]
|
|
870
874
|
required :internal_notes, String, nil?: true
|
|
871
875
|
|
|
872
|
-
# @!
|
|
876
|
+
# @!attribute metadata
|
|
877
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
878
|
+
# payment and membership events.
|
|
879
|
+
#
|
|
880
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
881
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
882
|
+
|
|
883
|
+
# @!method initialize(id:, internal_notes:, metadata:)
|
|
884
|
+
# Some parameter documentations has been truncated, see
|
|
885
|
+
# {WhopSDK::Models::Payment::Plan} for more details.
|
|
886
|
+
#
|
|
873
887
|
# The plan attached to this payment.
|
|
874
888
|
#
|
|
875
889
|
# @param id [String] The unique identifier for the plan.
|
|
876
890
|
#
|
|
877
891
|
# @param internal_notes [String, nil] A personal description or notes section for the business.
|
|
892
|
+
#
|
|
893
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
878
894
|
end
|
|
879
895
|
|
|
880
896
|
# @see WhopSDK::Models::Payment#product
|
|
@@ -885,6 +901,13 @@ module WhopSDK
|
|
|
885
901
|
# @return [String]
|
|
886
902
|
required :id, String
|
|
887
903
|
|
|
904
|
+
# @!attribute metadata
|
|
905
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
906
|
+
# payment and membership events.
|
|
907
|
+
#
|
|
908
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
909
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
910
|
+
|
|
888
911
|
# @!attribute route
|
|
889
912
|
# The URL slug used in the product's public link (e.g., 'my-product' in
|
|
890
913
|
# whop.com/company/my-product).
|
|
@@ -899,7 +922,7 @@ module WhopSDK
|
|
|
899
922
|
# @return [String]
|
|
900
923
|
required :title, String
|
|
901
924
|
|
|
902
|
-
# @!method initialize(id:, route:, title:)
|
|
925
|
+
# @!method initialize(id:, metadata:, route:, title:)
|
|
903
926
|
# Some parameter documentations has been truncated, see
|
|
904
927
|
# {WhopSDK::Models::Payment::Product} for more details.
|
|
905
928
|
#
|
|
@@ -907,6 +930,8 @@ module WhopSDK
|
|
|
907
930
|
#
|
|
908
931
|
# @param id [String] The unique identifier for the product.
|
|
909
932
|
#
|
|
933
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
934
|
+
#
|
|
910
935
|
# @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
|
|
911
936
|
#
|
|
912
937
|
# @param title [String] The display name of the product shown to customers on the product page and in se
|
|
@@ -27,6 +27,12 @@ module WhopSDK
|
|
|
27
27
|
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::BillingReasons] },
|
|
28
28
|
nil?: true
|
|
29
29
|
|
|
30
|
+
# @!attribute checkout_configuration_ids
|
|
31
|
+
# Only return payments from these checkout configurations.
|
|
32
|
+
#
|
|
33
|
+
# @return [Array<String>, nil]
|
|
34
|
+
optional :checkout_configuration_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
35
|
+
|
|
30
36
|
# @!attribute company_id
|
|
31
37
|
# The unique identifier of the company to list payments for.
|
|
32
38
|
#
|
|
@@ -127,7 +133,7 @@ module WhopSDK
|
|
|
127
133
|
# @return [Time, nil]
|
|
128
134
|
optional :updated_before, Time, nil?: true
|
|
129
135
|
|
|
130
|
-
# @!method initialize(after: nil, before: nil, billing_reasons: nil, company_id: nil, created_after: nil, created_before: nil, currencies: nil, direction: nil, first: nil, include_free: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, query: nil, statuses: nil, substatuses: nil, updated_after: nil, updated_before: nil, request_options: {})
|
|
136
|
+
# @!method initialize(after: nil, before: nil, billing_reasons: nil, checkout_configuration_ids: nil, company_id: nil, created_after: nil, created_before: nil, currencies: nil, direction: nil, first: nil, include_free: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, query: nil, statuses: nil, substatuses: nil, updated_after: nil, updated_before: nil, request_options: {})
|
|
131
137
|
# Some parameter documentations has been truncated, see
|
|
132
138
|
# {WhopSDK::Models::PaymentListParams} for more details.
|
|
133
139
|
#
|
|
@@ -137,6 +143,8 @@ module WhopSDK
|
|
|
137
143
|
#
|
|
138
144
|
# @param billing_reasons [Array<Symbol, WhopSDK::Models::BillingReasons>, nil] Filter payments by their billing reason.
|
|
139
145
|
#
|
|
146
|
+
# @param checkout_configuration_ids [Array<String>, nil] Only return payments from these checkout configurations.
|
|
147
|
+
#
|
|
140
148
|
# @param company_id [String, nil] The unique identifier of the company to list payments for.
|
|
141
149
|
#
|
|
142
150
|
# @param created_after [Time, nil] Only return payments created after this timestamp.
|
|
@@ -73,10 +73,10 @@ module WhopSDK
|
|
|
73
73
|
required :created_at, Time
|
|
74
74
|
|
|
75
75
|
# @!attribute currency
|
|
76
|
-
# The
|
|
76
|
+
# The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
77
77
|
#
|
|
78
|
-
# @return [Symbol, WhopSDK::Models::Currency
|
|
79
|
-
required :currency, enum: -> { WhopSDK::Currency }
|
|
78
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
79
|
+
required :currency, enum: -> { WhopSDK::Currency }
|
|
80
80
|
|
|
81
81
|
# @!attribute dispute_alerted_at
|
|
82
82
|
# When an alert came in that this transaction will be disputed
|
|
@@ -193,12 +193,10 @@ module WhopSDK
|
|
|
193
193
|
required :retryable, WhopSDK::Internal::Type::Boolean
|
|
194
194
|
|
|
195
195
|
# @!attribute settlement_currency
|
|
196
|
-
# The
|
|
197
|
-
# 'usd', 'eur'). For multi-currency payments this differs from the payment
|
|
198
|
-
# currency.
|
|
196
|
+
# The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
199
197
|
#
|
|
200
|
-
# @return [
|
|
201
|
-
required :settlement_currency,
|
|
198
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
199
|
+
required :settlement_currency, enum: -> { WhopSDK::Currency }
|
|
202
200
|
|
|
203
201
|
# @!attribute status
|
|
204
202
|
# The status of a receipt
|
|
@@ -291,7 +289,7 @@ module WhopSDK
|
|
|
291
289
|
#
|
|
292
290
|
# @param created_at [Time] The datetime the payment was created.
|
|
293
291
|
#
|
|
294
|
-
# @param currency [Symbol, WhopSDK::Models::Currency
|
|
292
|
+
# @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
295
293
|
#
|
|
296
294
|
# @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
|
|
297
295
|
#
|
|
@@ -329,7 +327,7 @@ module WhopSDK
|
|
|
329
327
|
#
|
|
330
328
|
# @param retryable [Boolean] True when the payment status is `open` and its membership is in one of the retry
|
|
331
329
|
#
|
|
332
|
-
# @param settlement_currency [
|
|
330
|
+
# @param settlement_currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
333
331
|
#
|
|
334
332
|
# @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
|
|
335
333
|
#
|
|
@@ -527,17 +525,25 @@ module WhopSDK
|
|
|
527
525
|
# @return [String]
|
|
528
526
|
required :id, String
|
|
529
527
|
|
|
528
|
+
# @!attribute phone_number
|
|
529
|
+
# The phone number associated with this membership.
|
|
530
|
+
#
|
|
531
|
+
# @return [String, nil]
|
|
532
|
+
required :phone_number, String, nil?: true
|
|
533
|
+
|
|
530
534
|
# @!attribute status
|
|
531
535
|
# The state of the membership.
|
|
532
536
|
#
|
|
533
537
|
# @return [Symbol, WhopSDK::Models::MembershipStatus]
|
|
534
538
|
required :status, enum: -> { WhopSDK::MembershipStatus }
|
|
535
539
|
|
|
536
|
-
# @!method initialize(id:, status:)
|
|
540
|
+
# @!method initialize(id:, phone_number:, status:)
|
|
537
541
|
# The membership attached to this payment.
|
|
538
542
|
#
|
|
539
543
|
# @param id [String] The unique identifier for the membership.
|
|
540
544
|
#
|
|
545
|
+
# @param phone_number [String, nil] The phone number associated with this membership.
|
|
546
|
+
#
|
|
541
547
|
# @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
|
|
542
548
|
end
|
|
543
549
|
|
|
@@ -639,12 +645,24 @@ module WhopSDK
|
|
|
639
645
|
# @return [String, nil]
|
|
640
646
|
required :internal_notes, String, nil?: true
|
|
641
647
|
|
|
642
|
-
# @!
|
|
648
|
+
# @!attribute metadata
|
|
649
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
650
|
+
# payment and membership events.
|
|
651
|
+
#
|
|
652
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
653
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
654
|
+
|
|
655
|
+
# @!method initialize(id:, internal_notes:, metadata:)
|
|
656
|
+
# Some parameter documentations has been truncated, see
|
|
657
|
+
# {WhopSDK::Models::PaymentListResponse::Plan} for more details.
|
|
658
|
+
#
|
|
643
659
|
# The plan attached to this payment.
|
|
644
660
|
#
|
|
645
661
|
# @param id [String] The unique identifier for the plan.
|
|
646
662
|
#
|
|
647
663
|
# @param internal_notes [String, nil] A personal description or notes section for the business.
|
|
664
|
+
#
|
|
665
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
648
666
|
end
|
|
649
667
|
|
|
650
668
|
# @see WhopSDK::Models::PaymentListResponse#product
|
|
@@ -655,6 +673,13 @@ module WhopSDK
|
|
|
655
673
|
# @return [String]
|
|
656
674
|
required :id, String
|
|
657
675
|
|
|
676
|
+
# @!attribute metadata
|
|
677
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
678
|
+
# payment and membership events.
|
|
679
|
+
#
|
|
680
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
681
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
682
|
+
|
|
658
683
|
# @!attribute route
|
|
659
684
|
# The URL slug used in the product's public link (e.g., 'my-product' in
|
|
660
685
|
# whop.com/company/my-product).
|
|
@@ -669,7 +694,7 @@ module WhopSDK
|
|
|
669
694
|
# @return [String]
|
|
670
695
|
required :title, String
|
|
671
696
|
|
|
672
|
-
# @!method initialize(id:, route:, title:)
|
|
697
|
+
# @!method initialize(id:, metadata:, route:, title:)
|
|
673
698
|
# Some parameter documentations has been truncated, see
|
|
674
699
|
# {WhopSDK::Models::PaymentListResponse::Product} for more details.
|
|
675
700
|
#
|
|
@@ -677,6 +702,8 @@ module WhopSDK
|
|
|
677
702
|
#
|
|
678
703
|
# @param id [String] The unique identifier for the product.
|
|
679
704
|
#
|
|
705
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
706
|
+
#
|
|
680
707
|
# @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
|
|
681
708
|
#
|
|
682
709
|
# @param title [String] The display name of the product shown to customers on the product page and in se
|
data/lib/whop_sdk/models/plan.rb
CHANGED
|
@@ -100,6 +100,13 @@ module WhopSDK
|
|
|
100
100
|
# @return [Integer, nil]
|
|
101
101
|
required :member_count, Integer, nil?: true
|
|
102
102
|
|
|
103
|
+
# @!attribute metadata
|
|
104
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
105
|
+
# payment and membership events.
|
|
106
|
+
#
|
|
107
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
108
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
109
|
+
|
|
103
110
|
# @!attribute payment_method_configuration
|
|
104
111
|
# The explicit payment method configuration specifying which payment methods are
|
|
105
112
|
# enabled or disabled for this plan. Null if the plan uses default settings.
|
|
@@ -163,6 +170,12 @@ module WhopSDK
|
|
|
163
170
|
# @return [Symbol, WhopSDK::Models::TaxType]
|
|
164
171
|
required :tax_type, enum: -> { WhopSDK::TaxType }
|
|
165
172
|
|
|
173
|
+
# @!attribute three_ds_level
|
|
174
|
+
# The 3D Secure behavior for a plan.
|
|
175
|
+
#
|
|
176
|
+
# @return [Symbol, WhopSDK::Models::Plan::ThreeDSLevel, nil]
|
|
177
|
+
required :three_ds_level, enum: -> { WhopSDK::Plan::ThreeDSLevel }, nil?: true
|
|
178
|
+
|
|
166
179
|
# @!attribute title
|
|
167
180
|
# The display name of the plan shown to customers on the product page and at
|
|
168
181
|
# checkout. Maximum 30 characters. Null if no title has been set.
|
|
@@ -198,7 +211,7 @@ module WhopSDK
|
|
|
198
211
|
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
199
212
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
200
213
|
|
|
201
|
-
# @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, split_pay_required_payments:, stock:, tax_type:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
214
|
+
# @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, metadata:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, split_pay_required_payments:, stock:, tax_type:, three_ds_level:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
202
215
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Plan}
|
|
203
216
|
# for more details.
|
|
204
217
|
#
|
|
@@ -234,6 +247,8 @@ module WhopSDK
|
|
|
234
247
|
#
|
|
235
248
|
# @param member_count [Integer, nil] The number of users who currently hold an active membership through this plan. O
|
|
236
249
|
#
|
|
250
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
251
|
+
#
|
|
237
252
|
# @param payment_method_configuration [WhopSDK::Models::Plan::PaymentMethodConfiguration, nil] The explicit payment method configuration specifying which payment methods are e
|
|
238
253
|
#
|
|
239
254
|
# @param plan_type [Symbol, WhopSDK::Models::PlanType] The billing model for this plan: 'renewal' for recurring subscriptions or 'one_t
|
|
@@ -252,6 +267,8 @@ module WhopSDK
|
|
|
252
267
|
#
|
|
253
268
|
# @param tax_type [Symbol, WhopSDK::Models::TaxType] How tax is handled for this plan: 'inclusive' (tax included in price), 'exclusiv
|
|
254
269
|
#
|
|
270
|
+
# @param three_ds_level [Symbol, WhopSDK::Models::Plan::ThreeDSLevel, nil] The 3D Secure behavior for a plan.
|
|
271
|
+
#
|
|
255
272
|
# @param title [String, nil] The display name of the plan shown to customers on the product page and at check
|
|
256
273
|
#
|
|
257
274
|
# @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a renewal plan. Null if
|
|
@@ -419,6 +436,19 @@ module WhopSDK
|
|
|
419
436
|
#
|
|
420
437
|
# @param title [String] The display name of the product shown to customers on the product page and in se
|
|
421
438
|
end
|
|
439
|
+
|
|
440
|
+
# The 3D Secure behavior for a plan.
|
|
441
|
+
#
|
|
442
|
+
# @see WhopSDK::Models::Plan#three_ds_level
|
|
443
|
+
module ThreeDSLevel
|
|
444
|
+
extend WhopSDK::Internal::Type::Enum
|
|
445
|
+
|
|
446
|
+
MANDATE_CHALLENGE = :mandate_challenge
|
|
447
|
+
FRICTIONLESS = :frictionless
|
|
448
|
+
|
|
449
|
+
# @!method self.values
|
|
450
|
+
# @return [Array<Symbol>]
|
|
451
|
+
end
|
|
422
452
|
end
|
|
423
453
|
end
|
|
424
454
|
end
|
|
@@ -92,6 +92,14 @@ module WhopSDK
|
|
|
92
92
|
# @return [Boolean, nil]
|
|
93
93
|
optional :legacy_payment_method_controls, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
94
94
|
|
|
95
|
+
# @!attribute metadata
|
|
96
|
+
# Custom key-value pairs to store on the plan. Included in webhook payloads for
|
|
97
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
98
|
+
# value.
|
|
99
|
+
#
|
|
100
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
101
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
102
|
+
|
|
95
103
|
# @!attribute override_tax_type
|
|
96
104
|
# Whether or not the tax is included in a plan's price (or if it hasn't been set
|
|
97
105
|
# up)
|
|
@@ -140,6 +148,12 @@ module WhopSDK
|
|
|
140
148
|
# @return [Integer, nil]
|
|
141
149
|
optional :stock, Integer, nil?: true
|
|
142
150
|
|
|
151
|
+
# @!attribute three_ds_level
|
|
152
|
+
# The 3D Secure behavior for a plan.
|
|
153
|
+
#
|
|
154
|
+
# @return [Symbol, WhopSDK::Models::PlanCreateParams::ThreeDSLevel, nil]
|
|
155
|
+
optional :three_ds_level, enum: -> { WhopSDK::PlanCreateParams::ThreeDSLevel }, nil?: true
|
|
156
|
+
|
|
143
157
|
# @!attribute title
|
|
144
158
|
# The display name of the plan shown to customers on the product page.
|
|
145
159
|
#
|
|
@@ -165,7 +179,7 @@ module WhopSDK
|
|
|
165
179
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
166
180
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
167
181
|
|
|
168
|
-
# @!method initialize(company_id:, product_id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: 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: {})
|
|
182
|
+
# @!method initialize(company_id:, product_id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, metadata: 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, three_ds_level: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
169
183
|
# Some parameter documentations has been truncated, see
|
|
170
184
|
# {WhopSDK::Models::PlanCreateParams} for more details.
|
|
171
185
|
#
|
|
@@ -195,6 +209,8 @@ module WhopSDK
|
|
|
195
209
|
#
|
|
196
210
|
# @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls.
|
|
197
211
|
#
|
|
212
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs to store on the plan. Included in webhook payloads for pa
|
|
213
|
+
#
|
|
198
214
|
# @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
|
|
199
215
|
#
|
|
200
216
|
# @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] Explicit payment method configuration for the plan. When not provided, the compa
|
|
@@ -209,6 +225,8 @@ module WhopSDK
|
|
|
209
225
|
#
|
|
210
226
|
# @param stock [Integer, nil] The maximum number of units available for purchase. Ignored when unlimited_stock
|
|
211
227
|
#
|
|
228
|
+
# @param three_ds_level [Symbol, WhopSDK::Models::PlanCreateParams::ThreeDSLevel, nil] The 3D Secure behavior for a plan.
|
|
229
|
+
#
|
|
212
230
|
# @param title [String, nil] The display name of the plan shown to customers on the product page.
|
|
213
231
|
#
|
|
214
232
|
# @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a recurring plan.
|
|
@@ -364,6 +382,17 @@ module WhopSDK
|
|
|
364
382
|
#
|
|
365
383
|
# @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
|
|
366
384
|
end
|
|
385
|
+
|
|
386
|
+
# The 3D Secure behavior for a plan.
|
|
387
|
+
module ThreeDSLevel
|
|
388
|
+
extend WhopSDK::Internal::Type::Enum
|
|
389
|
+
|
|
390
|
+
MANDATE_CHALLENGE = :mandate_challenge
|
|
391
|
+
FRICTIONLESS = :frictionless
|
|
392
|
+
|
|
393
|
+
# @!method self.values
|
|
394
|
+
# @return [Array<Symbol>]
|
|
395
|
+
end
|
|
367
396
|
end
|
|
368
397
|
end
|
|
369
398
|
end
|
|
@@ -87,6 +87,13 @@ module WhopSDK
|
|
|
87
87
|
# @return [Integer, nil]
|
|
88
88
|
required :member_count, Integer, nil?: true
|
|
89
89
|
|
|
90
|
+
# @!attribute metadata
|
|
91
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
92
|
+
# payment and membership events.
|
|
93
|
+
#
|
|
94
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
95
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
96
|
+
|
|
90
97
|
# @!attribute payment_method_configuration
|
|
91
98
|
# The explicit payment method configuration specifying which payment methods are
|
|
92
99
|
# enabled or disabled for this plan. Null if the plan uses default settings.
|
|
@@ -145,6 +152,12 @@ module WhopSDK
|
|
|
145
152
|
# @return [Integer, nil]
|
|
146
153
|
required :stock, Integer, nil?: true
|
|
147
154
|
|
|
155
|
+
# @!attribute three_ds_level
|
|
156
|
+
# The 3D Secure behavior for a plan.
|
|
157
|
+
#
|
|
158
|
+
# @return [Symbol, WhopSDK::Models::PlanListResponse::ThreeDSLevel, nil]
|
|
159
|
+
required :three_ds_level, enum: -> { WhopSDK::Models::PlanListResponse::ThreeDSLevel }, nil?: true
|
|
160
|
+
|
|
148
161
|
# @!attribute title
|
|
149
162
|
# The display name of the plan shown to customers on the product page and at
|
|
150
163
|
# checkout. Maximum 30 characters. Null if no title has been set.
|
|
@@ -180,7 +193,7 @@ module WhopSDK
|
|
|
180
193
|
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
181
194
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
182
195
|
|
|
183
|
-
# @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, split_pay_required_payments:, stock:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
196
|
+
# @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, metadata:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, split_pay_required_payments:, stock:, three_ds_level:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
184
197
|
# Some parameter documentations has been truncated, see
|
|
185
198
|
# {WhopSDK::Models::PlanListResponse} for more details.
|
|
186
199
|
#
|
|
@@ -212,6 +225,8 @@ module WhopSDK
|
|
|
212
225
|
#
|
|
213
226
|
# @param member_count [Integer, nil] The number of users who currently hold an active membership through this plan. O
|
|
214
227
|
#
|
|
228
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
229
|
+
#
|
|
215
230
|
# @param payment_method_configuration [WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration, nil] The explicit payment method configuration specifying which payment methods are e
|
|
216
231
|
#
|
|
217
232
|
# @param plan_type [Symbol, WhopSDK::Models::PlanType] The billing model for this plan: 'renewal' for recurring subscriptions or 'one_t
|
|
@@ -228,6 +243,8 @@ module WhopSDK
|
|
|
228
243
|
#
|
|
229
244
|
# @param stock [Integer, nil] The number of units available for purchase. Only visible to authorized team memb
|
|
230
245
|
#
|
|
246
|
+
# @param three_ds_level [Symbol, WhopSDK::Models::PlanListResponse::ThreeDSLevel, nil] The 3D Secure behavior for a plan.
|
|
247
|
+
#
|
|
231
248
|
# @param title [String, nil] The display name of the plan shown to customers on the product page and at check
|
|
232
249
|
#
|
|
233
250
|
# @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a renewal plan. Null if
|
|
@@ -343,6 +360,19 @@ module WhopSDK
|
|
|
343
360
|
#
|
|
344
361
|
# @param title [String] The display name of the product shown to customers on the product page and in se
|
|
345
362
|
end
|
|
363
|
+
|
|
364
|
+
# The 3D Secure behavior for a plan.
|
|
365
|
+
#
|
|
366
|
+
# @see WhopSDK::Models::PlanListResponse#three_ds_level
|
|
367
|
+
module ThreeDSLevel
|
|
368
|
+
extend WhopSDK::Internal::Type::Enum
|
|
369
|
+
|
|
370
|
+
MANDATE_CHALLENGE = :mandate_challenge
|
|
371
|
+
FRICTIONLESS = :frictionless
|
|
372
|
+
|
|
373
|
+
# @!method self.values
|
|
374
|
+
# @return [Array<Symbol>]
|
|
375
|
+
end
|
|
346
376
|
end
|
|
347
377
|
end
|
|
348
378
|
end
|
|
@@ -84,6 +84,14 @@ module WhopSDK
|
|
|
84
84
|
# @return [Boolean, nil]
|
|
85
85
|
optional :legacy_payment_method_controls, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
86
86
|
|
|
87
|
+
# @!attribute metadata
|
|
88
|
+
# Custom key-value pairs to store on the plan. Included in webhook payloads for
|
|
89
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
90
|
+
# value.
|
|
91
|
+
#
|
|
92
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
93
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
94
|
+
|
|
87
95
|
# @!attribute offer_cancel_discount
|
|
88
96
|
# Whether to offer a retention discount when a customer attempts to cancel.
|
|
89
97
|
#
|
|
@@ -134,6 +142,12 @@ module WhopSDK
|
|
|
134
142
|
# @return [Float, nil]
|
|
135
143
|
optional :strike_through_renewal_price, Float, nil?: true
|
|
136
144
|
|
|
145
|
+
# @!attribute three_ds_level
|
|
146
|
+
# The 3D Secure behavior for a plan.
|
|
147
|
+
#
|
|
148
|
+
# @return [Symbol, WhopSDK::Models::PlanUpdateParams::ThreeDSLevel, nil]
|
|
149
|
+
optional :three_ds_level, enum: -> { WhopSDK::PlanUpdateParams::ThreeDSLevel }, nil?: true
|
|
150
|
+
|
|
137
151
|
# @!attribute title
|
|
138
152
|
# The display name of the plan shown to customers on the product page.
|
|
139
153
|
#
|
|
@@ -158,7 +172,7 @@ module WhopSDK
|
|
|
158
172
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
159
173
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
160
174
|
|
|
161
|
-
# @!method initialize(id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: 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: {})
|
|
175
|
+
# @!method initialize(id:, adaptive_pricing_enabled: nil, billing_period: nil, checkout_styling: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, legacy_payment_method_controls: nil, metadata: 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, three_ds_level: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
162
176
|
# Some parameter documentations has been truncated, see
|
|
163
177
|
# {WhopSDK::Models::PlanUpdateParams} for more details.
|
|
164
178
|
#
|
|
@@ -186,6 +200,8 @@ module WhopSDK
|
|
|
186
200
|
#
|
|
187
201
|
# @param legacy_payment_method_controls [Boolean, nil] Whether this plan uses legacy payment method controls.
|
|
188
202
|
#
|
|
203
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs to store on the plan. Included in webhook payloads for pa
|
|
204
|
+
#
|
|
189
205
|
# @param offer_cancel_discount [Boolean, nil] Whether to offer a retention discount when a customer attempts to cancel.
|
|
190
206
|
#
|
|
191
207
|
# @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
|
|
@@ -200,6 +216,8 @@ module WhopSDK
|
|
|
200
216
|
#
|
|
201
217
|
# @param strike_through_renewal_price [Float, nil] A comparison price displayed with a strikethrough for the renewal price. Provide
|
|
202
218
|
#
|
|
219
|
+
# @param three_ds_level [Symbol, WhopSDK::Models::PlanUpdateParams::ThreeDSLevel, nil] The 3D Secure behavior for a plan.
|
|
220
|
+
#
|
|
203
221
|
# @param title [String, nil] The display name of the plan shown to customers on the product page.
|
|
204
222
|
#
|
|
205
223
|
# @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a recurring plan.
|
|
@@ -355,6 +373,17 @@ module WhopSDK
|
|
|
355
373
|
#
|
|
356
374
|
# @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
|
|
357
375
|
end
|
|
376
|
+
|
|
377
|
+
# The 3D Secure behavior for a plan.
|
|
378
|
+
module ThreeDSLevel
|
|
379
|
+
extend WhopSDK::Internal::Type::Enum
|
|
380
|
+
|
|
381
|
+
MANDATE_CHALLENGE = :mandate_challenge
|
|
382
|
+
FRICTIONLESS = :frictionless
|
|
383
|
+
|
|
384
|
+
# @!method self.values
|
|
385
|
+
# @return [Array<Symbol>]
|
|
386
|
+
end
|
|
358
387
|
end
|
|
359
388
|
end
|
|
360
389
|
end
|
|
@@ -105,6 +105,13 @@ module WhopSDK
|
|
|
105
105
|
# @return [Integer]
|
|
106
106
|
required :member_count, Integer
|
|
107
107
|
|
|
108
|
+
# @!attribute metadata
|
|
109
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
110
|
+
# payment and membership events.
|
|
111
|
+
#
|
|
112
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
113
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
114
|
+
|
|
108
115
|
# @!attribute owner_user
|
|
109
116
|
# The user who owns the company that sells this product.
|
|
110
117
|
#
|
|
@@ -157,7 +164,7 @@ module WhopSDK
|
|
|
157
164
|
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
158
165
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
159
166
|
|
|
160
|
-
# @!method initialize(id:, company:, created_at:, custom_cta:, custom_cta_url:, custom_statement_descriptor:, description:, external_identifier:, gallery_images:, global_affiliate_percentage:, global_affiliate_status:, headline:, member_affiliate_percentage:, member_affiliate_status:, member_count:, owner_user:, product_tax_code:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
|
|
167
|
+
# @!method initialize(id:, company:, created_at:, custom_cta:, custom_cta_url:, custom_statement_descriptor:, description:, external_identifier:, gallery_images:, global_affiliate_percentage:, global_affiliate_status:, headline:, member_affiliate_percentage:, member_affiliate_status:, member_count:, metadata:, owner_user:, product_tax_code:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
|
|
161
168
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Product}
|
|
162
169
|
# for more details.
|
|
163
170
|
#
|
|
@@ -194,6 +201,8 @@ module WhopSDK
|
|
|
194
201
|
#
|
|
195
202
|
# @param member_count [Integer] The number of users who currently hold an active membership to this product. Ret
|
|
196
203
|
#
|
|
204
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
205
|
+
#
|
|
197
206
|
# @param owner_user [WhopSDK::Models::Product::OwnerUser] The user who owns the company that sells this product.
|
|
198
207
|
#
|
|
199
208
|
# @param product_tax_code [WhopSDK::Models::Product::ProductTaxCode, nil] The tax classification code applied to purchases of this product for sales tax c
|