whop_sdk 0.0.23 → 0.0.25
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 +52 -0
- data/README.md +3 -3
- data/lib/whop_sdk/client.rb +12 -0
- data/lib/whop_sdk/models/ai_chat_create_params.rb +22 -0
- data/lib/whop_sdk/models/ai_chat_create_response.rb +89 -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_retrieve_response.rb +89 -0
- data/lib/whop_sdk/models/ai_chat_update_params.rb +22 -0
- data/lib/whop_sdk/models/ai_chat_update_response.rb +89 -0
- data/lib/whop_sdk/models/app_build_create_params.rb +16 -55
- data/lib/whop_sdk/models/app_create_params.rb +22 -1
- data/lib/whop_sdk/models/app_list_params.rb +6 -0
- data/lib/whop_sdk/models/app_update_params.rb +14 -53
- data/lib/whop_sdk/models/card_brands.rb +16 -0
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +32 -56
- data/lib/whop_sdk/models/company_create_params.rb +22 -1
- data/lib/whop_sdk/models/company_token_transaction_create_params.rb +69 -0
- data/lib/whop_sdk/models/company_token_transaction_create_response.rb +180 -0
- data/lib/whop_sdk/models/company_token_transaction_list_params.rb +84 -0
- data/lib/whop_sdk/models/company_token_transaction_list_response.rb +180 -0
- data/lib/whop_sdk/models/company_token_transaction_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/company_token_transaction_retrieve_response.rb +180 -0
- data/lib/whop_sdk/models/company_update_params.rb +28 -106
- data/lib/whop_sdk/models/course_create_params.rb +15 -62
- data/lib/whop_sdk/models/course_lesson_create_params.rb +14 -53
- data/lib/whop_sdk/models/course_lesson_update_params.rb +53 -214
- data/lib/whop_sdk/models/course_update_params.rb +14 -61
- data/lib/whop_sdk/models/dispute_update_evidence_params.rb +56 -212
- data/lib/whop_sdk/models/dm_member_create_params.rb +30 -0
- data/lib/whop_sdk/models/dm_member_create_response.rb +94 -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 +71 -0
- data/lib/whop_sdk/models/dm_member_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/dm_member_retrieve_response.rb +94 -0
- data/lib/whop_sdk/models/dm_member_update_params.rb +58 -0
- data/lib/whop_sdk/models/dm_member_update_response.rb +94 -0
- data/lib/whop_sdk/models/experience_create_params.rb +22 -1
- data/lib/whop_sdk/models/experience_update_params.rb +14 -53
- data/lib/whop_sdk/models/forum_post_create_params.rb +13 -52
- data/lib/whop_sdk/models/forum_post_update_params.rb +13 -52
- data/lib/whop_sdk/models/friendly_receipt_status.rb +23 -11
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +1 -34
- data/lib/whop_sdk/models/member_list_response.rb +9 -1
- data/lib/whop_sdk/models/member_retrieve_response.rb +9 -1
- data/lib/whop_sdk/models/membership.rb +76 -2
- data/lib/whop_sdk/models/membership_list_response.rb +38 -2
- data/lib/whop_sdk/models/membership_uncancel_params.rb +14 -0
- data/lib/whop_sdk/models/message_create_params.rb +22 -53
- 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/message_update_params.rb +14 -53
- data/lib/whop_sdk/models/payment.rb +17 -1
- data/lib/whop_sdk/models/payment_list_response.rb +17 -1
- data/lib/whop_sdk/models/payment_method_types.rb +59 -57
- data/lib/whop_sdk/models/payment_provider.rb +1 -0
- data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +26 -1
- data/lib/whop_sdk/models/payout_method_list_response.rb +26 -1
- data/lib/whop_sdk/models/payout_method_retrieve_response.rb +26 -1
- data/lib/whop_sdk/models/plan_create_params.rb +14 -53
- data/lib/whop_sdk/models/plan_update_params.rb +14 -53
- 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/withdrawal_create_params.rb +21 -1
- data/lib/whop_sdk/models/withdrawal_create_response.rb +2 -9
- data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +2 -9
- data/lib/whop_sdk/models/withdrawal_list_response.rb +1 -9
- data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +2 -9
- data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +2 -9
- data/lib/whop_sdk/models.rb +32 -2
- data/lib/whop_sdk/resources/ai_chats.rb +141 -0
- data/lib/whop_sdk/resources/app_builds.rb +1 -1
- data/lib/whop_sdk/resources/apps.rb +4 -2
- data/lib/whop_sdk/resources/checkout_configurations.rb +3 -1
- data/lib/whop_sdk/resources/companies.rb +5 -3
- data/lib/whop_sdk/resources/company_token_transactions.rb +121 -0
- data/lib/whop_sdk/resources/course_lessons.rb +4 -4
- data/lib/whop_sdk/resources/courses.rb +4 -8
- data/lib/whop_sdk/resources/disputes.rb +4 -4
- data/lib/whop_sdk/resources/dm_members.rb +155 -0
- data/lib/whop_sdk/resources/experiences.rb +4 -2
- data/lib/whop_sdk/resources/forum_posts.rb +2 -2
- data/lib/whop_sdk/resources/memberships.rb +32 -0
- data/lib/whop_sdk/resources/messages.rb +29 -3
- data/lib/whop_sdk/resources/notifications.rb +4 -0
- data/lib/whop_sdk/resources/plans.rb +2 -2
- data/lib/whop_sdk/resources/reactions.rb +34 -1
- data/lib/whop_sdk/resources/withdrawals.rb +8 -1
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +34 -1
- data/rbi/whop_sdk/client.rbi +9 -0
- data/rbi/whop_sdk/models/ai_chat_create_params.rbi +40 -0
- data/rbi/whop_sdk/models/ai_chat_create_response.rbi +128 -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_retrieve_response.rbi +128 -0
- data/rbi/whop_sdk/models/ai_chat_update_params.rbi +40 -0
- data/rbi/whop_sdk/models/ai_chat_update_response.rbi +128 -0
- data/rbi/whop_sdk/models/app_build_create_params.rbi +26 -89
- data/rbi/whop_sdk/models/app_create_params.rbi +36 -0
- data/rbi/whop_sdk/models/app_list_params.rbi +12 -0
- data/rbi/whop_sdk/models/app_update_params.rbi +21 -93
- data/rbi/whop_sdk/models/card_brands.rbi +17 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +45 -87
- data/rbi/whop_sdk/models/company_create_params.rbi +39 -0
- data/rbi/whop_sdk/models/company_token_transaction_create_params.rbi +92 -0
- data/rbi/whop_sdk/models/company_token_transaction_create_response.rbi +308 -0
- data/rbi/whop_sdk/models/company_token_transaction_list_params.rbi +146 -0
- data/rbi/whop_sdk/models/company_token_transaction_list_response.rbi +308 -0
- data/rbi/whop_sdk/models/company_token_transaction_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/company_token_transaction_retrieve_response.rbi +312 -0
- data/rbi/whop_sdk/models/company_update_params.rbi +47 -185
- data/rbi/whop_sdk/models/course_create_params.rbi +24 -101
- data/rbi/whop_sdk/models/course_lesson_create_params.rbi +25 -92
- data/rbi/whop_sdk/models/course_lesson_update_params.rbi +97 -359
- data/rbi/whop_sdk/models/course_update_params.rbi +24 -101
- data/rbi/whop_sdk/models/dispute_update_evidence_params.rbi +116 -340
- data/rbi/whop_sdk/models/dm_member_create_params.rbi +51 -0
- data/rbi/whop_sdk/models/dm_member_create_response.rbi +179 -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 +124 -0
- data/rbi/whop_sdk/models/dm_member_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/dm_member_retrieve_response.rbi +179 -0
- data/rbi/whop_sdk/models/dm_member_update_params.rbi +130 -0
- data/rbi/whop_sdk/models/dm_member_update_response.rbi +179 -0
- data/rbi/whop_sdk/models/experience_create_params.rbi +41 -0
- data/rbi/whop_sdk/models/experience_update_params.rbi +24 -93
- data/rbi/whop_sdk/models/forum_post_create_params.rbi +18 -94
- data/rbi/whop_sdk/models/forum_post_update_params.rbi +18 -94
- data/rbi/whop_sdk/models/friendly_receipt_status.rbi +62 -17
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +0 -105
- data/rbi/whop_sdk/models/member_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +8 -0
- data/rbi/whop_sdk/models/membership.rbi +126 -4
- data/rbi/whop_sdk/models/membership_list_response.rbi +98 -4
- data/rbi/whop_sdk/models/membership_uncancel_params.rbi +27 -0
- data/rbi/whop_sdk/models/message_create_params.rbi +26 -94
- 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/message_update_params.rbi +18 -94
- data/rbi/whop_sdk/models/payment.rbi +16 -0
- data/rbi/whop_sdk/models/payment_list_response.rbi +16 -0
- data/rbi/whop_sdk/models/payment_method_types.rbi +67 -64
- data/rbi/whop_sdk/models/payment_provider.rbi +1 -0
- data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +26 -0
- data/rbi/whop_sdk/models/payout_method_list_response.rbi +26 -0
- data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +26 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +21 -93
- data/rbi/whop_sdk/models/plan_update_params.rbi +21 -93
- 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/withdrawal_create_params.rbi +18 -0
- data/rbi/whop_sdk/models/withdrawal_create_response.rbi +8 -11
- data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +8 -11
- data/rbi/whop_sdk/models/withdrawal_list_response.rbi +3 -11
- data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +8 -11
- data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +8 -11
- data/rbi/whop_sdk/models.rbi +35 -2
- data/rbi/whop_sdk/resources/ai_chats.rbi +108 -0
- data/rbi/whop_sdk/resources/app_builds.rbi +1 -5
- data/rbi/whop_sdk/resources/apps.rbi +4 -7
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +3 -0
- data/rbi/whop_sdk/resources/companies.rbi +5 -13
- data/rbi/whop_sdk/resources/company_token_transactions.rbi +114 -0
- data/rbi/whop_sdk/resources/course_lessons.rbi +4 -24
- data/rbi/whop_sdk/resources/courses.rbi +2 -20
- data/rbi/whop_sdk/resources/disputes.rbi +4 -16
- data/rbi/whop_sdk/resources/dm_members.rbi +128 -0
- data/rbi/whop_sdk/resources/experiences.rbi +4 -7
- data/rbi/whop_sdk/resources/forum_posts.rbi +2 -12
- data/rbi/whop_sdk/resources/memberships.rbi +26 -0
- data/rbi/whop_sdk/resources/messages.rbi +23 -12
- data/rbi/whop_sdk/resources/notifications.rbi +4 -0
- data/rbi/whop_sdk/resources/plans.rbi +2 -14
- data/rbi/whop_sdk/resources/reactions.rbi +26 -0
- data/rbi/whop_sdk/resources/withdrawals.rbi +7 -0
- data/sig/whop_sdk/client.rbs +6 -0
- data/sig/whop_sdk/models/ai_chat_create_params.rbs +23 -0
- data/sig/whop_sdk/models/ai_chat_create_response.rbs +65 -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_retrieve_response.rbs +65 -0
- data/sig/whop_sdk/models/ai_chat_update_params.rbs +23 -0
- data/sig/whop_sdk/models/ai_chat_update_response.rbs +65 -0
- data/sig/whop_sdk/models/app_build_create_params.rbs +9 -30
- data/sig/whop_sdk/models/app_create_params.rbs +20 -1
- data/sig/whop_sdk/models/app_list_params.rbs +13 -1
- data/sig/whop_sdk/models/app_update_params.rbs +9 -30
- data/sig/whop_sdk/models/card_brands.rbs +32 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +19 -30
- data/sig/whop_sdk/models/company_create_params.rbs +15 -0
- data/sig/whop_sdk/models/company_token_transaction_create_params.rbs +56 -0
- data/sig/whop_sdk/models/company_token_transaction_create_response.rbs +115 -0
- data/sig/whop_sdk/models/company_token_transaction_list_params.rbs +68 -0
- data/sig/whop_sdk/models/company_token_transaction_list_response.rbs +115 -0
- data/sig/whop_sdk/models/company_token_transaction_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/company_token_transaction_retrieve_response.rbs +115 -0
- data/sig/whop_sdk/models/company_update_params.rbs +18 -60
- data/sig/whop_sdk/models/course_create_params.rbs +9 -35
- data/sig/whop_sdk/models/course_lesson_create_params.rbs +9 -30
- data/sig/whop_sdk/models/course_lesson_update_params.rbs +36 -120
- data/sig/whop_sdk/models/course_update_params.rbs +9 -35
- data/sig/whop_sdk/models/dispute_update_evidence_params.rbs +36 -120
- data/sig/whop_sdk/models/dm_member_create_params.rbs +28 -0
- data/sig/whop_sdk/models/dm_member_create_response.rbs +71 -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 +54 -0
- data/sig/whop_sdk/models/dm_member_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/dm_member_retrieve_response.rbs +71 -0
- data/sig/whop_sdk/models/dm_member_update_params.rbs +57 -0
- data/sig/whop_sdk/models/dm_member_update_response.rbs +71 -0
- data/sig/whop_sdk/models/experience_create_params.rbs +15 -0
- data/sig/whop_sdk/models/experience_update_params.rbs +9 -30
- data/sig/whop_sdk/models/forum_post_create_params.rbs +9 -30
- data/sig/whop_sdk/models/forum_post_update_params.rbs +9 -30
- data/sig/whop_sdk/models/friendly_receipt_status.rbs +46 -22
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +0 -38
- data/sig/whop_sdk/models/member_list_response.rbs +5 -0
- data/sig/whop_sdk/models/member_retrieve_response.rbs +5 -0
- data/sig/whop_sdk/models/membership.rbs +65 -4
- data/sig/whop_sdk/models/membership_list_response.rbs +45 -4
- data/sig/whop_sdk/models/membership_uncancel_params.rbs +15 -0
- data/sig/whop_sdk/models/message_create_params.rbs +15 -31
- 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/message_update_params.rbs +9 -30
- data/sig/whop_sdk/models/payment.rbs +10 -0
- data/sig/whop_sdk/models/payment_list_response.rbs +10 -0
- data/sig/whop_sdk/models/payment_method_types.rbs +119 -115
- data/sig/whop_sdk/models/payment_provider.rbs +2 -0
- data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +15 -0
- data/sig/whop_sdk/models/payout_method_list_response.rbs +15 -0
- data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +15 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +9 -30
- data/sig/whop_sdk/models/plan_update_params.rbs +9 -30
- 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/withdrawal_create_params.rbs +11 -1
- data/sig/whop_sdk/models/withdrawal_create_response.rbs +5 -8
- data/sig/whop_sdk/models/withdrawal_created_webhook_event.rbs +5 -8
- data/sig/whop_sdk/models/withdrawal_list_response.rbs +3 -8
- data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +5 -8
- data/sig/whop_sdk/models/withdrawal_updated_webhook_event.rbs +5 -8
- data/sig/whop_sdk/models.rbs +32 -2
- data/sig/whop_sdk/resources/ai_chats.rbs +33 -0
- data/sig/whop_sdk/resources/app_builds.rbs +1 -1
- data/sig/whop_sdk/resources/apps.rbs +2 -1
- data/sig/whop_sdk/resources/checkout_configurations.rbs +1 -0
- data/sig/whop_sdk/resources/companies.rbs +3 -2
- data/sig/whop_sdk/resources/company_token_transactions.rbs +34 -0
- data/sig/whop_sdk/resources/course_lessons.rbs +4 -4
- data/sig/whop_sdk/resources/courses.rbs +2 -4
- data/sig/whop_sdk/resources/disputes.rbs +4 -4
- data/sig/whop_sdk/resources/dm_members.rbs +36 -0
- data/sig/whop_sdk/resources/experiences.rbs +2 -1
- data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
- data/sig/whop_sdk/resources/memberships.rbs +5 -0
- data/sig/whop_sdk/resources/messages.rbs +5 -2
- data/sig/whop_sdk/resources/plans.rbs +2 -2
- data/sig/whop_sdk/resources/reactions.rbs +7 -0
- data/sig/whop_sdk/resources/withdrawals.rbs +2 -0
- metadata +118 -5
- data/lib/whop_sdk/models/withdrawal_types.rb +0 -16
- data/rbi/whop_sdk/models/withdrawal_types.rbi +0 -20
- data/sig/whop_sdk/models/withdrawal_types.rbs +0 -14
|
@@ -148,13 +148,7 @@ module WhopSDK
|
|
|
148
148
|
# @return [String, nil]
|
|
149
149
|
required :trace_code, String, nil?: true
|
|
150
150
|
|
|
151
|
-
# @!
|
|
152
|
-
# The type of withdrawal.
|
|
153
|
-
#
|
|
154
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
155
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
156
|
-
|
|
157
|
-
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:, withdrawal_type:)
|
|
151
|
+
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:)
|
|
158
152
|
# Some parameter documentations has been truncated, see
|
|
159
153
|
# {WhopSDK::Models::WithdrawalCreatedWebhookEvent::Data} for more details.
|
|
160
154
|
#
|
|
@@ -189,8 +183,6 @@ module WhopSDK
|
|
|
189
183
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
190
184
|
#
|
|
191
185
|
# @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
|
|
192
|
-
#
|
|
193
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
194
186
|
|
|
195
187
|
# The different error codes a payout can be in.
|
|
196
188
|
#
|
|
@@ -223,6 +215,7 @@ module WhopSDK
|
|
|
223
215
|
INVALID_ACCOUNT_NUMBER = :invalid_account_number
|
|
224
216
|
INVALID_BANK_CODE = :invalid_bank_code
|
|
225
217
|
INVALID_BENEFICIARY = :invalid_beneficiary
|
|
218
|
+
INVALID_MAILING_ADDRESS = :invalid_mailing_address
|
|
226
219
|
INVALID_BRANCH_NUMBER = :invalid_branch_number
|
|
227
220
|
INVALID_BRANCH_CODE = :invalid_branch_code
|
|
228
221
|
INVALID_PHONE_NUMBER = :invalid_phone_number
|
|
@@ -61,13 +61,7 @@ module WhopSDK
|
|
|
61
61
|
# @return [Symbol, WhopSDK::Models::WithdrawalStatus]
|
|
62
62
|
required :status, enum: -> { WhopSDK::WithdrawalStatus }
|
|
63
63
|
|
|
64
|
-
# @!
|
|
65
|
-
# The type of withdrawal.
|
|
66
|
-
#
|
|
67
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
68
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
69
|
-
|
|
70
|
-
# @!method initialize(id:, amount:, created_at:, currency:, fee_amount:, fee_type:, markup_fee:, speed:, status:, withdrawal_type:)
|
|
64
|
+
# @!method initialize(id:, amount:, created_at:, currency:, fee_amount:, fee_type:, markup_fee:, speed:, status:)
|
|
71
65
|
# Some parameter documentations has been truncated, see
|
|
72
66
|
# {WhopSDK::Models::WithdrawalListResponse} for more details.
|
|
73
67
|
#
|
|
@@ -90,8 +84,6 @@ module WhopSDK
|
|
|
90
84
|
# @param speed [Symbol, WhopSDK::Models::WithdrawalSpeeds] The speed of the withdrawal.
|
|
91
85
|
#
|
|
92
86
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
93
|
-
#
|
|
94
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
95
87
|
end
|
|
96
88
|
end
|
|
97
89
|
end
|
|
@@ -98,13 +98,7 @@ module WhopSDK
|
|
|
98
98
|
# @return [String, nil]
|
|
99
99
|
required :trace_code, String, nil?: true
|
|
100
100
|
|
|
101
|
-
# @!
|
|
102
|
-
# The type of withdrawal.
|
|
103
|
-
#
|
|
104
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
105
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
106
|
-
|
|
107
|
-
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:, withdrawal_type:)
|
|
101
|
+
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:)
|
|
108
102
|
# Some parameter documentations has been truncated, see
|
|
109
103
|
# {WhopSDK::Models::WithdrawalRetrieveResponse} for more details.
|
|
110
104
|
#
|
|
@@ -139,8 +133,6 @@ module WhopSDK
|
|
|
139
133
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
140
134
|
#
|
|
141
135
|
# @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
|
|
142
|
-
#
|
|
143
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
144
136
|
|
|
145
137
|
# The different error codes a payout can be in.
|
|
146
138
|
#
|
|
@@ -173,6 +165,7 @@ module WhopSDK
|
|
|
173
165
|
INVALID_ACCOUNT_NUMBER = :invalid_account_number
|
|
174
166
|
INVALID_BANK_CODE = :invalid_bank_code
|
|
175
167
|
INVALID_BENEFICIARY = :invalid_beneficiary
|
|
168
|
+
INVALID_MAILING_ADDRESS = :invalid_mailing_address
|
|
176
169
|
INVALID_BRANCH_NUMBER = :invalid_branch_number
|
|
177
170
|
INVALID_BRANCH_CODE = :invalid_branch_code
|
|
178
171
|
INVALID_PHONE_NUMBER = :invalid_phone_number
|
|
@@ -148,13 +148,7 @@ module WhopSDK
|
|
|
148
148
|
# @return [String, nil]
|
|
149
149
|
required :trace_code, String, nil?: true
|
|
150
150
|
|
|
151
|
-
# @!
|
|
152
|
-
# The type of withdrawal.
|
|
153
|
-
#
|
|
154
|
-
# @return [Symbol, WhopSDK::Models::WithdrawalTypes]
|
|
155
|
-
required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
|
|
156
|
-
|
|
157
|
-
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:, withdrawal_type:)
|
|
151
|
+
# @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:)
|
|
158
152
|
# Some parameter documentations has been truncated, see
|
|
159
153
|
# {WhopSDK::Models::WithdrawalUpdatedWebhookEvent::Data} for more details.
|
|
160
154
|
#
|
|
@@ -189,8 +183,6 @@ module WhopSDK
|
|
|
189
183
|
# @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
|
|
190
184
|
#
|
|
191
185
|
# @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
|
|
192
|
-
#
|
|
193
|
-
# @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
|
|
194
186
|
|
|
195
187
|
# The different error codes a payout can be in.
|
|
196
188
|
#
|
|
@@ -223,6 +215,7 @@ module WhopSDK
|
|
|
223
215
|
INVALID_ACCOUNT_NUMBER = :invalid_account_number
|
|
224
216
|
INVALID_BANK_CODE = :invalid_bank_code
|
|
225
217
|
INVALID_BENEFICIARY = :invalid_beneficiary
|
|
218
|
+
INVALID_MAILING_ADDRESS = :invalid_mailing_address
|
|
226
219
|
INVALID_BRANCH_NUMBER = :invalid_branch_number
|
|
227
220
|
INVALID_BRANCH_CODE = :invalid_branch_code
|
|
228
221
|
INVALID_PHONE_NUMBER = :invalid_phone_number
|
data/lib/whop_sdk/models.rb
CHANGED
|
@@ -47,6 +47,16 @@ module WhopSDK
|
|
|
47
47
|
|
|
48
48
|
AccountLinkCreateParams = WhopSDK::Models::AccountLinkCreateParams
|
|
49
49
|
|
|
50
|
+
AIChatCreateParams = WhopSDK::Models::AIChatCreateParams
|
|
51
|
+
|
|
52
|
+
AIChatDeleteParams = WhopSDK::Models::AIChatDeleteParams
|
|
53
|
+
|
|
54
|
+
AIChatListParams = WhopSDK::Models::AIChatListParams
|
|
55
|
+
|
|
56
|
+
AIChatRetrieveParams = WhopSDK::Models::AIChatRetrieveParams
|
|
57
|
+
|
|
58
|
+
AIChatUpdateParams = WhopSDK::Models::AIChatUpdateParams
|
|
59
|
+
|
|
50
60
|
App = WhopSDK::Models::App
|
|
51
61
|
|
|
52
62
|
AppBuild = WhopSDK::Models::AppBuild
|
|
@@ -119,6 +129,12 @@ module WhopSDK
|
|
|
119
129
|
|
|
120
130
|
CompanyRetrieveParams = WhopSDK::Models::CompanyRetrieveParams
|
|
121
131
|
|
|
132
|
+
CompanyTokenTransactionCreateParams = WhopSDK::Models::CompanyTokenTransactionCreateParams
|
|
133
|
+
|
|
134
|
+
CompanyTokenTransactionListParams = WhopSDK::Models::CompanyTokenTransactionListParams
|
|
135
|
+
|
|
136
|
+
CompanyTokenTransactionRetrieveParams = WhopSDK::Models::CompanyTokenTransactionRetrieveParams
|
|
137
|
+
|
|
122
138
|
CompanyUpdateParams = WhopSDK::Models::CompanyUpdateParams
|
|
123
139
|
|
|
124
140
|
Course = WhopSDK::Models::Course
|
|
@@ -200,6 +216,16 @@ module WhopSDK
|
|
|
200
216
|
|
|
201
217
|
DisputeUpdateEvidenceParams = WhopSDK::Models::DisputeUpdateEvidenceParams
|
|
202
218
|
|
|
219
|
+
DmMemberCreateParams = WhopSDK::Models::DmMemberCreateParams
|
|
220
|
+
|
|
221
|
+
DmMemberDeleteParams = WhopSDK::Models::DmMemberDeleteParams
|
|
222
|
+
|
|
223
|
+
DmMemberListParams = WhopSDK::Models::DmMemberListParams
|
|
224
|
+
|
|
225
|
+
DmMemberRetrieveParams = WhopSDK::Models::DmMemberRetrieveParams
|
|
226
|
+
|
|
227
|
+
DmMemberUpdateParams = WhopSDK::Models::DmMemberUpdateParams
|
|
228
|
+
|
|
203
229
|
DmsPostTypes = WhopSDK::Models::DmsPostTypes
|
|
204
230
|
|
|
205
231
|
EmailNotificationPreferences = WhopSDK::Models::EmailNotificationPreferences
|
|
@@ -349,6 +375,8 @@ module WhopSDK
|
|
|
349
375
|
|
|
350
376
|
MembershipStatus = WhopSDK::Models::MembershipStatus
|
|
351
377
|
|
|
378
|
+
MembershipUncancelParams = WhopSDK::Models::MembershipUncancelParams
|
|
379
|
+
|
|
352
380
|
MembershipUpdateParams = WhopSDK::Models::MembershipUpdateParams
|
|
353
381
|
|
|
354
382
|
MemberStatuses = WhopSDK::Models::MemberStatuses
|
|
@@ -357,6 +385,8 @@ module WhopSDK
|
|
|
357
385
|
|
|
358
386
|
MessageCreateParams = WhopSDK::Models::MessageCreateParams
|
|
359
387
|
|
|
388
|
+
MessageDeleteParams = WhopSDK::Models::MessageDeleteParams
|
|
389
|
+
|
|
360
390
|
MessageListParams = WhopSDK::Models::MessageListParams
|
|
361
391
|
|
|
362
392
|
MessageRetrieveParams = WhopSDK::Models::MessageRetrieveParams
|
|
@@ -453,6 +483,8 @@ module WhopSDK
|
|
|
453
483
|
|
|
454
484
|
ReactionCreateParams = WhopSDK::Models::ReactionCreateParams
|
|
455
485
|
|
|
486
|
+
ReactionDeleteParams = WhopSDK::Models::ReactionDeleteParams
|
|
487
|
+
|
|
456
488
|
ReactionListParams = WhopSDK::Models::ReactionListParams
|
|
457
489
|
|
|
458
490
|
ReactionRetrieveParams = WhopSDK::Models::ReactionRetrieveParams
|
|
@@ -577,7 +609,5 @@ module WhopSDK
|
|
|
577
609
|
|
|
578
610
|
WithdrawalStatus = WhopSDK::Models::WithdrawalStatus
|
|
579
611
|
|
|
580
|
-
WithdrawalTypes = WhopSDK::Models::WithdrawalTypes
|
|
581
|
-
|
|
582
612
|
WithdrawalUpdatedWebhookEvent = WhopSDK::Models::WithdrawalUpdatedWebhookEvent
|
|
583
613
|
end
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class AIChats
|
|
6
|
+
# Creates a new AI chat
|
|
7
|
+
#
|
|
8
|
+
# Required permissions:
|
|
9
|
+
#
|
|
10
|
+
# - `ai_chat:create`
|
|
11
|
+
#
|
|
12
|
+
# @overload create(title: nil, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param title [String, nil] The title of the AI chat
|
|
15
|
+
#
|
|
16
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
17
|
+
#
|
|
18
|
+
# @return [WhopSDK::Models::AIChatCreateResponse]
|
|
19
|
+
#
|
|
20
|
+
# @see WhopSDK::Models::AIChatCreateParams
|
|
21
|
+
def create(params = {})
|
|
22
|
+
parsed, options = WhopSDK::AIChatCreateParams.dump_request(params)
|
|
23
|
+
@client.request(
|
|
24
|
+
method: :post,
|
|
25
|
+
path: "ai_chats",
|
|
26
|
+
body: parsed,
|
|
27
|
+
model: WhopSDK::Models::AIChatCreateResponse,
|
|
28
|
+
options: options
|
|
29
|
+
)
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Fetches a single AI chat by ID
|
|
33
|
+
#
|
|
34
|
+
# @overload retrieve(id, request_options: {})
|
|
35
|
+
#
|
|
36
|
+
# @param id [String] The ID of the AI chat
|
|
37
|
+
#
|
|
38
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
39
|
+
#
|
|
40
|
+
# @return [WhopSDK::Models::AIChatRetrieveResponse]
|
|
41
|
+
#
|
|
42
|
+
# @see WhopSDK::Models::AIChatRetrieveParams
|
|
43
|
+
def retrieve(id, params = {})
|
|
44
|
+
@client.request(
|
|
45
|
+
method: :get,
|
|
46
|
+
path: ["ai_chats/%1$s", id],
|
|
47
|
+
model: WhopSDK::Models::AIChatRetrieveResponse,
|
|
48
|
+
options: params[:request_options]
|
|
49
|
+
)
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# Updates an AI chat
|
|
53
|
+
#
|
|
54
|
+
# Required permissions:
|
|
55
|
+
#
|
|
56
|
+
# - `ai_chat:update`
|
|
57
|
+
#
|
|
58
|
+
# @overload update(id, title: nil, request_options: {})
|
|
59
|
+
#
|
|
60
|
+
# @param id [String] The ID of the AI chat to update
|
|
61
|
+
#
|
|
62
|
+
# @param title [String, nil] The new title for the AI chat
|
|
63
|
+
#
|
|
64
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
65
|
+
#
|
|
66
|
+
# @return [WhopSDK::Models::AIChatUpdateResponse]
|
|
67
|
+
#
|
|
68
|
+
# @see WhopSDK::Models::AIChatUpdateParams
|
|
69
|
+
def update(id, params = {})
|
|
70
|
+
parsed, options = WhopSDK::AIChatUpdateParams.dump_request(params)
|
|
71
|
+
@client.request(
|
|
72
|
+
method: :patch,
|
|
73
|
+
path: ["ai_chats/%1$s", id],
|
|
74
|
+
body: parsed,
|
|
75
|
+
model: WhopSDK::Models::AIChatUpdateResponse,
|
|
76
|
+
options: options
|
|
77
|
+
)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Fetches all AI chats for the current user
|
|
81
|
+
#
|
|
82
|
+
# @overload list(after: nil, before: nil, first: nil, last: nil, request_options: {})
|
|
83
|
+
#
|
|
84
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
85
|
+
#
|
|
86
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
87
|
+
#
|
|
88
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
89
|
+
#
|
|
90
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
91
|
+
#
|
|
92
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
93
|
+
#
|
|
94
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AIChatListResponse>]
|
|
95
|
+
#
|
|
96
|
+
# @see WhopSDK::Models::AIChatListParams
|
|
97
|
+
def list(params = {})
|
|
98
|
+
parsed, options = WhopSDK::AIChatListParams.dump_request(params)
|
|
99
|
+
@client.request(
|
|
100
|
+
method: :get,
|
|
101
|
+
path: "ai_chats",
|
|
102
|
+
query: parsed,
|
|
103
|
+
page: WhopSDK::Internal::CursorPage,
|
|
104
|
+
model: WhopSDK::Models::AIChatListResponse,
|
|
105
|
+
options: options
|
|
106
|
+
)
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Deletes an AI chat
|
|
110
|
+
#
|
|
111
|
+
# Required permissions:
|
|
112
|
+
#
|
|
113
|
+
# - `ai_chat:delete`
|
|
114
|
+
#
|
|
115
|
+
# @overload delete(id, request_options: {})
|
|
116
|
+
#
|
|
117
|
+
# @param id [String] The ID of the AI chat to delete
|
|
118
|
+
#
|
|
119
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
120
|
+
#
|
|
121
|
+
# @return [Boolean]
|
|
122
|
+
#
|
|
123
|
+
# @see WhopSDK::Models::AIChatDeleteParams
|
|
124
|
+
def delete(id, params = {})
|
|
125
|
+
@client.request(
|
|
126
|
+
method: :delete,
|
|
127
|
+
path: ["ai_chats/%1$s", id],
|
|
128
|
+
model: WhopSDK::Internal::Type::Boolean,
|
|
129
|
+
options: params[:request_options]
|
|
130
|
+
)
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# @api private
|
|
134
|
+
#
|
|
135
|
+
# @param client [WhopSDK::Client]
|
|
136
|
+
def initialize(client:)
|
|
137
|
+
@client = client
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
@@ -14,7 +14,7 @@ module WhopSDK
|
|
|
14
14
|
#
|
|
15
15
|
# @overload create(attachment:, checksum:, platform:, ai_prompt_id: nil, app_id: nil, supported_app_view_types: nil, request_options: {})
|
|
16
16
|
#
|
|
17
|
-
# @param attachment [WhopSDK::Models::AppBuildCreateParams::Attachment
|
|
17
|
+
# @param attachment [WhopSDK::Models::AppBuildCreateParams::Attachment] Attachment input for the app build file. This should be an upload in .zip format
|
|
18
18
|
#
|
|
19
19
|
# @param checksum [String] Checksum of the app build file. This is generated by the client and used to veri
|
|
20
20
|
#
|
|
@@ -10,7 +10,7 @@ module WhopSDK
|
|
|
10
10
|
# - `developer:create_app`
|
|
11
11
|
# - `developer:manage_api_key`
|
|
12
12
|
#
|
|
13
|
-
# @overload create(company_id:, name:, base_url: nil, request_options: {})
|
|
13
|
+
# @overload create(company_id:, name:, base_url: nil, icon: nil, request_options: {})
|
|
14
14
|
#
|
|
15
15
|
# @param company_id [String] The ID of the company to create the app for
|
|
16
16
|
#
|
|
@@ -18,6 +18,8 @@ module WhopSDK
|
|
|
18
18
|
#
|
|
19
19
|
# @param base_url [String, nil] The base URL of the app to be created
|
|
20
20
|
#
|
|
21
|
+
# @param icon [WhopSDK::Models::AppCreateParams::Icon, nil] The icon for the app in png, jpeg, or gif format
|
|
22
|
+
#
|
|
21
23
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
24
|
#
|
|
23
25
|
# @return [WhopSDK::Models::App]
|
|
@@ -77,7 +79,7 @@ module WhopSDK
|
|
|
77
79
|
#
|
|
78
80
|
# @param experience_path [String, nil] The path for the hub view of the app
|
|
79
81
|
#
|
|
80
|
-
# @param icon [WhopSDK::Models::AppUpdateParams::Icon
|
|
82
|
+
# @param icon [WhopSDK::Models::AppUpdateParams::Icon, nil] The icon for the app
|
|
81
83
|
#
|
|
82
84
|
# @param name [String, nil] The name of the app
|
|
83
85
|
#
|
|
@@ -16,7 +16,7 @@ module WhopSDK
|
|
|
16
16
|
# - `access_pass:update`
|
|
17
17
|
# - `checkout_configuration:basic:read`
|
|
18
18
|
#
|
|
19
|
-
# @overload create(plan:, plan_id:, company_id:, affiliate_code: nil, currency: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, mode: :setup, request_options: {})
|
|
19
|
+
# @overload create(plan:, plan_id:, company_id:, affiliate_code: nil, currency: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, source_url: nil, mode: :setup, request_options: {})
|
|
20
20
|
#
|
|
21
21
|
# @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan] Pass this object to create a new plan for this checkout configuration
|
|
22
22
|
#
|
|
@@ -34,6 +34,8 @@ module WhopSDK
|
|
|
34
34
|
#
|
|
35
35
|
# @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
|
|
36
36
|
#
|
|
37
|
+
# @param source_url [String, nil] The URL of the page where the checkout is being initiated from.
|
|
38
|
+
#
|
|
37
39
|
# @param mode [Symbol, :setup]
|
|
38
40
|
#
|
|
39
41
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -13,7 +13,7 @@ module WhopSDK
|
|
|
13
13
|
# - `company:create_child`
|
|
14
14
|
# - `company:basic:read`
|
|
15
15
|
#
|
|
16
|
-
# @overload create(email:, parent_company_id:, title:, business_type: nil, industry_type: nil, metadata: nil, send_customer_emails: nil, request_options: {})
|
|
16
|
+
# @overload create(email:, parent_company_id:, title:, business_type: nil, industry_type: nil, logo: nil, metadata: nil, send_customer_emails: nil, request_options: {})
|
|
17
17
|
#
|
|
18
18
|
# @param email [String] The email of the user who the company will belong to.
|
|
19
19
|
#
|
|
@@ -25,6 +25,8 @@ module WhopSDK
|
|
|
25
25
|
#
|
|
26
26
|
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
27
27
|
#
|
|
28
|
+
# @param logo [WhopSDK::Models::CompanyCreateParams::Logo, nil] The logo for the company in png, jpeg, or gif format
|
|
29
|
+
#
|
|
28
30
|
# @param metadata [Hash{Symbol=>Object}, nil] Additional metadata for the account
|
|
29
31
|
#
|
|
30
32
|
# @param send_customer_emails [Boolean, nil] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
@@ -84,13 +86,13 @@ module WhopSDK
|
|
|
84
86
|
#
|
|
85
87
|
# @param id [String] The ID of the company to update
|
|
86
88
|
#
|
|
87
|
-
# @param banner_image [WhopSDK::Models::CompanyUpdateParams::BannerImage
|
|
89
|
+
# @param banner_image [WhopSDK::Models::CompanyUpdateParams::BannerImage, nil] The banner image for the company in png or jpeg format
|
|
88
90
|
#
|
|
89
91
|
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
90
92
|
#
|
|
91
93
|
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
92
94
|
#
|
|
93
|
-
# @param logo [WhopSDK::Models::CompanyUpdateParams::Logo
|
|
95
|
+
# @param logo [WhopSDK::Models::CompanyUpdateParams::Logo, nil] The logo for the company in png, jpeg, or gif format
|
|
94
96
|
#
|
|
95
97
|
# @param send_customer_emails [Boolean, nil] Whether Whop sends transactional emails to customers on behalf of this company.
|
|
96
98
|
#
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class CompanyTokenTransactions
|
|
6
|
+
# Create a token transaction (add/subtract/transfer) for a member
|
|
7
|
+
#
|
|
8
|
+
# Required permissions:
|
|
9
|
+
#
|
|
10
|
+
# - `company_token_transaction:create`
|
|
11
|
+
# - `member:basic:read`
|
|
12
|
+
# - `company:basic:read`
|
|
13
|
+
#
|
|
14
|
+
# @overload create(amount:, company_id:, destination_user_id:, user_id:, description: nil, idempotency_key: nil, transaction_type: :subtract, request_options: {})
|
|
15
|
+
#
|
|
16
|
+
# @param amount [Float] The positive amount of tokens
|
|
17
|
+
#
|
|
18
|
+
# @param company_id [String] The company ID
|
|
19
|
+
#
|
|
20
|
+
# @param destination_user_id [String] Required for transfers - the user to receive tokens
|
|
21
|
+
#
|
|
22
|
+
# @param user_id [String] The user ID whose balance will change
|
|
23
|
+
#
|
|
24
|
+
# @param description [String, nil] Optional description for the transaction
|
|
25
|
+
#
|
|
26
|
+
# @param idempotency_key [String, nil] Optional key to prevent duplicate transactions
|
|
27
|
+
#
|
|
28
|
+
# @param transaction_type [Symbol, :subtract]
|
|
29
|
+
#
|
|
30
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
31
|
+
#
|
|
32
|
+
# @return [WhopSDK::Models::CompanyTokenTransactionCreateResponse]
|
|
33
|
+
#
|
|
34
|
+
# @see WhopSDK::Models::CompanyTokenTransactionCreateParams
|
|
35
|
+
def create(params)
|
|
36
|
+
parsed, options = WhopSDK::CompanyTokenTransactionCreateParams.dump_request(params)
|
|
37
|
+
@client.request(
|
|
38
|
+
method: :post,
|
|
39
|
+
path: "company_token_transactions",
|
|
40
|
+
body: parsed,
|
|
41
|
+
model: WhopSDK::Models::CompanyTokenTransactionCreateResponse,
|
|
42
|
+
options: options
|
|
43
|
+
)
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
# Retrieves a token transaction by ID
|
|
47
|
+
#
|
|
48
|
+
# Required permissions:
|
|
49
|
+
#
|
|
50
|
+
# - `company_token_transaction:read`
|
|
51
|
+
# - `member:basic:read`
|
|
52
|
+
# - `company:basic:read`
|
|
53
|
+
#
|
|
54
|
+
# @overload retrieve(id, request_options: {})
|
|
55
|
+
#
|
|
56
|
+
# @param id [String] The ID of the transaction
|
|
57
|
+
#
|
|
58
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
59
|
+
#
|
|
60
|
+
# @return [WhopSDK::Models::CompanyTokenTransactionRetrieveResponse]
|
|
61
|
+
#
|
|
62
|
+
# @see WhopSDK::Models::CompanyTokenTransactionRetrieveParams
|
|
63
|
+
def retrieve(id, params = {})
|
|
64
|
+
@client.request(
|
|
65
|
+
method: :get,
|
|
66
|
+
path: ["company_token_transactions/%1$s", id],
|
|
67
|
+
model: WhopSDK::Models::CompanyTokenTransactionRetrieveResponse,
|
|
68
|
+
options: params[:request_options]
|
|
69
|
+
)
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# Lists token transactions for a company
|
|
73
|
+
#
|
|
74
|
+
# Required permissions:
|
|
75
|
+
#
|
|
76
|
+
# - `company_token_transaction:read`
|
|
77
|
+
# - `member:basic:read`
|
|
78
|
+
# - `company:basic:read`
|
|
79
|
+
#
|
|
80
|
+
# @overload list(company_id:, after: nil, before: nil, first: nil, last: nil, transaction_type: nil, user_id: nil, request_options: {})
|
|
81
|
+
#
|
|
82
|
+
# @param company_id [String] The ID of the company
|
|
83
|
+
#
|
|
84
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
85
|
+
#
|
|
86
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
87
|
+
#
|
|
88
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
89
|
+
#
|
|
90
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
91
|
+
#
|
|
92
|
+
# @param transaction_type [Symbol, WhopSDK::Models::CompanyTokenTransactionListParams::TransactionType, nil] The type of token transaction
|
|
93
|
+
#
|
|
94
|
+
# @param user_id [String, nil] Filter by user ID
|
|
95
|
+
#
|
|
96
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
97
|
+
#
|
|
98
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::CompanyTokenTransactionListResponse>]
|
|
99
|
+
#
|
|
100
|
+
# @see WhopSDK::Models::CompanyTokenTransactionListParams
|
|
101
|
+
def list(params)
|
|
102
|
+
parsed, options = WhopSDK::CompanyTokenTransactionListParams.dump_request(params)
|
|
103
|
+
@client.request(
|
|
104
|
+
method: :get,
|
|
105
|
+
path: "company_token_transactions",
|
|
106
|
+
query: parsed,
|
|
107
|
+
page: WhopSDK::Internal::CursorPage,
|
|
108
|
+
model: WhopSDK::Models::CompanyTokenTransactionListResponse,
|
|
109
|
+
options: options
|
|
110
|
+
)
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# @api private
|
|
114
|
+
#
|
|
115
|
+
# @param client [WhopSDK::Client]
|
|
116
|
+
def initialize(client:)
|
|
117
|
+
@client = client
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
end
|
|
121
|
+
end
|
|
@@ -23,7 +23,7 @@ module WhopSDK
|
|
|
23
23
|
#
|
|
24
24
|
# @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
|
|
25
25
|
#
|
|
26
|
-
# @param thumbnail [WhopSDK::Models::CourseLessonCreateParams::Thumbnail
|
|
26
|
+
# @param thumbnail [WhopSDK::Models::CourseLessonCreateParams::Thumbnail, nil] The thumbnail for the lesson in png, jpeg, or gif format
|
|
27
27
|
#
|
|
28
28
|
# @param title [String, nil] The title of the lesson
|
|
29
29
|
#
|
|
@@ -84,7 +84,7 @@ module WhopSDK
|
|
|
84
84
|
#
|
|
85
85
|
# @param assessment_questions [Array<WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion>, nil] Assessment questions for quiz/knowledge check lessons. Replaces all existing que
|
|
86
86
|
#
|
|
87
|
-
# @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment
|
|
87
|
+
# @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment>, nil] General attachments for the lesson (PDFs, files, etc). Replaces all existing att
|
|
88
88
|
#
|
|
89
89
|
# @param content [String, nil] The content of the lesson
|
|
90
90
|
#
|
|
@@ -96,13 +96,13 @@ module WhopSDK
|
|
|
96
96
|
#
|
|
97
97
|
# @param lesson_type [Symbol, WhopSDK::Models::LessonTypes, nil] The available types for a lesson
|
|
98
98
|
#
|
|
99
|
-
# @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf
|
|
99
|
+
# @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf, nil] The main PDF file for this lesson
|
|
100
100
|
#
|
|
101
101
|
# @param max_attempts [Integer, nil] Maximum number of attempts allowed for assessments
|
|
102
102
|
#
|
|
103
103
|
# @param mux_asset_id [String, nil] The ID of the Mux asset to attach to this lesson for video lessons
|
|
104
104
|
#
|
|
105
|
-
# @param thumbnail [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail
|
|
105
|
+
# @param thumbnail [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail, nil] The thumbnail for the lesson in png, jpeg, or gif format
|
|
106
106
|
#
|
|
107
107
|
# @param title [String, nil] The title of the lesson
|
|
108
108
|
#
|
|
@@ -12,7 +12,7 @@ module WhopSDK
|
|
|
12
12
|
#
|
|
13
13
|
# - `courses:update`
|
|
14
14
|
#
|
|
15
|
-
# @overload create(experience_id:, title:, certificate_after_completion_enabled: nil,
|
|
15
|
+
# @overload create(experience_id:, title:, certificate_after_completion_enabled: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, visibility: nil, request_options: {})
|
|
16
16
|
#
|
|
17
17
|
# @param experience_id [String] The ID of the experience to create the course in
|
|
18
18
|
#
|
|
@@ -20,15 +20,13 @@ module WhopSDK
|
|
|
20
20
|
#
|
|
21
21
|
# @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
|
|
22
22
|
#
|
|
23
|
-
# @param cover_image [String, nil] The cover image URL of the course
|
|
24
|
-
#
|
|
25
23
|
# @param order [String, nil] The decimal order position of the course within its experience. If not provided,
|
|
26
24
|
#
|
|
27
25
|
# @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
|
|
28
26
|
#
|
|
29
27
|
# @param tagline [String, nil] The tagline of the course
|
|
30
28
|
#
|
|
31
|
-
# @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail
|
|
29
|
+
# @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
|
|
32
30
|
#
|
|
33
31
|
# @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
|
|
34
32
|
#
|
|
@@ -81,7 +79,7 @@ module WhopSDK
|
|
|
81
79
|
#
|
|
82
80
|
# - `courses:update`
|
|
83
81
|
#
|
|
84
|
-
# @overload update(id, certificate_after_completion_enabled: nil, chapters: nil,
|
|
82
|
+
# @overload update(id, certificate_after_completion_enabled: nil, chapters: nil, description: nil, language: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
|
|
85
83
|
#
|
|
86
84
|
# @param id [String] The ID of the course to update
|
|
87
85
|
#
|
|
@@ -89,8 +87,6 @@ module WhopSDK
|
|
|
89
87
|
#
|
|
90
88
|
# @param chapters [Array<WhopSDK::Models::CourseUpdateParams::Chapter>, nil] The chapters and lessons to update
|
|
91
89
|
#
|
|
92
|
-
# @param cover_image [String, nil] The cover image URL of the course
|
|
93
|
-
#
|
|
94
90
|
# @param description [String, nil] A short description of the course
|
|
95
91
|
#
|
|
96
92
|
# @param language [Symbol, WhopSDK::Models::Languages, nil] The available languages for a course
|
|
@@ -101,7 +97,7 @@ module WhopSDK
|
|
|
101
97
|
#
|
|
102
98
|
# @param tagline [String, nil] A short tagline for the course
|
|
103
99
|
#
|
|
104
|
-
# @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail
|
|
100
|
+
# @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
|
|
105
101
|
#
|
|
106
102
|
# @param title [String, nil] The title of the course
|
|
107
103
|
#
|