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
|
@@ -90,6 +90,14 @@ module WhopSDK
|
|
|
90
90
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
91
91
|
optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
92
92
|
|
|
93
|
+
# @!attribute metadata
|
|
94
|
+
# Custom key-value pairs to store on the product. Included in webhook payloads for
|
|
95
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
96
|
+
# value.
|
|
97
|
+
#
|
|
98
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
99
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
100
|
+
|
|
93
101
|
# @!attribute plan_options
|
|
94
102
|
# Configuration for an automatically generated plan to attach to this product.
|
|
95
103
|
#
|
|
@@ -127,7 +135,7 @@ module WhopSDK
|
|
|
127
135
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
128
136
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
129
137
|
|
|
130
|
-
# @!method initialize(company_id:, title:, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, experience_ids: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, plan_options: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, visibility: nil, request_options: {})
|
|
138
|
+
# @!method initialize(company_id:, title:, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, experience_ids: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, metadata: nil, plan_options: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, visibility: nil, request_options: {})
|
|
131
139
|
# Some parameter documentations has been truncated, see
|
|
132
140
|
# {WhopSDK::Models::ProductCreateParams} for more details.
|
|
133
141
|
#
|
|
@@ -157,6 +165,8 @@ module WhopSDK
|
|
|
157
165
|
#
|
|
158
166
|
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
159
167
|
#
|
|
168
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs to store on the product. Included in webhook payloads for
|
|
169
|
+
#
|
|
160
170
|
# @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] Configuration for an automatically generated plan to attach to this product.
|
|
161
171
|
#
|
|
162
172
|
# @param product_tax_code_id [String, nil] The unique identifier of the tax classification code to apply to this product.
|
|
@@ -36,6 +36,13 @@ module WhopSDK
|
|
|
36
36
|
# @return [Integer]
|
|
37
37
|
required :member_count, Integer
|
|
38
38
|
|
|
39
|
+
# @!attribute metadata
|
|
40
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
41
|
+
# payment and membership events.
|
|
42
|
+
#
|
|
43
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
44
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
45
|
+
|
|
39
46
|
# @!attribute published_reviews_count
|
|
40
47
|
# The total number of published customer reviews for this product's company.
|
|
41
48
|
#
|
|
@@ -75,7 +82,7 @@ module WhopSDK
|
|
|
75
82
|
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
76
83
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
77
84
|
|
|
78
|
-
# @!method initialize(id:, created_at:, external_identifier:, headline:, member_count:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
|
|
85
|
+
# @!method initialize(id:, created_at:, external_identifier:, headline:, member_count:, metadata:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
|
|
79
86
|
# Some parameter documentations has been truncated, see
|
|
80
87
|
# {WhopSDK::Models::ProductListItem} for more details.
|
|
81
88
|
#
|
|
@@ -92,6 +99,8 @@ module WhopSDK
|
|
|
92
99
|
#
|
|
93
100
|
# @param member_count [Integer] The number of users who currently hold an active membership to this product. Ret
|
|
94
101
|
#
|
|
102
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
103
|
+
#
|
|
95
104
|
# @param published_reviews_count [Integer] The total number of published customer reviews for this product's company.
|
|
96
105
|
#
|
|
97
106
|
# @param route [String] The URL slug used in the product's public link (e.g., 'my-product' in whop.com/c
|
|
@@ -85,6 +85,14 @@ module WhopSDK
|
|
|
85
85
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
86
86
|
optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
87
87
|
|
|
88
|
+
# @!attribute metadata
|
|
89
|
+
# Custom key-value pairs to store on the product. Included in webhook payloads for
|
|
90
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
91
|
+
# value.
|
|
92
|
+
#
|
|
93
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
94
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
95
|
+
|
|
88
96
|
# @!attribute product_tax_code_id
|
|
89
97
|
# The unique identifier of the tax classification code to apply to this product.
|
|
90
98
|
#
|
|
@@ -128,7 +136,7 @@ module WhopSDK
|
|
|
128
136
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
129
137
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
130
138
|
|
|
131
|
-
# @!method initialize(id:, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, gallery_images: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
|
|
139
|
+
# @!method initialize(id:, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, gallery_images: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, metadata: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, send_welcome_message: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
|
|
132
140
|
# Some parameter documentations has been truncated, see
|
|
133
141
|
# {WhopSDK::Models::ProductUpdateParams} for more details.
|
|
134
142
|
#
|
|
@@ -156,6 +164,8 @@ module WhopSDK
|
|
|
156
164
|
#
|
|
157
165
|
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
158
166
|
#
|
|
167
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs to store on the product. Included in webhook payloads for
|
|
168
|
+
#
|
|
159
169
|
# @param product_tax_code_id [String, nil] The unique identifier of the tax classification code to apply to this product.
|
|
160
170
|
#
|
|
161
171
|
# @param redirect_purchase_url [String, nil] A URL to redirect the customer to after completing a purchase.
|
|
@@ -192,10 +192,10 @@ module WhopSDK
|
|
|
192
192
|
required :created_at, Time
|
|
193
193
|
|
|
194
194
|
# @!attribute currency
|
|
195
|
-
# The
|
|
195
|
+
# The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
196
196
|
#
|
|
197
|
-
# @return [Symbol, WhopSDK::Models::Currency
|
|
198
|
-
required :currency, enum: -> { WhopSDK::Currency }
|
|
197
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
198
|
+
required :currency, enum: -> { WhopSDK::Currency }
|
|
199
199
|
|
|
200
200
|
# @!attribute dispute_alerted_at
|
|
201
201
|
# When an alert came in that this transaction will be disputed
|
|
@@ -219,6 +219,13 @@ module WhopSDK
|
|
|
219
219
|
},
|
|
220
220
|
nil?: true
|
|
221
221
|
|
|
222
|
+
# @!attribute metadata
|
|
223
|
+
# The custom metadata stored on this payment. This will be copied over to the
|
|
224
|
+
# checkout configuration for which this payment was made
|
|
225
|
+
#
|
|
226
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
227
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
228
|
+
|
|
222
229
|
# @!attribute paid_at
|
|
223
230
|
# The time at which this payment was successfully collected. Null if the payment
|
|
224
231
|
# has not yet succeeded. As a Unix timestamp.
|
|
@@ -232,6 +239,18 @@ module WhopSDK
|
|
|
232
239
|
# @return [Symbol, WhopSDK::Models::PaymentMethodTypes, nil]
|
|
233
240
|
required :payment_method_type, enum: -> { WhopSDK::PaymentMethodTypes }, nil?: true
|
|
234
241
|
|
|
242
|
+
# @!attribute plan
|
|
243
|
+
# The plan attached to this payment.
|
|
244
|
+
#
|
|
245
|
+
# @return [WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::Plan, nil]
|
|
246
|
+
required :plan, -> { WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Plan }, nil?: true
|
|
247
|
+
|
|
248
|
+
# @!attribute product
|
|
249
|
+
# The product this payment was made for
|
|
250
|
+
#
|
|
251
|
+
# @return [WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::Product, nil]
|
|
252
|
+
required :product, -> { WhopSDK::RefundCreatedWebhookEvent::Data::Payment::Product }, nil?: true
|
|
253
|
+
|
|
235
254
|
# @!attribute subtotal
|
|
236
255
|
# The subtotal to show to the creator (excluding buyer fees).
|
|
237
256
|
#
|
|
@@ -275,7 +294,7 @@ module WhopSDK
|
|
|
275
294
|
# @return [WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::User, nil]
|
|
276
295
|
required :user, -> { WhopSDK::RefundCreatedWebhookEvent::Data::Payment::User }, nil?: true
|
|
277
296
|
|
|
278
|
-
# @!method initialize(id:, billing_reason:, card_brand:, card_last4:, created_at:, currency:, dispute_alerted_at:, member:, membership:, paid_at:, payment_method_type:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, usd_total:, user:)
|
|
297
|
+
# @!method initialize(id:, billing_reason:, card_brand:, card_last4:, created_at:, currency:, dispute_alerted_at:, member:, membership:, metadata:, paid_at:, payment_method_type:, plan:, product:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, usd_total:, user:)
|
|
279
298
|
# Some parameter documentations has been truncated, see
|
|
280
299
|
# {WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment} for more details.
|
|
281
300
|
#
|
|
@@ -292,7 +311,7 @@ module WhopSDK
|
|
|
292
311
|
#
|
|
293
312
|
# @param created_at [Time] The datetime the payment was created.
|
|
294
313
|
#
|
|
295
|
-
# @param currency [Symbol, WhopSDK::Models::Currency
|
|
314
|
+
# @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
296
315
|
#
|
|
297
316
|
# @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
|
|
298
317
|
#
|
|
@@ -300,10 +319,16 @@ module WhopSDK
|
|
|
300
319
|
#
|
|
301
320
|
# @param membership [WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::Membership, nil] The membership attached to this payment.
|
|
302
321
|
#
|
|
322
|
+
# @param metadata [Hash{Symbol=>Object}, nil] The custom metadata stored on this payment. This will be copied over to the chec
|
|
323
|
+
#
|
|
303
324
|
# @param paid_at [Time, nil] The time at which this payment was successfully collected. Null if the payment h
|
|
304
325
|
#
|
|
305
326
|
# @param payment_method_type [Symbol, WhopSDK::Models::PaymentMethodTypes, nil] The different types of payment methods that can be used.
|
|
306
327
|
#
|
|
328
|
+
# @param plan [WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::Plan, nil] The plan attached to this payment.
|
|
329
|
+
#
|
|
330
|
+
# @param product [WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::Product, nil] The product this payment was made for
|
|
331
|
+
#
|
|
307
332
|
# @param subtotal [Float, nil] The subtotal to show to the creator (excluding buyer fees).
|
|
308
333
|
#
|
|
309
334
|
# @param tax_amount [Float, nil] The calculated amount of the sales/VAT tax (if applicable).
|
|
@@ -362,6 +387,60 @@ module WhopSDK
|
|
|
362
387
|
# @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
|
|
363
388
|
end
|
|
364
389
|
|
|
390
|
+
# @see WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment#plan
|
|
391
|
+
class Plan < WhopSDK::Internal::Type::BaseModel
|
|
392
|
+
# @!attribute id
|
|
393
|
+
# The unique identifier for the plan.
|
|
394
|
+
#
|
|
395
|
+
# @return [String]
|
|
396
|
+
required :id, String
|
|
397
|
+
|
|
398
|
+
# @!attribute metadata
|
|
399
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
400
|
+
# payment and membership events.
|
|
401
|
+
#
|
|
402
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
403
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
404
|
+
|
|
405
|
+
# @!method initialize(id:, metadata:)
|
|
406
|
+
# Some parameter documentations has been truncated, see
|
|
407
|
+
# {WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::Plan} for more
|
|
408
|
+
# details.
|
|
409
|
+
#
|
|
410
|
+
# The plan attached to this payment.
|
|
411
|
+
#
|
|
412
|
+
# @param id [String] The unique identifier for the plan.
|
|
413
|
+
#
|
|
414
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
# @see WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment#product
|
|
418
|
+
class Product < WhopSDK::Internal::Type::BaseModel
|
|
419
|
+
# @!attribute id
|
|
420
|
+
# The unique identifier for the product.
|
|
421
|
+
#
|
|
422
|
+
# @return [String]
|
|
423
|
+
required :id, String
|
|
424
|
+
|
|
425
|
+
# @!attribute metadata
|
|
426
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
427
|
+
# payment and membership events.
|
|
428
|
+
#
|
|
429
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
430
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
431
|
+
|
|
432
|
+
# @!method initialize(id:, metadata:)
|
|
433
|
+
# Some parameter documentations has been truncated, see
|
|
434
|
+
# {WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment::Product} for more
|
|
435
|
+
# details.
|
|
436
|
+
#
|
|
437
|
+
# The product this payment was made for
|
|
438
|
+
#
|
|
439
|
+
# @param id [String] The unique identifier for the product.
|
|
440
|
+
#
|
|
441
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
442
|
+
end
|
|
443
|
+
|
|
365
444
|
# @see WhopSDK::Models::RefundCreatedWebhookEvent::Data::Payment#user
|
|
366
445
|
class User < WhopSDK::Internal::Type::BaseModel
|
|
367
446
|
# @!attribute id
|
|
@@ -138,10 +138,10 @@ module WhopSDK
|
|
|
138
138
|
required :created_at, Time
|
|
139
139
|
|
|
140
140
|
# @!attribute currency
|
|
141
|
-
# The
|
|
141
|
+
# The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
142
142
|
#
|
|
143
|
-
# @return [Symbol, WhopSDK::Models::Currency
|
|
144
|
-
required :currency, enum: -> { WhopSDK::Currency }
|
|
143
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
144
|
+
required :currency, enum: -> { WhopSDK::Currency }
|
|
145
145
|
|
|
146
146
|
# @!attribute dispute_alerted_at
|
|
147
147
|
# When an alert came in that this transaction will be disputed
|
|
@@ -161,6 +161,13 @@ module WhopSDK
|
|
|
161
161
|
# @return [WhopSDK::Models::RefundRetrieveResponse::Payment::Membership, nil]
|
|
162
162
|
required :membership, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::Membership }, nil?: true
|
|
163
163
|
|
|
164
|
+
# @!attribute metadata
|
|
165
|
+
# The custom metadata stored on this payment. This will be copied over to the
|
|
166
|
+
# checkout configuration for which this payment was made
|
|
167
|
+
#
|
|
168
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
169
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
170
|
+
|
|
164
171
|
# @!attribute paid_at
|
|
165
172
|
# The time at which this payment was successfully collected. Null if the payment
|
|
166
173
|
# has not yet succeeded. As a Unix timestamp.
|
|
@@ -174,6 +181,18 @@ module WhopSDK
|
|
|
174
181
|
# @return [Symbol, WhopSDK::Models::PaymentMethodTypes, nil]
|
|
175
182
|
required :payment_method_type, enum: -> { WhopSDK::PaymentMethodTypes }, nil?: true
|
|
176
183
|
|
|
184
|
+
# @!attribute plan
|
|
185
|
+
# The plan attached to this payment.
|
|
186
|
+
#
|
|
187
|
+
# @return [WhopSDK::Models::RefundRetrieveResponse::Payment::Plan, nil]
|
|
188
|
+
required :plan, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::Plan }, nil?: true
|
|
189
|
+
|
|
190
|
+
# @!attribute product
|
|
191
|
+
# The product this payment was made for
|
|
192
|
+
#
|
|
193
|
+
# @return [WhopSDK::Models::RefundRetrieveResponse::Payment::Product, nil]
|
|
194
|
+
required :product, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::Product }, nil?: true
|
|
195
|
+
|
|
177
196
|
# @!attribute subtotal
|
|
178
197
|
# The subtotal to show to the creator (excluding buyer fees).
|
|
179
198
|
#
|
|
@@ -217,7 +236,7 @@ module WhopSDK
|
|
|
217
236
|
# @return [WhopSDK::Models::RefundRetrieveResponse::Payment::User, nil]
|
|
218
237
|
required :user, -> { WhopSDK::Models::RefundRetrieveResponse::Payment::User }, nil?: true
|
|
219
238
|
|
|
220
|
-
# @!method initialize(id:, billing_reason:, card_brand:, card_last4:, created_at:, currency:, dispute_alerted_at:, member:, membership:, paid_at:, payment_method_type:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, usd_total:, user:)
|
|
239
|
+
# @!method initialize(id:, billing_reason:, card_brand:, card_last4:, created_at:, currency:, dispute_alerted_at:, member:, membership:, metadata:, paid_at:, payment_method_type:, plan:, product:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, usd_total:, user:)
|
|
221
240
|
# Some parameter documentations has been truncated, see
|
|
222
241
|
# {WhopSDK::Models::RefundRetrieveResponse::Payment} for more details.
|
|
223
242
|
#
|
|
@@ -234,7 +253,7 @@ module WhopSDK
|
|
|
234
253
|
#
|
|
235
254
|
# @param created_at [Time] The datetime the payment was created.
|
|
236
255
|
#
|
|
237
|
-
# @param currency [Symbol, WhopSDK::Models::Currency
|
|
256
|
+
# @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
238
257
|
#
|
|
239
258
|
# @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
|
|
240
259
|
#
|
|
@@ -242,10 +261,16 @@ module WhopSDK
|
|
|
242
261
|
#
|
|
243
262
|
# @param membership [WhopSDK::Models::RefundRetrieveResponse::Payment::Membership, nil] The membership attached to this payment.
|
|
244
263
|
#
|
|
264
|
+
# @param metadata [Hash{Symbol=>Object}, nil] The custom metadata stored on this payment. This will be copied over to the chec
|
|
265
|
+
#
|
|
245
266
|
# @param paid_at [Time, nil] The time at which this payment was successfully collected. Null if the payment h
|
|
246
267
|
#
|
|
247
268
|
# @param payment_method_type [Symbol, WhopSDK::Models::PaymentMethodTypes, nil] The different types of payment methods that can be used.
|
|
248
269
|
#
|
|
270
|
+
# @param plan [WhopSDK::Models::RefundRetrieveResponse::Payment::Plan, nil] The plan attached to this payment.
|
|
271
|
+
#
|
|
272
|
+
# @param product [WhopSDK::Models::RefundRetrieveResponse::Payment::Product, nil] The product this payment was made for
|
|
273
|
+
#
|
|
249
274
|
# @param subtotal [Float, nil] The subtotal to show to the creator (excluding buyer fees).
|
|
250
275
|
#
|
|
251
276
|
# @param tax_amount [Float, nil] The calculated amount of the sales/VAT tax (if applicable).
|
|
@@ -304,6 +329,58 @@ module WhopSDK
|
|
|
304
329
|
# @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
|
|
305
330
|
end
|
|
306
331
|
|
|
332
|
+
# @see WhopSDK::Models::RefundRetrieveResponse::Payment#plan
|
|
333
|
+
class Plan < WhopSDK::Internal::Type::BaseModel
|
|
334
|
+
# @!attribute id
|
|
335
|
+
# The unique identifier for the plan.
|
|
336
|
+
#
|
|
337
|
+
# @return [String]
|
|
338
|
+
required :id, String
|
|
339
|
+
|
|
340
|
+
# @!attribute metadata
|
|
341
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
342
|
+
# payment and membership events.
|
|
343
|
+
#
|
|
344
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
345
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
346
|
+
|
|
347
|
+
# @!method initialize(id:, metadata:)
|
|
348
|
+
# Some parameter documentations has been truncated, see
|
|
349
|
+
# {WhopSDK::Models::RefundRetrieveResponse::Payment::Plan} for more details.
|
|
350
|
+
#
|
|
351
|
+
# The plan attached to this payment.
|
|
352
|
+
#
|
|
353
|
+
# @param id [String] The unique identifier for the plan.
|
|
354
|
+
#
|
|
355
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# @see WhopSDK::Models::RefundRetrieveResponse::Payment#product
|
|
359
|
+
class Product < WhopSDK::Internal::Type::BaseModel
|
|
360
|
+
# @!attribute id
|
|
361
|
+
# The unique identifier for the product.
|
|
362
|
+
#
|
|
363
|
+
# @return [String]
|
|
364
|
+
required :id, String
|
|
365
|
+
|
|
366
|
+
# @!attribute metadata
|
|
367
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
368
|
+
# payment and membership events.
|
|
369
|
+
#
|
|
370
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
371
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
372
|
+
|
|
373
|
+
# @!method initialize(id:, metadata:)
|
|
374
|
+
# Some parameter documentations has been truncated, see
|
|
375
|
+
# {WhopSDK::Models::RefundRetrieveResponse::Payment::Product} for more details.
|
|
376
|
+
#
|
|
377
|
+
# The product this payment was made for
|
|
378
|
+
#
|
|
379
|
+
# @param id [String] The unique identifier for the product.
|
|
380
|
+
#
|
|
381
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
382
|
+
end
|
|
383
|
+
|
|
307
384
|
# @see WhopSDK::Models::RefundRetrieveResponse::Payment#user
|
|
308
385
|
class User < WhopSDK::Internal::Type::BaseModel
|
|
309
386
|
# @!attribute id
|
|
@@ -192,10 +192,10 @@ module WhopSDK
|
|
|
192
192
|
required :created_at, Time
|
|
193
193
|
|
|
194
194
|
# @!attribute currency
|
|
195
|
-
# The
|
|
195
|
+
# The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
196
196
|
#
|
|
197
|
-
# @return [Symbol, WhopSDK::Models::Currency
|
|
198
|
-
required :currency, enum: -> { WhopSDK::Currency }
|
|
197
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
198
|
+
required :currency, enum: -> { WhopSDK::Currency }
|
|
199
199
|
|
|
200
200
|
# @!attribute dispute_alerted_at
|
|
201
201
|
# When an alert came in that this transaction will be disputed
|
|
@@ -219,6 +219,13 @@ module WhopSDK
|
|
|
219
219
|
},
|
|
220
220
|
nil?: true
|
|
221
221
|
|
|
222
|
+
# @!attribute metadata
|
|
223
|
+
# The custom metadata stored on this payment. This will be copied over to the
|
|
224
|
+
# checkout configuration for which this payment was made
|
|
225
|
+
#
|
|
226
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
227
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
228
|
+
|
|
222
229
|
# @!attribute paid_at
|
|
223
230
|
# The time at which this payment was successfully collected. Null if the payment
|
|
224
231
|
# has not yet succeeded. As a Unix timestamp.
|
|
@@ -232,6 +239,18 @@ module WhopSDK
|
|
|
232
239
|
# @return [Symbol, WhopSDK::Models::PaymentMethodTypes, nil]
|
|
233
240
|
required :payment_method_type, enum: -> { WhopSDK::PaymentMethodTypes }, nil?: true
|
|
234
241
|
|
|
242
|
+
# @!attribute plan
|
|
243
|
+
# The plan attached to this payment.
|
|
244
|
+
#
|
|
245
|
+
# @return [WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::Plan, nil]
|
|
246
|
+
required :plan, -> { WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Plan }, nil?: true
|
|
247
|
+
|
|
248
|
+
# @!attribute product
|
|
249
|
+
# The product this payment was made for
|
|
250
|
+
#
|
|
251
|
+
# @return [WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::Product, nil]
|
|
252
|
+
required :product, -> { WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::Product }, nil?: true
|
|
253
|
+
|
|
235
254
|
# @!attribute subtotal
|
|
236
255
|
# The subtotal to show to the creator (excluding buyer fees).
|
|
237
256
|
#
|
|
@@ -275,7 +294,7 @@ module WhopSDK
|
|
|
275
294
|
# @return [WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::User, nil]
|
|
276
295
|
required :user, -> { WhopSDK::RefundUpdatedWebhookEvent::Data::Payment::User }, nil?: true
|
|
277
296
|
|
|
278
|
-
# @!method initialize(id:, billing_reason:, card_brand:, card_last4:, created_at:, currency:, dispute_alerted_at:, member:, membership:, paid_at:, payment_method_type:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, usd_total:, user:)
|
|
297
|
+
# @!method initialize(id:, billing_reason:, card_brand:, card_last4:, created_at:, currency:, dispute_alerted_at:, member:, membership:, metadata:, paid_at:, payment_method_type:, plan:, product:, subtotal:, tax_amount:, tax_behavior:, tax_refunded_amount:, total:, usd_total:, user:)
|
|
279
298
|
# Some parameter documentations has been truncated, see
|
|
280
299
|
# {WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment} for more details.
|
|
281
300
|
#
|
|
@@ -292,7 +311,7 @@ module WhopSDK
|
|
|
292
311
|
#
|
|
293
312
|
# @param created_at [Time] The datetime the payment was created.
|
|
294
313
|
#
|
|
295
|
-
# @param currency [Symbol, WhopSDK::Models::Currency
|
|
314
|
+
# @param currency [Symbol, WhopSDK::Models::Currency] The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
|
|
296
315
|
#
|
|
297
316
|
# @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
|
|
298
317
|
#
|
|
@@ -300,10 +319,16 @@ module WhopSDK
|
|
|
300
319
|
#
|
|
301
320
|
# @param membership [WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::Membership, nil] The membership attached to this payment.
|
|
302
321
|
#
|
|
322
|
+
# @param metadata [Hash{Symbol=>Object}, nil] The custom metadata stored on this payment. This will be copied over to the chec
|
|
323
|
+
#
|
|
303
324
|
# @param paid_at [Time, nil] The time at which this payment was successfully collected. Null if the payment h
|
|
304
325
|
#
|
|
305
326
|
# @param payment_method_type [Symbol, WhopSDK::Models::PaymentMethodTypes, nil] The different types of payment methods that can be used.
|
|
306
327
|
#
|
|
328
|
+
# @param plan [WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::Plan, nil] The plan attached to this payment.
|
|
329
|
+
#
|
|
330
|
+
# @param product [WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::Product, nil] The product this payment was made for
|
|
331
|
+
#
|
|
307
332
|
# @param subtotal [Float, nil] The subtotal to show to the creator (excluding buyer fees).
|
|
308
333
|
#
|
|
309
334
|
# @param tax_amount [Float, nil] The calculated amount of the sales/VAT tax (if applicable).
|
|
@@ -362,6 +387,60 @@ module WhopSDK
|
|
|
362
387
|
# @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
|
|
363
388
|
end
|
|
364
389
|
|
|
390
|
+
# @see WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment#plan
|
|
391
|
+
class Plan < WhopSDK::Internal::Type::BaseModel
|
|
392
|
+
# @!attribute id
|
|
393
|
+
# The unique identifier for the plan.
|
|
394
|
+
#
|
|
395
|
+
# @return [String]
|
|
396
|
+
required :id, String
|
|
397
|
+
|
|
398
|
+
# @!attribute metadata
|
|
399
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
400
|
+
# payment and membership events.
|
|
401
|
+
#
|
|
402
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
403
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
404
|
+
|
|
405
|
+
# @!method initialize(id:, metadata:)
|
|
406
|
+
# Some parameter documentations has been truncated, see
|
|
407
|
+
# {WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::Plan} for more
|
|
408
|
+
# details.
|
|
409
|
+
#
|
|
410
|
+
# The plan attached to this payment.
|
|
411
|
+
#
|
|
412
|
+
# @param id [String] The unique identifier for the plan.
|
|
413
|
+
#
|
|
414
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
# @see WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment#product
|
|
418
|
+
class Product < WhopSDK::Internal::Type::BaseModel
|
|
419
|
+
# @!attribute id
|
|
420
|
+
# The unique identifier for the product.
|
|
421
|
+
#
|
|
422
|
+
# @return [String]
|
|
423
|
+
required :id, String
|
|
424
|
+
|
|
425
|
+
# @!attribute metadata
|
|
426
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
427
|
+
# payment and membership events.
|
|
428
|
+
#
|
|
429
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
430
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
431
|
+
|
|
432
|
+
# @!method initialize(id:, metadata:)
|
|
433
|
+
# Some parameter documentations has been truncated, see
|
|
434
|
+
# {WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment::Product} for more
|
|
435
|
+
# details.
|
|
436
|
+
#
|
|
437
|
+
# The product this payment was made for
|
|
438
|
+
#
|
|
439
|
+
# @param id [String] The unique identifier for the product.
|
|
440
|
+
#
|
|
441
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
442
|
+
end
|
|
443
|
+
|
|
365
444
|
# @see WhopSDK::Models::RefundUpdatedWebhookEvent::Data::Payment#user
|
|
366
445
|
class User < WhopSDK::Internal::Type::BaseModel
|
|
367
446
|
# @!attribute id
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# Types of optimization results tracked from external ad platforms
|
|
6
|
+
module ResultLabelKeys
|
|
7
|
+
extend WhopSDK::Internal::Type::Enum
|
|
8
|
+
|
|
9
|
+
APP_INSTALLS = :app_installs
|
|
10
|
+
MESSAGING_CONVERSATIONS_STARTED = :messaging_conversations_started
|
|
11
|
+
POST_ENGAGEMENT = :post_engagement
|
|
12
|
+
EVENT_RESPONSES = :event_responses
|
|
13
|
+
IMPRESSIONS = :impressions
|
|
14
|
+
WEBSITE_PURCHASES = :website_purchases
|
|
15
|
+
LANDING_PAGE_VIEWS = :landing_page_views
|
|
16
|
+
LEADS = :leads
|
|
17
|
+
LINK_CLICKS = :link_clicks
|
|
18
|
+
QUALITY_CALLS = :quality_calls
|
|
19
|
+
APPOINTMENTS_BOOKED = :appointments_booked
|
|
20
|
+
MESSAGING_PURCHASES = :messaging_purchases
|
|
21
|
+
PAGE_LIKES = :page_likes
|
|
22
|
+
INSTAGRAM_PROFILE_VISITS = :instagram_profile_visits
|
|
23
|
+
REACH = :reach
|
|
24
|
+
REMINDERS_SET = :reminders_set
|
|
25
|
+
NEW_SUBSCRIBERS = :new_subscribers
|
|
26
|
+
VIDEO_VIEWS = :video_views
|
|
27
|
+
REGISTRATIONS = :registrations
|
|
28
|
+
CONTENT_VIEWS = :content_views
|
|
29
|
+
SEARCHES = :searches
|
|
30
|
+
WEBSITE_SCHEDULES = :website_schedules
|
|
31
|
+
WEBSITE_SUBMIT_APPLICATIONS = :website_submit_applications
|
|
32
|
+
CUSTOM = :custom
|
|
33
|
+
|
|
34
|
+
# @!method self.values
|
|
35
|
+
# @return [Array<Symbol>]
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Swaps#create_quote
|
|
6
|
+
class SwapCreateQuoteParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute amount
|
|
11
|
+
# Input token amount.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :amount, String
|
|
15
|
+
|
|
16
|
+
# @!attribute from_token
|
|
17
|
+
# Source token contract address.
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :from_token, String
|
|
21
|
+
|
|
22
|
+
# @!attribute to_token
|
|
23
|
+
# Destination token contract address.
|
|
24
|
+
#
|
|
25
|
+
# @return [String]
|
|
26
|
+
required :to_token, String
|
|
27
|
+
|
|
28
|
+
# @!attribute from_address
|
|
29
|
+
#
|
|
30
|
+
# @return [String, nil]
|
|
31
|
+
optional :from_address, String, nil?: true
|
|
32
|
+
|
|
33
|
+
# @!attribute from_chain
|
|
34
|
+
#
|
|
35
|
+
# @return [String, Integer, nil]
|
|
36
|
+
optional :from_chain, union: -> { WhopSDK::SwapCreateQuoteParams::FromChain }, nil?: true
|
|
37
|
+
|
|
38
|
+
# @!attribute metadata
|
|
39
|
+
#
|
|
40
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
41
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
|
|
42
|
+
|
|
43
|
+
# @!attribute slippage_bps
|
|
44
|
+
#
|
|
45
|
+
# @return [Integer, nil]
|
|
46
|
+
optional :slippage_bps, Integer, nil?: true
|
|
47
|
+
|
|
48
|
+
# @!attribute to_address
|
|
49
|
+
#
|
|
50
|
+
# @return [String, nil]
|
|
51
|
+
optional :to_address, String, nil?: true
|
|
52
|
+
|
|
53
|
+
# @!attribute to_chain
|
|
54
|
+
#
|
|
55
|
+
# @return [String, Integer, nil]
|
|
56
|
+
optional :to_chain, union: -> { WhopSDK::SwapCreateQuoteParams::ToChain }, nil?: true
|
|
57
|
+
|
|
58
|
+
# @!method initialize(amount:, from_token:, to_token:, from_address: nil, from_chain: nil, metadata: nil, slippage_bps: nil, to_address: nil, to_chain: nil, request_options: {})
|
|
59
|
+
# @param amount [String] Input token amount.
|
|
60
|
+
#
|
|
61
|
+
# @param from_token [String] Source token contract address.
|
|
62
|
+
#
|
|
63
|
+
# @param to_token [String] Destination token contract address.
|
|
64
|
+
#
|
|
65
|
+
# @param from_address [String, nil]
|
|
66
|
+
#
|
|
67
|
+
# @param from_chain [String, Integer, nil]
|
|
68
|
+
#
|
|
69
|
+
# @param metadata [Hash{Symbol=>Object}]
|
|
70
|
+
#
|
|
71
|
+
# @param slippage_bps [Integer, nil]
|
|
72
|
+
#
|
|
73
|
+
# @param to_address [String, nil]
|
|
74
|
+
#
|
|
75
|
+
# @param to_chain [String, Integer, nil]
|
|
76
|
+
#
|
|
77
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
78
|
+
|
|
79
|
+
module FromChain
|
|
80
|
+
extend WhopSDK::Internal::Type::Union
|
|
81
|
+
|
|
82
|
+
variant String
|
|
83
|
+
|
|
84
|
+
variant Integer
|
|
85
|
+
|
|
86
|
+
# @!method self.variants
|
|
87
|
+
# @return [Array(String, Integer)]
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
module ToChain
|
|
91
|
+
extend WhopSDK::Internal::Type::Union
|
|
92
|
+
|
|
93
|
+
variant String
|
|
94
|
+
|
|
95
|
+
variant Integer
|
|
96
|
+
|
|
97
|
+
# @!method self.variants
|
|
98
|
+
# @return [Array(String, Integer)]
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|