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,406 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Products#create
|
|
6
|
+
class ProductCreateParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute company_id
|
|
11
|
+
# The ID of the company to create the product for.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :company_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute title
|
|
17
|
+
# The title of the product.
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :title, String
|
|
21
|
+
|
|
22
|
+
# @!attribute access_pass_type
|
|
23
|
+
# The different types an access pass can be.
|
|
24
|
+
#
|
|
25
|
+
# @return [Symbol, WhopSDK::Models::AccessPassType, nil]
|
|
26
|
+
optional :access_pass_type, enum: -> { WhopSDK::AccessPassType }, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute banner_image
|
|
29
|
+
# A banner image for the product in png, jpeg format
|
|
30
|
+
#
|
|
31
|
+
# @return [WhopSDK::Models::ProductCreateParams::BannerImage, nil]
|
|
32
|
+
optional :banner_image, -> { WhopSDK::ProductCreateParams::BannerImage }, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute business_type
|
|
35
|
+
# The different business types a company can be.
|
|
36
|
+
#
|
|
37
|
+
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
38
|
+
optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!attribute collect_shipping_address
|
|
41
|
+
# Whether or not to collect shipping information at checkout from the customer.
|
|
42
|
+
#
|
|
43
|
+
# @return [Boolean, nil]
|
|
44
|
+
optional :collect_shipping_address, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
45
|
+
|
|
46
|
+
# @!attribute custom_cta
|
|
47
|
+
# The different types of custom CTAs that can be selected.
|
|
48
|
+
#
|
|
49
|
+
# @return [Symbol, WhopSDK::Models::CustomCta, nil]
|
|
50
|
+
optional :custom_cta, enum: -> { WhopSDK::CustomCta }, nil?: true
|
|
51
|
+
|
|
52
|
+
# @!attribute custom_cta_url
|
|
53
|
+
# The custom call to action URL for the product.
|
|
54
|
+
#
|
|
55
|
+
# @return [String, nil]
|
|
56
|
+
optional :custom_cta_url, String, nil?: true
|
|
57
|
+
|
|
58
|
+
# @!attribute custom_statement_descriptor
|
|
59
|
+
# The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
|
|
60
|
+
# between 5 and 22 characters, contain at least one letter, and not contain any of
|
|
61
|
+
# the following characters: <, >, \, ', "
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :custom_statement_descriptor, String, nil?: true
|
|
65
|
+
|
|
66
|
+
# @!attribute description
|
|
67
|
+
# A written description of the product.
|
|
68
|
+
#
|
|
69
|
+
# @return [String, nil]
|
|
70
|
+
optional :description, String, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!attribute experience_ids
|
|
73
|
+
# An array of experience IDs that this pass has
|
|
74
|
+
#
|
|
75
|
+
# @return [Array<String>, nil]
|
|
76
|
+
optional :experience_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute global_affiliate_percentage
|
|
79
|
+
# The percentage of the revenue that goes to the global affiliate program.
|
|
80
|
+
#
|
|
81
|
+
# @return [Float, nil]
|
|
82
|
+
optional :global_affiliate_percentage, Float, nil?: true
|
|
83
|
+
|
|
84
|
+
# @!attribute global_affiliate_status
|
|
85
|
+
# The different statuses of the global affiliate program for an access pass.
|
|
86
|
+
#
|
|
87
|
+
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
88
|
+
optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
89
|
+
|
|
90
|
+
# @!attribute headline
|
|
91
|
+
# The headline of the product.
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :headline, String, nil?: true
|
|
95
|
+
|
|
96
|
+
# @!attribute industry_type
|
|
97
|
+
# The different industry types a company can be in.
|
|
98
|
+
#
|
|
99
|
+
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
100
|
+
optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
101
|
+
|
|
102
|
+
# @!attribute member_affiliate_percentage
|
|
103
|
+
# The percentage of the revenue that goes to the member affiliate program.
|
|
104
|
+
#
|
|
105
|
+
# @return [Float, nil]
|
|
106
|
+
optional :member_affiliate_percentage, Float, nil?: true
|
|
107
|
+
|
|
108
|
+
# @!attribute member_affiliate_status
|
|
109
|
+
# The different statuses of the global affiliate program for an access pass.
|
|
110
|
+
#
|
|
111
|
+
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
112
|
+
optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
113
|
+
|
|
114
|
+
# @!attribute plan_options
|
|
115
|
+
# The details to assign an autogenerated plan.
|
|
116
|
+
#
|
|
117
|
+
# @return [WhopSDK::Models::ProductCreateParams::PlanOptions, nil]
|
|
118
|
+
optional :plan_options, -> { WhopSDK::ProductCreateParams::PlanOptions }, nil?: true
|
|
119
|
+
|
|
120
|
+
# @!attribute product_highlights
|
|
121
|
+
# The product highlights for the product.
|
|
122
|
+
#
|
|
123
|
+
# @return [Array<WhopSDK::Models::ProductCreateParams::ProductHighlight>, nil]
|
|
124
|
+
optional :product_highlights,
|
|
125
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ProductCreateParams::ProductHighlight] },
|
|
126
|
+
nil?: true
|
|
127
|
+
|
|
128
|
+
# @!attribute product_tax_code_id
|
|
129
|
+
# The ID of the product tax code to apply to this product.
|
|
130
|
+
#
|
|
131
|
+
# @return [String, nil]
|
|
132
|
+
optional :product_tax_code_id, String, nil?: true
|
|
133
|
+
|
|
134
|
+
# @!attribute redirect_purchase_url
|
|
135
|
+
# The URL to redirect the customer to after a purchase.
|
|
136
|
+
#
|
|
137
|
+
# @return [String, nil]
|
|
138
|
+
optional :redirect_purchase_url, String, nil?: true
|
|
139
|
+
|
|
140
|
+
# @!attribute route
|
|
141
|
+
# The route of the product.
|
|
142
|
+
#
|
|
143
|
+
# @return [String, nil]
|
|
144
|
+
optional :route, String, nil?: true
|
|
145
|
+
|
|
146
|
+
# @!attribute visibility
|
|
147
|
+
# Visibility of a resource
|
|
148
|
+
#
|
|
149
|
+
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
150
|
+
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
151
|
+
|
|
152
|
+
# @!method initialize(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: {})
|
|
153
|
+
# Some parameter documentations has been truncated, see
|
|
154
|
+
# {WhopSDK::Models::ProductCreateParams} for more details.
|
|
155
|
+
#
|
|
156
|
+
# @param company_id [String] The ID of the company to create the product for.
|
|
157
|
+
#
|
|
158
|
+
# @param title [String] The title of the product.
|
|
159
|
+
#
|
|
160
|
+
# @param access_pass_type [Symbol, WhopSDK::Models::AccessPassType, nil] The different types an access pass can be.
|
|
161
|
+
#
|
|
162
|
+
# @param banner_image [WhopSDK::Models::ProductCreateParams::BannerImage, nil] A banner image for the product in png, jpeg format
|
|
163
|
+
#
|
|
164
|
+
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
165
|
+
#
|
|
166
|
+
# @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
|
|
167
|
+
#
|
|
168
|
+
# @param custom_cta [Symbol, WhopSDK::Models::CustomCta, nil] The different types of custom CTAs that can be selected.
|
|
169
|
+
#
|
|
170
|
+
# @param custom_cta_url [String, nil] The custom call to action URL for the product.
|
|
171
|
+
#
|
|
172
|
+
# @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
|
|
173
|
+
# betwee
|
|
174
|
+
#
|
|
175
|
+
# @param description [String, nil] A written description of the product.
|
|
176
|
+
#
|
|
177
|
+
# @param experience_ids [Array<String>, nil] An array of experience IDs that this pass has
|
|
178
|
+
#
|
|
179
|
+
# @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
|
|
180
|
+
#
|
|
181
|
+
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
|
|
182
|
+
#
|
|
183
|
+
# @param headline [String, nil] The headline of the product.
|
|
184
|
+
#
|
|
185
|
+
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
186
|
+
#
|
|
187
|
+
# @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
|
|
188
|
+
#
|
|
189
|
+
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
|
|
190
|
+
#
|
|
191
|
+
# @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] The details to assign an autogenerated plan.
|
|
192
|
+
#
|
|
193
|
+
# @param product_highlights [Array<WhopSDK::Models::ProductCreateParams::ProductHighlight>, nil] The product highlights for the product.
|
|
194
|
+
#
|
|
195
|
+
# @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
|
|
196
|
+
#
|
|
197
|
+
# @param redirect_purchase_url [String, nil] The URL to redirect the customer to after a purchase.
|
|
198
|
+
#
|
|
199
|
+
# @param route [String, nil] The route of the product.
|
|
200
|
+
#
|
|
201
|
+
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
202
|
+
#
|
|
203
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
204
|
+
|
|
205
|
+
class BannerImage < WhopSDK::Internal::Type::BaseModel
|
|
206
|
+
# @!attribute id
|
|
207
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
208
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
209
|
+
# doing.
|
|
210
|
+
#
|
|
211
|
+
# @return [String, nil]
|
|
212
|
+
optional :id, String, nil?: true
|
|
213
|
+
|
|
214
|
+
# @!attribute direct_upload_id
|
|
215
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
216
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
217
|
+
# mediaDirectUpload mutation.
|
|
218
|
+
#
|
|
219
|
+
# @return [String, nil]
|
|
220
|
+
optional :direct_upload_id, String, nil?: true
|
|
221
|
+
|
|
222
|
+
# @!method initialize(id: nil, direct_upload_id: nil)
|
|
223
|
+
# Some parameter documentations has been truncated, see
|
|
224
|
+
# {WhopSDK::Models::ProductCreateParams::BannerImage} for more details.
|
|
225
|
+
#
|
|
226
|
+
# A banner image for the product in png, jpeg format
|
|
227
|
+
#
|
|
228
|
+
# @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
|
|
229
|
+
#
|
|
230
|
+
# @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
class PlanOptions < WhopSDK::Internal::Type::BaseModel
|
|
234
|
+
# @!attribute base_currency
|
|
235
|
+
# The available currencies on the platform
|
|
236
|
+
#
|
|
237
|
+
# @return [Symbol, WhopSDK::Models::Currency, nil]
|
|
238
|
+
optional :base_currency, enum: -> { WhopSDK::Currency }, nil?: true
|
|
239
|
+
|
|
240
|
+
# @!attribute billing_period
|
|
241
|
+
# The interval at which the plan charges (renewal plans).
|
|
242
|
+
#
|
|
243
|
+
# @return [Integer, nil]
|
|
244
|
+
optional :billing_period, Integer, nil?: true
|
|
245
|
+
|
|
246
|
+
# @!attribute custom_fields
|
|
247
|
+
# An array of custom field objects.
|
|
248
|
+
#
|
|
249
|
+
# @return [Array<WhopSDK::Models::ProductCreateParams::PlanOptions::CustomField>, nil]
|
|
250
|
+
optional :custom_fields,
|
|
251
|
+
-> {
|
|
252
|
+
WhopSDK::Internal::Type::ArrayOf[WhopSDK::ProductCreateParams::PlanOptions::CustomField]
|
|
253
|
+
},
|
|
254
|
+
nil?: true
|
|
255
|
+
|
|
256
|
+
# @!attribute initial_price
|
|
257
|
+
# An additional amount charged upon first purchase.
|
|
258
|
+
#
|
|
259
|
+
# @return [Float, nil]
|
|
260
|
+
optional :initial_price, Float, nil?: true
|
|
261
|
+
|
|
262
|
+
# @!attribute plan_type
|
|
263
|
+
# The type of plan that can be attached to an access pass
|
|
264
|
+
#
|
|
265
|
+
# @return [Symbol, WhopSDK::Models::PlanType, nil]
|
|
266
|
+
optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
|
|
267
|
+
|
|
268
|
+
# @!attribute release_method
|
|
269
|
+
# The methods of how a plan can be released.
|
|
270
|
+
#
|
|
271
|
+
# @return [Symbol, WhopSDK::Models::ReleaseMethod, nil]
|
|
272
|
+
optional :release_method, enum: -> { WhopSDK::ReleaseMethod }, nil?: true
|
|
273
|
+
|
|
274
|
+
# @!attribute renewal_price
|
|
275
|
+
# The amount the customer is charged every billing period.
|
|
276
|
+
#
|
|
277
|
+
# @return [Float, nil]
|
|
278
|
+
optional :renewal_price, Float, nil?: true
|
|
279
|
+
|
|
280
|
+
# @!attribute visibility
|
|
281
|
+
# Visibility of a resource
|
|
282
|
+
#
|
|
283
|
+
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
284
|
+
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
285
|
+
|
|
286
|
+
# @!method initialize(base_currency: nil, billing_period: nil, custom_fields: nil, initial_price: nil, plan_type: nil, release_method: nil, renewal_price: nil, visibility: nil)
|
|
287
|
+
# The details to assign an autogenerated plan.
|
|
288
|
+
#
|
|
289
|
+
# @param base_currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
|
|
290
|
+
#
|
|
291
|
+
# @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
|
|
292
|
+
#
|
|
293
|
+
# @param custom_fields [Array<WhopSDK::Models::ProductCreateParams::PlanOptions::CustomField>, nil] An array of custom field objects.
|
|
294
|
+
#
|
|
295
|
+
# @param initial_price [Float, nil] An additional amount charged upon first purchase.
|
|
296
|
+
#
|
|
297
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
|
|
298
|
+
#
|
|
299
|
+
# @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
|
|
300
|
+
#
|
|
301
|
+
# @param renewal_price [Float, nil] The amount the customer is charged every billing period.
|
|
302
|
+
#
|
|
303
|
+
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
304
|
+
|
|
305
|
+
class CustomField < WhopSDK::Internal::Type::BaseModel
|
|
306
|
+
# @!attribute field_type
|
|
307
|
+
# The type of the custom field.
|
|
308
|
+
#
|
|
309
|
+
# @return [Symbol, :text]
|
|
310
|
+
required :field_type, const: :text
|
|
311
|
+
|
|
312
|
+
# @!attribute name
|
|
313
|
+
# The name of the custom field.
|
|
314
|
+
#
|
|
315
|
+
# @return [String]
|
|
316
|
+
required :name, String
|
|
317
|
+
|
|
318
|
+
# @!attribute id
|
|
319
|
+
# The ID of the custom field (if being updated)
|
|
320
|
+
#
|
|
321
|
+
# @return [String, nil]
|
|
322
|
+
optional :id, String, nil?: true
|
|
323
|
+
|
|
324
|
+
# @!attribute order
|
|
325
|
+
# The order of the field.
|
|
326
|
+
#
|
|
327
|
+
# @return [Integer, nil]
|
|
328
|
+
optional :order, Integer, nil?: true
|
|
329
|
+
|
|
330
|
+
# @!attribute placeholder
|
|
331
|
+
# The placeholder value of the field.
|
|
332
|
+
#
|
|
333
|
+
# @return [String, nil]
|
|
334
|
+
optional :placeholder, String, nil?: true
|
|
335
|
+
|
|
336
|
+
# @!attribute required
|
|
337
|
+
# Whether or not the field is required.
|
|
338
|
+
#
|
|
339
|
+
# @return [Boolean, nil]
|
|
340
|
+
optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
341
|
+
|
|
342
|
+
# @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
|
|
343
|
+
# @param name [String] The name of the custom field.
|
|
344
|
+
#
|
|
345
|
+
# @param id [String, nil] The ID of the custom field (if being updated)
|
|
346
|
+
#
|
|
347
|
+
# @param order [Integer, nil] The order of the field.
|
|
348
|
+
#
|
|
349
|
+
# @param placeholder [String, nil] The placeholder value of the field.
|
|
350
|
+
#
|
|
351
|
+
# @param required [Boolean, nil] Whether or not the field is required.
|
|
352
|
+
#
|
|
353
|
+
# @param field_type [Symbol, :text] The type of the custom field.
|
|
354
|
+
end
|
|
355
|
+
end
|
|
356
|
+
|
|
357
|
+
class ProductHighlight < WhopSDK::Internal::Type::BaseModel
|
|
358
|
+
# @!attribute content
|
|
359
|
+
# Text to display to describe the product highlight (max length 250 for
|
|
360
|
+
# qualification or benefits, 170 for who this is for, 140 for pricing features).
|
|
361
|
+
#
|
|
362
|
+
# @return [String]
|
|
363
|
+
required :content, String
|
|
364
|
+
|
|
365
|
+
# @!attribute highlight_type
|
|
366
|
+
# The type of this highlight.
|
|
367
|
+
#
|
|
368
|
+
# @return [Symbol, WhopSDK::Models::ProductCreateParams::ProductHighlight::HighlightType]
|
|
369
|
+
required :highlight_type, enum: -> { WhopSDK::ProductCreateParams::ProductHighlight::HighlightType }
|
|
370
|
+
|
|
371
|
+
# @!attribute title
|
|
372
|
+
# The title of the product highlight, if applicable.
|
|
373
|
+
#
|
|
374
|
+
# @return [String, nil]
|
|
375
|
+
optional :title, String, nil?: true
|
|
376
|
+
|
|
377
|
+
# @!method initialize(content:, highlight_type:, title: nil)
|
|
378
|
+
# Some parameter documentations has been truncated, see
|
|
379
|
+
# {WhopSDK::Models::ProductCreateParams::ProductHighlight} for more details.
|
|
380
|
+
#
|
|
381
|
+
# Input for creating a product highlight
|
|
382
|
+
#
|
|
383
|
+
# @param content [String] Text to display to describe the product highlight (max length 250 for qualificat
|
|
384
|
+
#
|
|
385
|
+
# @param highlight_type [Symbol, WhopSDK::Models::ProductCreateParams::ProductHighlight::HighlightType] The type of this highlight.
|
|
386
|
+
#
|
|
387
|
+
# @param title [String, nil] The title of the product highlight, if applicable.
|
|
388
|
+
|
|
389
|
+
# The type of this highlight.
|
|
390
|
+
#
|
|
391
|
+
# @see WhopSDK::Models::ProductCreateParams::ProductHighlight#highlight_type
|
|
392
|
+
module HighlightType
|
|
393
|
+
extend WhopSDK::Internal::Type::Enum
|
|
394
|
+
|
|
395
|
+
QUALIFICATION = :qualification
|
|
396
|
+
BENEFIT = :benefit
|
|
397
|
+
WHO_THIS_IS_FOR = :who_this_is_for
|
|
398
|
+
PRICING_FEATURE = :pricing_feature
|
|
399
|
+
|
|
400
|
+
# @!method self.values
|
|
401
|
+
# @return [Array<Symbol>]
|
|
402
|
+
end
|
|
403
|
+
end
|
|
404
|
+
end
|
|
405
|
+
end
|
|
406
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Products#delete
|
|
6
|
+
class ProductDeleteParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
class ProductListItem < WhopSDK::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The internal ID of the public product.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute business_type
|
|
13
|
+
# The different business types a company can be.
|
|
14
|
+
#
|
|
15
|
+
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
16
|
+
required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute created_at
|
|
19
|
+
# When the product was created.
|
|
20
|
+
#
|
|
21
|
+
# @return [Time]
|
|
22
|
+
required :created_at, Time
|
|
23
|
+
|
|
24
|
+
# @!attribute headline
|
|
25
|
+
# The headline of the product.
|
|
26
|
+
#
|
|
27
|
+
# @return [String, nil]
|
|
28
|
+
required :headline, String, nil?: true
|
|
29
|
+
|
|
30
|
+
# @!attribute industry_type
|
|
31
|
+
# The different industry types a company can be in.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
34
|
+
required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
35
|
+
|
|
36
|
+
# @!attribute member_count
|
|
37
|
+
# The number of active users for this product.
|
|
38
|
+
#
|
|
39
|
+
# @return [Integer]
|
|
40
|
+
required :member_count, Integer
|
|
41
|
+
|
|
42
|
+
# @!attribute published_reviews_count
|
|
43
|
+
# The number of reviews that have been published for the product.
|
|
44
|
+
#
|
|
45
|
+
# @return [Integer]
|
|
46
|
+
required :published_reviews_count, Integer
|
|
47
|
+
|
|
48
|
+
# @!attribute route
|
|
49
|
+
# The route of the product.
|
|
50
|
+
#
|
|
51
|
+
# @return [String]
|
|
52
|
+
required :route, String
|
|
53
|
+
|
|
54
|
+
# @!attribute title
|
|
55
|
+
# The title of the product. Use for Whop 4.0.
|
|
56
|
+
#
|
|
57
|
+
# @return [String]
|
|
58
|
+
required :title, String
|
|
59
|
+
|
|
60
|
+
# @!attribute updated_at
|
|
61
|
+
# When the product was updated.
|
|
62
|
+
#
|
|
63
|
+
# @return [Time]
|
|
64
|
+
required :updated_at, Time
|
|
65
|
+
|
|
66
|
+
# @!attribute verified
|
|
67
|
+
# Whether this product is Whop verified.
|
|
68
|
+
#
|
|
69
|
+
# @return [Boolean]
|
|
70
|
+
required :verified, WhopSDK::Internal::Type::Boolean
|
|
71
|
+
|
|
72
|
+
# @!attribute visibility
|
|
73
|
+
# This product will/will not be displayed publicly.
|
|
74
|
+
#
|
|
75
|
+
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
76
|
+
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
77
|
+
|
|
78
|
+
# @!method initialize(id:, business_type:, created_at:, headline:, industry_type:, member_count:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:)
|
|
79
|
+
# An object representing a (sanitized) access pass.
|
|
80
|
+
#
|
|
81
|
+
# @param id [String] The internal ID of the public product.
|
|
82
|
+
#
|
|
83
|
+
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
84
|
+
#
|
|
85
|
+
# @param created_at [Time] When the product was created.
|
|
86
|
+
#
|
|
87
|
+
# @param headline [String, nil] The headline of the product.
|
|
88
|
+
#
|
|
89
|
+
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
90
|
+
#
|
|
91
|
+
# @param member_count [Integer] The number of active users for this product.
|
|
92
|
+
#
|
|
93
|
+
# @param published_reviews_count [Integer] The number of reviews that have been published for the product.
|
|
94
|
+
#
|
|
95
|
+
# @param route [String] The route of the product.
|
|
96
|
+
#
|
|
97
|
+
# @param title [String] The title of the product. Use for Whop 4.0.
|
|
98
|
+
#
|
|
99
|
+
# @param updated_at [Time] When the product was updated.
|
|
100
|
+
#
|
|
101
|
+
# @param verified [Boolean] Whether this product is Whop verified.
|
|
102
|
+
#
|
|
103
|
+
# @param visibility [Symbol, WhopSDK::Models::Visibility] This product will/will not be displayed publicly.
|
|
104
|
+
end
|
|
105
|
+
end
|
|
106
|
+
end
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Products#list
|
|
6
|
+
class ProductListParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute company_id
|
|
11
|
+
# The ID of the company to filter products by
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :company_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute after
|
|
17
|
+
# Returns the elements in the list that come after the specified cursor.
|
|
18
|
+
#
|
|
19
|
+
# @return [String, nil]
|
|
20
|
+
optional :after, String, nil?: true
|
|
21
|
+
|
|
22
|
+
# @!attribute before
|
|
23
|
+
# Returns the elements in the list that come before the specified cursor.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :before, String, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute direction
|
|
29
|
+
# The direction of the sort.
|
|
30
|
+
#
|
|
31
|
+
# @return [Symbol, WhopSDK::Models::Direction, nil]
|
|
32
|
+
optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute first
|
|
35
|
+
# Returns the first _n_ elements from the list.
|
|
36
|
+
#
|
|
37
|
+
# @return [Integer, nil]
|
|
38
|
+
optional :first, Integer, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!attribute last
|
|
41
|
+
# Returns the last _n_ elements from the list.
|
|
42
|
+
#
|
|
43
|
+
# @return [Integer, nil]
|
|
44
|
+
optional :last, Integer, nil?: true
|
|
45
|
+
|
|
46
|
+
# @!attribute order
|
|
47
|
+
# The ways a relation of AccessPasses can be ordered
|
|
48
|
+
#
|
|
49
|
+
# @return [Symbol, WhopSDK::Models::ProductListParams::Order, nil]
|
|
50
|
+
optional :order, enum: -> { WhopSDK::ProductListParams::Order }, nil?: true
|
|
51
|
+
|
|
52
|
+
# @!attribute product_types
|
|
53
|
+
# The type of products to filter by
|
|
54
|
+
#
|
|
55
|
+
# @return [Array<Symbol, WhopSDK::Models::AccessPassType>, nil]
|
|
56
|
+
optional :product_types,
|
|
57
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AccessPassType] },
|
|
58
|
+
nil?: true
|
|
59
|
+
|
|
60
|
+
# @!attribute visibilities
|
|
61
|
+
# The visibility of the products to filter by
|
|
62
|
+
#
|
|
63
|
+
# @return [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil]
|
|
64
|
+
optional :visibilities,
|
|
65
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::VisibilityFilter] },
|
|
66
|
+
nil?: true
|
|
67
|
+
|
|
68
|
+
# @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, product_types: nil, visibilities: nil, request_options: {})
|
|
69
|
+
# @param company_id [String] The ID of the company to filter products by
|
|
70
|
+
#
|
|
71
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
72
|
+
#
|
|
73
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
74
|
+
#
|
|
75
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
76
|
+
#
|
|
77
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
78
|
+
#
|
|
79
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
80
|
+
#
|
|
81
|
+
# @param order [Symbol, WhopSDK::Models::ProductListParams::Order, nil] The ways a relation of AccessPasses can be ordered
|
|
82
|
+
#
|
|
83
|
+
# @param product_types [Array<Symbol, WhopSDK::Models::AccessPassType>, nil] The type of products to filter by
|
|
84
|
+
#
|
|
85
|
+
# @param visibilities [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil] The visibility of the products to filter by
|
|
86
|
+
#
|
|
87
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
88
|
+
|
|
89
|
+
# The ways a relation of AccessPasses can be ordered
|
|
90
|
+
module Order
|
|
91
|
+
extend WhopSDK::Internal::Type::Enum
|
|
92
|
+
|
|
93
|
+
ACTIVE_MEMBERSHIPS_COUNT = :active_memberships_count
|
|
94
|
+
CREATED_AT = :created_at
|
|
95
|
+
USD_GMV = :usd_gmv
|
|
96
|
+
USD_GMV_30_DAYS = :usd_gmv_30_days
|
|
97
|
+
|
|
98
|
+
# @!method self.values
|
|
99
|
+
# @return [Array<Symbol>]
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Products#retrieve
|
|
6
|
+
class ProductRetrieveParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|