whop_sdk 0.0.3 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +47 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +8 -0
- data/lib/whop_sdk/internal/transport/base_client.rb +7 -1
- data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +6 -2
- data/lib/whop_sdk/models/access_level.rb +1 -1
- data/lib/whop_sdk/models/access_pass_type.rb +2 -1
- data/lib/whop_sdk/models/access_token_create_params.rb +67 -0
- data/lib/whop_sdk/models/access_token_create_response.rb +27 -0
- data/lib/whop_sdk/models/app_build_create_params.rb +53 -29
- data/lib/whop_sdk/models/app_update_params.rb +53 -29
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +119 -43
- data/lib/whop_sdk/models/company.rb +13 -1
- data/lib/whop_sdk/models/company_create_params.rb +46 -0
- data/lib/whop_sdk/models/company_list_params.rb +62 -0
- data/lib/whop_sdk/models/company_list_response.rb +175 -0
- data/lib/whop_sdk/models/course.rb +18 -1
- data/lib/whop_sdk/models/course_create_params.rb +94 -30
- data/lib/whop_sdk/models/course_lesson_create_params.rb +77 -1
- data/lib/whop_sdk/models/course_lesson_list_response.rb +43 -1
- data/lib/whop_sdk/models/course_lesson_update_params.rb +280 -83
- data/lib/whop_sdk/models/course_list_response.rb +18 -1
- data/lib/whop_sdk/models/course_student_list_params.rb +62 -0
- data/lib/whop_sdk/models/course_student_list_response.rb +97 -0
- data/lib/whop_sdk/models/course_student_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/course_student_retrieve_response.rb +149 -0
- data/lib/whop_sdk/models/course_update_params.rb +70 -28
- data/lib/whop_sdk/models/course_visibilities.rb +17 -0
- data/lib/whop_sdk/models/embed_type.rb +16 -0
- data/lib/whop_sdk/models/entry.rb +3 -3
- data/lib/whop_sdk/models/entry_list_response.rb +3 -3
- data/lib/whop_sdk/models/experience.rb +5 -6
- data/lib/whop_sdk/models/experience_update_params.rb +53 -29
- data/lib/whop_sdk/models/forum_post.rb +2 -2
- data/lib/whop_sdk/models/forum_post_create_params.rb +51 -27
- data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
- data/lib/whop_sdk/models/forum_post_update_params.rb +51 -27
- data/lib/whop_sdk/models/global_affiliate_status.rb +1 -1
- data/lib/whop_sdk/models/invoice_create_params.rb +50 -34
- data/lib/whop_sdk/models/invoice_list_params.rb +27 -40
- data/lib/whop_sdk/models/lesson.rb +59 -9
- data/lib/whop_sdk/models/member_list_params.rb +11 -11
- data/lib/whop_sdk/models/member_list_response.rb +3 -3
- data/lib/whop_sdk/models/member_retrieve_response.rb +3 -3
- data/lib/whop_sdk/models/membership_list_params.rb +9 -9
- data/lib/whop_sdk/models/message.rb +2 -2
- data/lib/whop_sdk/models/message_create_params.rb +51 -27
- data/lib/whop_sdk/models/message_list_response.rb +2 -2
- data/lib/whop_sdk/models/message_update_params.rb +51 -27
- data/lib/whop_sdk/models/payment.rb +13 -4
- data/lib/whop_sdk/models/payment_list_response.rb +13 -4
- data/lib/whop_sdk/models/payment_method_types.rb +2 -1
- data/lib/whop_sdk/models/plan.rb +54 -5
- data/lib/whop_sdk/models/plan_create_params.rb +99 -24
- data/lib/whop_sdk/models/plan_list_response.rb +57 -5
- data/lib/whop_sdk/models/plan_type.rb +1 -1
- data/lib/whop_sdk/models/plan_update_params.rb +97 -22
- data/lib/whop_sdk/models/product.rb +1 -1
- data/lib/whop_sdk/models/product_create_params.rb +6 -6
- data/lib/whop_sdk/models/product_list_item.rb +1 -1
- data/lib/whop_sdk/models/product_update_params.rb +57 -33
- data/lib/whop_sdk/models/promo_code.rb +3 -3
- data/lib/whop_sdk/models/promo_code_list_response.rb +3 -3
- data/lib/whop_sdk/models/transfer.rb +9 -1
- data/lib/whop_sdk/models/transfer_create_params.rb +9 -1
- data/lib/whop_sdk/models/transfer_list_response.rb +9 -1
- data/lib/whop_sdk/models.rb +14 -0
- data/lib/whop_sdk/resources/access_tokens.rb +46 -0
- data/lib/whop_sdk/resources/app_builds.rb +5 -3
- data/lib/whop_sdk/resources/apps.rb +4 -3
- data/lib/whop_sdk/resources/authorized_users.rb +2 -1
- data/lib/whop_sdk/resources/chat_channels.rb +9 -2
- data/lib/whop_sdk/resources/checkout_configurations.rb +8 -7
- data/lib/whop_sdk/resources/companies.rb +72 -1
- data/lib/whop_sdk/resources/course_chapters.rb +5 -3
- data/lib/whop_sdk/resources/course_lesson_interactions.rb +4 -3
- data/lib/whop_sdk/resources/course_lessons.rb +25 -7
- data/lib/whop_sdk/resources/course_students.rb +77 -0
- data/lib/whop_sdk/resources/courses.rb +24 -7
- data/lib/whop_sdk/resources/entries.rb +6 -3
- data/lib/whop_sdk/resources/experiences.rb +9 -7
- data/lib/whop_sdk/resources/forum_posts.rb +5 -4
- data/lib/whop_sdk/resources/forums.rb +3 -2
- data/lib/whop_sdk/resources/invoices.rb +22 -16
- data/lib/whop_sdk/resources/ledger_accounts.rb +6 -2
- data/lib/whop_sdk/resources/members.rb +6 -5
- data/lib/whop_sdk/resources/memberships.rb +10 -8
- data/lib/whop_sdk/resources/messages.rb +5 -4
- data/lib/whop_sdk/resources/payments.rb +7 -4
- data/lib/whop_sdk/resources/plans.rb +14 -8
- data/lib/whop_sdk/resources/products.rb +10 -8
- data/lib/whop_sdk/resources/promo_codes.rb +4 -2
- data/lib/whop_sdk/resources/reactions.rb +2 -1
- data/lib/whop_sdk/resources/reviews.rb +2 -1
- data/lib/whop_sdk/resources/shipments.rb +2 -1
- data/lib/whop_sdk/resources/support_channels.rb +2 -1
- data/lib/whop_sdk/resources/transfers.rb +5 -2
- data/lib/whop_sdk/resources/users.rb +9 -3
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +14 -1
- data/manifest.yaml +1 -0
- data/rbi/whop_sdk/client.rbi +6 -0
- data/rbi/whop_sdk/internal/transport/base_client.rbi +5 -0
- data/rbi/whop_sdk/internal/transport/pooled_net_requester.rbi +6 -2
- data/rbi/whop_sdk/internal/type/base_model.rbi +8 -4
- data/rbi/whop_sdk/models/access_level.rbi +1 -1
- data/rbi/whop_sdk/models/access_pass_type.rbi +2 -1
- data/rbi/whop_sdk/models/access_token_create_params.rbi +126 -0
- data/rbi/whop_sdk/models/access_token_create_response.rbi +37 -0
- data/rbi/whop_sdk/models/app_build_create_params.rbi +80 -40
- data/rbi/whop_sdk/models/app_update_params.rbi +86 -37
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +196 -68
- data/rbi/whop_sdk/models/company.rbi +10 -0
- data/rbi/whop_sdk/models/company_create_params.rbi +67 -0
- data/rbi/whop_sdk/models/company_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/company_list_response.rbi +235 -0
- data/rbi/whop_sdk/models/course.rbi +21 -3
- data/rbi/whop_sdk/models/course_create_params.rbi +126 -38
- data/rbi/whop_sdk/models/course_lesson_create_params.rbi +126 -0
- data/rbi/whop_sdk/models/course_lesson_list_response.rbi +68 -0
- data/rbi/whop_sdk/models/course_lesson_update_params.rbi +449 -111
- data/rbi/whop_sdk/models/course_list_response.rbi +21 -3
- data/rbi/whop_sdk/models/course_student_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/course_student_list_response.rbi +142 -0
- data/rbi/whop_sdk/models/course_student_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/course_student_retrieve_response.rbi +250 -0
- data/rbi/whop_sdk/models/course_update_params.rbi +104 -38
- data/rbi/whop_sdk/models/course_visibilities.rbi +23 -0
- data/rbi/whop_sdk/models/embed_type.rbi +20 -0
- data/rbi/whop_sdk/models/entry.rbi +3 -3
- data/rbi/whop_sdk/models/entry_list_response.rbi +3 -3
- data/rbi/whop_sdk/models/experience.rbi +7 -9
- data/rbi/whop_sdk/models/experience_update_params.rbi +84 -38
- data/rbi/whop_sdk/models/forum_post.rbi +2 -2
- data/rbi/whop_sdk/models/forum_post_create_params.rbi +85 -32
- data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/forum_post_update_params.rbi +85 -32
- data/rbi/whop_sdk/models/global_affiliate_status.rbi +1 -1
- data/rbi/whop_sdk/models/invoice_create_params.rbi +60 -46
- data/rbi/whop_sdk/models/invoice_list_params.rbi +26 -71
- data/rbi/whop_sdk/models/lesson.rbi +68 -10
- data/rbi/whop_sdk/models/member_list_params.rbi +10 -10
- data/rbi/whop_sdk/models/member_list_response.rbi +6 -6
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +6 -6
- data/rbi/whop_sdk/models/membership_list_params.rbi +8 -8
- data/rbi/whop_sdk/models/message.rbi +2 -2
- data/rbi/whop_sdk/models/message_create_params.rbi +85 -32
- data/rbi/whop_sdk/models/message_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/message_update_params.rbi +85 -32
- data/rbi/whop_sdk/models/payment.rbi +13 -3
- data/rbi/whop_sdk/models/payment_list_response.rbi +13 -3
- data/rbi/whop_sdk/models/payment_method_types.rbi +3 -1
- data/rbi/whop_sdk/models/plan.rbi +88 -4
- data/rbi/whop_sdk/models/plan_create_params.rbi +176 -34
- data/rbi/whop_sdk/models/plan_list_response.rbi +100 -4
- data/rbi/whop_sdk/models/plan_type.rbi +1 -1
- data/rbi/whop_sdk/models/plan_update_params.rbi +174 -32
- data/rbi/whop_sdk/models/product.rbi +1 -1
- data/rbi/whop_sdk/models/product_create_params.rbi +6 -6
- data/rbi/whop_sdk/models/product_list_item.rbi +1 -1
- data/rbi/whop_sdk/models/product_update_params.rbi +87 -43
- data/rbi/whop_sdk/models/promo_code.rbi +3 -3
- data/rbi/whop_sdk/models/promo_code_list_response.rbi +3 -3
- data/rbi/whop_sdk/models/transfer.rbi +8 -0
- data/rbi/whop_sdk/models/transfer_create_params.rbi +8 -0
- data/rbi/whop_sdk/models/transfer_list_response.rbi +8 -0
- data/rbi/whop_sdk/models.rbi +14 -0
- data/rbi/whop_sdk/resources/access_tokens.rbi +41 -0
- data/rbi/whop_sdk/resources/app_builds.rbi +15 -3
- data/rbi/whop_sdk/resources/apps.rbi +13 -2
- data/rbi/whop_sdk/resources/authorized_users.rbi +5 -1
- data/rbi/whop_sdk/resources/chat_channels.rbi +8 -1
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +11 -8
- data/rbi/whop_sdk/resources/companies.rbi +68 -1
- data/rbi/whop_sdk/resources/course_chapters.rbi +11 -2
- data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +7 -3
- data/rbi/whop_sdk/resources/course_lessons.rbi +62 -4
- data/rbi/whop_sdk/resources/course_students.rbi +69 -0
- data/rbi/whop_sdk/resources/courses.rbi +50 -4
- data/rbi/whop_sdk/resources/entries.rbi +15 -3
- data/rbi/whop_sdk/resources/experiences.rbi +21 -3
- data/rbi/whop_sdk/resources/forum_posts.rbi +18 -3
- data/rbi/whop_sdk/resources/forums.rbi +6 -1
- data/rbi/whop_sdk/resources/invoices.rbi +38 -23
- data/rbi/whop_sdk/resources/ledger_accounts.rbi +7 -2
- data/rbi/whop_sdk/resources/members.rbi +9 -5
- data/rbi/whop_sdk/resources/memberships.rbi +16 -5
- data/rbi/whop_sdk/resources/messages.rbi +18 -3
- data/rbi/whop_sdk/resources/payments.rbi +16 -3
- data/rbi/whop_sdk/resources/plans.rbi +40 -5
- data/rbi/whop_sdk/resources/products.rbi +21 -7
- data/rbi/whop_sdk/resources/promo_codes.rbi +10 -2
- data/rbi/whop_sdk/resources/reactions.rbi +5 -1
- data/rbi/whop_sdk/resources/reviews.rbi +5 -1
- data/rbi/whop_sdk/resources/shipments.rbi +5 -1
- data/rbi/whop_sdk/resources/support_channels.rbi +5 -1
- data/rbi/whop_sdk/resources/transfers.rbi +8 -1
- data/rbi/whop_sdk/resources/users.rbi +13 -2
- data/sig/whop_sdk/client.rbs +4 -0
- data/sig/whop_sdk/internal/transport/base_client.rbs +2 -0
- data/sig/whop_sdk/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/whop_sdk/models/access_token_create_params.rbs +56 -0
- data/sig/whop_sdk/models/access_token_create_response.rbs +15 -0
- data/sig/whop_sdk/models/app_build_create_params.rbs +29 -10
- data/sig/whop_sdk/models/app_update_params.rbs +29 -10
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +72 -21
- data/sig/whop_sdk/models/company.rbs +5 -0
- data/sig/whop_sdk/models/company_create_params.rbs +41 -0
- data/sig/whop_sdk/models/company_list_params.rbs +51 -0
- data/sig/whop_sdk/models/company_list_response.rbs +109 -0
- data/sig/whop_sdk/models/course.rbs +13 -3
- data/sig/whop_sdk/models/course_create_params.rbs +49 -10
- data/sig/whop_sdk/models/course_lesson_create_params.rbs +46 -0
- data/sig/whop_sdk/models/course_lesson_list_response.rbs +25 -0
- data/sig/whop_sdk/models/course_lesson_update_params.rbs +162 -30
- data/sig/whop_sdk/models/course_list_response.rbs +13 -3
- data/sig/whop_sdk/models/course_student_list_params.rbs +51 -0
- data/sig/whop_sdk/models/course_student_list_response.rbs +64 -0
- data/sig/whop_sdk/models/course_student_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/course_student_retrieve_response.rbs +106 -0
- data/sig/whop_sdk/models/course_update_params.rbs +40 -11
- data/sig/whop_sdk/models/course_visibilities.rbs +14 -0
- data/sig/whop_sdk/models/embed_type.rbs +14 -0
- data/sig/whop_sdk/models/experience_update_params.rbs +29 -10
- data/sig/whop_sdk/models/forum_post_create_params.rbs +29 -10
- data/sig/whop_sdk/models/forum_post_update_params.rbs +29 -10
- data/sig/whop_sdk/models/invoice_create_params.rbs +28 -18
- data/sig/whop_sdk/models/invoice_list_params.rbs +16 -33
- data/sig/whop_sdk/models/lesson.rbs +33 -8
- data/sig/whop_sdk/models/member_list_params.rbs +5 -5
- data/sig/whop_sdk/models/membership_list_params.rbs +5 -5
- data/sig/whop_sdk/models/message_create_params.rbs +29 -10
- data/sig/whop_sdk/models/message_update_params.rbs +29 -10
- data/sig/whop_sdk/models/payment.rbs +5 -0
- data/sig/whop_sdk/models/payment_list_response.rbs +5 -0
- data/sig/whop_sdk/models/payment_method_types.rbs +4 -2
- data/sig/whop_sdk/models/plan.rbs +32 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +61 -10
- data/sig/whop_sdk/models/plan_list_response.rbs +32 -0
- data/sig/whop_sdk/models/plan_update_params.rbs +61 -10
- data/sig/whop_sdk/models/product_update_params.rbs +29 -10
- data/sig/whop_sdk/models/transfer.rbs +5 -0
- data/sig/whop_sdk/models/transfer_create_params.rbs +5 -0
- data/sig/whop_sdk/models/transfer_list_response.rbs +5 -0
- data/sig/whop_sdk/models.rbs +14 -0
- data/sig/whop_sdk/resources/access_tokens.rbs +15 -0
- data/sig/whop_sdk/resources/app_builds.rbs +1 -1
- data/sig/whop_sdk/resources/apps.rbs +1 -1
- data/sig/whop_sdk/resources/checkout_configurations.rbs +2 -2
- data/sig/whop_sdk/resources/companies.rbs +18 -0
- data/sig/whop_sdk/resources/course_lessons.rbs +10 -2
- data/sig/whop_sdk/resources/course_students.rbs +22 -0
- data/sig/whop_sdk/resources/courses.rbs +8 -2
- data/sig/whop_sdk/resources/experiences.rbs +1 -1
- data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
- data/sig/whop_sdk/resources/invoices.rbs +8 -6
- data/sig/whop_sdk/resources/members.rbs +1 -1
- data/sig/whop_sdk/resources/memberships.rbs +1 -1
- data/sig/whop_sdk/resources/messages.rbs +2 -2
- data/sig/whop_sdk/resources/plans.rbs +4 -2
- data/sig/whop_sdk/resources/products.rbs +1 -1
- data/sig/whop_sdk/resources/transfers.rbs +1 -0
- metadata +41 -5
- data/lib/whop_sdk/models/invoice_create_response.rb +0 -27
- data/rbi/whop_sdk/models/invoice_create_response.rbi +0 -49
- data/sig/whop_sdk/models/invoice_create_response.rbs +0 -19
|
@@ -7,6 +7,12 @@ module WhopSDK
|
|
|
7
7
|
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include WhopSDK::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute plan
|
|
11
|
+
# Pass this object to create a new plan for this checkout configuration
|
|
12
|
+
#
|
|
13
|
+
# @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan]
|
|
14
|
+
required :plan, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan }
|
|
15
|
+
|
|
10
16
|
# @!attribute affiliate_code
|
|
11
17
|
# The affiliate code to use for the checkout configuration
|
|
12
18
|
#
|
|
@@ -19,33 +25,27 @@ module WhopSDK
|
|
|
19
25
|
# @return [Hash{Symbol=>Object}, nil]
|
|
20
26
|
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
21
27
|
|
|
22
|
-
# @!attribute
|
|
23
|
-
#
|
|
28
|
+
# @!attribute redirect_url
|
|
29
|
+
# The URL to redirect the user to after the checkout configuration is created
|
|
24
30
|
#
|
|
25
|
-
# @return [
|
|
26
|
-
optional :
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :redirect_url, String, nil?: true
|
|
27
33
|
|
|
28
34
|
# @!attribute plan_id
|
|
29
35
|
# The ID of the plan to use for the checkout configuration
|
|
30
36
|
#
|
|
31
|
-
# @return [String
|
|
32
|
-
|
|
37
|
+
# @return [String]
|
|
38
|
+
required :plan_id, String
|
|
33
39
|
|
|
34
|
-
# @!
|
|
35
|
-
#
|
|
40
|
+
# @!method initialize(plan:, plan_id:, affiliate_code: nil, metadata: nil, redirect_url: nil, request_options: {})
|
|
41
|
+
# @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan] Pass this object to create a new plan for this checkout configuration
|
|
42
|
+
#
|
|
43
|
+
# @param plan_id [String] The ID of the plan to use for the checkout configuration
|
|
36
44
|
#
|
|
37
|
-
# @return [String, nil]
|
|
38
|
-
optional :redirect_url, String, nil?: true
|
|
39
|
-
|
|
40
|
-
# @!method initialize(affiliate_code: nil, metadata: nil, plan: nil, plan_id: nil, redirect_url: nil, request_options: {})
|
|
41
45
|
# @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
|
|
42
46
|
#
|
|
43
47
|
# @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
|
|
44
48
|
#
|
|
45
|
-
# @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil] Pass this object to create a new plan for this checkout configuration
|
|
46
|
-
#
|
|
47
|
-
# @param plan_id [String, nil] The ID of the plan to use for the checkout configuration
|
|
48
|
-
#
|
|
49
49
|
# @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
|
|
50
50
|
#
|
|
51
51
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -101,8 +101,8 @@ module WhopSDK
|
|
|
101
101
|
# @!attribute image
|
|
102
102
|
# An image for the plan. This will be visible on the product page to customers.
|
|
103
103
|
#
|
|
104
|
-
# @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image, nil]
|
|
105
|
-
optional :image, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image }, nil?: true
|
|
104
|
+
# @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID, nil]
|
|
105
|
+
optional :image, union: -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image }, nil?: true
|
|
106
106
|
|
|
107
107
|
# @!attribute initial_price
|
|
108
108
|
# An additional amount charged upon first purchase.
|
|
@@ -123,8 +123,17 @@ module WhopSDK
|
|
|
123
123
|
# @return [Symbol, WhopSDK::Models::TaxType, nil]
|
|
124
124
|
optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
|
|
125
125
|
|
|
126
|
+
# @!attribute payment_method_configuration
|
|
127
|
+
# The explicit payment method configuration for the plan. If not provided, the
|
|
128
|
+
# platform or company's defaults will apply.
|
|
129
|
+
#
|
|
130
|
+
# @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration, nil]
|
|
131
|
+
optional :payment_method_configuration,
|
|
132
|
+
-> { WhopSDK::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration },
|
|
133
|
+
nil?: true
|
|
134
|
+
|
|
126
135
|
# @!attribute plan_type
|
|
127
|
-
# The type of plan that can be attached to
|
|
136
|
+
# The type of plan that can be attached to a product
|
|
128
137
|
#
|
|
129
138
|
# @return [Symbol, WhopSDK::Models::PlanType, nil]
|
|
130
139
|
optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
|
|
@@ -172,7 +181,7 @@ module WhopSDK
|
|
|
172
181
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
173
182
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
174
183
|
|
|
175
|
-
# @!method initialize(company_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, product: nil, product_id: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil)
|
|
184
|
+
# @!method initialize(company_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product: nil, product_id: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil)
|
|
176
185
|
# Some parameter documentations has been truncated, see
|
|
177
186
|
# {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan} for more details.
|
|
178
187
|
#
|
|
@@ -192,7 +201,7 @@ module WhopSDK
|
|
|
192
201
|
#
|
|
193
202
|
# @param force_create_new_plan [Boolean, nil] Whether to force the creation of a new plan even if one with the same attributes
|
|
194
203
|
#
|
|
195
|
-
# @param image [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image, nil] An image for the plan. This will be visible on the product page to customers.
|
|
204
|
+
# @param image [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
|
|
196
205
|
#
|
|
197
206
|
# @param initial_price [Float, nil] An additional amount charged upon first purchase.
|
|
198
207
|
#
|
|
@@ -200,7 +209,9 @@ module WhopSDK
|
|
|
200
209
|
#
|
|
201
210
|
# @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
|
|
202
211
|
#
|
|
203
|
-
# @param
|
|
212
|
+
# @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
|
|
213
|
+
#
|
|
214
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
|
|
204
215
|
#
|
|
205
216
|
# @param product [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Product, nil] Pass this object to create a new product for this plan. We will use the product
|
|
206
217
|
#
|
|
@@ -267,34 +278,99 @@ module WhopSDK
|
|
|
267
278
|
# @param field_type [Symbol, :text] The type of the custom field.
|
|
268
279
|
end
|
|
269
280
|
|
|
281
|
+
# An image for the plan. This will be visible on the product page to customers.
|
|
282
|
+
#
|
|
270
283
|
# @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#image
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
#
|
|
275
|
-
|
|
284
|
+
module Image
|
|
285
|
+
extend WhopSDK::Internal::Type::Union
|
|
286
|
+
|
|
287
|
+
# Input for an attachment
|
|
288
|
+
variant -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID }
|
|
289
|
+
|
|
290
|
+
# Input for an attachment
|
|
291
|
+
variant -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID }
|
|
292
|
+
|
|
293
|
+
class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
|
|
294
|
+
# @!attribute direct_upload_id
|
|
295
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
296
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
297
|
+
# mediaDirectUpload mutation.
|
|
298
|
+
#
|
|
299
|
+
# @return [String]
|
|
300
|
+
required :direct_upload_id, String
|
|
301
|
+
|
|
302
|
+
# @!method initialize(direct_upload_id:)
|
|
303
|
+
# Some parameter documentations has been truncated, see
|
|
304
|
+
# {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID}
|
|
305
|
+
# for more details.
|
|
306
|
+
#
|
|
307
|
+
# Input for an attachment
|
|
308
|
+
#
|
|
309
|
+
# @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
|
|
310
|
+
end
|
|
311
|
+
|
|
312
|
+
class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
|
|
313
|
+
# @!attribute id
|
|
314
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
315
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
316
|
+
# doing.
|
|
317
|
+
#
|
|
318
|
+
# @return [String]
|
|
319
|
+
required :id, String
|
|
320
|
+
|
|
321
|
+
# @!method initialize(id:)
|
|
322
|
+
# Some parameter documentations has been truncated, see
|
|
323
|
+
# {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID}
|
|
324
|
+
# for more details.
|
|
325
|
+
#
|
|
326
|
+
# Input for an attachment
|
|
327
|
+
#
|
|
328
|
+
# @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
# @!method self.variants
|
|
332
|
+
# @return [Array(WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID)]
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
# @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#payment_method_configuration
|
|
336
|
+
class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
|
|
337
|
+
# @!attribute disabled
|
|
338
|
+
# An array of payment method identifiers that are explicitly disabled. Only
|
|
339
|
+
# applies if the include_platform_defaults is true.
|
|
276
340
|
#
|
|
277
|
-
# @return [
|
|
278
|
-
|
|
341
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
342
|
+
required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
279
343
|
|
|
280
|
-
# @!attribute
|
|
281
|
-
#
|
|
282
|
-
#
|
|
283
|
-
#
|
|
344
|
+
# @!attribute enabled
|
|
345
|
+
# An array of payment method identifiers that are explicitly enabled. This means
|
|
346
|
+
# these payment methods will be shown on checkout. Example use case is to only
|
|
347
|
+
# enable a specific payment method like cashapp, or extending the platform
|
|
348
|
+
# defaults with additional methods.
|
|
284
349
|
#
|
|
285
|
-
# @return [
|
|
286
|
-
|
|
350
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
351
|
+
required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
287
352
|
|
|
288
|
-
# @!
|
|
353
|
+
# @!attribute include_platform_defaults
|
|
354
|
+
# Whether Whop's platform default payment method enablement settings are included
|
|
355
|
+
# in this configuration. The full list of default payment methods can be found in
|
|
356
|
+
# the documentation at docs.whop.com/payments.
|
|
357
|
+
#
|
|
358
|
+
# @return [Boolean]
|
|
359
|
+
required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
|
|
360
|
+
|
|
361
|
+
# @!method initialize(disabled:, enabled:, include_platform_defaults:)
|
|
289
362
|
# Some parameter documentations has been truncated, see
|
|
290
|
-
# {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::
|
|
291
|
-
# details.
|
|
363
|
+
# {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration}
|
|
364
|
+
# for more details.
|
|
365
|
+
#
|
|
366
|
+
# The explicit payment method configuration for the plan. If not provided, the
|
|
367
|
+
# platform or company's defaults will apply.
|
|
292
368
|
#
|
|
293
|
-
#
|
|
369
|
+
# @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
|
|
294
370
|
#
|
|
295
|
-
# @param
|
|
371
|
+
# @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
|
|
296
372
|
#
|
|
297
|
-
# @param
|
|
373
|
+
# @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
|
|
298
374
|
end
|
|
299
375
|
|
|
300
376
|
# @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#product
|
|
@@ -346,7 +422,7 @@ module WhopSDK
|
|
|
346
422
|
optional :global_affiliate_percentage, Float, nil?: true
|
|
347
423
|
|
|
348
424
|
# @!attribute global_affiliate_status
|
|
349
|
-
# The different statuses of the global affiliate program for
|
|
425
|
+
# The different statuses of the global affiliate program for a product.
|
|
350
426
|
#
|
|
351
427
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
352
428
|
optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
@@ -410,7 +486,7 @@ module WhopSDK
|
|
|
410
486
|
#
|
|
411
487
|
# @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
|
|
412
488
|
#
|
|
413
|
-
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for
|
|
489
|
+
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
414
490
|
#
|
|
415
491
|
# @param headline [String, nil] The headline of the product.
|
|
416
492
|
#
|
|
@@ -45,6 +45,13 @@ module WhopSDK
|
|
|
45
45
|
# @return [Integer]
|
|
46
46
|
required :member_count, Integer
|
|
47
47
|
|
|
48
|
+
# @!attribute metadata
|
|
49
|
+
# A key-value store of data for the account, created/updated by the platform that
|
|
50
|
+
# made the account.
|
|
51
|
+
#
|
|
52
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
53
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
54
|
+
|
|
48
55
|
# @!attribute owner_user
|
|
49
56
|
# The user who owns this company
|
|
50
57
|
#
|
|
@@ -87,7 +94,10 @@ module WhopSDK
|
|
|
87
94
|
# @return [Boolean]
|
|
88
95
|
required :verified, WhopSDK::Internal::Type::Boolean
|
|
89
96
|
|
|
90
|
-
# @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, owner_user:, published_reviews_count:, route:, social_links:, title:, updated_at:, verified:)
|
|
97
|
+
# @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, social_links:, title:, updated_at:, verified:)
|
|
98
|
+
# Some parameter documentations has been truncated, see {WhopSDK::Models::Company}
|
|
99
|
+
# for more details.
|
|
100
|
+
#
|
|
91
101
|
# An object representing a (sanitized) company.
|
|
92
102
|
#
|
|
93
103
|
# @param id [String] The ID (tag) of the company.
|
|
@@ -104,6 +114,8 @@ module WhopSDK
|
|
|
104
114
|
#
|
|
105
115
|
# @param member_count [Integer] The number of members in the company.
|
|
106
116
|
#
|
|
117
|
+
# @param metadata [Hash{Symbol=>Object}, nil] A key-value store of data for the account, created/updated by the platform that
|
|
118
|
+
#
|
|
107
119
|
# @param owner_user [WhopSDK::Models::Company::OwnerUser] The user who owns this company
|
|
108
120
|
#
|
|
109
121
|
# @param published_reviews_count [Integer] The number of reviews that have been published for the company.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Companies#create
|
|
6
|
+
class CompanyCreateParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute email
|
|
11
|
+
# The email of the user who the company will belong to.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :email, String
|
|
15
|
+
|
|
16
|
+
# @!attribute parent_company_id
|
|
17
|
+
# The company ID of the platform creating this company.
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :parent_company_id, String
|
|
21
|
+
|
|
22
|
+
# @!attribute title
|
|
23
|
+
# The name of the company being created.
|
|
24
|
+
#
|
|
25
|
+
# @return [String]
|
|
26
|
+
required :title, String
|
|
27
|
+
|
|
28
|
+
# @!attribute metadata
|
|
29
|
+
# Additional metadata for the account
|
|
30
|
+
#
|
|
31
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
32
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
33
|
+
|
|
34
|
+
# @!method initialize(email:, parent_company_id:, title:, metadata: nil, request_options: {})
|
|
35
|
+
# @param email [String] The email of the user who the company will belong to.
|
|
36
|
+
#
|
|
37
|
+
# @param parent_company_id [String] The company ID of the platform creating this company.
|
|
38
|
+
#
|
|
39
|
+
# @param title [String] The name of the company being created.
|
|
40
|
+
#
|
|
41
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Additional metadata for the account
|
|
42
|
+
#
|
|
43
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Companies#list
|
|
6
|
+
class CompanyListParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute parent_company_id
|
|
11
|
+
# The ID of the parent company to list sub companies for
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :parent_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
|
+
# @!method initialize(parent_company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
47
|
+
# @param parent_company_id [String] The ID of the parent company to list sub companies for
|
|
48
|
+
#
|
|
49
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
50
|
+
#
|
|
51
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
52
|
+
#
|
|
53
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
54
|
+
#
|
|
55
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
56
|
+
#
|
|
57
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
58
|
+
#
|
|
59
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Companies#list
|
|
6
|
+
class CompanyListResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The ID (tag) of the company.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute business_type
|
|
14
|
+
# The different business types a company can be.
|
|
15
|
+
#
|
|
16
|
+
# @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
|
|
17
|
+
required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute created_at
|
|
20
|
+
# When the company was created (signed up)
|
|
21
|
+
#
|
|
22
|
+
# @return [Time]
|
|
23
|
+
required :created_at, Time
|
|
24
|
+
|
|
25
|
+
# @!attribute description
|
|
26
|
+
# The creator pitch for the company.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
required :description, String, nil?: true
|
|
30
|
+
|
|
31
|
+
# @!attribute industry_type
|
|
32
|
+
# The different industry types a company can be in.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
|
|
35
|
+
required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
|
|
36
|
+
|
|
37
|
+
# @!attribute logo
|
|
38
|
+
# The company's logo.
|
|
39
|
+
#
|
|
40
|
+
# @return [WhopSDK::Models::CompanyListResponse::Logo, nil]
|
|
41
|
+
required :logo, -> { WhopSDK::Models::CompanyListResponse::Logo }, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!attribute member_count
|
|
44
|
+
# The number of members in the company.
|
|
45
|
+
#
|
|
46
|
+
# @return [Integer]
|
|
47
|
+
required :member_count, Integer
|
|
48
|
+
|
|
49
|
+
# @!attribute metadata
|
|
50
|
+
# A key-value store of data for the account, created/updated by the platform that
|
|
51
|
+
# made the account.
|
|
52
|
+
#
|
|
53
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
54
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
55
|
+
|
|
56
|
+
# @!attribute owner_user
|
|
57
|
+
# The user who owns this company
|
|
58
|
+
#
|
|
59
|
+
# @return [WhopSDK::Models::CompanyListResponse::OwnerUser]
|
|
60
|
+
required :owner_user, -> { WhopSDK::Models::CompanyListResponse::OwnerUser }
|
|
61
|
+
|
|
62
|
+
# @!attribute published_reviews_count
|
|
63
|
+
# The number of reviews that have been published for the company.
|
|
64
|
+
#
|
|
65
|
+
# @return [Integer]
|
|
66
|
+
required :published_reviews_count, Integer
|
|
67
|
+
|
|
68
|
+
# @!attribute route
|
|
69
|
+
# The slug/route of the company on the Whop site.
|
|
70
|
+
#
|
|
71
|
+
# @return [String]
|
|
72
|
+
required :route, String
|
|
73
|
+
|
|
74
|
+
# @!attribute title
|
|
75
|
+
# The title of the company.
|
|
76
|
+
#
|
|
77
|
+
# @return [String]
|
|
78
|
+
required :title, String
|
|
79
|
+
|
|
80
|
+
# @!attribute updated_at
|
|
81
|
+
# The time the company was last updated.
|
|
82
|
+
#
|
|
83
|
+
# @return [Time]
|
|
84
|
+
required :updated_at, Time
|
|
85
|
+
|
|
86
|
+
# @!attribute verified
|
|
87
|
+
# If the company is Whop Verified
|
|
88
|
+
#
|
|
89
|
+
# @return [Boolean]
|
|
90
|
+
required :verified, WhopSDK::Internal::Type::Boolean
|
|
91
|
+
|
|
92
|
+
# @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, title:, updated_at:, verified:)
|
|
93
|
+
# Some parameter documentations has been truncated, see
|
|
94
|
+
# {WhopSDK::Models::CompanyListResponse} for more details.
|
|
95
|
+
#
|
|
96
|
+
# An object representing a (sanitized) company.
|
|
97
|
+
#
|
|
98
|
+
# @param id [String] The ID (tag) of the company.
|
|
99
|
+
#
|
|
100
|
+
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
101
|
+
#
|
|
102
|
+
# @param created_at [Time] When the company was created (signed up)
|
|
103
|
+
#
|
|
104
|
+
# @param description [String, nil] The creator pitch for the company.
|
|
105
|
+
#
|
|
106
|
+
# @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
|
|
107
|
+
#
|
|
108
|
+
# @param logo [WhopSDK::Models::CompanyListResponse::Logo, nil] The company's logo.
|
|
109
|
+
#
|
|
110
|
+
# @param member_count [Integer] The number of members in the company.
|
|
111
|
+
#
|
|
112
|
+
# @param metadata [Hash{Symbol=>Object}, nil] A key-value store of data for the account, created/updated by the platform that
|
|
113
|
+
#
|
|
114
|
+
# @param owner_user [WhopSDK::Models::CompanyListResponse::OwnerUser] The user who owns this company
|
|
115
|
+
#
|
|
116
|
+
# @param published_reviews_count [Integer] The number of reviews that have been published for the company.
|
|
117
|
+
#
|
|
118
|
+
# @param route [String] The slug/route of the company on the Whop site.
|
|
119
|
+
#
|
|
120
|
+
# @param title [String] The title of the company.
|
|
121
|
+
#
|
|
122
|
+
# @param updated_at [Time] The time the company was last updated.
|
|
123
|
+
#
|
|
124
|
+
# @param verified [Boolean] If the company is Whop Verified
|
|
125
|
+
|
|
126
|
+
# @see WhopSDK::Models::CompanyListResponse#logo
|
|
127
|
+
class Logo < WhopSDK::Internal::Type::BaseModel
|
|
128
|
+
# @!attribute url
|
|
129
|
+
# This is the URL you use to render optimized attachments on the client. This
|
|
130
|
+
# should be used for apps.
|
|
131
|
+
#
|
|
132
|
+
# @return [String, nil]
|
|
133
|
+
required :url, String, nil?: true
|
|
134
|
+
|
|
135
|
+
# @!method initialize(url:)
|
|
136
|
+
# Some parameter documentations has been truncated, see
|
|
137
|
+
# {WhopSDK::Models::CompanyListResponse::Logo} for more details.
|
|
138
|
+
#
|
|
139
|
+
# The company's logo.
|
|
140
|
+
#
|
|
141
|
+
# @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# @see WhopSDK::Models::CompanyListResponse#owner_user
|
|
145
|
+
class OwnerUser < WhopSDK::Internal::Type::BaseModel
|
|
146
|
+
# @!attribute id
|
|
147
|
+
# The internal ID of the user.
|
|
148
|
+
#
|
|
149
|
+
# @return [String]
|
|
150
|
+
required :id, String
|
|
151
|
+
|
|
152
|
+
# @!attribute name
|
|
153
|
+
# The name of the user from their Whop account.
|
|
154
|
+
#
|
|
155
|
+
# @return [String, nil]
|
|
156
|
+
required :name, String, nil?: true
|
|
157
|
+
|
|
158
|
+
# @!attribute username
|
|
159
|
+
# The username of the user from their Whop account.
|
|
160
|
+
#
|
|
161
|
+
# @return [String]
|
|
162
|
+
required :username, String
|
|
163
|
+
|
|
164
|
+
# @!method initialize(id:, name:, username:)
|
|
165
|
+
# The user who owns this company
|
|
166
|
+
#
|
|
167
|
+
# @param id [String] The internal ID of the user.
|
|
168
|
+
#
|
|
169
|
+
# @param name [String, nil] The name of the user from their Whop account.
|
|
170
|
+
#
|
|
171
|
+
# @param username [String] The username of the user from their Whop account.
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
end
|
|
@@ -42,6 +42,12 @@ module WhopSDK
|
|
|
42
42
|
# @return [Symbol, WhopSDK::Models::Languages]
|
|
43
43
|
required :language, enum: -> { WhopSDK::Languages }
|
|
44
44
|
|
|
45
|
+
# @!attribute order
|
|
46
|
+
# The order of the course within its experience
|
|
47
|
+
#
|
|
48
|
+
# @return [String]
|
|
49
|
+
required :order, String
|
|
50
|
+
|
|
45
51
|
# @!attribute require_completing_lessons_in_order
|
|
46
52
|
# Whether the course requires students to complete the previous lesson before
|
|
47
53
|
# moving on to the next one
|
|
@@ -73,7 +79,14 @@ module WhopSDK
|
|
|
73
79
|
# @return [Time]
|
|
74
80
|
required :updated_at, Time
|
|
75
81
|
|
|
76
|
-
# @!
|
|
82
|
+
# @!attribute visibility
|
|
83
|
+
# The visibility of the course. Determines how / whether this course is visible to
|
|
84
|
+
# users.
|
|
85
|
+
#
|
|
86
|
+
# @return [Symbol, WhopSDK::Models::CourseVisibilities]
|
|
87
|
+
required :visibility, enum: -> { WhopSDK::CourseVisibilities }
|
|
88
|
+
|
|
89
|
+
# @!method initialize(id:, certificate_after_completion_enabled:, chapters:, created_at:, description:, language:, order:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:, visibility:)
|
|
77
90
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Course}
|
|
78
91
|
# for more details.
|
|
79
92
|
#
|
|
@@ -91,6 +104,8 @@ module WhopSDK
|
|
|
91
104
|
#
|
|
92
105
|
# @param language [Symbol, WhopSDK::Models::Languages] The language spoken in the video content of the course, used to generate closed
|
|
93
106
|
#
|
|
107
|
+
# @param order [String] The order of the course within its experience
|
|
108
|
+
#
|
|
94
109
|
# @param require_completing_lessons_in_order [Boolean] Whether the course requires students to complete the previous lesson before movi
|
|
95
110
|
#
|
|
96
111
|
# @param tagline [String, nil] A short tagline for the course. It is displayed under the course title in the UI
|
|
@@ -100,6 +115,8 @@ module WhopSDK
|
|
|
100
115
|
# @param title [String, nil] The title of the course
|
|
101
116
|
#
|
|
102
117
|
# @param updated_at [Time] The timestamp of when the course was last updated
|
|
118
|
+
#
|
|
119
|
+
# @param visibility [Symbol, WhopSDK::Models::CourseVisibilities] The visibility of the course. Determines how / whether this course is visible to
|
|
103
120
|
|
|
104
121
|
class Chapter < WhopSDK::Internal::Type::BaseModel
|
|
105
122
|
# @!attribute id
|