whop_sdk 0.0.2
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 +7 -0
- data/.ignore +2 -0
- data/CHANGELOG.md +116 -0
- data/README.md +266 -0
- data/SECURITY.md +23 -0
- data/lib/whop_sdk/client.rb +212 -0
- data/lib/whop_sdk/errors.rb +228 -0
- data/lib/whop_sdk/file_part.rb +58 -0
- data/lib/whop_sdk/helpers/verify_user_token.rb +102 -0
- data/lib/whop_sdk/internal/cursor_page.rb +101 -0
- data/lib/whop_sdk/internal/transport/base_client.rb +567 -0
- data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +198 -0
- data/lib/whop_sdk/internal/type/array_of.rb +168 -0
- data/lib/whop_sdk/internal/type/base_model.rb +531 -0
- data/lib/whop_sdk/internal/type/base_page.rb +55 -0
- data/lib/whop_sdk/internal/type/boolean.rb +77 -0
- data/lib/whop_sdk/internal/type/converter.rb +327 -0
- data/lib/whop_sdk/internal/type/enum.rb +156 -0
- data/lib/whop_sdk/internal/type/file_input.rb +111 -0
- data/lib/whop_sdk/internal/type/hash_of.rb +188 -0
- data/lib/whop_sdk/internal/type/request_parameters.rb +42 -0
- data/lib/whop_sdk/internal/type/union.rb +250 -0
- data/lib/whop_sdk/internal/type/unknown.rb +81 -0
- data/lib/whop_sdk/internal/util.rb +915 -0
- data/lib/whop_sdk/internal.rb +20 -0
- data/lib/whop_sdk/models/access_level.rb +17 -0
- data/lib/whop_sdk/models/access_pass_type.rb +18 -0
- data/lib/whop_sdk/models/app.rb +351 -0
- data/lib/whop_sdk/models/app_build.rb +88 -0
- data/lib/whop_sdk/models/app_build_create_params.rb +95 -0
- data/lib/whop_sdk/models/app_build_list_params.rb +70 -0
- data/lib/whop_sdk/models/app_build_list_response.rb +89 -0
- data/lib/whop_sdk/models/app_build_platforms.rb +17 -0
- data/lib/whop_sdk/models/app_build_promote_params.rb +14 -0
- data/lib/whop_sdk/models/app_build_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/app_build_statuses.rb +18 -0
- data/lib/whop_sdk/models/app_create_params.rb +38 -0
- data/lib/whop_sdk/models/app_list_params.rb +112 -0
- data/lib/whop_sdk/models/app_list_response.rb +200 -0
- data/lib/whop_sdk/models/app_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/app_statuses.rb +17 -0
- data/lib/whop_sdk/models/app_update_params.rb +134 -0
- data/lib/whop_sdk/models/app_view_type.rb +19 -0
- data/lib/whop_sdk/models/authorized_user_list_params.rb +70 -0
- data/lib/whop_sdk/models/authorized_user_list_response.rb +73 -0
- data/lib/whop_sdk/models/authorized_user_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/authorized_user_retrieve_response.rb +73 -0
- data/lib/whop_sdk/models/authorized_user_roles.rb +21 -0
- data/lib/whop_sdk/models/business_types.rb +28 -0
- data/lib/whop_sdk/models/chat_channel.rb +96 -0
- data/lib/whop_sdk/models/chat_channel_list_params.rb +62 -0
- data/lib/whop_sdk/models/chat_channel_list_response.rb +97 -0
- data/lib/whop_sdk/models/chat_channel_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/chat_channel_update_params.rb +62 -0
- data/lib/whop_sdk/models/checkout_configuration.rb +156 -0
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +293 -0
- data/lib/whop_sdk/models/checkout_configuration_list_params.rb +70 -0
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +157 -0
- data/lib/whop_sdk/models/checkout_configuration_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/collection_method.rb +16 -0
- data/lib/whop_sdk/models/company.rb +218 -0
- data/lib/whop_sdk/models/company_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/course_lesson_interaction.rb +154 -0
- data/lib/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/course_lesson_interaction_list_item.rb +102 -0
- data/lib/whop_sdk/models/course_lesson_interaction_list_params.rb +78 -0
- data/lib/whop_sdk/models/course_lesson_interaction_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/currency.rb +98 -0
- data/lib/whop_sdk/models/custom_cta.rb +27 -0
- data/lib/whop_sdk/models/direction.rb +16 -0
- data/lib/whop_sdk/models/dms_post_types.rb +17 -0
- data/lib/whop_sdk/models/email_notification_preferences.rb +17 -0
- data/lib/whop_sdk/models/entry.rb +171 -0
- data/lib/whop_sdk/models/entry_approve_params.rb +14 -0
- data/lib/whop_sdk/models/entry_approve_response.rb +19 -0
- data/lib/whop_sdk/models/entry_approved_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/entry_created_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/entry_deleted_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/entry_denied_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/entry_deny_params.rb +14 -0
- data/lib/whop_sdk/models/entry_list_params.rb +105 -0
- data/lib/whop_sdk/models/entry_list_response.rb +133 -0
- data/lib/whop_sdk/models/entry_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/entry_status.rb +19 -0
- data/lib/whop_sdk/models/experience.rb +210 -0
- data/lib/whop_sdk/models/experience_attach_params.rb +22 -0
- data/lib/whop_sdk/models/experience_create_params.rb +46 -0
- data/lib/whop_sdk/models/experience_delete_params.rb +14 -0
- data/lib/whop_sdk/models/experience_delete_response.rb +8 -0
- data/lib/whop_sdk/models/experience_detach_params.rb +22 -0
- data/lib/whop_sdk/models/experience_list_params.rb +70 -0
- data/lib/whop_sdk/models/experience_list_response.rb +168 -0
- data/lib/whop_sdk/models/experience_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/experience_update_params.rb +93 -0
- data/lib/whop_sdk/models/forum.rb +72 -0
- data/lib/whop_sdk/models/forum_list_params.rb +62 -0
- data/lib/whop_sdk/models/forum_list_response.rb +73 -0
- data/lib/whop_sdk/models/forum_post.rb +128 -0
- data/lib/whop_sdk/models/forum_post_create_params.rb +166 -0
- data/lib/whop_sdk/models/forum_post_list_params.rb +70 -0
- data/lib/whop_sdk/models/forum_post_list_response.rb +129 -0
- data/lib/whop_sdk/models/forum_post_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/forum_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/forum_update_params.rb +38 -0
- data/lib/whop_sdk/models/friendly_receipt_status.rb +30 -0
- data/lib/whop_sdk/models/global_affiliate_status.rb +16 -0
- data/lib/whop_sdk/models/industry_types.rb +73 -0
- data/lib/whop_sdk/models/invoice.rb +142 -0
- data/lib/whop_sdk/models/invoice_create_params.rb +288 -0
- data/lib/whop_sdk/models/invoice_create_response.rb +27 -0
- data/lib/whop_sdk/models/invoice_created_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/invoice_list_item.rb +142 -0
- data/lib/whop_sdk/models/invoice_list_params.rb +121 -0
- data/lib/whop_sdk/models/invoice_paid_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/invoice_past_due_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/invoice_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/invoice_status.rb +18 -0
- data/lib/whop_sdk/models/invoice_void_params.rb +14 -0
- data/lib/whop_sdk/models/invoice_void_response.rb +8 -0
- data/lib/whop_sdk/models/invoice_voided_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/ledger_account_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +242 -0
- data/lib/whop_sdk/models/member_list_params.rb +162 -0
- data/lib/whop_sdk/models/member_list_response.rb +145 -0
- data/lib/whop_sdk/models/member_most_recent_actions.rb +28 -0
- data/lib/whop_sdk/models/member_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/member_retrieve_response.rb +183 -0
- data/lib/whop_sdk/models/member_statuses.rb +17 -0
- data/lib/whop_sdk/models/membership.rb +264 -0
- data/lib/whop_sdk/models/membership_activated_webhook_event.rb +52 -0
- data/lib/whop_sdk/models/membership_cancel_params.rb +33 -0
- data/lib/whop_sdk/models/membership_deactivated_webhook_event.rb +52 -0
- data/lib/whop_sdk/models/membership_list_params.rb +160 -0
- data/lib/whop_sdk/models/membership_list_response.rb +265 -0
- data/lib/whop_sdk/models/membership_pause_params.rb +26 -0
- data/lib/whop_sdk/models/membership_resume_params.rb +14 -0
- data/lib/whop_sdk/models/membership_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/membership_status.rb +22 -0
- data/lib/whop_sdk/models/membership_update_params.rb +22 -0
- data/lib/whop_sdk/models/message.rb +221 -0
- data/lib/whop_sdk/models/message_create_params.rb +110 -0
- data/lib/whop_sdk/models/message_list_params.rb +62 -0
- data/lib/whop_sdk/models/message_list_response.rb +226 -0
- data/lib/whop_sdk/models/message_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/page_info.rb +42 -0
- data/lib/whop_sdk/models/payment.rb +534 -0
- data/lib/whop_sdk/models/payment_failed_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/payment_list_params.rb +173 -0
- data/lib/whop_sdk/models/payment_list_response.rb +535 -0
- data/lib/whop_sdk/models/payment_pending_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/payment_refund_params.rb +22 -0
- data/lib/whop_sdk/models/payment_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/payment_retry_params.rb +14 -0
- data/lib/whop_sdk/models/payment_succeeded_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/payment_void_params.rb +14 -0
- data/lib/whop_sdk/models/plan.rb +297 -0
- data/lib/whop_sdk/models/plan_create_params.rb +238 -0
- data/lib/whop_sdk/models/plan_delete_params.rb +14 -0
- data/lib/whop_sdk/models/plan_delete_response.rb +8 -0
- data/lib/whop_sdk/models/plan_list_params.rb +120 -0
- data/lib/whop_sdk/models/plan_list_response.rb +221 -0
- data/lib/whop_sdk/models/plan_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/plan_type.rb +16 -0
- data/lib/whop_sdk/models/plan_update_params.rb +211 -0
- data/lib/whop_sdk/models/product.rb +303 -0
- data/lib/whop_sdk/models/product_create_params.rb +406 -0
- data/lib/whop_sdk/models/product_delete_params.rb +14 -0
- data/lib/whop_sdk/models/product_delete_response.rb +8 -0
- data/lib/whop_sdk/models/product_list_item.rb +106 -0
- data/lib/whop_sdk/models/product_list_params.rb +103 -0
- data/lib/whop_sdk/models/product_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/product_update_params.rb +192 -0
- data/lib/whop_sdk/models/promo_type.rb +16 -0
- data/lib/whop_sdk/models/reaction.rb +72 -0
- data/lib/whop_sdk/models/reaction_create_params.rb +34 -0
- data/lib/whop_sdk/models/reaction_list_params.rb +54 -0
- data/lib/whop_sdk/models/reaction_list_response.rb +73 -0
- data/lib/whop_sdk/models/reaction_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/receipt_status.rb +21 -0
- data/lib/whop_sdk/models/release_method.rb +16 -0
- data/lib/whop_sdk/models/shipment.rb +104 -0
- data/lib/whop_sdk/models/shipment_carrier.rb +90 -0
- data/lib/whop_sdk/models/shipment_create_params.rb +38 -0
- data/lib/whop_sdk/models/shipment_list_params.rb +70 -0
- data/lib/whop_sdk/models/shipment_list_response.rb +105 -0
- data/lib/whop_sdk/models/shipment_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/shipment_status.rb +24 -0
- data/lib/whop_sdk/models/shipment_substatus.rb +42 -0
- data/lib/whop_sdk/models/support_channel.rb +88 -0
- data/lib/whop_sdk/models/support_channel_create_params.rb +30 -0
- data/lib/whop_sdk/models/support_channel_list_params.rb +94 -0
- data/lib/whop_sdk/models/support_channel_list_response.rb +89 -0
- data/lib/whop_sdk/models/support_channel_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/tax_type.rb +18 -0
- data/lib/whop_sdk/models/transfer.rb +274 -0
- data/lib/whop_sdk/models/transfer_create_params.rb +67 -0
- data/lib/whop_sdk/models/transfer_list_params.rb +94 -0
- data/lib/whop_sdk/models/transfer_list_response.rb +75 -0
- data/lib/whop_sdk/models/transfer_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +40 -0
- data/lib/whop_sdk/models/user_check_access_params.rb +20 -0
- data/lib/whop_sdk/models/user_check_access_response.rb +27 -0
- data/lib/whop_sdk/models/user_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/user_retrieve_response.rb +77 -0
- data/lib/whop_sdk/models/visibility.rb +18 -0
- data/lib/whop_sdk/models/visibility_filter.rb +21 -0
- data/lib/whop_sdk/models/webhook_unwrap_params.rb +14 -0
- data/lib/whop_sdk/models/who_can_comment_types.rb +16 -0
- data/lib/whop_sdk/models/who_can_post.rb +16 -0
- data/lib/whop_sdk/models/who_can_post_types.rb +16 -0
- data/lib/whop_sdk/models/who_can_react.rb +16 -0
- data/lib/whop_sdk/models.rb +356 -0
- data/lib/whop_sdk/request_options.rb +77 -0
- data/lib/whop_sdk/resources/app_builds.rb +136 -0
- data/lib/whop_sdk/resources/apps.rb +153 -0
- data/lib/whop_sdk/resources/authorized_users.rb +78 -0
- data/lib/whop_sdk/resources/chat_channels.rb +112 -0
- data/lib/whop_sdk/resources/checkout_configurations.rb +111 -0
- data/lib/whop_sdk/resources/companies.rb +37 -0
- data/lib/whop_sdk/resources/course_lesson_interactions.rb +80 -0
- data/lib/whop_sdk/resources/entries.rb +132 -0
- data/lib/whop_sdk/resources/experiences.rb +215 -0
- data/lib/whop_sdk/resources/forum_posts.rb +123 -0
- data/lib/whop_sdk/resources/forums.rb +106 -0
- data/lib/whop_sdk/resources/invoices.rb +153 -0
- data/lib/whop_sdk/resources/ledger_accounts.rb +37 -0
- data/lib/whop_sdk/resources/members.rb +101 -0
- data/lib/whop_sdk/resources/memberships.rb +205 -0
- data/lib/whop_sdk/resources/messages.rb +106 -0
- data/lib/whop_sdk/resources/payments.rb +198 -0
- data/lib/whop_sdk/resources/plans.rb +223 -0
- data/lib/whop_sdk/resources/products.rb +245 -0
- data/lib/whop_sdk/resources/reactions.rb +103 -0
- data/lib/whop_sdk/resources/shipments.rb +109 -0
- data/lib/whop_sdk/resources/support_channels.rb +110 -0
- data/lib/whop_sdk/resources/transfers.rb +120 -0
- data/lib/whop_sdk/resources/users.rb +58 -0
- data/lib/whop_sdk/resources/webhooks.rb +22 -0
- data/lib/whop_sdk/version.rb +5 -0
- data/lib/whop_sdk.rb +266 -0
- data/manifest.yaml +15 -0
- data/rbi/whop_sdk/client.rbi +129 -0
- data/rbi/whop_sdk/errors.rbi +205 -0
- data/rbi/whop_sdk/file_part.rbi +37 -0
- data/rbi/whop_sdk/internal/cursor_page.rbi +40 -0
- data/rbi/whop_sdk/internal/transport/base_client.rbi +292 -0
- data/rbi/whop_sdk/internal/transport/pooled_net_requester.rbi +79 -0
- data/rbi/whop_sdk/internal/type/array_of.rbi +104 -0
- data/rbi/whop_sdk/internal/type/base_model.rbi +302 -0
- data/rbi/whop_sdk/internal/type/base_page.rbi +42 -0
- data/rbi/whop_sdk/internal/type/boolean.rbi +58 -0
- data/rbi/whop_sdk/internal/type/converter.rbi +216 -0
- data/rbi/whop_sdk/internal/type/enum.rbi +82 -0
- data/rbi/whop_sdk/internal/type/file_input.rbi +59 -0
- data/rbi/whop_sdk/internal/type/hash_of.rbi +104 -0
- data/rbi/whop_sdk/internal/type/request_parameters.rbi +29 -0
- data/rbi/whop_sdk/internal/type/union.rbi +128 -0
- data/rbi/whop_sdk/internal/type/unknown.rbi +58 -0
- data/rbi/whop_sdk/internal/util.rbi +484 -0
- data/rbi/whop_sdk/internal.rbi +16 -0
- data/rbi/whop_sdk/models/access_level.rbi +21 -0
- data/rbi/whop_sdk/models/access_pass_type.rbi +23 -0
- data/rbi/whop_sdk/models/app.rbi +487 -0
- data/rbi/whop_sdk/models/app_build.rbi +107 -0
- data/rbi/whop_sdk/models/app_build_create_params.rbi +147 -0
- data/rbi/whop_sdk/models/app_build_list_params.rbi +91 -0
- data/rbi/whop_sdk/models/app_build_list_response.rbi +112 -0
- data/rbi/whop_sdk/models/app_build_platforms.rbi +23 -0
- data/rbi/whop_sdk/models/app_build_promote_params.rbi +27 -0
- data/rbi/whop_sdk/models/app_build_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/app_build_statuses.rbi +24 -0
- data/rbi/whop_sdk/models/app_create_params.rbi +59 -0
- data/rbi/whop_sdk/models/app_list_params.rbi +154 -0
- data/rbi/whop_sdk/models/app_list_response.rbi +280 -0
- data/rbi/whop_sdk/models/app_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/app_statuses.rbi +21 -0
- data/rbi/whop_sdk/models/app_update_params.rbi +201 -0
- data/rbi/whop_sdk/models/app_view_type.rbi +23 -0
- data/rbi/whop_sdk/models/authorized_user_list_params.rbi +91 -0
- data/rbi/whop_sdk/models/authorized_user_list_response.rbi +124 -0
- data/rbi/whop_sdk/models/authorized_user_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/authorized_user_retrieve_response.rbi +124 -0
- data/rbi/whop_sdk/models/authorized_user_roles.rbi +30 -0
- data/rbi/whop_sdk/models/business_types.rbi +36 -0
- data/rbi/whop_sdk/models/chat_channel.rbi +124 -0
- data/rbi/whop_sdk/models/chat_channel_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/chat_channel_list_response.rbi +138 -0
- data/rbi/whop_sdk/models/chat_channel_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/chat_channel_update_params.rbi +83 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +201 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +427 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_params.rbi +94 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +209 -0
- data/rbi/whop_sdk/models/checkout_configuration_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/collection_method.rbi +24 -0
- data/rbi/whop_sdk/models/company.rbi +307 -0
- data/rbi/whop_sdk/models/company_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_lesson_interaction.rbi +256 -0
- data/rbi/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rbi +75 -0
- data/rbi/whop_sdk/models/course_lesson_interaction_list_item.rbi +165 -0
- data/rbi/whop_sdk/models/course_lesson_interaction_list_params.rbi +102 -0
- data/rbi/whop_sdk/models/course_lesson_interaction_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/currency.rbi +102 -0
- data/rbi/whop_sdk/models/custom_cta.rbi +31 -0
- data/rbi/whop_sdk/models/direction.rbi +20 -0
- data/rbi/whop_sdk/models/dms_post_types.rbi +21 -0
- data/rbi/whop_sdk/models/email_notification_preferences.rbi +34 -0
- data/rbi/whop_sdk/models/entry.rbi +248 -0
- data/rbi/whop_sdk/models/entry_approve_params.rbi +27 -0
- data/rbi/whop_sdk/models/entry_approve_response.rbi +31 -0
- data/rbi/whop_sdk/models/entry_approved_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/entry_created_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/entry_deleted_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/entry_denied_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/entry_deny_params.rbi +27 -0
- data/rbi/whop_sdk/models/entry_list_params.rbi +136 -0
- data/rbi/whop_sdk/models/entry_list_response.rbi +217 -0
- data/rbi/whop_sdk/models/entry_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/entry_status.rbi +23 -0
- data/rbi/whop_sdk/models/experience.rbi +292 -0
- data/rbi/whop_sdk/models/experience_attach_params.rbi +40 -0
- data/rbi/whop_sdk/models/experience_create_params.rbi +67 -0
- data/rbi/whop_sdk/models/experience_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/experience_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/experience_detach_params.rbi +40 -0
- data/rbi/whop_sdk/models/experience_list_params.rbi +91 -0
- data/rbi/whop_sdk/models/experience_list_response.rbi +279 -0
- data/rbi/whop_sdk/models/experience_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/experience_update_params.rbi +167 -0
- data/rbi/whop_sdk/models/forum.rbi +102 -0
- data/rbi/whop_sdk/models/forum_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/forum_list_response.rbi +111 -0
- data/rbi/whop_sdk/models/forum_post.rbi +162 -0
- data/rbi/whop_sdk/models/forum_post_create_params.rbi +254 -0
- data/rbi/whop_sdk/models/forum_post_list_params.rbi +91 -0
- data/rbi/whop_sdk/models/forum_post_list_response.rbi +172 -0
- data/rbi/whop_sdk/models/forum_post_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/forum_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/forum_update_params.rbi +63 -0
- data/rbi/whop_sdk/models/friendly_receipt_status.rbi +47 -0
- data/rbi/whop_sdk/models/global_affiliate_status.rbi +23 -0
- data/rbi/whop_sdk/models/industry_types.rbi +97 -0
- data/rbi/whop_sdk/models/invoice.rbi +198 -0
- data/rbi/whop_sdk/models/invoice_create_params.rbi +401 -0
- data/rbi/whop_sdk/models/invoice_create_response.rbi +49 -0
- data/rbi/whop_sdk/models/invoice_created_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/invoice_list_item.rbi +207 -0
- data/rbi/whop_sdk/models/invoice_list_params.rbi +185 -0
- data/rbi/whop_sdk/models/invoice_paid_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/invoice_past_due_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/invoice_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/invoice_status.rbi +22 -0
- data/rbi/whop_sdk/models/invoice_void_params.rbi +27 -0
- data/rbi/whop_sdk/models/invoice_void_response.rbi +7 -0
- data/rbi/whop_sdk/models/invoice_voided_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/ledger_account_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +457 -0
- data/rbi/whop_sdk/models/member_list_params.rbi +202 -0
- data/rbi/whop_sdk/models/member_list_response.rbi +195 -0
- data/rbi/whop_sdk/models/member_most_recent_actions.rbi +49 -0
- data/rbi/whop_sdk/models/member_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +255 -0
- data/rbi/whop_sdk/models/member_statuses.rbi +21 -0
- data/rbi/whop_sdk/models/membership.rbi +351 -0
- data/rbi/whop_sdk/models/membership_activated_webhook_event.rbi +77 -0
- data/rbi/whop_sdk/models/membership_cancel_params.rbi +85 -0
- data/rbi/whop_sdk/models/membership_deactivated_webhook_event.rbi +77 -0
- data/rbi/whop_sdk/models/membership_list_params.rbi +253 -0
- data/rbi/whop_sdk/models/membership_list_response.rbi +396 -0
- data/rbi/whop_sdk/models/membership_pause_params.rbi +45 -0
- data/rbi/whop_sdk/models/membership_resume_params.rbi +27 -0
- data/rbi/whop_sdk/models/membership_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/membership_status.rbi +28 -0
- data/rbi/whop_sdk/models/membership_update_params.rbi +43 -0
- data/rbi/whop_sdk/models/message.rbi +309 -0
- data/rbi/whop_sdk/models/message_create_params.rbi +194 -0
- data/rbi/whop_sdk/models/message_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/message_list_response.rbi +359 -0
- data/rbi/whop_sdk/models/message_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/page_info.rbi +60 -0
- data/rbi/whop_sdk/models/payment.rbi +691 -0
- data/rbi/whop_sdk/models/payment_failed_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/payment_list_params.rbi +253 -0
- data/rbi/whop_sdk/models/payment_list_response.rbi +769 -0
- data/rbi/whop_sdk/models/payment_pending_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/payment_refund_params.rbi +43 -0
- data/rbi/whop_sdk/models/payment_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/payment_retry_params.rbi +27 -0
- data/rbi/whop_sdk/models/payment_succeeded_webhook_event.rbi +75 -0
- data/rbi/whop_sdk/models/payment_void_params.rbi +27 -0
- data/rbi/whop_sdk/models/plan.rbi +366 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +309 -0
- data/rbi/whop_sdk/models/plan_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/plan_delete_response.rbi +7 -0
- data/rbi/whop_sdk/models/plan_list_params.rbi +157 -0
- data/rbi/whop_sdk/models/plan_list_response.rbi +296 -0
- data/rbi/whop_sdk/models/plan_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/plan_type.rbi +20 -0
- data/rbi/whop_sdk/models/plan_update_params.rbi +279 -0
- data/rbi/whop_sdk/models/product.rbi +403 -0
- data/rbi/whop_sdk/models/product_create_params.rbi +592 -0
- data/rbi/whop_sdk/models/product_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/product_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/product_list_item.rbi +126 -0
- data/rbi/whop_sdk/models/product_list_params.rbi +142 -0
- data/rbi/whop_sdk/models/product_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/product_update_params.rbi +245 -0
- data/rbi/whop_sdk/models/promo_type.rbi +20 -0
- data/rbi/whop_sdk/models/reaction.rbi +106 -0
- data/rbi/whop_sdk/models/reaction_create_params.rbi +53 -0
- data/rbi/whop_sdk/models/reaction_list_params.rbi +75 -0
- data/rbi/whop_sdk/models/reaction_list_response.rbi +116 -0
- data/rbi/whop_sdk/models/reaction_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/receipt_status.rbi +26 -0
- data/rbi/whop_sdk/models/release_method.rbi +20 -0
- data/rbi/whop_sdk/models/shipment.rbi +134 -0
- data/rbi/whop_sdk/models/shipment_carrier.rbi +117 -0
- data/rbi/whop_sdk/models/shipment_create_params.rbi +59 -0
- data/rbi/whop_sdk/models/shipment_list_params.rbi +91 -0
- data/rbi/whop_sdk/models/shipment_list_response.rbi +146 -0
- data/rbi/whop_sdk/models/shipment_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/shipment_status.rbi +31 -0
- data/rbi/whop_sdk/models/shipment_substatus.rbi +86 -0
- data/rbi/whop_sdk/models/support_channel.rbi +133 -0
- data/rbi/whop_sdk/models/support_channel_create_params.rbi +51 -0
- data/rbi/whop_sdk/models/support_channel_list_params.rbi +136 -0
- data/rbi/whop_sdk/models/support_channel_list_response.rbi +147 -0
- data/rbi/whop_sdk/models/support_channel_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/tax_type.rbi +22 -0
- data/rbi/whop_sdk/models/transfer.rbi +387 -0
- data/rbi/whop_sdk/models/transfer_create_params.rbi +87 -0
- data/rbi/whop_sdk/models/transfer_list_params.rbi +125 -0
- data/rbi/whop_sdk/models/transfer_list_response.rbi +97 -0
- data/rbi/whop_sdk/models/transfer_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +33 -0
- data/rbi/whop_sdk/models/user_check_access_params.rbi +35 -0
- data/rbi/whop_sdk/models/user_check_access_response.rbi +49 -0
- data/rbi/whop_sdk/models/user_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/user_retrieve_response.rbi +127 -0
- data/rbi/whop_sdk/models/visibility.rbi +22 -0
- data/rbi/whop_sdk/models/visibility_filter.rbi +29 -0
- data/rbi/whop_sdk/models/webhook_unwrap_params.rbi +27 -0
- data/rbi/whop_sdk/models/who_can_comment_types.rbi +22 -0
- data/rbi/whop_sdk/models/who_can_post.rbi +20 -0
- data/rbi/whop_sdk/models/who_can_post_types.rbi +20 -0
- data/rbi/whop_sdk/models/who_can_react.rbi +20 -0
- data/rbi/whop_sdk/models.rbi +326 -0
- data/rbi/whop_sdk/request_options.rbi +57 -0
- data/rbi/whop_sdk/resources/app_builds.rbi +115 -0
- data/rbi/whop_sdk/resources/apps.rbi +146 -0
- data/rbi/whop_sdk/resources/authorized_users.rbi +68 -0
- data/rbi/whop_sdk/resources/chat_channels.rbi +98 -0
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +98 -0
- data/rbi/whop_sdk/resources/companies.rbi +26 -0
- data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +71 -0
- data/rbi/whop_sdk/resources/entries.rbi +105 -0
- data/rbi/whop_sdk/resources/experiences.rbi +170 -0
- data/rbi/whop_sdk/resources/forum_posts.rbi +117 -0
- data/rbi/whop_sdk/resources/forums.rbi +88 -0
- data/rbi/whop_sdk/resources/invoices.rbi +139 -0
- data/rbi/whop_sdk/resources/ledger_accounts.rbi +26 -0
- data/rbi/whop_sdk/resources/members.rbi +97 -0
- data/rbi/whop_sdk/resources/memberships.rbi +171 -0
- data/rbi/whop_sdk/resources/messages.rbi +91 -0
- data/rbi/whop_sdk/resources/payments.rbi +173 -0
- data/rbi/whop_sdk/resources/plans.rbi +228 -0
- data/rbi/whop_sdk/resources/products.rbi +254 -0
- data/rbi/whop_sdk/resources/reactions.rbi +80 -0
- data/rbi/whop_sdk/resources/shipments.rbi +91 -0
- data/rbi/whop_sdk/resources/support_channels.rbi +93 -0
- data/rbi/whop_sdk/resources/transfers.rbi +104 -0
- data/rbi/whop_sdk/resources/users.rbi +33 -0
- data/rbi/whop_sdk/resources/webhooks.rbi +38 -0
- data/rbi/whop_sdk/version.rbi +5 -0
- data/sig/whop_sdk/client.rbs +77 -0
- data/sig/whop_sdk/errors.rbs +117 -0
- data/sig/whop_sdk/file_part.rbs +21 -0
- data/sig/whop_sdk/internal/cursor_page.rbs +24 -0
- data/sig/whop_sdk/internal/transport/base_client.rbs +131 -0
- data/sig/whop_sdk/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/whop_sdk/internal/type/array_of.rbs +48 -0
- data/sig/whop_sdk/internal/type/base_model.rbs +102 -0
- data/sig/whop_sdk/internal/type/base_page.rbs +24 -0
- data/sig/whop_sdk/internal/type/boolean.rbs +26 -0
- data/sig/whop_sdk/internal/type/converter.rbs +79 -0
- data/sig/whop_sdk/internal/type/enum.rbs +32 -0
- data/sig/whop_sdk/internal/type/file_input.rbs +25 -0
- data/sig/whop_sdk/internal/type/hash_of.rbs +48 -0
- data/sig/whop_sdk/internal/type/request_parameters.rbs +17 -0
- data/sig/whop_sdk/internal/type/union.rbs +52 -0
- data/sig/whop_sdk/internal/type/unknown.rbs +26 -0
- data/sig/whop_sdk/internal/util.rbs +185 -0
- data/sig/whop_sdk/internal.rbs +9 -0
- data/sig/whop_sdk/models/access_level.rbs +15 -0
- data/sig/whop_sdk/models/access_pass_type.rbs +16 -0
- data/sig/whop_sdk/models/app.rbs +216 -0
- data/sig/whop_sdk/models/app_build.rbs +60 -0
- data/sig/whop_sdk/models/app_build_create_params.rbs +58 -0
- data/sig/whop_sdk/models/app_build_list_params.rbs +56 -0
- data/sig/whop_sdk/models/app_build_list_response.rbs +60 -0
- data/sig/whop_sdk/models/app_build_platforms.rbs +15 -0
- data/sig/whop_sdk/models/app_build_promote_params.rbs +15 -0
- data/sig/whop_sdk/models/app_build_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/app_build_statuses.rbs +16 -0
- data/sig/whop_sdk/models/app_create_params.rbs +32 -0
- data/sig/whop_sdk/models/app_list_params.rbs +90 -0
- data/sig/whop_sdk/models/app_list_response.rbs +116 -0
- data/sig/whop_sdk/models/app_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/app_statuses.rbs +15 -0
- data/sig/whop_sdk/models/app_update_params.rbs +93 -0
- data/sig/whop_sdk/models/app_view_type.rbs +17 -0
- data/sig/whop_sdk/models/authorized_user_list_params.rbs +56 -0
- data/sig/whop_sdk/models/authorized_user_list_response.rbs +57 -0
- data/sig/whop_sdk/models/authorized_user_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/authorized_user_retrieve_response.rbs +57 -0
- data/sig/whop_sdk/models/authorized_user_roles.rbs +26 -0
- data/sig/whop_sdk/models/business_types.rbs +40 -0
- data/sig/whop_sdk/models/chat_channel.rbs +67 -0
- data/sig/whop_sdk/models/chat_channel_list_params.rbs +51 -0
- data/sig/whop_sdk/models/chat_channel_list_response.rbs +67 -0
- data/sig/whop_sdk/models/chat_channel_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/chat_channel_update_params.rbs +51 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +112 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +202 -0
- data/sig/whop_sdk/models/checkout_configuration_list_params.rbs +56 -0
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +112 -0
- data/sig/whop_sdk/models/checkout_configuration_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/collection_method.rbs +14 -0
- data/sig/whop_sdk/models/company.rbs +161 -0
- data/sig/whop_sdk/models/company_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/course_lesson_interaction.rbs +108 -0
- data/sig/whop_sdk/models/course_lesson_interaction_completed_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/course_lesson_interaction_list_item.rbs +66 -0
- data/sig/whop_sdk/models/course_lesson_interaction_list_params.rbs +61 -0
- data/sig/whop_sdk/models/course_lesson_interaction_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/currency.rbs +180 -0
- data/sig/whop_sdk/models/custom_cta.rbs +38 -0
- data/sig/whop_sdk/models/direction.rbs +14 -0
- data/sig/whop_sdk/models/dms_post_types.rbs +15 -0
- data/sig/whop_sdk/models/email_notification_preferences.rbs +16 -0
- data/sig/whop_sdk/models/entry.rbs +114 -0
- data/sig/whop_sdk/models/entry_approve_params.rbs +15 -0
- data/sig/whop_sdk/models/entry_approve_response.rbs +13 -0
- data/sig/whop_sdk/models/entry_approved_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/entry_created_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/entry_deleted_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/entry_denied_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/entry_deny_params.rbs +14 -0
- data/sig/whop_sdk/models/entry_list_params.rbs +82 -0
- data/sig/whop_sdk/models/entry_list_response.rbs +94 -0
- data/sig/whop_sdk/models/entry_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/entry_status.rbs +17 -0
- data/sig/whop_sdk/models/experience.rbs +126 -0
- data/sig/whop_sdk/models/experience_attach_params.rbs +23 -0
- data/sig/whop_sdk/models/experience_create_params.rbs +36 -0
- data/sig/whop_sdk/models/experience_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/experience_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/experience_detach_params.rbs +23 -0
- data/sig/whop_sdk/models/experience_list_params.rbs +56 -0
- data/sig/whop_sdk/models/experience_list_response.rbs +111 -0
- data/sig/whop_sdk/models/experience_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/experience_update_params.rbs +69 -0
- data/sig/whop_sdk/models/forum.rbs +52 -0
- data/sig/whop_sdk/models/forum_list_params.rbs +51 -0
- data/sig/whop_sdk/models/forum_list_response.rbs +52 -0
- data/sig/whop_sdk/models/forum_post.rbs +84 -0
- data/sig/whop_sdk/models/forum_post_create_params.rbs +110 -0
- data/sig/whop_sdk/models/forum_post_list_params.rbs +56 -0
- data/sig/whop_sdk/models/forum_post_list_response.rbs +84 -0
- data/sig/whop_sdk/models/forum_post_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/forum_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/forum_update_params.rbs +36 -0
- data/sig/whop_sdk/models/friendly_receipt_status.rbs +44 -0
- data/sig/whop_sdk/models/global_affiliate_status.rbs +14 -0
- data/sig/whop_sdk/models/industry_types.rbs +130 -0
- data/sig/whop_sdk/models/invoice.rbs +101 -0
- data/sig/whop_sdk/models/invoice_create_params.rbs +197 -0
- data/sig/whop_sdk/models/invoice_create_response.rbs +19 -0
- data/sig/whop_sdk/models/invoice_created_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/invoice_list_item.rbs +101 -0
- data/sig/whop_sdk/models/invoice_list_params.rbs +100 -0
- data/sig/whop_sdk/models/invoice_paid_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/invoice_past_due_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/invoice_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/invoice_status.rbs +16 -0
- data/sig/whop_sdk/models/invoice_void_params.rbs +15 -0
- data/sig/whop_sdk/models/invoice_void_response.rbs +5 -0
- data/sig/whop_sdk/models/invoice_voided_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/ledger_account_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +183 -0
- data/sig/whop_sdk/models/member_list_params.rbs +116 -0
- data/sig/whop_sdk/models/member_list_response.rbs +97 -0
- data/sig/whop_sdk/models/member_most_recent_actions.rbs +40 -0
- data/sig/whop_sdk/models/member_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/member_retrieve_response.rbs +116 -0
- data/sig/whop_sdk/models/member_statuses.rbs +15 -0
- data/sig/whop_sdk/models/membership.rbs +166 -0
- data/sig/whop_sdk/models/membership_activated_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/membership_cancel_params.rbs +37 -0
- data/sig/whop_sdk/models/membership_deactivated_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/membership_list_params.rbs +130 -0
- data/sig/whop_sdk/models/membership_list_response.rbs +166 -0
- data/sig/whop_sdk/models/membership_pause_params.rbs +23 -0
- data/sig/whop_sdk/models/membership_resume_params.rbs +15 -0
- data/sig/whop_sdk/models/membership_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/membership_status.rbs +28 -0
- data/sig/whop_sdk/models/membership_update_params.rbs +24 -0
- data/sig/whop_sdk/models/message.rbs +142 -0
- data/sig/whop_sdk/models/message_create_params.rbs +80 -0
- data/sig/whop_sdk/models/message_list_params.rbs +51 -0
- data/sig/whop_sdk/models/message_list_response.rbs +147 -0
- data/sig/whop_sdk/models/message_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/page_info.rbs +35 -0
- data/sig/whop_sdk/models/payment.rbs +355 -0
- data/sig/whop_sdk/models/payment_failed_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/payment_list_params.rbs +134 -0
- data/sig/whop_sdk/models/payment_list_response.rbs +355 -0
- data/sig/whop_sdk/models/payment_pending_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/payment_refund_params.rbs +23 -0
- data/sig/whop_sdk/models/payment_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/payment_retry_params.rbs +15 -0
- data/sig/whop_sdk/models/payment_succeeded_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/payment_void_params.rbs +15 -0
- data/sig/whop_sdk/models/plan.rbs +201 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +160 -0
- data/sig/whop_sdk/models/plan_delete_params.rbs +14 -0
- data/sig/whop_sdk/models/plan_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/plan_list_params.rbs +95 -0
- data/sig/whop_sdk/models/plan_list_response.rbs +144 -0
- data/sig/whop_sdk/models/plan_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/plan_type.rbs +14 -0
- data/sig/whop_sdk/models/plan_update_params.rbs +145 -0
- data/sig/whop_sdk/models/product.rbs +197 -0
- data/sig/whop_sdk/models/product_create_params.rbs +283 -0
- data/sig/whop_sdk/models/product_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/product_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/product_list_item.rbs +75 -0
- data/sig/whop_sdk/models/product_list_params.rbs +80 -0
- data/sig/whop_sdk/models/product_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/product_update_params.rbs +123 -0
- data/sig/whop_sdk/models/promo_type.rbs +14 -0
- data/sig/whop_sdk/models/reaction.rbs +49 -0
- data/sig/whop_sdk/models/reaction_create_params.rbs +28 -0
- data/sig/whop_sdk/models/reaction_list_params.rbs +46 -0
- data/sig/whop_sdk/models/reaction_list_response.rbs +49 -0
- data/sig/whop_sdk/models/reaction_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/receipt_status.rbs +20 -0
- data/sig/whop_sdk/models/release_method.rbs +14 -0
- data/sig/whop_sdk/models/shipment.rbs +75 -0
- data/sig/whop_sdk/models/shipment_carrier.rbs +164 -0
- data/sig/whop_sdk/models/shipment_create_params.rbs +32 -0
- data/sig/whop_sdk/models/shipment_list_params.rbs +56 -0
- data/sig/whop_sdk/models/shipment_list_response.rbs +75 -0
- data/sig/whop_sdk/models/shipment_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/shipment_status.rbs +32 -0
- data/sig/whop_sdk/models/shipment_substatus.rbs +68 -0
- data/sig/whop_sdk/models/support_channel.rbs +59 -0
- data/sig/whop_sdk/models/support_channel_create_params.rbs +28 -0
- data/sig/whop_sdk/models/support_channel_list_params.rbs +72 -0
- data/sig/whop_sdk/models/support_channel_list_response.rbs +59 -0
- data/sig/whop_sdk/models/support_channel_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/tax_type.rbs +15 -0
- data/sig/whop_sdk/models/transfer.rbs +192 -0
- data/sig/whop_sdk/models/transfer_create_params.rbs +51 -0
- data/sig/whop_sdk/models/transfer_list_params.rbs +72 -0
- data/sig/whop_sdk/models/transfer_list_response.rbs +55 -0
- data/sig/whop_sdk/models/transfer_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +25 -0
- data/sig/whop_sdk/models/user_check_access_params.rbs +20 -0
- data/sig/whop_sdk/models/user_check_access_response.rbs +22 -0
- data/sig/whop_sdk/models/user_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/user_retrieve_response.rbs +55 -0
- data/sig/whop_sdk/models/visibility.rbs +16 -0
- data/sig/whop_sdk/models/visibility_filter.rbs +26 -0
- data/sig/whop_sdk/models/webhook_unwrap_params.rbs +15 -0
- data/sig/whop_sdk/models/who_can_comment_types.rbs +14 -0
- data/sig/whop_sdk/models/who_can_post.rbs +14 -0
- data/sig/whop_sdk/models/who_can_post_types.rbs +14 -0
- data/sig/whop_sdk/models/who_can_react.rbs +14 -0
- data/sig/whop_sdk/models.rbs +315 -0
- data/sig/whop_sdk/request_options.rbs +34 -0
- data/sig/whop_sdk/resources/app_builds.rbs +37 -0
- data/sig/whop_sdk/resources/apps.rbs +48 -0
- data/sig/whop_sdk/resources/authorized_users.rbs +23 -0
- data/sig/whop_sdk/resources/chat_channels.rbs +33 -0
- data/sig/whop_sdk/resources/checkout_configurations.rbs +32 -0
- data/sig/whop_sdk/resources/companies.rbs +12 -0
- data/sig/whop_sdk/resources/course_lesson_interactions.rbs +24 -0
- data/sig/whop_sdk/resources/entries.rbs +36 -0
- data/sig/whop_sdk/resources/experiences.rbs +55 -0
- data/sig/whop_sdk/resources/forum_posts.rbs +37 -0
- data/sig/whop_sdk/resources/forums.rbs +30 -0
- data/sig/whop_sdk/resources/invoices.rbs +41 -0
- data/sig/whop_sdk/resources/ledger_accounts.rbs +12 -0
- data/sig/whop_sdk/resources/members.rbs +32 -0
- data/sig/whop_sdk/resources/memberships.rbs +53 -0
- data/sig/whop_sdk/resources/messages.rbs +30 -0
- data/sig/whop_sdk/resources/payments.rbs +48 -0
- data/sig/whop_sdk/resources/plans.rbs +69 -0
- data/sig/whop_sdk/resources/products.rbs +77 -0
- data/sig/whop_sdk/resources/reactions.rbs +27 -0
- data/sig/whop_sdk/resources/shipments.rbs +30 -0
- data/sig/whop_sdk/resources/support_channels.rbs +30 -0
- data/sig/whop_sdk/resources/transfers.rbs +34 -0
- data/sig/whop_sdk/resources/users.rbs +18 -0
- data/sig/whop_sdk/resources/webhooks.rbs +24 -0
- data/sig/whop_sdk/version.rbs +3 -0
- metadata +765 -0
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Payments
|
|
6
|
+
# Retrieves a payment by ID
|
|
7
|
+
#
|
|
8
|
+
# Required permissions:
|
|
9
|
+
#
|
|
10
|
+
# - `payment:basic:read`
|
|
11
|
+
# - `plan:basic:read`
|
|
12
|
+
# - `access_pass:basic:read`
|
|
13
|
+
# - `member:email:read`
|
|
14
|
+
# - `member:basic:read`
|
|
15
|
+
# - `member:phone:read`
|
|
16
|
+
# - `promo_code:basic:read`
|
|
17
|
+
#
|
|
18
|
+
# @overload retrieve(id, request_options: {})
|
|
19
|
+
#
|
|
20
|
+
# @param id [String]
|
|
21
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
|
+
#
|
|
23
|
+
# @return [WhopSDK::Models::Payment]
|
|
24
|
+
#
|
|
25
|
+
# @see WhopSDK::Models::PaymentRetrieveParams
|
|
26
|
+
def retrieve(id, params = {})
|
|
27
|
+
@client.request(
|
|
28
|
+
method: :get,
|
|
29
|
+
path: ["payments/%1$s", id],
|
|
30
|
+
model: WhopSDK::Payment,
|
|
31
|
+
options: params[:request_options]
|
|
32
|
+
)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Lists payments
|
|
36
|
+
#
|
|
37
|
+
# Required permissions:
|
|
38
|
+
#
|
|
39
|
+
# - `payment:basic:read`
|
|
40
|
+
# - `plan:basic:read`
|
|
41
|
+
# - `access_pass:basic:read`
|
|
42
|
+
# - `member:email:read`
|
|
43
|
+
# - `member:basic:read`
|
|
44
|
+
# - `member:phone:read`
|
|
45
|
+
# - `promo_code:basic:read`
|
|
46
|
+
#
|
|
47
|
+
# @overload list(company_id:, after: nil, before: nil, billing_reasons: nil, created_after: nil, created_before: nil, currencies: nil, direction: nil, first: nil, include_free: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, substatuses: nil, request_options: {})
|
|
48
|
+
#
|
|
49
|
+
# @param company_id [String] The ID of the company to list payments for
|
|
50
|
+
#
|
|
51
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
52
|
+
#
|
|
53
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
54
|
+
#
|
|
55
|
+
# @param billing_reasons [Array<Symbol, WhopSDK::Models::PaymentListParams::BillingReason>, nil] The billing reason for the payment
|
|
56
|
+
#
|
|
57
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
58
|
+
#
|
|
59
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
60
|
+
#
|
|
61
|
+
# @param currencies [Array<Symbol, WhopSDK::Models::Currency>, nil] The currency of the payment.
|
|
62
|
+
#
|
|
63
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
64
|
+
#
|
|
65
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
66
|
+
#
|
|
67
|
+
# @param include_free [Boolean, nil] Whether to include free payments.
|
|
68
|
+
#
|
|
69
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
70
|
+
#
|
|
71
|
+
# @param order [Symbol, WhopSDK::Models::PaymentListParams::Order, nil] The order to sort the results by.
|
|
72
|
+
#
|
|
73
|
+
# @param plan_ids [Array<String>, nil] A specific plan.
|
|
74
|
+
#
|
|
75
|
+
# @param product_ids [Array<String>, nil] A specific product.
|
|
76
|
+
#
|
|
77
|
+
# @param statuses [Array<Symbol, WhopSDK::Models::ReceiptStatus>, nil] The status of the payment.
|
|
78
|
+
#
|
|
79
|
+
# @param substatuses [Array<Symbol, WhopSDK::Models::FriendlyReceiptStatus>, nil] The substatus of the payment.
|
|
80
|
+
#
|
|
81
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
82
|
+
#
|
|
83
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::PaymentListResponse>]
|
|
84
|
+
#
|
|
85
|
+
# @see WhopSDK::Models::PaymentListParams
|
|
86
|
+
def list(params)
|
|
87
|
+
parsed, options = WhopSDK::PaymentListParams.dump_request(params)
|
|
88
|
+
@client.request(
|
|
89
|
+
method: :get,
|
|
90
|
+
path: "payments",
|
|
91
|
+
query: parsed,
|
|
92
|
+
page: WhopSDK::Internal::CursorPage,
|
|
93
|
+
model: WhopSDK::Models::PaymentListResponse,
|
|
94
|
+
options: options
|
|
95
|
+
)
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# Refunds a payment
|
|
99
|
+
#
|
|
100
|
+
# Required permissions:
|
|
101
|
+
#
|
|
102
|
+
# - `payment:manage`
|
|
103
|
+
# - `plan:basic:read`
|
|
104
|
+
# - `access_pass:basic:read`
|
|
105
|
+
# - `member:email:read`
|
|
106
|
+
# - `member:basic:read`
|
|
107
|
+
# - `member:phone:read`
|
|
108
|
+
# - `promo_code:basic:read`
|
|
109
|
+
#
|
|
110
|
+
# @overload refund(id, partial_amount: nil, request_options: {})
|
|
111
|
+
#
|
|
112
|
+
# @param id [String]
|
|
113
|
+
#
|
|
114
|
+
# @param partial_amount [Float, nil] An amount if the refund is supposed to be partial.
|
|
115
|
+
#
|
|
116
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
117
|
+
#
|
|
118
|
+
# @return [WhopSDK::Models::Payment]
|
|
119
|
+
#
|
|
120
|
+
# @see WhopSDK::Models::PaymentRefundParams
|
|
121
|
+
def refund(id, params = {})
|
|
122
|
+
parsed, options = WhopSDK::PaymentRefundParams.dump_request(params)
|
|
123
|
+
@client.request(
|
|
124
|
+
method: :post,
|
|
125
|
+
path: ["payments/%1$s/refund", id],
|
|
126
|
+
body: parsed,
|
|
127
|
+
model: WhopSDK::Payment,
|
|
128
|
+
options: options
|
|
129
|
+
)
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
# Retries a payment
|
|
133
|
+
#
|
|
134
|
+
# Required permissions:
|
|
135
|
+
#
|
|
136
|
+
# - `payment:manage`
|
|
137
|
+
# - `plan:basic:read`
|
|
138
|
+
# - `access_pass:basic:read`
|
|
139
|
+
# - `member:email:read`
|
|
140
|
+
# - `member:basic:read`
|
|
141
|
+
# - `member:phone:read`
|
|
142
|
+
# - `promo_code:basic:read`
|
|
143
|
+
#
|
|
144
|
+
# @overload retry_(id, request_options: {})
|
|
145
|
+
#
|
|
146
|
+
# @param id [String]
|
|
147
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
148
|
+
#
|
|
149
|
+
# @return [WhopSDK::Models::Payment]
|
|
150
|
+
#
|
|
151
|
+
# @see WhopSDK::Models::PaymentRetryParams
|
|
152
|
+
def retry_(id, params = {})
|
|
153
|
+
@client.request(
|
|
154
|
+
method: :post,
|
|
155
|
+
path: ["payments/%1$s/retry", id],
|
|
156
|
+
model: WhopSDK::Payment,
|
|
157
|
+
options: params[:request_options]
|
|
158
|
+
)
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# Voids a payment
|
|
162
|
+
#
|
|
163
|
+
# Required permissions:
|
|
164
|
+
#
|
|
165
|
+
# - `payment:manage`
|
|
166
|
+
# - `plan:basic:read`
|
|
167
|
+
# - `access_pass:basic:read`
|
|
168
|
+
# - `member:email:read`
|
|
169
|
+
# - `member:basic:read`
|
|
170
|
+
# - `member:phone:read`
|
|
171
|
+
# - `promo_code:basic:read`
|
|
172
|
+
#
|
|
173
|
+
# @overload void(id, request_options: {})
|
|
174
|
+
#
|
|
175
|
+
# @param id [String]
|
|
176
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
177
|
+
#
|
|
178
|
+
# @return [WhopSDK::Models::Payment]
|
|
179
|
+
#
|
|
180
|
+
# @see WhopSDK::Models::PaymentVoidParams
|
|
181
|
+
def void(id, params = {})
|
|
182
|
+
@client.request(
|
|
183
|
+
method: :post,
|
|
184
|
+
path: ["payments/%1$s/void", id],
|
|
185
|
+
model: WhopSDK::Payment,
|
|
186
|
+
options: params[:request_options]
|
|
187
|
+
)
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
# @api private
|
|
191
|
+
#
|
|
192
|
+
# @param client [WhopSDK::Client]
|
|
193
|
+
def initialize(client:)
|
|
194
|
+
@client = client
|
|
195
|
+
end
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
end
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Plans
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {WhopSDK::Models::PlanCreateParams} for more details.
|
|
8
|
+
#
|
|
9
|
+
# Create a new Plan
|
|
10
|
+
#
|
|
11
|
+
# Required permissions:
|
|
12
|
+
#
|
|
13
|
+
# - `plan:create`
|
|
14
|
+
# - `access_pass:basic:read`
|
|
15
|
+
# - `plan:basic:read`
|
|
16
|
+
#
|
|
17
|
+
# @overload create(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil, request_options: {})
|
|
18
|
+
#
|
|
19
|
+
# @param company_id [String] The company the plan should be created for.
|
|
20
|
+
#
|
|
21
|
+
# @param product_id [String] The product the plan is related to.
|
|
22
|
+
#
|
|
23
|
+
# @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
|
|
24
|
+
#
|
|
25
|
+
# @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
|
|
26
|
+
#
|
|
27
|
+
# @param custom_fields [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil] An array of custom field objects.
|
|
28
|
+
#
|
|
29
|
+
# @param description [String, nil] The description of the plan.
|
|
30
|
+
#
|
|
31
|
+
# @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
|
|
32
|
+
#
|
|
33
|
+
# @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
|
|
34
|
+
#
|
|
35
|
+
# @param initial_price [Float, nil] An additional amount charged upon first purchase. Use only if a one time payment
|
|
36
|
+
#
|
|
37
|
+
# @param internal_notes [String, nil] A personal description or notes section for the business.
|
|
38
|
+
#
|
|
39
|
+
# @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
|
|
40
|
+
#
|
|
41
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
|
|
42
|
+
#
|
|
43
|
+
# @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
|
|
44
|
+
#
|
|
45
|
+
# @param renewal_price [Float, nil] The amount the customer is charged every billing period. Use only if a recurring
|
|
46
|
+
#
|
|
47
|
+
# @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
|
|
48
|
+
#
|
|
49
|
+
# @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
|
|
50
|
+
#
|
|
51
|
+
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
52
|
+
#
|
|
53
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
54
|
+
#
|
|
55
|
+
# @return [WhopSDK::Models::Plan]
|
|
56
|
+
#
|
|
57
|
+
# @see WhopSDK::Models::PlanCreateParams
|
|
58
|
+
def create(params)
|
|
59
|
+
parsed, options = WhopSDK::PlanCreateParams.dump_request(params)
|
|
60
|
+
@client.request(method: :post, path: "plans", body: parsed, model: WhopSDK::Plan, options: options)
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# Retrieves a plan by ID
|
|
64
|
+
#
|
|
65
|
+
# Required permissions:
|
|
66
|
+
#
|
|
67
|
+
# - `plan:basic:read`
|
|
68
|
+
#
|
|
69
|
+
# @overload retrieve(id, request_options: {})
|
|
70
|
+
#
|
|
71
|
+
# @param id [String]
|
|
72
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
73
|
+
#
|
|
74
|
+
# @return [WhopSDK::Models::Plan]
|
|
75
|
+
#
|
|
76
|
+
# @see WhopSDK::Models::PlanRetrieveParams
|
|
77
|
+
def retrieve(id, params = {})
|
|
78
|
+
@client.request(
|
|
79
|
+
method: :get,
|
|
80
|
+
path: ["plans/%1$s", id],
|
|
81
|
+
model: WhopSDK::Plan,
|
|
82
|
+
options: params[:request_options]
|
|
83
|
+
)
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# Some parameter documentations has been truncated, see
|
|
87
|
+
# {WhopSDK::Models::PlanUpdateParams} for more details.
|
|
88
|
+
#
|
|
89
|
+
# Update an existing Plan
|
|
90
|
+
#
|
|
91
|
+
# Required permissions:
|
|
92
|
+
#
|
|
93
|
+
# - `plan:update`
|
|
94
|
+
# - `access_pass:basic:read`
|
|
95
|
+
# - `plan:basic:read`
|
|
96
|
+
#
|
|
97
|
+
# @overload update(id, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil, request_options: {})
|
|
98
|
+
#
|
|
99
|
+
# @param id [String]
|
|
100
|
+
#
|
|
101
|
+
# @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
|
|
102
|
+
#
|
|
103
|
+
# @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
|
|
104
|
+
#
|
|
105
|
+
# @param custom_fields [Array<WhopSDK::Models::PlanUpdateParams::CustomField>, nil] An array of custom field objects.
|
|
106
|
+
#
|
|
107
|
+
# @param description [String, nil] The description of the plan.
|
|
108
|
+
#
|
|
109
|
+
# @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
|
|
110
|
+
#
|
|
111
|
+
# @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
|
|
112
|
+
#
|
|
113
|
+
# @param initial_price [Float, nil] An additional amount charged upon first purchase.
|
|
114
|
+
#
|
|
115
|
+
# @param internal_notes [String, nil] A personal description or notes section for the business.
|
|
116
|
+
#
|
|
117
|
+
# @param offer_cancel_discount [Boolean, nil] Whether or not to offer a discount to cancel a subscription.
|
|
118
|
+
#
|
|
119
|
+
# @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
|
|
120
|
+
#
|
|
121
|
+
# @param renewal_price [Float, nil] The amount the customer is charged every billing period.
|
|
122
|
+
#
|
|
123
|
+
# @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
|
|
124
|
+
#
|
|
125
|
+
# @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
|
|
126
|
+
#
|
|
127
|
+
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
128
|
+
#
|
|
129
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
130
|
+
#
|
|
131
|
+
# @return [WhopSDK::Models::Plan]
|
|
132
|
+
#
|
|
133
|
+
# @see WhopSDK::Models::PlanUpdateParams
|
|
134
|
+
def update(id, params = {})
|
|
135
|
+
parsed, options = WhopSDK::PlanUpdateParams.dump_request(params)
|
|
136
|
+
@client.request(
|
|
137
|
+
method: :patch,
|
|
138
|
+
path: ["plans/%1$s", id],
|
|
139
|
+
body: parsed,
|
|
140
|
+
model: WhopSDK::Plan,
|
|
141
|
+
options: options
|
|
142
|
+
)
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# Lists plans for a company
|
|
146
|
+
#
|
|
147
|
+
# Required permissions:
|
|
148
|
+
#
|
|
149
|
+
# - `plan:basic:read`
|
|
150
|
+
#
|
|
151
|
+
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, plan_types: nil, product_ids: nil, release_methods: nil, visibilities: nil, request_options: {})
|
|
152
|
+
#
|
|
153
|
+
# @param company_id [String] The ID of the company
|
|
154
|
+
#
|
|
155
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
156
|
+
#
|
|
157
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
158
|
+
#
|
|
159
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
160
|
+
#
|
|
161
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
162
|
+
#
|
|
163
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
164
|
+
#
|
|
165
|
+
# @param order [Symbol, WhopSDK::Models::PlanListParams::Order, nil] The ways a relation of Plans can be ordered
|
|
166
|
+
#
|
|
167
|
+
# @param plan_types [Array<Symbol, WhopSDK::Models::PlanType>, nil] The plan type to filter the plans by
|
|
168
|
+
#
|
|
169
|
+
# @param product_ids [Array<String>, nil] The product IDs to filter the plans by
|
|
170
|
+
#
|
|
171
|
+
# @param release_methods [Array<Symbol, WhopSDK::Models::ReleaseMethod>, nil] The release method to filter the plans by
|
|
172
|
+
#
|
|
173
|
+
# @param visibilities [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil] The visibility to filter the plans by
|
|
174
|
+
#
|
|
175
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
176
|
+
#
|
|
177
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::PlanListResponse>]
|
|
178
|
+
#
|
|
179
|
+
# @see WhopSDK::Models::PlanListParams
|
|
180
|
+
def list(params)
|
|
181
|
+
parsed, options = WhopSDK::PlanListParams.dump_request(params)
|
|
182
|
+
@client.request(
|
|
183
|
+
method: :get,
|
|
184
|
+
path: "plans",
|
|
185
|
+
query: parsed,
|
|
186
|
+
page: WhopSDK::Internal::CursorPage,
|
|
187
|
+
model: WhopSDK::Models::PlanListResponse,
|
|
188
|
+
options: options
|
|
189
|
+
)
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# Delete an existing Plan
|
|
193
|
+
#
|
|
194
|
+
# Required permissions:
|
|
195
|
+
#
|
|
196
|
+
# - `plan:delete`
|
|
197
|
+
#
|
|
198
|
+
# @overload delete(id, request_options: {})
|
|
199
|
+
#
|
|
200
|
+
# @param id [String]
|
|
201
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
202
|
+
#
|
|
203
|
+
# @return [Boolean]
|
|
204
|
+
#
|
|
205
|
+
# @see WhopSDK::Models::PlanDeleteParams
|
|
206
|
+
def delete(id, params = {})
|
|
207
|
+
@client.request(
|
|
208
|
+
method: :delete,
|
|
209
|
+
path: ["plans/%1$s", id],
|
|
210
|
+
model: WhopSDK::Internal::Type::Boolean,
|
|
211
|
+
options: params[:request_options]
|
|
212
|
+
)
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# @api private
|
|
216
|
+
#
|
|
217
|
+
# @param client [WhopSDK::Client]
|
|
218
|
+
def initialize(client:)
|
|
219
|
+
@client = client
|
|
220
|
+
end
|
|
221
|
+
end
|
|
222
|
+
end
|
|
223
|
+
end
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Products
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {WhopSDK::Models::ProductCreateParams} for more details.
|
|
8
|
+
#
|
|
9
|
+
# Creates a new Product
|
|
10
|
+
#
|
|
11
|
+
# Required permissions:
|
|
12
|
+
#
|
|
13
|
+
# - `access_pass:create`
|
|
14
|
+
# - `access_pass:basic:read`
|
|
15
|
+
#
|
|
16
|
+
# @overload create(company_id:, title:, access_pass_type: nil, banner_image: nil, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, experience_ids: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, plan_options: nil, product_highlights: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil, request_options: {})
|
|
17
|
+
#
|
|
18
|
+
# @param company_id [String] The ID of the company to create the product for.
|
|
19
|
+
#
|
|
20
|
+
# @param title [String] The title of the product.
|
|
21
|
+
#
|
|
22
|
+
# @param access_pass_type [Symbol, WhopSDK::Models::AccessPassType, nil] The different types an access pass can be.
|
|
23
|
+
#
|
|
24
|
+
# @param banner_image [WhopSDK::Models::ProductCreateParams::BannerImage, nil] A banner image for the product in png, jpeg format
|
|
25
|
+
#
|
|
26
|
+
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
27
|
+
#
|
|
28
|
+
# @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
|
|
29
|
+
#
|
|
30
|
+
# @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
|
|
31
|
+
#
|
|
32
|
+
# @param custom_cta_url [String, nil] The custom call to action URL for the product.
|
|
33
|
+
#
|
|
34
|
+
# @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
|
|
35
|
+
# betwee
|
|
36
|
+
#
|
|
37
|
+
# @param description [String, nil] A written description of the product.
|
|
38
|
+
#
|
|
39
|
+
# @param experience_ids [Array<String>, nil] An array of experience IDs that this pass has
|
|
40
|
+
#
|
|
41
|
+
# @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
|
|
42
|
+
#
|
|
43
|
+
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
|
|
44
|
+
#
|
|
45
|
+
# @param headline [String, nil] The headline of the product.
|
|
46
|
+
#
|
|
47
|
+
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
48
|
+
#
|
|
49
|
+
# @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
|
|
50
|
+
#
|
|
51
|
+
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
|
|
52
|
+
#
|
|
53
|
+
# @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] The details to assign an autogenerated plan.
|
|
54
|
+
#
|
|
55
|
+
# @param product_highlights [Array<WhopSDK::Models::ProductCreateParams::ProductHighlight>, nil] The product highlights for the product.
|
|
56
|
+
#
|
|
57
|
+
# @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
|
|
58
|
+
#
|
|
59
|
+
# @param redirect_purchase_url [String, nil] The URL to redirect the customer to after a purchase.
|
|
60
|
+
#
|
|
61
|
+
# @param route [String, nil] The route of the product.
|
|
62
|
+
#
|
|
63
|
+
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
64
|
+
#
|
|
65
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
66
|
+
#
|
|
67
|
+
# @return [WhopSDK::Models::Product]
|
|
68
|
+
#
|
|
69
|
+
# @see WhopSDK::Models::ProductCreateParams
|
|
70
|
+
def create(params)
|
|
71
|
+
parsed, options = WhopSDK::ProductCreateParams.dump_request(params)
|
|
72
|
+
@client.request(
|
|
73
|
+
method: :post,
|
|
74
|
+
path: "products",
|
|
75
|
+
body: parsed,
|
|
76
|
+
model: WhopSDK::Product,
|
|
77
|
+
options: options
|
|
78
|
+
)
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# Retrieves a product by ID or route
|
|
82
|
+
#
|
|
83
|
+
# Required permissions:
|
|
84
|
+
#
|
|
85
|
+
# - `access_pass:basic:read`
|
|
86
|
+
#
|
|
87
|
+
# @overload retrieve(id, request_options: {})
|
|
88
|
+
#
|
|
89
|
+
# @param id [String]
|
|
90
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
91
|
+
#
|
|
92
|
+
# @return [WhopSDK::Models::Product]
|
|
93
|
+
#
|
|
94
|
+
# @see WhopSDK::Models::ProductRetrieveParams
|
|
95
|
+
def retrieve(id, params = {})
|
|
96
|
+
@client.request(
|
|
97
|
+
method: :get,
|
|
98
|
+
path: ["products/%1$s", id],
|
|
99
|
+
model: WhopSDK::Product,
|
|
100
|
+
options: params[:request_options]
|
|
101
|
+
)
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# Some parameter documentations has been truncated, see
|
|
105
|
+
# {WhopSDK::Models::ProductUpdateParams} for more details.
|
|
106
|
+
#
|
|
107
|
+
# Updates an existing Product
|
|
108
|
+
#
|
|
109
|
+
# Required permissions:
|
|
110
|
+
#
|
|
111
|
+
# - `access_pass:update`
|
|
112
|
+
# - `access_pass:basic:read`
|
|
113
|
+
#
|
|
114
|
+
# @overload update(id, banner_image: nil, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, title: nil, visibility: nil, request_options: {})
|
|
115
|
+
#
|
|
116
|
+
# @param id [String]
|
|
117
|
+
#
|
|
118
|
+
# @param banner_image [WhopSDK::Models::ProductUpdateParams::BannerImage, nil] A banner image for the product in png, jpeg format
|
|
119
|
+
#
|
|
120
|
+
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
121
|
+
#
|
|
122
|
+
# @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
|
|
123
|
+
#
|
|
124
|
+
# @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
|
|
125
|
+
#
|
|
126
|
+
# @param custom_cta_url [String, nil] The custom call to action URL for the product.
|
|
127
|
+
#
|
|
128
|
+
# @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
|
|
129
|
+
# betwee
|
|
130
|
+
#
|
|
131
|
+
# @param description [String, nil] A written description of the product.
|
|
132
|
+
#
|
|
133
|
+
# @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
|
|
134
|
+
#
|
|
135
|
+
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
|
|
136
|
+
#
|
|
137
|
+
# @param headline [String, nil] The headline of the product.
|
|
138
|
+
#
|
|
139
|
+
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
140
|
+
#
|
|
141
|
+
# @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
|
|
142
|
+
#
|
|
143
|
+
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
|
|
144
|
+
#
|
|
145
|
+
# @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
|
|
146
|
+
#
|
|
147
|
+
# @param redirect_purchase_url [String, nil] The URL to redirect the customer to after a purchase.
|
|
148
|
+
#
|
|
149
|
+
# @param route [String, nil] The route of the product.
|
|
150
|
+
#
|
|
151
|
+
# @param title [String, nil] The title of the product.
|
|
152
|
+
#
|
|
153
|
+
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
154
|
+
#
|
|
155
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
156
|
+
#
|
|
157
|
+
# @return [WhopSDK::Models::Product]
|
|
158
|
+
#
|
|
159
|
+
# @see WhopSDK::Models::ProductUpdateParams
|
|
160
|
+
def update(id, params = {})
|
|
161
|
+
parsed, options = WhopSDK::ProductUpdateParams.dump_request(params)
|
|
162
|
+
@client.request(
|
|
163
|
+
method: :patch,
|
|
164
|
+
path: ["products/%1$s", id],
|
|
165
|
+
body: parsed,
|
|
166
|
+
model: WhopSDK::Product,
|
|
167
|
+
options: options
|
|
168
|
+
)
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Lists products for a company
|
|
172
|
+
#
|
|
173
|
+
# Required permissions:
|
|
174
|
+
#
|
|
175
|
+
# - `access_pass:basic:read`
|
|
176
|
+
#
|
|
177
|
+
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, product_types: nil, visibilities: nil, request_options: {})
|
|
178
|
+
#
|
|
179
|
+
# @param company_id [String] The ID of the company to filter products by
|
|
180
|
+
#
|
|
181
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
182
|
+
#
|
|
183
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
184
|
+
#
|
|
185
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
186
|
+
#
|
|
187
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
188
|
+
#
|
|
189
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
190
|
+
#
|
|
191
|
+
# @param order [Symbol, WhopSDK::Models::ProductListParams::Order, nil] The ways a relation of AccessPasses can be ordered
|
|
192
|
+
#
|
|
193
|
+
# @param product_types [Array<Symbol, WhopSDK::Models::AccessPassType>, nil] The type of products to filter by
|
|
194
|
+
#
|
|
195
|
+
# @param visibilities [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil] The visibility of the products to filter by
|
|
196
|
+
#
|
|
197
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
198
|
+
#
|
|
199
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::ProductListItem>]
|
|
200
|
+
#
|
|
201
|
+
# @see WhopSDK::Models::ProductListParams
|
|
202
|
+
def list(params)
|
|
203
|
+
parsed, options = WhopSDK::ProductListParams.dump_request(params)
|
|
204
|
+
@client.request(
|
|
205
|
+
method: :get,
|
|
206
|
+
path: "products",
|
|
207
|
+
query: parsed,
|
|
208
|
+
page: WhopSDK::Internal::CursorPage,
|
|
209
|
+
model: WhopSDK::ProductListItem,
|
|
210
|
+
options: options
|
|
211
|
+
)
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
# Deletes an existing Product
|
|
215
|
+
#
|
|
216
|
+
# Required permissions:
|
|
217
|
+
#
|
|
218
|
+
# - `access_pass:delete`
|
|
219
|
+
#
|
|
220
|
+
# @overload delete(id, request_options: {})
|
|
221
|
+
#
|
|
222
|
+
# @param id [String]
|
|
223
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
224
|
+
#
|
|
225
|
+
# @return [Boolean]
|
|
226
|
+
#
|
|
227
|
+
# @see WhopSDK::Models::ProductDeleteParams
|
|
228
|
+
def delete(id, params = {})
|
|
229
|
+
@client.request(
|
|
230
|
+
method: :delete,
|
|
231
|
+
path: ["products/%1$s", id],
|
|
232
|
+
model: WhopSDK::Internal::Type::Boolean,
|
|
233
|
+
options: params[:request_options]
|
|
234
|
+
)
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# @api private
|
|
238
|
+
#
|
|
239
|
+
# @param client [WhopSDK::Client]
|
|
240
|
+
def initialize(client:)
|
|
241
|
+
@client = client
|
|
242
|
+
end
|
|
243
|
+
end
|
|
244
|
+
end
|
|
245
|
+
end
|