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
|
@@ -54,8 +54,8 @@ module WhopSDK
|
|
|
54
54
|
# @!attribute image
|
|
55
55
|
# An image for the plan. This will be visible on the product page to customers.
|
|
56
56
|
#
|
|
57
|
-
# @return [WhopSDK::Models::PlanCreateParams::Image, nil]
|
|
58
|
-
optional :image, -> { WhopSDK::PlanCreateParams::Image }, nil?: true
|
|
57
|
+
# @return [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil]
|
|
58
|
+
optional :image, union: -> { WhopSDK::PlanCreateParams::Image }, nil?: true
|
|
59
59
|
|
|
60
60
|
# @!attribute initial_price
|
|
61
61
|
# An additional amount charged upon first purchase. Use only if a one time payment
|
|
@@ -78,8 +78,17 @@ module WhopSDK
|
|
|
78
78
|
# @return [Symbol, WhopSDK::Models::TaxType, nil]
|
|
79
79
|
optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
|
|
80
80
|
|
|
81
|
+
# @!attribute payment_method_configuration
|
|
82
|
+
# The explicit payment method configuration for the plan. If not provided, the
|
|
83
|
+
# platform or company's defaults will apply.
|
|
84
|
+
#
|
|
85
|
+
# @return [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil]
|
|
86
|
+
optional :payment_method_configuration,
|
|
87
|
+
-> { WhopSDK::PlanCreateParams::PaymentMethodConfiguration },
|
|
88
|
+
nil?: true
|
|
89
|
+
|
|
81
90
|
# @!attribute plan_type
|
|
82
|
-
# The type of plan that can be attached to
|
|
91
|
+
# The type of plan that can be attached to a product
|
|
83
92
|
#
|
|
84
93
|
# @return [Symbol, WhopSDK::Models::PlanType, nil]
|
|
85
94
|
optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
|
|
@@ -141,7 +150,7 @@ module WhopSDK
|
|
|
141
150
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
142
151
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
143
152
|
|
|
144
|
-
# @!method initialize(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
153
|
+
# @!method initialize(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
145
154
|
# Some parameter documentations has been truncated, see
|
|
146
155
|
# {WhopSDK::Models::PlanCreateParams} for more details.
|
|
147
156
|
#
|
|
@@ -159,7 +168,7 @@ module WhopSDK
|
|
|
159
168
|
#
|
|
160
169
|
# @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
|
|
161
170
|
#
|
|
162
|
-
# @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
|
|
171
|
+
# @param image [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
|
|
163
172
|
#
|
|
164
173
|
# @param initial_price [Float, nil] An additional amount charged upon first purchase. Use only if a one time payment
|
|
165
174
|
#
|
|
@@ -167,7 +176,9 @@ module WhopSDK
|
|
|
167
176
|
#
|
|
168
177
|
# @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
|
|
169
178
|
#
|
|
170
|
-
# @param
|
|
179
|
+
# @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
|
|
180
|
+
#
|
|
181
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
|
|
171
182
|
#
|
|
172
183
|
# @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
|
|
173
184
|
#
|
|
@@ -240,32 +251,96 @@ module WhopSDK
|
|
|
240
251
|
# @param field_type [Symbol, :text] The type of the custom field.
|
|
241
252
|
end
|
|
242
253
|
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
#
|
|
254
|
+
# An image for the plan. This will be visible on the product page to customers.
|
|
255
|
+
module Image
|
|
256
|
+
extend WhopSDK::Internal::Type::Union
|
|
257
|
+
|
|
258
|
+
# Input for an attachment
|
|
259
|
+
variant -> { WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID }
|
|
260
|
+
|
|
261
|
+
# Input for an attachment
|
|
262
|
+
variant -> { WhopSDK::PlanCreateParams::Image::AttachmentInputWithID }
|
|
263
|
+
|
|
264
|
+
class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
|
|
265
|
+
# @!attribute direct_upload_id
|
|
266
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
267
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
268
|
+
# mediaDirectUpload mutation.
|
|
269
|
+
#
|
|
270
|
+
# @return [String]
|
|
271
|
+
required :direct_upload_id, String
|
|
272
|
+
|
|
273
|
+
# @!method initialize(direct_upload_id:)
|
|
274
|
+
# Some parameter documentations has been truncated, see
|
|
275
|
+
# {WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID}
|
|
276
|
+
# for more details.
|
|
277
|
+
#
|
|
278
|
+
# Input for an attachment
|
|
279
|
+
#
|
|
280
|
+
# @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
|
|
284
|
+
# @!attribute id
|
|
285
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
286
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
287
|
+
# doing.
|
|
288
|
+
#
|
|
289
|
+
# @return [String]
|
|
290
|
+
required :id, String
|
|
291
|
+
|
|
292
|
+
# @!method initialize(id:)
|
|
293
|
+
# Some parameter documentations has been truncated, see
|
|
294
|
+
# {WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID} for more
|
|
295
|
+
# details.
|
|
296
|
+
#
|
|
297
|
+
# Input for an attachment
|
|
298
|
+
#
|
|
299
|
+
# @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
# @!method self.variants
|
|
303
|
+
# @return [Array(WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID)]
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
|
|
307
|
+
# @!attribute disabled
|
|
308
|
+
# An array of payment method identifiers that are explicitly disabled. Only
|
|
309
|
+
# applies if the include_platform_defaults is true.
|
|
248
310
|
#
|
|
249
|
-
# @return [
|
|
250
|
-
|
|
311
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
312
|
+
required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
313
|
+
|
|
314
|
+
# @!attribute enabled
|
|
315
|
+
# An array of payment method identifiers that are explicitly enabled. This means
|
|
316
|
+
# these payment methods will be shown on checkout. Example use case is to only
|
|
317
|
+
# enable a specific payment method like cashapp, or extending the platform
|
|
318
|
+
# defaults with additional methods.
|
|
319
|
+
#
|
|
320
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
321
|
+
required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
251
322
|
|
|
252
|
-
# @!attribute
|
|
253
|
-
#
|
|
254
|
-
#
|
|
255
|
-
#
|
|
323
|
+
# @!attribute include_platform_defaults
|
|
324
|
+
# Whether Whop's platform default payment method enablement settings are included
|
|
325
|
+
# in this configuration. The full list of default payment methods can be found in
|
|
326
|
+
# the documentation at docs.whop.com/payments.
|
|
256
327
|
#
|
|
257
|
-
# @return [
|
|
258
|
-
|
|
328
|
+
# @return [Boolean]
|
|
329
|
+
required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
|
|
259
330
|
|
|
260
|
-
# @!method initialize(
|
|
331
|
+
# @!method initialize(disabled:, enabled:, include_platform_defaults:)
|
|
261
332
|
# Some parameter documentations has been truncated, see
|
|
262
|
-
# {WhopSDK::Models::PlanCreateParams::
|
|
333
|
+
# {WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration} for more
|
|
334
|
+
# details.
|
|
335
|
+
#
|
|
336
|
+
# The explicit payment method configuration for the plan. If not provided, the
|
|
337
|
+
# platform or company's defaults will apply.
|
|
263
338
|
#
|
|
264
|
-
#
|
|
339
|
+
# @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
|
|
265
340
|
#
|
|
266
|
-
# @param
|
|
341
|
+
# @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
|
|
267
342
|
#
|
|
268
|
-
# @param
|
|
343
|
+
# @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
|
|
269
344
|
end
|
|
270
345
|
end
|
|
271
346
|
end
|
|
@@ -70,6 +70,14 @@ module WhopSDK
|
|
|
70
70
|
# @return [Integer, nil]
|
|
71
71
|
required :member_count, Integer, nil?: true
|
|
72
72
|
|
|
73
|
+
# @!attribute payment_method_configuration
|
|
74
|
+
# The explicit payment method configuration for the plan, if any.
|
|
75
|
+
#
|
|
76
|
+
# @return [WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration, nil]
|
|
77
|
+
required :payment_method_configuration,
|
|
78
|
+
-> { WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration },
|
|
79
|
+
nil?: true
|
|
80
|
+
|
|
73
81
|
# @!attribute plan_type
|
|
74
82
|
# Indicates if the plan is a one time payment or recurring.
|
|
75
83
|
#
|
|
@@ -77,7 +85,7 @@ module WhopSDK
|
|
|
77
85
|
required :plan_type, enum: -> { WhopSDK::PlanType }
|
|
78
86
|
|
|
79
87
|
# @!attribute product
|
|
80
|
-
# The
|
|
88
|
+
# The product that this plan belongs to.
|
|
81
89
|
#
|
|
82
90
|
# @return [WhopSDK::Models::PlanListResponse::Product, nil]
|
|
83
91
|
required :product, -> { WhopSDK::Models::PlanListResponse::Product }, nil?: true
|
|
@@ -136,8 +144,10 @@ module WhopSDK
|
|
|
136
144
|
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
137
145
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
138
146
|
|
|
139
|
-
# @!method initialize(id:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
140
|
-
#
|
|
147
|
+
# @!method initialize(id:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
148
|
+
# A plan for an product. Plans define the core parameters that define a checkout
|
|
149
|
+
# and payment on whop. Use plans to create different ways to price your products
|
|
150
|
+
# (Eg renewal / one_time)
|
|
141
151
|
#
|
|
142
152
|
# @param id [String] The internal ID of the plan.
|
|
143
153
|
#
|
|
@@ -161,9 +171,11 @@ module WhopSDK
|
|
|
161
171
|
#
|
|
162
172
|
# @param member_count [Integer, nil] The number of members for the plan.
|
|
163
173
|
#
|
|
174
|
+
# @param payment_method_configuration [WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan, if any.
|
|
175
|
+
#
|
|
164
176
|
# @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
|
|
165
177
|
#
|
|
166
|
-
# @param product [WhopSDK::Models::PlanListResponse::Product, nil] The
|
|
178
|
+
# @param product [WhopSDK::Models::PlanListResponse::Product, nil] The product that this plan belongs to.
|
|
167
179
|
#
|
|
168
180
|
# @param purchase_url [String] The direct link to purchase the product.
|
|
169
181
|
#
|
|
@@ -219,6 +231,46 @@ module WhopSDK
|
|
|
219
231
|
# @param id [String] The ID of the invoice.
|
|
220
232
|
end
|
|
221
233
|
|
|
234
|
+
# @see WhopSDK::Models::PlanListResponse#payment_method_configuration
|
|
235
|
+
class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
|
|
236
|
+
# @!attribute disabled
|
|
237
|
+
# An array of payment method identifiers that are explicitly disabled. Only
|
|
238
|
+
# applies if the include_platform_defaults is true.
|
|
239
|
+
#
|
|
240
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
241
|
+
required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
242
|
+
|
|
243
|
+
# @!attribute enabled
|
|
244
|
+
# An array of payment method identifiers that are explicitly enabled. This means
|
|
245
|
+
# these payment methods will be shown on checkout. Example use case is to only
|
|
246
|
+
# enable a specific payment method like cashapp, or extending the platform
|
|
247
|
+
# defaults with additional methods.
|
|
248
|
+
#
|
|
249
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
250
|
+
required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
251
|
+
|
|
252
|
+
# @!attribute include_platform_defaults
|
|
253
|
+
# Whether Whop's platform default payment method enablement settings are included
|
|
254
|
+
# in this configuration. The full list of default payment methods can be found in
|
|
255
|
+
# the documentation at docs.whop.com/payments.
|
|
256
|
+
#
|
|
257
|
+
# @return [Boolean]
|
|
258
|
+
required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
|
|
259
|
+
|
|
260
|
+
# @!method initialize(disabled:, enabled:, include_platform_defaults:)
|
|
261
|
+
# Some parameter documentations has been truncated, see
|
|
262
|
+
# {WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration} for more
|
|
263
|
+
# details.
|
|
264
|
+
#
|
|
265
|
+
# The explicit payment method configuration for the plan, if any.
|
|
266
|
+
#
|
|
267
|
+
# @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
|
|
268
|
+
#
|
|
269
|
+
# @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
|
|
270
|
+
#
|
|
271
|
+
# @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
|
|
272
|
+
end
|
|
273
|
+
|
|
222
274
|
# @see WhopSDK::Models::PlanListResponse#product
|
|
223
275
|
class Product < WhopSDK::Internal::Type::BaseModel
|
|
224
276
|
# @!attribute id
|
|
@@ -234,7 +286,7 @@ module WhopSDK
|
|
|
234
286
|
required :title, String
|
|
235
287
|
|
|
236
288
|
# @!method initialize(id:, title:)
|
|
237
|
-
# The
|
|
289
|
+
# The product that this plan belongs to.
|
|
238
290
|
#
|
|
239
291
|
# @param id [String] The internal ID of the public product.
|
|
240
292
|
#
|
|
@@ -42,8 +42,8 @@ module WhopSDK
|
|
|
42
42
|
# @!attribute image
|
|
43
43
|
# An image for the plan. This will be visible on the product page to customers.
|
|
44
44
|
#
|
|
45
|
-
# @return [WhopSDK::Models::PlanUpdateParams::Image, nil]
|
|
46
|
-
optional :image, -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
|
|
45
|
+
# @return [WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID, nil]
|
|
46
|
+
optional :image, union: -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
|
|
47
47
|
|
|
48
48
|
# @!attribute initial_price
|
|
49
49
|
# An additional amount charged upon first purchase.
|
|
@@ -70,6 +70,15 @@ module WhopSDK
|
|
|
70
70
|
# @return [Symbol, WhopSDK::Models::TaxType, nil]
|
|
71
71
|
optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
|
|
72
72
|
|
|
73
|
+
# @!attribute payment_method_configuration
|
|
74
|
+
# The explicit payment method configuration for the plan. If sent as null, the
|
|
75
|
+
# custom configuration will be removed.
|
|
76
|
+
#
|
|
77
|
+
# @return [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil]
|
|
78
|
+
optional :payment_method_configuration,
|
|
79
|
+
-> { WhopSDK::PlanUpdateParams::PaymentMethodConfiguration },
|
|
80
|
+
nil?: true
|
|
81
|
+
|
|
73
82
|
# @!attribute renewal_price
|
|
74
83
|
# The amount the customer is charged every billing period.
|
|
75
84
|
#
|
|
@@ -120,7 +129,7 @@ module WhopSDK
|
|
|
120
129
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
121
130
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
122
131
|
|
|
123
|
-
# @!method initialize(billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
132
|
+
# @!method initialize(billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
|
|
124
133
|
# Some parameter documentations has been truncated, see
|
|
125
134
|
# {WhopSDK::Models::PlanUpdateParams} for more details.
|
|
126
135
|
#
|
|
@@ -134,7 +143,7 @@ module WhopSDK
|
|
|
134
143
|
#
|
|
135
144
|
# @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
|
|
136
145
|
#
|
|
137
|
-
# @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
|
|
146
|
+
# @param image [WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
|
|
138
147
|
#
|
|
139
148
|
# @param initial_price [Float, nil] An additional amount charged upon first purchase.
|
|
140
149
|
#
|
|
@@ -144,6 +153,8 @@ module WhopSDK
|
|
|
144
153
|
#
|
|
145
154
|
# @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
|
|
146
155
|
#
|
|
156
|
+
# @param payment_method_configuration [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If sent as null, the cus
|
|
157
|
+
#
|
|
147
158
|
# @param renewal_price [Float, nil] The amount the customer is charged every billing period.
|
|
148
159
|
#
|
|
149
160
|
# @param stock [Integer, nil] The number of units available for purchase.
|
|
@@ -213,32 +224,96 @@ module WhopSDK
|
|
|
213
224
|
# @param field_type [Symbol, :text] The type of the custom field.
|
|
214
225
|
end
|
|
215
226
|
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
#
|
|
227
|
+
# An image for the plan. This will be visible on the product page to customers.
|
|
228
|
+
module Image
|
|
229
|
+
extend WhopSDK::Internal::Type::Union
|
|
230
|
+
|
|
231
|
+
# Input for an attachment
|
|
232
|
+
variant -> { WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID }
|
|
233
|
+
|
|
234
|
+
# Input for an attachment
|
|
235
|
+
variant -> { WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID }
|
|
236
|
+
|
|
237
|
+
class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
|
|
238
|
+
# @!attribute direct_upload_id
|
|
239
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
240
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
241
|
+
# mediaDirectUpload mutation.
|
|
242
|
+
#
|
|
243
|
+
# @return [String]
|
|
244
|
+
required :direct_upload_id, String
|
|
245
|
+
|
|
246
|
+
# @!method initialize(direct_upload_id:)
|
|
247
|
+
# Some parameter documentations has been truncated, see
|
|
248
|
+
# {WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID}
|
|
249
|
+
# for more details.
|
|
250
|
+
#
|
|
251
|
+
# Input for an attachment
|
|
252
|
+
#
|
|
253
|
+
# @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
|
|
257
|
+
# @!attribute id
|
|
258
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
259
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
260
|
+
# doing.
|
|
261
|
+
#
|
|
262
|
+
# @return [String]
|
|
263
|
+
required :id, String
|
|
264
|
+
|
|
265
|
+
# @!method initialize(id:)
|
|
266
|
+
# Some parameter documentations has been truncated, see
|
|
267
|
+
# {WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID} for more
|
|
268
|
+
# details.
|
|
269
|
+
#
|
|
270
|
+
# Input for an attachment
|
|
271
|
+
#
|
|
272
|
+
# @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
|
|
273
|
+
end
|
|
274
|
+
|
|
275
|
+
# @!method self.variants
|
|
276
|
+
# @return [Array(WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID)]
|
|
277
|
+
end
|
|
278
|
+
|
|
279
|
+
class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
|
|
280
|
+
# @!attribute disabled
|
|
281
|
+
# An array of payment method identifiers that are explicitly disabled. Only
|
|
282
|
+
# applies if the include_platform_defaults is true.
|
|
221
283
|
#
|
|
222
|
-
# @return [
|
|
223
|
-
|
|
284
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
285
|
+
required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
224
286
|
|
|
225
|
-
# @!attribute
|
|
226
|
-
#
|
|
227
|
-
#
|
|
228
|
-
#
|
|
287
|
+
# @!attribute enabled
|
|
288
|
+
# An array of payment method identifiers that are explicitly enabled. This means
|
|
289
|
+
# these payment methods will be shown on checkout. Example use case is to only
|
|
290
|
+
# enable a specific payment method like cashapp, or extending the platform
|
|
291
|
+
# defaults with additional methods.
|
|
229
292
|
#
|
|
230
|
-
# @return [
|
|
231
|
-
|
|
293
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
294
|
+
required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
232
295
|
|
|
233
|
-
# @!
|
|
296
|
+
# @!attribute include_platform_defaults
|
|
297
|
+
# Whether Whop's platform default payment method enablement settings are included
|
|
298
|
+
# in this configuration. The full list of default payment methods can be found in
|
|
299
|
+
# the documentation at docs.whop.com/payments.
|
|
300
|
+
#
|
|
301
|
+
# @return [Boolean]
|
|
302
|
+
required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
|
|
303
|
+
|
|
304
|
+
# @!method initialize(disabled:, enabled:, include_platform_defaults:)
|
|
234
305
|
# Some parameter documentations has been truncated, see
|
|
235
|
-
# {WhopSDK::Models::PlanUpdateParams::
|
|
306
|
+
# {WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration} for more
|
|
307
|
+
# details.
|
|
308
|
+
#
|
|
309
|
+
# The explicit payment method configuration for the plan. If sent as null, the
|
|
310
|
+
# custom configuration will be removed.
|
|
236
311
|
#
|
|
237
|
-
#
|
|
312
|
+
# @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
|
|
238
313
|
#
|
|
239
|
-
# @param
|
|
314
|
+
# @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
|
|
240
315
|
#
|
|
241
|
-
# @param
|
|
316
|
+
# @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
|
|
242
317
|
end
|
|
243
318
|
end
|
|
244
319
|
end
|
|
@@ -155,7 +155,7 @@ module WhopSDK
|
|
|
155
155
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Product}
|
|
156
156
|
# for more details.
|
|
157
157
|
#
|
|
158
|
-
#
|
|
158
|
+
# Represents a product on whop. Use products to sell anything on the platform.
|
|
159
159
|
#
|
|
160
160
|
# @param id [String] The internal ID of the public product.
|
|
161
161
|
#
|
|
@@ -70,7 +70,7 @@ module WhopSDK
|
|
|
70
70
|
optional :global_affiliate_percentage, Float, nil?: true
|
|
71
71
|
|
|
72
72
|
# @!attribute global_affiliate_status
|
|
73
|
-
# The different statuses of the global affiliate program for
|
|
73
|
+
# The different statuses of the global affiliate program for a product.
|
|
74
74
|
#
|
|
75
75
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
76
76
|
optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
@@ -94,7 +94,7 @@ module WhopSDK
|
|
|
94
94
|
optional :member_affiliate_percentage, Float, nil?: true
|
|
95
95
|
|
|
96
96
|
# @!attribute member_affiliate_status
|
|
97
|
-
# The different statuses of the global affiliate program for
|
|
97
|
+
# The different statuses of the global affiliate program for a product.
|
|
98
98
|
#
|
|
99
99
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
100
100
|
optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
@@ -162,7 +162,7 @@ module WhopSDK
|
|
|
162
162
|
#
|
|
163
163
|
# @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
|
|
164
164
|
#
|
|
165
|
-
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for
|
|
165
|
+
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
166
166
|
#
|
|
167
167
|
# @param headline [String, nil] The headline of the product.
|
|
168
168
|
#
|
|
@@ -170,7 +170,7 @@ module WhopSDK
|
|
|
170
170
|
#
|
|
171
171
|
# @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
|
|
172
172
|
#
|
|
173
|
-
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for
|
|
173
|
+
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
174
174
|
#
|
|
175
175
|
# @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] The details to assign an autogenerated plan.
|
|
176
176
|
#
|
|
@@ -216,7 +216,7 @@ module WhopSDK
|
|
|
216
216
|
optional :initial_price, Float, nil?: true
|
|
217
217
|
|
|
218
218
|
# @!attribute plan_type
|
|
219
|
-
# The type of plan that can be attached to
|
|
219
|
+
# The type of plan that can be attached to a product
|
|
220
220
|
#
|
|
221
221
|
# @return [Symbol, WhopSDK::Models::PlanType, nil]
|
|
222
222
|
optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
|
|
@@ -250,7 +250,7 @@ module WhopSDK
|
|
|
250
250
|
#
|
|
251
251
|
# @param initial_price [Float, nil] An additional amount charged upon first purchase.
|
|
252
252
|
#
|
|
253
|
-
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to
|
|
253
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
|
|
254
254
|
#
|
|
255
255
|
# @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
|
|
256
256
|
#
|
|
@@ -87,7 +87,7 @@ module WhopSDK
|
|
|
87
87
|
# Some parameter documentations has been truncated, see
|
|
88
88
|
# {WhopSDK::Models::ProductListItem} for more details.
|
|
89
89
|
#
|
|
90
|
-
#
|
|
90
|
+
# Represents a product on whop. Use products to sell anything on the platform.
|
|
91
91
|
#
|
|
92
92
|
# @param id [String] The internal ID of the public product.
|
|
93
93
|
#
|