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
|
@@ -0,0 +1,431 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
class IdentityProfileUpdatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# A unique ID for every single webhook request
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute api_version
|
|
13
|
+
# The API version for this webhook
|
|
14
|
+
#
|
|
15
|
+
# @return [Symbol, :v1]
|
|
16
|
+
required :api_version, const: :v1
|
|
17
|
+
|
|
18
|
+
# @!attribute data
|
|
19
|
+
# A consolidated identity or business profile synced from verification provider
|
|
20
|
+
# data.
|
|
21
|
+
#
|
|
22
|
+
# @return [WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data]
|
|
23
|
+
required :data, -> { WhopSDK::IdentityProfileUpdatedWebhookEvent::Data }
|
|
24
|
+
|
|
25
|
+
# @!attribute timestamp
|
|
26
|
+
# The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
27
|
+
#
|
|
28
|
+
# @return [Time]
|
|
29
|
+
required :timestamp, Time
|
|
30
|
+
|
|
31
|
+
# @!attribute type
|
|
32
|
+
# The webhook event type
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, :"identity_profile.updated"]
|
|
35
|
+
required :type, const: :"identity_profile.updated"
|
|
36
|
+
|
|
37
|
+
# @!attribute company_id
|
|
38
|
+
# The company ID that this webhook event is associated with
|
|
39
|
+
#
|
|
40
|
+
# @return [String, nil]
|
|
41
|
+
optional :company_id, String, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!method initialize(id:, data:, timestamp:, company_id: nil, api_version: :v1, type: :"identity_profile.updated")
|
|
44
|
+
# Some parameter documentations has been truncated, see
|
|
45
|
+
# {WhopSDK::Models::IdentityProfileUpdatedWebhookEvent} for more details.
|
|
46
|
+
#
|
|
47
|
+
# @param id [String] A unique ID for every single webhook request
|
|
48
|
+
#
|
|
49
|
+
# @param data [WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data] A consolidated identity or business profile synced from verification provider da
|
|
50
|
+
#
|
|
51
|
+
# @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
|
|
52
|
+
#
|
|
53
|
+
# @param company_id [String, nil] The company ID that this webhook event is associated with
|
|
54
|
+
#
|
|
55
|
+
# @param api_version [Symbol, :v1] The API version for this webhook
|
|
56
|
+
#
|
|
57
|
+
# @param type [Symbol, :"identity_profile.updated"] The webhook event type
|
|
58
|
+
|
|
59
|
+
# @see WhopSDK::Models::IdentityProfileUpdatedWebhookEvent#data
|
|
60
|
+
class Data < WhopSDK::Internal::Type::BaseModel
|
|
61
|
+
# @!attribute id
|
|
62
|
+
# The tag of the identity profile (idpf_xxx).
|
|
63
|
+
#
|
|
64
|
+
# @return [String]
|
|
65
|
+
required :id, String
|
|
66
|
+
|
|
67
|
+
# @!attribute business_address
|
|
68
|
+
# Registered business address reported by the identity provider. Present on
|
|
69
|
+
# `business` profiles.
|
|
70
|
+
#
|
|
71
|
+
# @return [WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::BusinessAddress, nil]
|
|
72
|
+
required :business_address,
|
|
73
|
+
-> { WhopSDK::IdentityProfileUpdatedWebhookEvent::Data::BusinessAddress },
|
|
74
|
+
nil?: true
|
|
75
|
+
|
|
76
|
+
# @!attribute business_name
|
|
77
|
+
# Business entity name. Present on `business` profiles.
|
|
78
|
+
#
|
|
79
|
+
# @return [String, nil]
|
|
80
|
+
required :business_name, String, nil?: true
|
|
81
|
+
|
|
82
|
+
# @!attribute business_structure
|
|
83
|
+
# Reported legal structure of a business profile (e.g. `corp`, `llc`).
|
|
84
|
+
# Provider-specific values; present on `business` profiles.
|
|
85
|
+
#
|
|
86
|
+
# @return [String, nil]
|
|
87
|
+
required :business_structure, String, nil?: true
|
|
88
|
+
|
|
89
|
+
# @!attribute country
|
|
90
|
+
# ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
|
|
91
|
+
# country of citizenship or residence reported by the identity provider; for
|
|
92
|
+
# businesses this is the country of incorporation.
|
|
93
|
+
#
|
|
94
|
+
# @return [String, nil]
|
|
95
|
+
required :country, String, nil?: true
|
|
96
|
+
|
|
97
|
+
# @!attribute created_at
|
|
98
|
+
# When the identity profile was first created.
|
|
99
|
+
#
|
|
100
|
+
# @return [Time]
|
|
101
|
+
required :created_at, Time
|
|
102
|
+
|
|
103
|
+
# @!attribute date_of_birth
|
|
104
|
+
# ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on
|
|
105
|
+
# `individual` profiles.
|
|
106
|
+
#
|
|
107
|
+
# @return [String, nil]
|
|
108
|
+
required :date_of_birth, String, nil?: true
|
|
109
|
+
|
|
110
|
+
# @!attribute email
|
|
111
|
+
# Email address reported by the identity provider. Typically present on
|
|
112
|
+
# `individual` profiles.
|
|
113
|
+
#
|
|
114
|
+
# @return [String, nil]
|
|
115
|
+
required :email, String, nil?: true
|
|
116
|
+
|
|
117
|
+
# @!attribute first_name
|
|
118
|
+
# Individual's first name.
|
|
119
|
+
#
|
|
120
|
+
# @return [String, nil]
|
|
121
|
+
required :first_name, String, nil?: true
|
|
122
|
+
|
|
123
|
+
# @!attribute last_name
|
|
124
|
+
# Individual's last name.
|
|
125
|
+
#
|
|
126
|
+
# @return [String, nil]
|
|
127
|
+
required :last_name, String, nil?: true
|
|
128
|
+
|
|
129
|
+
# @!attribute linked_companies
|
|
130
|
+
# The companies this identity profile is currently linked to. Only populated for
|
|
131
|
+
# direct Whop user sessions; always empty when authenticated via API key, app, or
|
|
132
|
+
# OAuth scope (a single identity can be linked to companies the calling platform
|
|
133
|
+
# is not entitled to see).
|
|
134
|
+
#
|
|
135
|
+
# @return [Array<WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::LinkedCompany>]
|
|
136
|
+
required :linked_companies,
|
|
137
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::IdentityProfileUpdatedWebhookEvent::Data::LinkedCompany] }
|
|
138
|
+
|
|
139
|
+
# @!attribute personal_address
|
|
140
|
+
# Residential address reported by the identity provider. Present on `individual`
|
|
141
|
+
# profiles.
|
|
142
|
+
#
|
|
143
|
+
# @return [WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::PersonalAddress, nil]
|
|
144
|
+
required :personal_address,
|
|
145
|
+
-> { WhopSDK::IdentityProfileUpdatedWebhookEvent::Data::PersonalAddress },
|
|
146
|
+
nil?: true
|
|
147
|
+
|
|
148
|
+
# @!attribute phone
|
|
149
|
+
# Phone number reported by the identity provider. Typically present on
|
|
150
|
+
# `individual` profiles.
|
|
151
|
+
#
|
|
152
|
+
# @return [String, nil]
|
|
153
|
+
required :phone, String, nil?: true
|
|
154
|
+
|
|
155
|
+
# @!attribute profile_type
|
|
156
|
+
# Whether this is an 'individual' or 'business' profile.
|
|
157
|
+
#
|
|
158
|
+
# @return [String]
|
|
159
|
+
required :profile_type, String
|
|
160
|
+
|
|
161
|
+
# @!attribute status
|
|
162
|
+
# Derived verification status across all linked verifications.
|
|
163
|
+
#
|
|
164
|
+
# @return [Symbol, WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::Status]
|
|
165
|
+
required :status, enum: -> { WhopSDK::IdentityProfileUpdatedWebhookEvent::Data::Status }
|
|
166
|
+
|
|
167
|
+
# @!attribute updated_at
|
|
168
|
+
# When the identity profile was last synced from a verification.
|
|
169
|
+
#
|
|
170
|
+
# @return [Time]
|
|
171
|
+
required :updated_at, Time
|
|
172
|
+
|
|
173
|
+
# @!attribute verifications
|
|
174
|
+
# All verification attempts attached to this identity profile, ordered most-recent
|
|
175
|
+
# first.
|
|
176
|
+
#
|
|
177
|
+
# @return [Array<WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::Verification>]
|
|
178
|
+
required :verifications,
|
|
179
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::IdentityProfileUpdatedWebhookEvent::Data::Verification] }
|
|
180
|
+
|
|
181
|
+
# @!method initialize(id:, business_address:, business_name:, business_structure:, country:, created_at:, date_of_birth:, email:, first_name:, last_name:, linked_companies:, personal_address:, phone:, profile_type:, status:, updated_at:, verifications:)
|
|
182
|
+
# Some parameter documentations has been truncated, see
|
|
183
|
+
# {WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data} for more details.
|
|
184
|
+
#
|
|
185
|
+
# A consolidated identity or business profile synced from verification provider
|
|
186
|
+
# data.
|
|
187
|
+
#
|
|
188
|
+
# @param id [String] The tag of the identity profile (idpf_xxx).
|
|
189
|
+
#
|
|
190
|
+
# @param business_address [WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::BusinessAddress, nil] Registered business address reported by the identity provider. Present on `busin
|
|
191
|
+
#
|
|
192
|
+
# @param business_name [String, nil] Business entity name. Present on `business` profiles.
|
|
193
|
+
#
|
|
194
|
+
# @param business_structure [String, nil] Reported legal structure of a business profile (e.g. `corp`, `llc`). Provider-sp
|
|
195
|
+
#
|
|
196
|
+
# @param country [String, nil] ISO 3166-1 alpha-3 country code (e.g. `USA`, `GBR`). For individuals this is the
|
|
197
|
+
#
|
|
198
|
+
# @param created_at [Time] When the identity profile was first created.
|
|
199
|
+
#
|
|
200
|
+
# @param date_of_birth [String, nil] ISO date (`YYYY-MM-DD`) reported by the identity provider. Present on `individua
|
|
201
|
+
#
|
|
202
|
+
# @param email [String, nil] Email address reported by the identity provider. Typically present on `individua
|
|
203
|
+
#
|
|
204
|
+
# @param first_name [String, nil] Individual's first name.
|
|
205
|
+
#
|
|
206
|
+
# @param last_name [String, nil] Individual's last name.
|
|
207
|
+
#
|
|
208
|
+
# @param linked_companies [Array<WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::LinkedCompany>] The companies this identity profile is currently linked to. Only populated for d
|
|
209
|
+
#
|
|
210
|
+
# @param personal_address [WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::PersonalAddress, nil] Residential address reported by the identity provider. Present on `individual` p
|
|
211
|
+
#
|
|
212
|
+
# @param phone [String, nil] Phone number reported by the identity provider. Typically present on `individual
|
|
213
|
+
#
|
|
214
|
+
# @param profile_type [String] Whether this is an 'individual' or 'business' profile.
|
|
215
|
+
#
|
|
216
|
+
# @param status [Symbol, WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::Status] Derived verification status across all linked verifications.
|
|
217
|
+
#
|
|
218
|
+
# @param updated_at [Time] When the identity profile was last synced from a verification.
|
|
219
|
+
#
|
|
220
|
+
# @param verifications [Array<WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::Verification>] All verification attempts attached to this identity profile, ordered most-recent
|
|
221
|
+
|
|
222
|
+
# @see WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data#business_address
|
|
223
|
+
class BusinessAddress < WhopSDK::Internal::Type::BaseModel
|
|
224
|
+
# @!attribute city
|
|
225
|
+
# The city of the address.
|
|
226
|
+
#
|
|
227
|
+
# @return [String, nil]
|
|
228
|
+
required :city, String, nil?: true
|
|
229
|
+
|
|
230
|
+
# @!attribute country
|
|
231
|
+
# The country of the address.
|
|
232
|
+
#
|
|
233
|
+
# @return [String, nil]
|
|
234
|
+
required :country, String, nil?: true
|
|
235
|
+
|
|
236
|
+
# @!attribute line1
|
|
237
|
+
# The line 1 of the address.
|
|
238
|
+
#
|
|
239
|
+
# @return [String, nil]
|
|
240
|
+
required :line1, String, nil?: true
|
|
241
|
+
|
|
242
|
+
# @!attribute line2
|
|
243
|
+
# The line 2 of the address.
|
|
244
|
+
#
|
|
245
|
+
# @return [String, nil]
|
|
246
|
+
required :line2, String, nil?: true
|
|
247
|
+
|
|
248
|
+
# @!attribute postal_code
|
|
249
|
+
# The postal code of the address.
|
|
250
|
+
#
|
|
251
|
+
# @return [String, nil]
|
|
252
|
+
required :postal_code, String, nil?: true
|
|
253
|
+
|
|
254
|
+
# @!attribute state
|
|
255
|
+
# The state of the address.
|
|
256
|
+
#
|
|
257
|
+
# @return [String, nil]
|
|
258
|
+
required :state, String, nil?: true
|
|
259
|
+
|
|
260
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
|
261
|
+
# Registered business address reported by the identity provider. Present on
|
|
262
|
+
# `business` profiles.
|
|
263
|
+
#
|
|
264
|
+
# @param city [String, nil] The city of the address.
|
|
265
|
+
#
|
|
266
|
+
# @param country [String, nil] The country of the address.
|
|
267
|
+
#
|
|
268
|
+
# @param line1 [String, nil] The line 1 of the address.
|
|
269
|
+
#
|
|
270
|
+
# @param line2 [String, nil] The line 2 of the address.
|
|
271
|
+
#
|
|
272
|
+
# @param postal_code [String, nil] The postal code of the address.
|
|
273
|
+
#
|
|
274
|
+
# @param state [String, nil] The state of the address.
|
|
275
|
+
end
|
|
276
|
+
|
|
277
|
+
class LinkedCompany < WhopSDK::Internal::Type::BaseModel
|
|
278
|
+
# @!attribute id
|
|
279
|
+
# The unique identifier for the company.
|
|
280
|
+
#
|
|
281
|
+
# @return [String]
|
|
282
|
+
required :id, String
|
|
283
|
+
|
|
284
|
+
# @!attribute title
|
|
285
|
+
# The display name of the company shown to customers.
|
|
286
|
+
#
|
|
287
|
+
# @return [String]
|
|
288
|
+
required :title, String
|
|
289
|
+
|
|
290
|
+
# @!method initialize(id:, title:)
|
|
291
|
+
# A company is a seller on Whop. Companies own products, manage members, and
|
|
292
|
+
# receive payouts.
|
|
293
|
+
#
|
|
294
|
+
# @param id [String] The unique identifier for the company.
|
|
295
|
+
#
|
|
296
|
+
# @param title [String] The display name of the company shown to customers.
|
|
297
|
+
end
|
|
298
|
+
|
|
299
|
+
# @see WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data#personal_address
|
|
300
|
+
class PersonalAddress < WhopSDK::Internal::Type::BaseModel
|
|
301
|
+
# @!attribute city
|
|
302
|
+
# The city of the address.
|
|
303
|
+
#
|
|
304
|
+
# @return [String, nil]
|
|
305
|
+
required :city, String, nil?: true
|
|
306
|
+
|
|
307
|
+
# @!attribute country
|
|
308
|
+
# The country of the address.
|
|
309
|
+
#
|
|
310
|
+
# @return [String, nil]
|
|
311
|
+
required :country, String, nil?: true
|
|
312
|
+
|
|
313
|
+
# @!attribute line1
|
|
314
|
+
# The line 1 of the address.
|
|
315
|
+
#
|
|
316
|
+
# @return [String, nil]
|
|
317
|
+
required :line1, String, nil?: true
|
|
318
|
+
|
|
319
|
+
# @!attribute line2
|
|
320
|
+
# The line 2 of the address.
|
|
321
|
+
#
|
|
322
|
+
# @return [String, nil]
|
|
323
|
+
required :line2, String, nil?: true
|
|
324
|
+
|
|
325
|
+
# @!attribute postal_code
|
|
326
|
+
# The postal code of the address.
|
|
327
|
+
#
|
|
328
|
+
# @return [String, nil]
|
|
329
|
+
required :postal_code, String, nil?: true
|
|
330
|
+
|
|
331
|
+
# @!attribute state
|
|
332
|
+
# The state of the address.
|
|
333
|
+
#
|
|
334
|
+
# @return [String, nil]
|
|
335
|
+
required :state, String, nil?: true
|
|
336
|
+
|
|
337
|
+
# @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
|
|
338
|
+
# Residential address reported by the identity provider. Present on `individual`
|
|
339
|
+
# profiles.
|
|
340
|
+
#
|
|
341
|
+
# @param city [String, nil] The city of the address.
|
|
342
|
+
#
|
|
343
|
+
# @param country [String, nil] The country of the address.
|
|
344
|
+
#
|
|
345
|
+
# @param line1 [String, nil] The line 1 of the address.
|
|
346
|
+
#
|
|
347
|
+
# @param line2 [String, nil] The line 2 of the address.
|
|
348
|
+
#
|
|
349
|
+
# @param postal_code [String, nil] The postal code of the address.
|
|
350
|
+
#
|
|
351
|
+
# @param state [String, nil] The state of the address.
|
|
352
|
+
end
|
|
353
|
+
|
|
354
|
+
# Derived verification status across all linked verifications.
|
|
355
|
+
#
|
|
356
|
+
# @see WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data#status
|
|
357
|
+
module Status
|
|
358
|
+
extend WhopSDK::Internal::Type::Enum
|
|
359
|
+
|
|
360
|
+
NOT_STARTED = :not_started
|
|
361
|
+
PENDING = :pending
|
|
362
|
+
APPROVED = :approved
|
|
363
|
+
REJECTED = :rejected
|
|
364
|
+
|
|
365
|
+
# @!method self.values
|
|
366
|
+
# @return [Array<Symbol>]
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
class Verification < WhopSDK::Internal::Type::BaseModel
|
|
370
|
+
# @!attribute id
|
|
371
|
+
# The numeric id of the verification record.
|
|
372
|
+
#
|
|
373
|
+
# @return [String]
|
|
374
|
+
required :id, String
|
|
375
|
+
|
|
376
|
+
# @!attribute created_at
|
|
377
|
+
# When the verification record was created.
|
|
378
|
+
#
|
|
379
|
+
# @return [Time]
|
|
380
|
+
required :created_at, Time
|
|
381
|
+
|
|
382
|
+
# @!attribute last_error_code
|
|
383
|
+
# An error code for a verification attempt.
|
|
384
|
+
#
|
|
385
|
+
# @return [Symbol, WhopSDK::Models::VerificationErrorCode, nil]
|
|
386
|
+
required :last_error_code, enum: -> { WhopSDK::VerificationErrorCode }, nil?: true
|
|
387
|
+
|
|
388
|
+
# @!attribute last_error_reason
|
|
389
|
+
# A human-readable explanation of the most recent verification error. Null if no
|
|
390
|
+
# error has occurred.
|
|
391
|
+
#
|
|
392
|
+
# @return [String, nil]
|
|
393
|
+
required :last_error_reason, String, nil?: true
|
|
394
|
+
|
|
395
|
+
# @!attribute session_url
|
|
396
|
+
# A URL the user can visit to complete the verification process. Null if the
|
|
397
|
+
# session does not require user interaction.
|
|
398
|
+
#
|
|
399
|
+
# @return [String, nil]
|
|
400
|
+
required :session_url, String, nil?: true
|
|
401
|
+
|
|
402
|
+
# @!attribute status
|
|
403
|
+
# The current status of this verification session.
|
|
404
|
+
#
|
|
405
|
+
# @return [Symbol, WhopSDK::Models::VerificationStatus]
|
|
406
|
+
required :status, enum: -> { WhopSDK::VerificationStatus }
|
|
407
|
+
|
|
408
|
+
# @!method initialize(id:, created_at:, last_error_code:, last_error_reason:, session_url:, status:)
|
|
409
|
+
# Some parameter documentations has been truncated, see
|
|
410
|
+
# {WhopSDK::Models::IdentityProfileUpdatedWebhookEvent::Data::Verification} for
|
|
411
|
+
# more details.
|
|
412
|
+
#
|
|
413
|
+
# An identity verification session used to confirm a person or entity's identity
|
|
414
|
+
# for payout account eligibility.
|
|
415
|
+
#
|
|
416
|
+
# @param id [String] The numeric id of the verification record.
|
|
417
|
+
#
|
|
418
|
+
# @param created_at [Time] When the verification record was created.
|
|
419
|
+
#
|
|
420
|
+
# @param last_error_code [Symbol, WhopSDK::Models::VerificationErrorCode, nil] An error code for a verification attempt.
|
|
421
|
+
#
|
|
422
|
+
# @param last_error_reason [String, nil] A human-readable explanation of the most recent verification error. Null if no e
|
|
423
|
+
#
|
|
424
|
+
# @param session_url [String, nil] A URL the user can visit to complete the verification process. Null if the sessi
|
|
425
|
+
#
|
|
426
|
+
# @param status [Symbol, WhopSDK::Models::VerificationStatus] The current status of this verification session.
|
|
427
|
+
end
|
|
428
|
+
end
|
|
429
|
+
end
|
|
430
|
+
end
|
|
431
|
+
end
|
|
@@ -51,7 +51,15 @@ module WhopSDK
|
|
|
51
51
|
# @return [Float, nil]
|
|
52
52
|
required :transfer_fee, Float, nil?: true
|
|
53
53
|
|
|
54
|
-
# @!
|
|
54
|
+
# @!attribute treasury_balance
|
|
55
|
+
# The balance cache associated with the account by currency.
|
|
56
|
+
#
|
|
57
|
+
# @return [WhopSDK::Models::LedgerAccountRetrieveResponse::TreasuryBalance, nil]
|
|
58
|
+
required :treasury_balance,
|
|
59
|
+
-> { WhopSDK::Models::LedgerAccountRetrieveResponse::TreasuryBalance },
|
|
60
|
+
nil?: true
|
|
61
|
+
|
|
62
|
+
# @!method initialize(id:, balances:, ledger_type:, owner:, payments_approval_status:, payout_account_details:, transfer_fee:, treasury_balance:)
|
|
55
63
|
# A ledger account represents a financial account on Whop that can hold many
|
|
56
64
|
# balances.
|
|
57
65
|
#
|
|
@@ -68,6 +76,8 @@ module WhopSDK
|
|
|
68
76
|
# @param payout_account_details [WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails, nil] The payout account associated with the LedgerAccount, if any.
|
|
69
77
|
#
|
|
70
78
|
# @param transfer_fee [Float, nil] The fee for transfers, if applicable.
|
|
79
|
+
#
|
|
80
|
+
# @param treasury_balance [WhopSDK::Models::LedgerAccountRetrieveResponse::TreasuryBalance, nil] The balance cache associated with the account by currency.
|
|
71
81
|
|
|
72
82
|
class Balance < WhopSDK::Internal::Type::BaseModel
|
|
73
83
|
# @!attribute balance
|
|
@@ -452,6 +462,60 @@ module WhopSDK
|
|
|
452
462
|
# @param status [Symbol, WhopSDK::Models::VerificationStatus] The current status of this verification session.
|
|
453
463
|
end
|
|
454
464
|
end
|
|
465
|
+
|
|
466
|
+
# @see WhopSDK::Models::LedgerAccountRetrieveResponse#treasury_balance
|
|
467
|
+
class TreasuryBalance < WhopSDK::Internal::Type::BaseModel
|
|
468
|
+
# @!attribute balance
|
|
469
|
+
# The amount of the balance.
|
|
470
|
+
#
|
|
471
|
+
# @return [Float]
|
|
472
|
+
required :balance, Float
|
|
473
|
+
|
|
474
|
+
# @!attribute balance_usd
|
|
475
|
+
# The balance converted to USD.
|
|
476
|
+
#
|
|
477
|
+
# @return [Float]
|
|
478
|
+
required :balance_usd, Float
|
|
479
|
+
|
|
480
|
+
# @!attribute currency
|
|
481
|
+
# The currency of the balance.
|
|
482
|
+
#
|
|
483
|
+
# @return [Symbol, WhopSDK::Models::Currency]
|
|
484
|
+
required :currency, enum: -> { WhopSDK::Currency }
|
|
485
|
+
|
|
486
|
+
# @!attribute pending_balance
|
|
487
|
+
# The amount of the balance that is pending.
|
|
488
|
+
#
|
|
489
|
+
# @return [Float]
|
|
490
|
+
required :pending_balance, Float
|
|
491
|
+
|
|
492
|
+
# @!attribute reserve_balance
|
|
493
|
+
# The amount of the balance that is reserved.
|
|
494
|
+
#
|
|
495
|
+
# @return [Float]
|
|
496
|
+
required :reserve_balance, Float
|
|
497
|
+
|
|
498
|
+
# @!attribute total_withdrawable_balance
|
|
499
|
+
# The amount of the balance that is withdrawable.
|
|
500
|
+
#
|
|
501
|
+
# @return [Float]
|
|
502
|
+
required :total_withdrawable_balance, Float
|
|
503
|
+
|
|
504
|
+
# @!method initialize(balance:, balance_usd:, currency:, pending_balance:, reserve_balance:, total_withdrawable_balance:)
|
|
505
|
+
# The balance cache associated with the account by currency.
|
|
506
|
+
#
|
|
507
|
+
# @param balance [Float] The amount of the balance.
|
|
508
|
+
#
|
|
509
|
+
# @param balance_usd [Float] The balance converted to USD.
|
|
510
|
+
#
|
|
511
|
+
# @param currency [Symbol, WhopSDK::Models::Currency] The currency of the balance.
|
|
512
|
+
#
|
|
513
|
+
# @param pending_balance [Float] The amount of the balance that is pending.
|
|
514
|
+
#
|
|
515
|
+
# @param reserve_balance [Float] The amount of the balance that is reserved.
|
|
516
|
+
#
|
|
517
|
+
# @param total_withdrawable_balance [Float] The amount of the balance that is withdrawable.
|
|
518
|
+
end
|
|
455
519
|
end
|
|
456
520
|
end
|
|
457
521
|
end
|
|
@@ -20,7 +20,8 @@ module WhopSDK
|
|
|
20
20
|
required :access_level, enum: -> { WhopSDK::AccessLevel }
|
|
21
21
|
|
|
22
22
|
# @!attribute company_token_balance
|
|
23
|
-
# The member's token balance for this company
|
|
23
|
+
# The member's token balance for this company. Computed live from the ledger, not
|
|
24
|
+
# from a cache.
|
|
24
25
|
#
|
|
25
26
|
# @return [Float]
|
|
26
27
|
required :company_token_balance, Float
|
|
@@ -90,7 +91,7 @@ module WhopSDK
|
|
|
90
91
|
#
|
|
91
92
|
# @param access_level [Symbol, WhopSDK::Models::AccessLevel] The access level of the product member. If its admin, the member is an authorize
|
|
92
93
|
#
|
|
93
|
-
# @param company_token_balance [Float] The member's token balance for this company
|
|
94
|
+
# @param company_token_balance [Float] The member's token balance for this company. Computed live from the ledger, not
|
|
94
95
|
#
|
|
95
96
|
# @param created_at [Time] The datetime the company member was created.
|
|
96
97
|
#
|
|
@@ -26,7 +26,8 @@ module WhopSDK
|
|
|
26
26
|
required :company, -> { WhopSDK::Models::MemberRetrieveResponse::Company }
|
|
27
27
|
|
|
28
28
|
# @!attribute company_token_balance
|
|
29
|
-
# The member's token balance for this company
|
|
29
|
+
# The member's token balance for this company. Computed live from the ledger, not
|
|
30
|
+
# from a cache.
|
|
30
31
|
#
|
|
31
32
|
# @return [Float]
|
|
32
33
|
required :company_token_balance, Float
|
|
@@ -98,7 +99,7 @@ module WhopSDK
|
|
|
98
99
|
#
|
|
99
100
|
# @param company [WhopSDK::Models::MemberRetrieveResponse::Company] The company for the member.
|
|
100
101
|
#
|
|
101
|
-
# @param company_token_balance [Float] The member's token balance for this company
|
|
102
|
+
# @param company_token_balance [Float] The member's token balance for this company. Computed live from the ledger, not
|
|
102
103
|
#
|
|
103
104
|
# @param created_at [Time] The datetime the company member was created.
|
|
104
105
|
#
|
|
@@ -294,10 +294,22 @@ module WhopSDK
|
|
|
294
294
|
# @return [String]
|
|
295
295
|
required :id, String
|
|
296
296
|
|
|
297
|
-
# @!
|
|
297
|
+
# @!attribute metadata
|
|
298
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
299
|
+
# payment and membership events.
|
|
300
|
+
#
|
|
301
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
302
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
303
|
+
|
|
304
|
+
# @!method initialize(id:, metadata:)
|
|
305
|
+
# Some parameter documentations has been truncated, see
|
|
306
|
+
# {WhopSDK::Models::Membership::Plan} for more details.
|
|
307
|
+
#
|
|
298
308
|
# The plan the customer purchased to create this membership.
|
|
299
309
|
#
|
|
300
310
|
# @param id [String] The unique identifier for the plan.
|
|
311
|
+
#
|
|
312
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
301
313
|
end
|
|
302
314
|
|
|
303
315
|
# @see WhopSDK::Models::Membership#product
|
|
@@ -308,6 +320,13 @@ module WhopSDK
|
|
|
308
320
|
# @return [String]
|
|
309
321
|
required :id, String
|
|
310
322
|
|
|
323
|
+
# @!attribute metadata
|
|
324
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
325
|
+
# payment and membership events.
|
|
326
|
+
#
|
|
327
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
328
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
329
|
+
|
|
311
330
|
# @!attribute title
|
|
312
331
|
# The display name of the product shown to customers on the product page and in
|
|
313
332
|
# search results.
|
|
@@ -315,7 +334,7 @@ module WhopSDK
|
|
|
315
334
|
# @return [String]
|
|
316
335
|
required :title, String
|
|
317
336
|
|
|
318
|
-
# @!method initialize(id:, title:)
|
|
337
|
+
# @!method initialize(id:, metadata:, title:)
|
|
319
338
|
# Some parameter documentations has been truncated, see
|
|
320
339
|
# {WhopSDK::Models::Membership::Product} for more details.
|
|
321
340
|
#
|
|
@@ -323,6 +342,8 @@ module WhopSDK
|
|
|
323
342
|
#
|
|
324
343
|
# @param id [String] The unique identifier for the product.
|
|
325
344
|
#
|
|
345
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
346
|
+
#
|
|
326
347
|
# @param title [String] The display name of the product shown to customers on the product page and in se
|
|
327
348
|
end
|
|
328
349
|
|
|
@@ -256,10 +256,22 @@ module WhopSDK
|
|
|
256
256
|
# @return [String]
|
|
257
257
|
required :id, String
|
|
258
258
|
|
|
259
|
-
# @!
|
|
259
|
+
# @!attribute metadata
|
|
260
|
+
# Custom key-value pairs stored on the plan. Included in webhook payloads for
|
|
261
|
+
# payment and membership events.
|
|
262
|
+
#
|
|
263
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
264
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
265
|
+
|
|
266
|
+
# @!method initialize(id:, metadata:)
|
|
267
|
+
# Some parameter documentations has been truncated, see
|
|
268
|
+
# {WhopSDK::Models::MembershipListResponse::Plan} for more details.
|
|
269
|
+
#
|
|
260
270
|
# The plan the customer purchased to create this membership.
|
|
261
271
|
#
|
|
262
272
|
# @param id [String] The unique identifier for the plan.
|
|
273
|
+
#
|
|
274
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the plan. Included in webhook payloads for paym
|
|
263
275
|
end
|
|
264
276
|
|
|
265
277
|
# @see WhopSDK::Models::MembershipListResponse#product
|
|
@@ -270,6 +282,13 @@ module WhopSDK
|
|
|
270
282
|
# @return [String]
|
|
271
283
|
required :id, String
|
|
272
284
|
|
|
285
|
+
# @!attribute metadata
|
|
286
|
+
# Custom key-value pairs stored on the product. Included in webhook payloads for
|
|
287
|
+
# payment and membership events.
|
|
288
|
+
#
|
|
289
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
290
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
291
|
+
|
|
273
292
|
# @!attribute title
|
|
274
293
|
# The display name of the product shown to customers on the product page and in
|
|
275
294
|
# search results.
|
|
@@ -277,7 +296,7 @@ module WhopSDK
|
|
|
277
296
|
# @return [String]
|
|
278
297
|
required :title, String
|
|
279
298
|
|
|
280
|
-
# @!method initialize(id:, title:)
|
|
299
|
+
# @!method initialize(id:, metadata:, title:)
|
|
281
300
|
# Some parameter documentations has been truncated, see
|
|
282
301
|
# {WhopSDK::Models::MembershipListResponse::Product} for more details.
|
|
283
302
|
#
|
|
@@ -285,6 +304,8 @@ module WhopSDK
|
|
|
285
304
|
#
|
|
286
305
|
# @param id [String] The unique identifier for the product.
|
|
287
306
|
#
|
|
307
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Custom key-value pairs stored on the product. Included in webhook payloads for p
|
|
308
|
+
#
|
|
288
309
|
# @param title [String] The display name of the product shown to customers on the product page and in se
|
|
289
310
|
end
|
|
290
311
|
|