whop_sdk 0.0.24 → 0.0.26
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 +32 -0
- data/README.md +3 -3
- data/lib/whop_sdk/client.rb +16 -0
- data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/whop_sdk/models/ai_chat.rb +89 -0
- data/lib/whop_sdk/models/ai_chat_create_params.rb +22 -0
- data/lib/whop_sdk/models/ai_chat_delete_params.rb +14 -0
- data/lib/whop_sdk/models/ai_chat_delete_response.rb +8 -0
- data/lib/whop_sdk/models/ai_chat_list_params.rb +46 -0
- data/lib/whop_sdk/models/ai_chat_list_response.rb +89 -0
- data/lib/whop_sdk/models/ai_chat_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/ai_chat_update_params.rb +22 -0
- data/lib/whop_sdk/models/api_version.rb +17 -0
- data/lib/whop_sdk/models/app_list_params.rb +1 -0
- data/lib/whop_sdk/models/authorized_user_list_params.rb +9 -9
- data/lib/whop_sdk/models/authorized_user_list_response.rb +31 -1
- data/lib/whop_sdk/models/authorized_user_retrieve_response.rb +31 -1
- data/lib/whop_sdk/models/bot_token_transaction_types.rb +17 -0
- data/lib/whop_sdk/models/cancel_options.rb +22 -0
- data/lib/whop_sdk/models/company_token_transaction.rb +165 -0
- data/lib/whop_sdk/models/company_token_transaction_create_params.rb +69 -0
- data/lib/whop_sdk/models/company_token_transaction_list_params.rb +70 -0
- data/lib/whop_sdk/models/company_token_transaction_list_response.rb +165 -0
- data/lib/whop_sdk/models/company_token_transaction_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/dm_channel.rb +43 -0
- data/lib/whop_sdk/models/dm_channel_create_params.rb +38 -0
- data/lib/whop_sdk/models/dm_channel_delete_params.rb +14 -0
- data/lib/whop_sdk/models/dm_channel_delete_response.rb +8 -0
- data/lib/whop_sdk/models/dm_channel_list_params.rb +54 -0
- data/lib/whop_sdk/models/dm_channel_list_response.rb +43 -0
- data/lib/whop_sdk/models/dm_channel_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/dm_channel_update_params.rb +22 -0
- data/lib/whop_sdk/models/dm_feed_member_notification_preferences.rb +17 -0
- data/lib/whop_sdk/models/dm_feed_member_statuses.rb +19 -0
- data/lib/whop_sdk/models/dm_member.rb +63 -0
- data/lib/whop_sdk/models/dm_member_create_params.rb +30 -0
- data/lib/whop_sdk/models/dm_member_delete_params.rb +14 -0
- data/lib/whop_sdk/models/dm_member_delete_response.rb +8 -0
- data/lib/whop_sdk/models/dm_member_list_params.rb +54 -0
- data/lib/whop_sdk/models/dm_member_list_response.rb +55 -0
- data/lib/whop_sdk/models/dm_member_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/dm_member_update_params.rb +30 -0
- data/lib/whop_sdk/models/file_create_response.rb +3 -18
- data/lib/whop_sdk/models/file_retrieve_response.rb +3 -18
- data/lib/whop_sdk/models/{lead_create_response.rb → lead.rb} +13 -13
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +6 -63
- data/lib/whop_sdk/models/member_list_params.rb +9 -9
- data/lib/whop_sdk/models/membership.rb +3 -22
- data/lib/whop_sdk/models/membership_list_params.rb +3 -20
- data/lib/whop_sdk/models/membership_list_response.rb +3 -22
- data/lib/whop_sdk/models/message_create_params.rb +9 -1
- data/lib/whop_sdk/models/message_delete_params.rb +14 -0
- data/lib/whop_sdk/models/message_delete_response.rb +8 -0
- data/lib/whop_sdk/models/payment.rb +63 -1
- data/lib/whop_sdk/models/payment_list_response.rb +63 -1
- data/lib/whop_sdk/models/payment_method_types.rb +1 -0
- data/lib/whop_sdk/models/payout_destination_category.rb +20 -0
- data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +3 -20
- data/lib/whop_sdk/models/payout_method_list_response.rb +3 -20
- data/lib/whop_sdk/models/payout_method_retrieve_response.rb +3 -20
- data/lib/whop_sdk/models/reaction_create_params.rb +10 -1
- data/lib/whop_sdk/models/reaction_delete_params.rb +22 -0
- data/lib/whop_sdk/models/reaction_delete_response.rb +8 -0
- data/lib/whop_sdk/models/upload_status.rb +18 -0
- data/lib/whop_sdk/models/verification_error_code.rb +33 -0
- data/lib/whop_sdk/models/verification_retrieve_response.rb +6 -62
- data/lib/whop_sdk/models/verification_status.rb +27 -0
- data/lib/whop_sdk/models/verification_succeeded_webhook_event.rb +6 -62
- data/lib/whop_sdk/models/webhook.rb +88 -0
- data/lib/whop_sdk/models/webhook_create_params.rb +6 -56
- data/lib/whop_sdk/models/webhook_create_response.rb +9 -97
- data/lib/whop_sdk/models/webhook_event.rb +41 -0
- data/lib/whop_sdk/models/webhook_list_response.rb +6 -57
- data/lib/whop_sdk/models/webhook_update_params.rb +6 -56
- data/lib/whop_sdk/models/{withdrawal_create_response.rb → withdrawal.rb} +15 -15
- data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +3 -267
- data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +3 -267
- data/lib/whop_sdk/models.rb +74 -0
- data/lib/whop_sdk/resources/ai_chats.rb +141 -0
- data/lib/whop_sdk/resources/authorized_users.rb +4 -4
- data/lib/whop_sdk/resources/company_token_transactions.rb +121 -0
- data/lib/whop_sdk/resources/dm_channels.rb +151 -0
- data/lib/whop_sdk/resources/dm_members.rb +155 -0
- data/lib/whop_sdk/resources/leads.rb +6 -12
- data/lib/whop_sdk/resources/members.rb +4 -4
- data/lib/whop_sdk/resources/memberships.rb +1 -1
- data/lib/whop_sdk/resources/messages.rb +27 -1
- data/lib/whop_sdk/resources/reactions.rb +34 -1
- data/lib/whop_sdk/resources/webhooks.rb +8 -8
- data/lib/whop_sdk/resources/withdrawals.rb +4 -4
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +50 -7
- data/rbi/whop_sdk/client.rbi +12 -0
- data/rbi/whop_sdk/models/ai_chat.rbi +118 -0
- data/rbi/whop_sdk/models/ai_chat_create_params.rbi +40 -0
- data/rbi/whop_sdk/models/ai_chat_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/ai_chat_delete_response.rbi +7 -0
- data/rbi/whop_sdk/models/ai_chat_list_params.rbi +67 -0
- data/rbi/whop_sdk/models/ai_chat_list_response.rbi +125 -0
- data/rbi/whop_sdk/models/ai_chat_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/ai_chat_update_params.rbi +40 -0
- data/rbi/whop_sdk/models/api_version.rbi +21 -0
- data/rbi/whop_sdk/models/app_list_params.rbi +2 -0
- data/rbi/whop_sdk/models/authorized_user_list_params.rbi +8 -8
- data/rbi/whop_sdk/models/authorized_user_list_response.rbi +47 -0
- data/rbi/whop_sdk/models/authorized_user_retrieve_response.rbi +49 -0
- data/rbi/whop_sdk/models/bot_token_transaction_types.rbi +28 -0
- data/rbi/whop_sdk/models/cancel_options.rbi +30 -0
- data/rbi/whop_sdk/models/company_token_transaction.rbi +237 -0
- data/rbi/whop_sdk/models/company_token_transaction_create_params.rbi +92 -0
- data/rbi/whop_sdk/models/company_token_transaction_list_params.rbi +96 -0
- data/rbi/whop_sdk/models/company_token_transaction_list_response.rbi +262 -0
- data/rbi/whop_sdk/models/company_token_transaction_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/dm_channel.rbi +60 -0
- data/rbi/whop_sdk/models/dm_channel_create_params.rbi +59 -0
- data/rbi/whop_sdk/models/dm_channel_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/dm_channel_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/dm_channel_list_params.rbi +75 -0
- data/rbi/whop_sdk/models/dm_channel_list_response.rbi +65 -0
- data/rbi/whop_sdk/models/dm_channel_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/dm_channel_update_params.rbi +43 -0
- data/rbi/whop_sdk/models/dm_feed_member_notification_preferences.rbi +34 -0
- data/rbi/whop_sdk/models/dm_feed_member_statuses.rbi +26 -0
- data/rbi/whop_sdk/models/dm_member.rbi +82 -0
- data/rbi/whop_sdk/models/dm_member_create_params.rbi +51 -0
- data/rbi/whop_sdk/models/dm_member_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/dm_member_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/dm_member_list_params.rbi +75 -0
- data/rbi/whop_sdk/models/dm_member_list_response.rbi +75 -0
- data/rbi/whop_sdk/models/dm_member_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/dm_member_update_params.rbi +57 -0
- data/rbi/whop_sdk/models/file_create_response.rbi +3 -49
- data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -51
- data/rbi/whop_sdk/models/{lead_update_response.rbi → lead.rbi} +17 -42
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +6 -230
- data/rbi/whop_sdk/models/member_list_params.rbi +8 -8
- data/rbi/whop_sdk/models/membership.rbi +3 -47
- data/rbi/whop_sdk/models/membership_list_params.rbi +3 -70
- data/rbi/whop_sdk/models/membership_list_response.rbi +3 -73
- data/rbi/whop_sdk/models/message_create_params.rbi +8 -0
- data/rbi/whop_sdk/models/message_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/message_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/payment.rbi +88 -0
- data/rbi/whop_sdk/models/payment_list_response.rbi +100 -0
- data/rbi/whop_sdk/models/payment_method_types.rbi +1 -0
- data/rbi/whop_sdk/models/payout_destination_category.rbi +33 -0
- data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +3 -64
- data/rbi/whop_sdk/models/payout_method_list_response.rbi +3 -64
- data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +3 -64
- data/rbi/whop_sdk/models/reaction_create_params.rbi +10 -0
- data/rbi/whop_sdk/models/reaction_delete_params.rbi +40 -0
- data/rbi/whop_sdk/models/reaction_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/upload_status.rbi +22 -0
- data/rbi/whop_sdk/models/verification_error_code.rbi +101 -0
- data/rbi/whop_sdk/models/verification_retrieve_response.rbi +6 -230
- data/rbi/whop_sdk/models/verification_status.rbi +38 -0
- data/rbi/whop_sdk/models/verification_succeeded_webhook_event.rbi +6 -232
- data/rbi/whop_sdk/models/webhook.rbi +104 -0
- data/rbi/whop_sdk/models/webhook_create_params.rbi +6 -194
- data/rbi/whop_sdk/models/webhook_create_response.rbi +9 -386
- data/rbi/whop_sdk/models/webhook_event.rbi +79 -0
- data/rbi/whop_sdk/models/webhook_list_response.rbi +6 -210
- data/rbi/whop_sdk/models/webhook_update_params.rbi +6 -194
- data/rbi/whop_sdk/models/{withdrawal_create_response.rbi → withdrawal.rbi} +63 -127
- data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +4 -571
- data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +4 -571
- data/rbi/whop_sdk/models.rbi +78 -0
- data/rbi/whop_sdk/resources/ai_chats.rbi +108 -0
- data/rbi/whop_sdk/resources/authorized_users.rbi +3 -3
- data/rbi/whop_sdk/resources/company_token_transactions.rbi +112 -0
- data/rbi/whop_sdk/resources/dm_channels.rbi +121 -0
- data/rbi/whop_sdk/resources/dm_members.rbi +126 -0
- data/rbi/whop_sdk/resources/leads.rbi +3 -3
- data/rbi/whop_sdk/resources/members.rbi +3 -3
- data/rbi/whop_sdk/resources/memberships.rbi +1 -4
- data/rbi/whop_sdk/resources/messages.rbi +21 -0
- data/rbi/whop_sdk/resources/reactions.rbi +26 -0
- data/rbi/whop_sdk/resources/webhooks.rbi +6 -10
- data/rbi/whop_sdk/resources/withdrawals.rbi +2 -2
- data/sig/whop_sdk/client.rbs +8 -0
- data/sig/whop_sdk/models/ai_chat.rbs +65 -0
- data/sig/whop_sdk/models/ai_chat_create_params.rbs +23 -0
- data/sig/whop_sdk/models/ai_chat_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/ai_chat_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/ai_chat_list_params.rbs +36 -0
- data/sig/whop_sdk/models/ai_chat_list_response.rbs +65 -0
- data/sig/whop_sdk/models/ai_chat_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/ai_chat_update_params.rbs +23 -0
- data/sig/whop_sdk/models/api_version.rbs +15 -0
- data/sig/whop_sdk/models/app_list_params.rbs +3 -1
- data/sig/whop_sdk/models/authorized_user_list_params.rbs +5 -5
- data/sig/whop_sdk/models/authorized_user_list_response.rbs +17 -0
- data/sig/whop_sdk/models/authorized_user_retrieve_response.rbs +17 -0
- data/sig/whop_sdk/models/bot_token_transaction_types.rbs +15 -0
- data/sig/whop_sdk/models/cancel_options.rbs +26 -0
- data/sig/whop_sdk/models/company_token_transaction.rbs +103 -0
- data/sig/whop_sdk/models/company_token_transaction_create_params.rbs +56 -0
- data/sig/whop_sdk/models/company_token_transaction_list_params.rbs +56 -0
- data/sig/whop_sdk/models/company_token_transaction_list_response.rbs +103 -0
- data/sig/whop_sdk/models/company_token_transaction_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/dm_channel.rbs +30 -0
- data/sig/whop_sdk/models/dm_channel_create_params.rbs +36 -0
- data/sig/whop_sdk/models/dm_channel_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/dm_channel_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/dm_channel_list_params.rbs +46 -0
- data/sig/whop_sdk/models/dm_channel_list_response.rbs +30 -0
- data/sig/whop_sdk/models/dm_channel_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/dm_channel_update_params.rbs +23 -0
- data/sig/whop_sdk/models/dm_feed_member_notification_preferences.rbs +15 -0
- data/sig/whop_sdk/models/dm_feed_member_statuses.rbs +18 -0
- data/sig/whop_sdk/models/dm_member.rbs +45 -0
- data/sig/whop_sdk/models/dm_member_create_params.rbs +28 -0
- data/sig/whop_sdk/models/dm_member_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/dm_member_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/dm_member_list_params.rbs +46 -0
- data/sig/whop_sdk/models/dm_member_list_response.rbs +40 -0
- data/sig/whop_sdk/models/dm_member_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/dm_member_update_params.rbs +31 -0
- data/sig/whop_sdk/models/file_create_response.rbs +4 -17
- data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -17
- data/sig/whop_sdk/models/{lead_create_response.rbs → lead.rbs} +14 -14
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +8 -90
- data/sig/whop_sdk/models/member_list_params.rbs +5 -5
- data/sig/whop_sdk/models/membership.rbs +4 -27
- data/sig/whop_sdk/models/membership_list_params.rbs +4 -27
- data/sig/whop_sdk/models/membership_list_response.rbs +4 -27
- data/sig/whop_sdk/models/message_create_params.rbs +6 -1
- data/sig/whop_sdk/models/message_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/message_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/payment.rbs +47 -0
- data/sig/whop_sdk/models/payment_list_response.rbs +47 -0
- data/sig/whop_sdk/models/payment_method_types.rbs +2 -0
- data/sig/whop_sdk/models/payout_destination_category.rbs +19 -0
- data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +4 -25
- data/sig/whop_sdk/models/payout_method_list_response.rbs +4 -25
- data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +4 -25
- data/sig/whop_sdk/models/reaction_create_params.rbs +5 -1
- data/sig/whop_sdk/models/reaction_delete_params.rbs +23 -0
- data/sig/whop_sdk/models/reaction_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/upload_status.rbs +16 -0
- data/sig/whop_sdk/models/verification_error_code.rbs +50 -0
- data/sig/whop_sdk/models/verification_retrieve_response.rbs +8 -90
- data/sig/whop_sdk/models/verification_status.rbs +38 -0
- data/sig/whop_sdk/models/verification_succeeded_webhook_event.rbs +8 -90
- data/sig/whop_sdk/models/webhook.rbs +60 -0
- data/sig/whop_sdk/models/webhook_create_params.rbs +8 -83
- data/sig/whop_sdk/models/webhook_create_response.rbs +12 -150
- data/sig/whop_sdk/models/webhook_event.rbs +66 -0
- data/sig/whop_sdk/models/webhook_list_response.rbs +8 -83
- data/sig/whop_sdk/models/webhook_update_params.rbs +8 -83
- data/sig/whop_sdk/models/{withdrawal_create_response.rbs → withdrawal.rbs} +15 -15
- data/sig/whop_sdk/models/withdrawal_created_webhook_event.rbs +4 -241
- data/sig/whop_sdk/models/withdrawal_updated_webhook_event.rbs +4 -241
- data/sig/whop_sdk/models.rbs +74 -0
- data/sig/whop_sdk/resources/ai_chats.rbs +33 -0
- data/sig/whop_sdk/resources/authorized_users.rbs +1 -1
- data/sig/whop_sdk/resources/company_token_transactions.rbs +34 -0
- data/sig/whop_sdk/resources/dm_channels.rbs +36 -0
- data/sig/whop_sdk/resources/dm_members.rbs +36 -0
- data/sig/whop_sdk/resources/leads.rbs +3 -3
- data/sig/whop_sdk/resources/members.rbs +1 -1
- data/sig/whop_sdk/resources/memberships.rbs +1 -1
- data/sig/whop_sdk/resources/messages.rbs +3 -0
- data/sig/whop_sdk/resources/reactions.rbs +7 -0
- data/sig/whop_sdk/resources/webhooks.rbs +6 -6
- data/sig/whop_sdk/resources/withdrawals.rbs +2 -2
- metadata +152 -23
- data/lib/whop_sdk/models/lead_retrieve_response.rb +0 -149
- data/lib/whop_sdk/models/lead_update_response.rb +0 -149
- data/lib/whop_sdk/models/webhook_retrieve_response.rb +0 -176
- data/lib/whop_sdk/models/webhook_update_response.rb +0 -176
- data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +0 -268
- data/rbi/whop_sdk/models/lead_create_response.rbi +0 -234
- data/rbi/whop_sdk/models/lead_retrieve_response.rbi +0 -238
- data/rbi/whop_sdk/models/webhook_retrieve_response.rbi +0 -491
- data/rbi/whop_sdk/models/webhook_update_response.rbi +0 -486
- data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +0 -568
- data/sig/whop_sdk/models/lead_retrieve_response.rbs +0 -104
- data/sig/whop_sdk/models/lead_update_response.rbs +0 -104
- data/sig/whop_sdk/models/webhook_retrieve_response.rbs +0 -198
- data/sig/whop_sdk/models/webhook_update_response.rbs +0 -198
- data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +0 -240
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module WhopSDK
|
|
4
|
-
module Models
|
|
5
|
-
# @see WhopSDK::Resources::Leads#retrieve
|
|
6
|
-
class LeadRetrieveResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# The ID of the lead.
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute created_at
|
|
14
|
-
# The timestamp of when the lead was created.
|
|
15
|
-
#
|
|
16
|
-
# @return [Time]
|
|
17
|
-
required :created_at, Time
|
|
18
|
-
|
|
19
|
-
# @!attribute member
|
|
20
|
-
# The converted member, if any.
|
|
21
|
-
#
|
|
22
|
-
# @return [WhopSDK::Models::LeadRetrieveResponse::Member, nil]
|
|
23
|
-
required :member, -> { WhopSDK::Models::LeadRetrieveResponse::Member }, nil?: true
|
|
24
|
-
|
|
25
|
-
# @!attribute metadata
|
|
26
|
-
# Custom metadata for the lead.
|
|
27
|
-
#
|
|
28
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
29
|
-
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
30
|
-
|
|
31
|
-
# @!attribute product
|
|
32
|
-
# The access pass the lead is interested in, if available.
|
|
33
|
-
#
|
|
34
|
-
# @return [WhopSDK::Models::LeadRetrieveResponse::Product, nil]
|
|
35
|
-
required :product, -> { WhopSDK::Models::LeadRetrieveResponse::Product }, nil?: true
|
|
36
|
-
|
|
37
|
-
# @!attribute referrer
|
|
38
|
-
# The referrer URL that brought this lead.
|
|
39
|
-
#
|
|
40
|
-
# @return [String, nil]
|
|
41
|
-
required :referrer, String, nil?: true
|
|
42
|
-
|
|
43
|
-
# @!attribute updated_at
|
|
44
|
-
# The timestamp of when the lead was last updated.
|
|
45
|
-
#
|
|
46
|
-
# @return [Time]
|
|
47
|
-
required :updated_at, Time
|
|
48
|
-
|
|
49
|
-
# @!attribute user
|
|
50
|
-
# The user who is the lead.
|
|
51
|
-
#
|
|
52
|
-
# @return [WhopSDK::Models::LeadRetrieveResponse::User]
|
|
53
|
-
required :user, -> { WhopSDK::Models::LeadRetrieveResponse::User }
|
|
54
|
-
|
|
55
|
-
# @!method initialize(id:, created_at:, member:, metadata:, product:, referrer:, updated_at:, user:)
|
|
56
|
-
# An object representing a lead (someone who is interested in a whop).
|
|
57
|
-
#
|
|
58
|
-
# @param id [String] The ID of the lead.
|
|
59
|
-
#
|
|
60
|
-
# @param created_at [Time] The timestamp of when the lead was created.
|
|
61
|
-
#
|
|
62
|
-
# @param member [WhopSDK::Models::LeadRetrieveResponse::Member, nil] The converted member, if any.
|
|
63
|
-
#
|
|
64
|
-
# @param metadata [Hash{Symbol=>Object}, nil] Custom metadata for the lead.
|
|
65
|
-
#
|
|
66
|
-
# @param product [WhopSDK::Models::LeadRetrieveResponse::Product, nil] The access pass the lead is interested in, if available.
|
|
67
|
-
#
|
|
68
|
-
# @param referrer [String, nil] The referrer URL that brought this lead.
|
|
69
|
-
#
|
|
70
|
-
# @param updated_at [Time] The timestamp of when the lead was last updated.
|
|
71
|
-
#
|
|
72
|
-
# @param user [WhopSDK::Models::LeadRetrieveResponse::User] The user who is the lead.
|
|
73
|
-
|
|
74
|
-
# @see WhopSDK::Models::LeadRetrieveResponse#member
|
|
75
|
-
class Member < WhopSDK::Internal::Type::BaseModel
|
|
76
|
-
# @!attribute id
|
|
77
|
-
# The ID of the member
|
|
78
|
-
#
|
|
79
|
-
# @return [String]
|
|
80
|
-
required :id, String
|
|
81
|
-
|
|
82
|
-
# @!method initialize(id:)
|
|
83
|
-
# The converted member, if any.
|
|
84
|
-
#
|
|
85
|
-
# @param id [String] The ID of the member
|
|
86
|
-
end
|
|
87
|
-
|
|
88
|
-
# @see WhopSDK::Models::LeadRetrieveResponse#product
|
|
89
|
-
class Product < WhopSDK::Internal::Type::BaseModel
|
|
90
|
-
# @!attribute id
|
|
91
|
-
# The internal ID of the public product.
|
|
92
|
-
#
|
|
93
|
-
# @return [String]
|
|
94
|
-
required :id, String
|
|
95
|
-
|
|
96
|
-
# @!attribute title
|
|
97
|
-
# The title of the product. Use for Whop 4.0.
|
|
98
|
-
#
|
|
99
|
-
# @return [String]
|
|
100
|
-
required :title, String
|
|
101
|
-
|
|
102
|
-
# @!method initialize(id:, title:)
|
|
103
|
-
# The access pass the lead is interested in, if available.
|
|
104
|
-
#
|
|
105
|
-
# @param id [String] The internal ID of the public product.
|
|
106
|
-
#
|
|
107
|
-
# @param title [String] The title of the product. Use for Whop 4.0.
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
# @see WhopSDK::Models::LeadRetrieveResponse#user
|
|
111
|
-
class User < WhopSDK::Internal::Type::BaseModel
|
|
112
|
-
# @!attribute id
|
|
113
|
-
# The internal ID of the user.
|
|
114
|
-
#
|
|
115
|
-
# @return [String]
|
|
116
|
-
required :id, String
|
|
117
|
-
|
|
118
|
-
# @!attribute email
|
|
119
|
-
# The email of the user
|
|
120
|
-
#
|
|
121
|
-
# @return [String, nil]
|
|
122
|
-
required :email, String, nil?: true
|
|
123
|
-
|
|
124
|
-
# @!attribute name
|
|
125
|
-
# The name of the user from their Whop account.
|
|
126
|
-
#
|
|
127
|
-
# @return [String, nil]
|
|
128
|
-
required :name, String, nil?: true
|
|
129
|
-
|
|
130
|
-
# @!attribute username
|
|
131
|
-
# The username of the user from their Whop account.
|
|
132
|
-
#
|
|
133
|
-
# @return [String]
|
|
134
|
-
required :username, String
|
|
135
|
-
|
|
136
|
-
# @!method initialize(id:, email:, name:, username:)
|
|
137
|
-
# The user who is the lead.
|
|
138
|
-
#
|
|
139
|
-
# @param id [String] The internal ID of the user.
|
|
140
|
-
#
|
|
141
|
-
# @param email [String, nil] The email of the user
|
|
142
|
-
#
|
|
143
|
-
# @param name [String, nil] The name of the user from their Whop account.
|
|
144
|
-
#
|
|
145
|
-
# @param username [String] The username of the user from their Whop account.
|
|
146
|
-
end
|
|
147
|
-
end
|
|
148
|
-
end
|
|
149
|
-
end
|
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module WhopSDK
|
|
4
|
-
module Models
|
|
5
|
-
# @see WhopSDK::Resources::Leads#update
|
|
6
|
-
class LeadUpdateResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# The ID of the lead.
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute created_at
|
|
14
|
-
# The timestamp of when the lead was created.
|
|
15
|
-
#
|
|
16
|
-
# @return [Time]
|
|
17
|
-
required :created_at, Time
|
|
18
|
-
|
|
19
|
-
# @!attribute member
|
|
20
|
-
# The converted member, if any.
|
|
21
|
-
#
|
|
22
|
-
# @return [WhopSDK::Models::LeadUpdateResponse::Member, nil]
|
|
23
|
-
required :member, -> { WhopSDK::Models::LeadUpdateResponse::Member }, nil?: true
|
|
24
|
-
|
|
25
|
-
# @!attribute metadata
|
|
26
|
-
# Custom metadata for the lead.
|
|
27
|
-
#
|
|
28
|
-
# @return [Hash{Symbol=>Object}, nil]
|
|
29
|
-
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
30
|
-
|
|
31
|
-
# @!attribute product
|
|
32
|
-
# The access pass the lead is interested in, if available.
|
|
33
|
-
#
|
|
34
|
-
# @return [WhopSDK::Models::LeadUpdateResponse::Product, nil]
|
|
35
|
-
required :product, -> { WhopSDK::Models::LeadUpdateResponse::Product }, nil?: true
|
|
36
|
-
|
|
37
|
-
# @!attribute referrer
|
|
38
|
-
# The referrer URL that brought this lead.
|
|
39
|
-
#
|
|
40
|
-
# @return [String, nil]
|
|
41
|
-
required :referrer, String, nil?: true
|
|
42
|
-
|
|
43
|
-
# @!attribute updated_at
|
|
44
|
-
# The timestamp of when the lead was last updated.
|
|
45
|
-
#
|
|
46
|
-
# @return [Time]
|
|
47
|
-
required :updated_at, Time
|
|
48
|
-
|
|
49
|
-
# @!attribute user
|
|
50
|
-
# The user who is the lead.
|
|
51
|
-
#
|
|
52
|
-
# @return [WhopSDK::Models::LeadUpdateResponse::User]
|
|
53
|
-
required :user, -> { WhopSDK::Models::LeadUpdateResponse::User }
|
|
54
|
-
|
|
55
|
-
# @!method initialize(id:, created_at:, member:, metadata:, product:, referrer:, updated_at:, user:)
|
|
56
|
-
# An object representing a lead (someone who is interested in a whop).
|
|
57
|
-
#
|
|
58
|
-
# @param id [String] The ID of the lead.
|
|
59
|
-
#
|
|
60
|
-
# @param created_at [Time] The timestamp of when the lead was created.
|
|
61
|
-
#
|
|
62
|
-
# @param member [WhopSDK::Models::LeadUpdateResponse::Member, nil] The converted member, if any.
|
|
63
|
-
#
|
|
64
|
-
# @param metadata [Hash{Symbol=>Object}, nil] Custom metadata for the lead.
|
|
65
|
-
#
|
|
66
|
-
# @param product [WhopSDK::Models::LeadUpdateResponse::Product, nil] The access pass the lead is interested in, if available.
|
|
67
|
-
#
|
|
68
|
-
# @param referrer [String, nil] The referrer URL that brought this lead.
|
|
69
|
-
#
|
|
70
|
-
# @param updated_at [Time] The timestamp of when the lead was last updated.
|
|
71
|
-
#
|
|
72
|
-
# @param user [WhopSDK::Models::LeadUpdateResponse::User] The user who is the lead.
|
|
73
|
-
|
|
74
|
-
# @see WhopSDK::Models::LeadUpdateResponse#member
|
|
75
|
-
class Member < WhopSDK::Internal::Type::BaseModel
|
|
76
|
-
# @!attribute id
|
|
77
|
-
# The ID of the member
|
|
78
|
-
#
|
|
79
|
-
# @return [String]
|
|
80
|
-
required :id, String
|
|
81
|
-
|
|
82
|
-
# @!method initialize(id:)
|
|
83
|
-
# The converted member, if any.
|
|
84
|
-
#
|
|
85
|
-
# @param id [String] The ID of the member
|
|
86
|
-
end
|
|
87
|
-
|
|
88
|
-
# @see WhopSDK::Models::LeadUpdateResponse#product
|
|
89
|
-
class Product < WhopSDK::Internal::Type::BaseModel
|
|
90
|
-
# @!attribute id
|
|
91
|
-
# The internal ID of the public product.
|
|
92
|
-
#
|
|
93
|
-
# @return [String]
|
|
94
|
-
required :id, String
|
|
95
|
-
|
|
96
|
-
# @!attribute title
|
|
97
|
-
# The title of the product. Use for Whop 4.0.
|
|
98
|
-
#
|
|
99
|
-
# @return [String]
|
|
100
|
-
required :title, String
|
|
101
|
-
|
|
102
|
-
# @!method initialize(id:, title:)
|
|
103
|
-
# The access pass the lead is interested in, if available.
|
|
104
|
-
#
|
|
105
|
-
# @param id [String] The internal ID of the public product.
|
|
106
|
-
#
|
|
107
|
-
# @param title [String] The title of the product. Use for Whop 4.0.
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
# @see WhopSDK::Models::LeadUpdateResponse#user
|
|
111
|
-
class User < WhopSDK::Internal::Type::BaseModel
|
|
112
|
-
# @!attribute id
|
|
113
|
-
# The internal ID of the user.
|
|
114
|
-
#
|
|
115
|
-
# @return [String]
|
|
116
|
-
required :id, String
|
|
117
|
-
|
|
118
|
-
# @!attribute email
|
|
119
|
-
# The email of the user
|
|
120
|
-
#
|
|
121
|
-
# @return [String, nil]
|
|
122
|
-
required :email, String, nil?: true
|
|
123
|
-
|
|
124
|
-
# @!attribute name
|
|
125
|
-
# The name of the user from their Whop account.
|
|
126
|
-
#
|
|
127
|
-
# @return [String, nil]
|
|
128
|
-
required :name, String, nil?: true
|
|
129
|
-
|
|
130
|
-
# @!attribute username
|
|
131
|
-
# The username of the user from their Whop account.
|
|
132
|
-
#
|
|
133
|
-
# @return [String]
|
|
134
|
-
required :username, String
|
|
135
|
-
|
|
136
|
-
# @!method initialize(id:, email:, name:, username:)
|
|
137
|
-
# The user who is the lead.
|
|
138
|
-
#
|
|
139
|
-
# @param id [String] The internal ID of the user.
|
|
140
|
-
#
|
|
141
|
-
# @param email [String, nil] The email of the user
|
|
142
|
-
#
|
|
143
|
-
# @param name [String, nil] The name of the user from their Whop account.
|
|
144
|
-
#
|
|
145
|
-
# @param username [String] The username of the user from their Whop account.
|
|
146
|
-
end
|
|
147
|
-
end
|
|
148
|
-
end
|
|
149
|
-
end
|
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module WhopSDK
|
|
4
|
-
module Models
|
|
5
|
-
# @see WhopSDK::Resources::Webhooks#retrieve
|
|
6
|
-
class WebhookRetrieveResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# The ID of the webhook
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute api_version
|
|
14
|
-
# The API version for this webhook
|
|
15
|
-
#
|
|
16
|
-
# @return [Symbol, WhopSDK::Models::WebhookRetrieveResponse::APIVersion]
|
|
17
|
-
required :api_version, enum: -> { WhopSDK::Models::WebhookRetrieveResponse::APIVersion }
|
|
18
|
-
|
|
19
|
-
# @!attribute child_resource_events
|
|
20
|
-
# Whether or not to send events for child resources. For example, if the webhook
|
|
21
|
-
# is created for a Company, enabling this will only send events from the Company's
|
|
22
|
-
# sub-merchants (child companies).
|
|
23
|
-
#
|
|
24
|
-
# @return [Boolean]
|
|
25
|
-
required :child_resource_events, WhopSDK::Internal::Type::Boolean
|
|
26
|
-
|
|
27
|
-
# @!attribute created_at
|
|
28
|
-
# The timestamp of when the webhook was created
|
|
29
|
-
#
|
|
30
|
-
# @return [Time]
|
|
31
|
-
required :created_at, Time
|
|
32
|
-
|
|
33
|
-
# @!attribute enabled
|
|
34
|
-
# Whether or not this webhook is turned on or not
|
|
35
|
-
#
|
|
36
|
-
# @return [Boolean]
|
|
37
|
-
required :enabled, WhopSDK::Internal::Type::Boolean
|
|
38
|
-
|
|
39
|
-
# @!attribute events
|
|
40
|
-
# The number of events this webhooks is configured to receive
|
|
41
|
-
#
|
|
42
|
-
# @return [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::Event>]
|
|
43
|
-
required :events,
|
|
44
|
-
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookRetrieveResponse::Event] }
|
|
45
|
-
|
|
46
|
-
# @!attribute resource_id
|
|
47
|
-
# The resource ID
|
|
48
|
-
#
|
|
49
|
-
# @return [String]
|
|
50
|
-
required :resource_id, String
|
|
51
|
-
|
|
52
|
-
# @!attribute testable_events
|
|
53
|
-
# The list of events that can be tested with this webhook
|
|
54
|
-
#
|
|
55
|
-
# @return [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::TestableEvent>]
|
|
56
|
-
required :testable_events,
|
|
57
|
-
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookRetrieveResponse::TestableEvent] }
|
|
58
|
-
|
|
59
|
-
# @!attribute url
|
|
60
|
-
# The URL the webhook events will be sent to
|
|
61
|
-
#
|
|
62
|
-
# @return [String]
|
|
63
|
-
required :url, String
|
|
64
|
-
|
|
65
|
-
# @!method initialize(id:, api_version:, child_resource_events:, created_at:, enabled:, events:, resource_id:, testable_events:, url:)
|
|
66
|
-
# Some parameter documentations has been truncated, see
|
|
67
|
-
# {WhopSDK::Models::WebhookRetrieveResponse} for more details.
|
|
68
|
-
#
|
|
69
|
-
# A webhook object, which can be configured to be sent updates about a company
|
|
70
|
-
#
|
|
71
|
-
# @param id [String] The ID of the webhook
|
|
72
|
-
#
|
|
73
|
-
# @param api_version [Symbol, WhopSDK::Models::WebhookRetrieveResponse::APIVersion] The API version for this webhook
|
|
74
|
-
#
|
|
75
|
-
# @param child_resource_events [Boolean] Whether or not to send events for child resources. For example, if the webhook i
|
|
76
|
-
#
|
|
77
|
-
# @param created_at [Time] The timestamp of when the webhook was created
|
|
78
|
-
#
|
|
79
|
-
# @param enabled [Boolean] Whether or not this webhook is turned on or not
|
|
80
|
-
#
|
|
81
|
-
# @param events [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::Event>] The number of events this webhooks is configured to receive
|
|
82
|
-
#
|
|
83
|
-
# @param resource_id [String] The resource ID
|
|
84
|
-
#
|
|
85
|
-
# @param testable_events [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::TestableEvent>] The list of events that can be tested with this webhook
|
|
86
|
-
#
|
|
87
|
-
# @param url [String] The URL the webhook events will be sent to
|
|
88
|
-
|
|
89
|
-
# The API version for this webhook
|
|
90
|
-
#
|
|
91
|
-
# @see WhopSDK::Models::WebhookRetrieveResponse#api_version
|
|
92
|
-
module APIVersion
|
|
93
|
-
extend WhopSDK::Internal::Type::Enum
|
|
94
|
-
|
|
95
|
-
V1 = :v1
|
|
96
|
-
V2 = :v2
|
|
97
|
-
V5 = :v5
|
|
98
|
-
|
|
99
|
-
# @!method self.values
|
|
100
|
-
# @return [Array<Symbol>]
|
|
101
|
-
end
|
|
102
|
-
|
|
103
|
-
# The different event types available
|
|
104
|
-
module Event
|
|
105
|
-
extend WhopSDK::Internal::Type::Enum
|
|
106
|
-
|
|
107
|
-
INVOICE_CREATED = :"invoice.created"
|
|
108
|
-
INVOICE_PAID = :"invoice.paid"
|
|
109
|
-
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
110
|
-
INVOICE_VOIDED = :"invoice.voided"
|
|
111
|
-
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
112
|
-
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
113
|
-
ENTRY_CREATED = :"entry.created"
|
|
114
|
-
ENTRY_APPROVED = :"entry.approved"
|
|
115
|
-
ENTRY_DENIED = :"entry.denied"
|
|
116
|
-
ENTRY_DELETED = :"entry.deleted"
|
|
117
|
-
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
118
|
-
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
119
|
-
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
120
|
-
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
121
|
-
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
122
|
-
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
123
|
-
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
124
|
-
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
125
|
-
PAYMENT_CREATED = :"payment.created"
|
|
126
|
-
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
127
|
-
PAYMENT_FAILED = :"payment.failed"
|
|
128
|
-
PAYMENT_PENDING = :"payment.pending"
|
|
129
|
-
DISPUTE_CREATED = :"dispute.created"
|
|
130
|
-
DISPUTE_UPDATED = :"dispute.updated"
|
|
131
|
-
REFUND_CREATED = :"refund.created"
|
|
132
|
-
REFUND_UPDATED = :"refund.updated"
|
|
133
|
-
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
134
|
-
|
|
135
|
-
# @!method self.values
|
|
136
|
-
# @return [Array<Symbol>]
|
|
137
|
-
end
|
|
138
|
-
|
|
139
|
-
# The different event types available
|
|
140
|
-
module TestableEvent
|
|
141
|
-
extend WhopSDK::Internal::Type::Enum
|
|
142
|
-
|
|
143
|
-
INVOICE_CREATED = :"invoice.created"
|
|
144
|
-
INVOICE_PAID = :"invoice.paid"
|
|
145
|
-
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
146
|
-
INVOICE_VOIDED = :"invoice.voided"
|
|
147
|
-
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
148
|
-
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
149
|
-
ENTRY_CREATED = :"entry.created"
|
|
150
|
-
ENTRY_APPROVED = :"entry.approved"
|
|
151
|
-
ENTRY_DENIED = :"entry.denied"
|
|
152
|
-
ENTRY_DELETED = :"entry.deleted"
|
|
153
|
-
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
154
|
-
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
155
|
-
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
156
|
-
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
157
|
-
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
158
|
-
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
159
|
-
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
160
|
-
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
161
|
-
PAYMENT_CREATED = :"payment.created"
|
|
162
|
-
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
163
|
-
PAYMENT_FAILED = :"payment.failed"
|
|
164
|
-
PAYMENT_PENDING = :"payment.pending"
|
|
165
|
-
DISPUTE_CREATED = :"dispute.created"
|
|
166
|
-
DISPUTE_UPDATED = :"dispute.updated"
|
|
167
|
-
REFUND_CREATED = :"refund.created"
|
|
168
|
-
REFUND_UPDATED = :"refund.updated"
|
|
169
|
-
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
170
|
-
|
|
171
|
-
# @!method self.values
|
|
172
|
-
# @return [Array<Symbol>]
|
|
173
|
-
end
|
|
174
|
-
end
|
|
175
|
-
end
|
|
176
|
-
end
|
|
@@ -1,176 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module WhopSDK
|
|
4
|
-
module Models
|
|
5
|
-
# @see WhopSDK::Resources::Webhooks#update
|
|
6
|
-
class WebhookUpdateResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# The ID of the webhook
|
|
9
|
-
#
|
|
10
|
-
# @return [String]
|
|
11
|
-
required :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute api_version
|
|
14
|
-
# The API version for this webhook
|
|
15
|
-
#
|
|
16
|
-
# @return [Symbol, WhopSDK::Models::WebhookUpdateResponse::APIVersion]
|
|
17
|
-
required :api_version, enum: -> { WhopSDK::Models::WebhookUpdateResponse::APIVersion }
|
|
18
|
-
|
|
19
|
-
# @!attribute child_resource_events
|
|
20
|
-
# Whether or not to send events for child resources. For example, if the webhook
|
|
21
|
-
# is created for a Company, enabling this will only send events from the Company's
|
|
22
|
-
# sub-merchants (child companies).
|
|
23
|
-
#
|
|
24
|
-
# @return [Boolean]
|
|
25
|
-
required :child_resource_events, WhopSDK::Internal::Type::Boolean
|
|
26
|
-
|
|
27
|
-
# @!attribute created_at
|
|
28
|
-
# The timestamp of when the webhook was created
|
|
29
|
-
#
|
|
30
|
-
# @return [Time]
|
|
31
|
-
required :created_at, Time
|
|
32
|
-
|
|
33
|
-
# @!attribute enabled
|
|
34
|
-
# Whether or not this webhook is turned on or not
|
|
35
|
-
#
|
|
36
|
-
# @return [Boolean]
|
|
37
|
-
required :enabled, WhopSDK::Internal::Type::Boolean
|
|
38
|
-
|
|
39
|
-
# @!attribute events
|
|
40
|
-
# The number of events this webhooks is configured to receive
|
|
41
|
-
#
|
|
42
|
-
# @return [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::Event>]
|
|
43
|
-
required :events,
|
|
44
|
-
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookUpdateResponse::Event] }
|
|
45
|
-
|
|
46
|
-
# @!attribute resource_id
|
|
47
|
-
# The resource ID
|
|
48
|
-
#
|
|
49
|
-
# @return [String]
|
|
50
|
-
required :resource_id, String
|
|
51
|
-
|
|
52
|
-
# @!attribute testable_events
|
|
53
|
-
# The list of events that can be tested with this webhook
|
|
54
|
-
#
|
|
55
|
-
# @return [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::TestableEvent>]
|
|
56
|
-
required :testable_events,
|
|
57
|
-
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookUpdateResponse::TestableEvent] }
|
|
58
|
-
|
|
59
|
-
# @!attribute url
|
|
60
|
-
# The URL the webhook events will be sent to
|
|
61
|
-
#
|
|
62
|
-
# @return [String]
|
|
63
|
-
required :url, String
|
|
64
|
-
|
|
65
|
-
# @!method initialize(id:, api_version:, child_resource_events:, created_at:, enabled:, events:, resource_id:, testable_events:, url:)
|
|
66
|
-
# Some parameter documentations has been truncated, see
|
|
67
|
-
# {WhopSDK::Models::WebhookUpdateResponse} for more details.
|
|
68
|
-
#
|
|
69
|
-
# A webhook object, which can be configured to be sent updates about a company
|
|
70
|
-
#
|
|
71
|
-
# @param id [String] The ID of the webhook
|
|
72
|
-
#
|
|
73
|
-
# @param api_version [Symbol, WhopSDK::Models::WebhookUpdateResponse::APIVersion] The API version for this webhook
|
|
74
|
-
#
|
|
75
|
-
# @param child_resource_events [Boolean] Whether or not to send events for child resources. For example, if the webhook i
|
|
76
|
-
#
|
|
77
|
-
# @param created_at [Time] The timestamp of when the webhook was created
|
|
78
|
-
#
|
|
79
|
-
# @param enabled [Boolean] Whether or not this webhook is turned on or not
|
|
80
|
-
#
|
|
81
|
-
# @param events [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::Event>] The number of events this webhooks is configured to receive
|
|
82
|
-
#
|
|
83
|
-
# @param resource_id [String] The resource ID
|
|
84
|
-
#
|
|
85
|
-
# @param testable_events [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::TestableEvent>] The list of events that can be tested with this webhook
|
|
86
|
-
#
|
|
87
|
-
# @param url [String] The URL the webhook events will be sent to
|
|
88
|
-
|
|
89
|
-
# The API version for this webhook
|
|
90
|
-
#
|
|
91
|
-
# @see WhopSDK::Models::WebhookUpdateResponse#api_version
|
|
92
|
-
module APIVersion
|
|
93
|
-
extend WhopSDK::Internal::Type::Enum
|
|
94
|
-
|
|
95
|
-
V1 = :v1
|
|
96
|
-
V2 = :v2
|
|
97
|
-
V5 = :v5
|
|
98
|
-
|
|
99
|
-
# @!method self.values
|
|
100
|
-
# @return [Array<Symbol>]
|
|
101
|
-
end
|
|
102
|
-
|
|
103
|
-
# The different event types available
|
|
104
|
-
module Event
|
|
105
|
-
extend WhopSDK::Internal::Type::Enum
|
|
106
|
-
|
|
107
|
-
INVOICE_CREATED = :"invoice.created"
|
|
108
|
-
INVOICE_PAID = :"invoice.paid"
|
|
109
|
-
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
110
|
-
INVOICE_VOIDED = :"invoice.voided"
|
|
111
|
-
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
112
|
-
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
113
|
-
ENTRY_CREATED = :"entry.created"
|
|
114
|
-
ENTRY_APPROVED = :"entry.approved"
|
|
115
|
-
ENTRY_DENIED = :"entry.denied"
|
|
116
|
-
ENTRY_DELETED = :"entry.deleted"
|
|
117
|
-
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
118
|
-
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
119
|
-
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
120
|
-
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
121
|
-
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
122
|
-
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
123
|
-
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
124
|
-
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
125
|
-
PAYMENT_CREATED = :"payment.created"
|
|
126
|
-
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
127
|
-
PAYMENT_FAILED = :"payment.failed"
|
|
128
|
-
PAYMENT_PENDING = :"payment.pending"
|
|
129
|
-
DISPUTE_CREATED = :"dispute.created"
|
|
130
|
-
DISPUTE_UPDATED = :"dispute.updated"
|
|
131
|
-
REFUND_CREATED = :"refund.created"
|
|
132
|
-
REFUND_UPDATED = :"refund.updated"
|
|
133
|
-
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
134
|
-
|
|
135
|
-
# @!method self.values
|
|
136
|
-
# @return [Array<Symbol>]
|
|
137
|
-
end
|
|
138
|
-
|
|
139
|
-
# The different event types available
|
|
140
|
-
module TestableEvent
|
|
141
|
-
extend WhopSDK::Internal::Type::Enum
|
|
142
|
-
|
|
143
|
-
INVOICE_CREATED = :"invoice.created"
|
|
144
|
-
INVOICE_PAID = :"invoice.paid"
|
|
145
|
-
INVOICE_PAST_DUE = :"invoice.past_due"
|
|
146
|
-
INVOICE_VOIDED = :"invoice.voided"
|
|
147
|
-
MEMBERSHIP_ACTIVATED = :"membership.activated"
|
|
148
|
-
MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
|
|
149
|
-
ENTRY_CREATED = :"entry.created"
|
|
150
|
-
ENTRY_APPROVED = :"entry.approved"
|
|
151
|
-
ENTRY_DENIED = :"entry.denied"
|
|
152
|
-
ENTRY_DELETED = :"entry.deleted"
|
|
153
|
-
SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
|
|
154
|
-
SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
|
|
155
|
-
SETUP_INTENT_CANCELED = :"setup_intent.canceled"
|
|
156
|
-
WITHDRAWAL_CREATED = :"withdrawal.created"
|
|
157
|
-
WITHDRAWAL_UPDATED = :"withdrawal.updated"
|
|
158
|
-
COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
|
|
159
|
-
PAYOUT_METHOD_CREATED = :"payout_method.created"
|
|
160
|
-
VERIFICATION_SUCCEEDED = :"verification.succeeded"
|
|
161
|
-
PAYMENT_CREATED = :"payment.created"
|
|
162
|
-
PAYMENT_SUCCEEDED = :"payment.succeeded"
|
|
163
|
-
PAYMENT_FAILED = :"payment.failed"
|
|
164
|
-
PAYMENT_PENDING = :"payment.pending"
|
|
165
|
-
DISPUTE_CREATED = :"dispute.created"
|
|
166
|
-
DISPUTE_UPDATED = :"dispute.updated"
|
|
167
|
-
REFUND_CREATED = :"refund.created"
|
|
168
|
-
REFUND_UPDATED = :"refund.updated"
|
|
169
|
-
MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
|
|
170
|
-
|
|
171
|
-
# @!method self.values
|
|
172
|
-
# @return [Array<Symbol>]
|
|
173
|
-
end
|
|
174
|
-
end
|
|
175
|
-
end
|
|
176
|
-
end
|