whop_sdk 0.0.2 → 0.0.3
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 +29 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +20 -0
- data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +30 -24
- data/lib/whop_sdk/models/assessment_question_types.rb +18 -0
- data/lib/whop_sdk/models/billing_reasons.rb +20 -0
- data/lib/whop_sdk/models/card_brands.rb +30 -0
- data/lib/whop_sdk/models/checkout_configuration.rb +10 -7
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +140 -3
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +10 -7
- data/lib/whop_sdk/models/course.rb +230 -0
- data/lib/whop_sdk/models/course_chapter.rb +72 -0
- data/lib/whop_sdk/models/course_chapter_create_params.rb +30 -0
- data/lib/whop_sdk/models/course_chapter_delete_params.rb +14 -0
- data/lib/whop_sdk/models/course_chapter_delete_response.rb +8 -0
- data/lib/whop_sdk/models/course_chapter_list_params.rb +54 -0
- data/lib/whop_sdk/models/course_chapter_list_response.rb +35 -0
- data/lib/whop_sdk/models/course_chapter_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/course_chapter_update_params.rb +22 -0
- data/lib/whop_sdk/models/course_create_params.rb +82 -0
- data/lib/whop_sdk/models/course_delete_params.rb +14 -0
- data/lib/whop_sdk/models/course_delete_response.rb +8 -0
- data/lib/whop_sdk/models/course_lesson_create_params.rb +54 -0
- data/lib/whop_sdk/models/course_lesson_delete_params.rb +14 -0
- data/lib/whop_sdk/models/course_lesson_delete_response.rb +8 -0
- data/lib/whop_sdk/models/course_lesson_list_params.rb +62 -0
- data/lib/whop_sdk/models/course_lesson_list_response.rb +71 -0
- data/lib/whop_sdk/models/course_lesson_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/course_lesson_update_params.rb +278 -0
- data/lib/whop_sdk/models/course_list_params.rb +62 -0
- data/lib/whop_sdk/models/course_list_response.rb +148 -0
- data/lib/whop_sdk/models/course_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/course_update_params.rb +197 -0
- data/lib/whop_sdk/models/experience_duplicate_params.rb +22 -0
- data/lib/whop_sdk/models/forum_post.rb +17 -1
- data/lib/whop_sdk/models/forum_post_list_response.rb +17 -1
- data/lib/whop_sdk/models/forum_post_update_params.rb +80 -0
- data/lib/whop_sdk/models/invoice.rb +6 -2
- data/lib/whop_sdk/models/invoice_list_item.rb +6 -2
- data/lib/whop_sdk/models/languages.rb +36 -0
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +9 -0
- data/lib/whop_sdk/models/lesson.rb +365 -0
- data/lib/whop_sdk/models/lesson_types.rb +20 -0
- data/lib/whop_sdk/models/lesson_visibilities.rb +17 -0
- data/lib/whop_sdk/models/member_list_params.rb +9 -1
- data/lib/whop_sdk/models/membership.rb +31 -1
- data/lib/whop_sdk/models/membership_list_params.rb +16 -8
- data/lib/whop_sdk/models/membership_list_response.rb +31 -1
- data/lib/whop_sdk/models/message_update_params.rb +68 -0
- data/lib/whop_sdk/models/payment.rb +24 -21
- data/lib/whop_sdk/models/payment_list_params.rb +3 -18
- data/lib/whop_sdk/models/payment_list_response.rb +24 -21
- data/lib/whop_sdk/models/payment_method_types.rb +98 -0
- data/lib/whop_sdk/models/plan.rb +25 -1
- data/lib/whop_sdk/models/plan_create_params.rb +37 -3
- data/lib/whop_sdk/models/plan_list_response.rb +25 -1
- data/lib/whop_sdk/models/plan_update_params.rb +35 -1
- data/lib/whop_sdk/models/product.rb +11 -1
- data/lib/whop_sdk/models/product_create_params.rb +1 -45
- data/lib/whop_sdk/models/product_list_item.rb +14 -1
- data/lib/whop_sdk/models/product_update_params.rb +30 -1
- data/lib/whop_sdk/models/promo_code.rb +211 -0
- data/lib/whop_sdk/models/promo_code_create_params.rb +140 -0
- data/lib/whop_sdk/models/promo_code_delete_params.rb +14 -0
- data/lib/whop_sdk/models/promo_code_delete_response.rb +8 -0
- data/lib/whop_sdk/models/promo_code_list_params.rb +78 -0
- data/lib/whop_sdk/models/promo_code_list_response.rb +181 -0
- data/lib/whop_sdk/models/promo_code_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/promo_code_status.rb +17 -0
- data/lib/whop_sdk/models/promo_duration.rb +17 -0
- data/lib/whop_sdk/models/review_list_params.rb +70 -0
- data/lib/whop_sdk/models/review_list_response.rb +183 -0
- data/lib/whop_sdk/models/review_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/review_retrieve_response.rb +251 -0
- data/lib/whop_sdk/models/review_status.rb +17 -0
- data/lib/whop_sdk/models.rb +76 -0
- data/lib/whop_sdk/resources/checkout_configurations.rb +2 -0
- data/lib/whop_sdk/resources/course_chapters.rb +151 -0
- data/lib/whop_sdk/resources/course_lessons.rb +178 -0
- data/lib/whop_sdk/resources/courses.rb +178 -0
- data/lib/whop_sdk/resources/experiences.rb +33 -0
- data/lib/whop_sdk/resources/forum_posts.rb +33 -0
- data/lib/whop_sdk/resources/members.rb +3 -1
- data/lib/whop_sdk/resources/memberships.rb +6 -4
- data/lib/whop_sdk/resources/messages.rb +28 -0
- data/lib/whop_sdk/resources/payments.rb +1 -1
- data/lib/whop_sdk/resources/plans.rb +19 -3
- data/lib/whop_sdk/resources/products.rb +4 -6
- data/lib/whop_sdk/resources/promo_codes.rb +161 -0
- data/lib/whop_sdk/resources/reviews.rb +68 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +53 -0
- data/rbi/whop_sdk/client.rbi +15 -0
- data/rbi/whop_sdk/models/assessment_question_types.rbi +31 -0
- data/rbi/whop_sdk/models/billing_reasons.rbi +27 -0
- data/rbi/whop_sdk/models/card_brands.rbi +35 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +4 -2
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +183 -2
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +4 -2
- data/rbi/whop_sdk/models/course.rbi +313 -0
- data/rbi/whop_sdk/models/course_chapter.rbi +101 -0
- data/rbi/whop_sdk/models/course_chapter_create_params.rbi +51 -0
- data/rbi/whop_sdk/models/course_chapter_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_chapter_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_chapter_list_params.rbi +75 -0
- data/rbi/whop_sdk/models/course_chapter_list_response.rbi +47 -0
- data/rbi/whop_sdk/models/course_chapter_retrieve_params.rbi +30 -0
- data/rbi/whop_sdk/models/course_chapter_update_params.rbi +40 -0
- data/rbi/whop_sdk/models/course_create_params.rbi +131 -0
- data/rbi/whop_sdk/models/course_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_delete_response.rbi +7 -0
- data/rbi/whop_sdk/models/course_lesson_create_params.rbi +75 -0
- data/rbi/whop_sdk/models/course_lesson_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_lesson_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/course_lesson_list_response.rbi +91 -0
- data/rbi/whop_sdk/models/course_lesson_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_lesson_update_params.rbi +465 -0
- data/rbi/whop_sdk/models/course_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/course_list_response.rbi +198 -0
- data/rbi/whop_sdk/models/course_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_update_params.rbi +293 -0
- data/rbi/whop_sdk/models/experience_duplicate_params.rbi +40 -0
- data/rbi/whop_sdk/models/forum_post.rbi +16 -0
- data/rbi/whop_sdk/models/forum_post_list_response.rbi +16 -0
- data/rbi/whop_sdk/models/forum_post_update_params.rbi +124 -0
- data/rbi/whop_sdk/models/invoice.rbi +4 -2
- data/rbi/whop_sdk/models/invoice_list_item.rbi +4 -2
- data/rbi/whop_sdk/models/languages.rbi +40 -0
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +45 -0
- data/rbi/whop_sdk/models/lesson.rbi +517 -0
- data/rbi/whop_sdk/models/lesson_types.rbi +25 -0
- data/rbi/whop_sdk/models/lesson_visibilities.rbi +23 -0
- data/rbi/whop_sdk/models/member_list_params.rbi +8 -0
- data/rbi/whop_sdk/models/membership.rbi +40 -0
- data/rbi/whop_sdk/models/membership_list_params.rbi +16 -8
- data/rbi/whop_sdk/models/membership_list_response.rbi +47 -0
- data/rbi/whop_sdk/models/message_update_params.rbi +114 -0
- data/rbi/whop_sdk/models/payment.rbi +32 -25
- data/rbi/whop_sdk/models/payment_list_params.rbi +3 -63
- data/rbi/whop_sdk/models/payment_list_response.rbi +32 -25
- data/rbi/whop_sdk/models/payment_method_types.rbi +116 -0
- data/rbi/whop_sdk/models/plan.rbi +24 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +38 -2
- data/rbi/whop_sdk/models/plan_list_response.rbi +24 -0
- data/rbi/whop_sdk/models/plan_update_params.rbi +36 -0
- data/rbi/whop_sdk/models/product.rbi +12 -0
- data/rbi/whop_sdk/models/product_create_params.rbi +0 -74
- data/rbi/whop_sdk/models/product_list_item.rbi +12 -0
- data/rbi/whop_sdk/models/product_update_params.rbi +59 -0
- data/rbi/whop_sdk/models/promo_code.rbi +248 -0
- data/rbi/whop_sdk/models/promo_code_create_params.rbi +161 -0
- data/rbi/whop_sdk/models/promo_code_delete_params.rbi +27 -0
- data/rbi/whop_sdk/models/promo_code_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/promo_code_list_params.rbi +99 -0
- data/rbi/whop_sdk/models/promo_code_list_response.rbi +222 -0
- data/rbi/whop_sdk/models/promo_code_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/promo_code_status.rbi +21 -0
- data/rbi/whop_sdk/models/promo_duration.rbi +21 -0
- data/rbi/whop_sdk/models/review_list_params.rbi +91 -0
- data/rbi/whop_sdk/models/review_list_response.rbi +243 -0
- data/rbi/whop_sdk/models/review_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/review_retrieve_response.rbi +354 -0
- data/rbi/whop_sdk/models/review_status.rbi +21 -0
- data/rbi/whop_sdk/models.rbi +76 -0
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +2 -0
- data/rbi/whop_sdk/resources/course_chapters.rbi +115 -0
- data/rbi/whop_sdk/resources/course_lessons.rbi +163 -0
- data/rbi/whop_sdk/resources/courses.rbi +152 -0
- data/rbi/whop_sdk/resources/experiences.rbi +25 -0
- data/rbi/whop_sdk/resources/forum_posts.rbi +29 -0
- data/rbi/whop_sdk/resources/members.rbi +3 -0
- data/rbi/whop_sdk/resources/memberships.rbi +6 -3
- data/rbi/whop_sdk/resources/messages.rbi +25 -0
- data/rbi/whop_sdk/resources/payments.rbi +1 -3
- data/rbi/whop_sdk/resources/plans.rbi +29 -1
- data/rbi/whop_sdk/resources/products.rbi +4 -7
- data/rbi/whop_sdk/resources/promo_codes.rbi +147 -0
- data/rbi/whop_sdk/resources/reviews.rbi +56 -0
- data/sig/whop_sdk/client.rbs +10 -0
- data/sig/whop_sdk/models/assessment_question_types.rbs +17 -0
- data/sig/whop_sdk/models/billing_reasons.rbs +24 -0
- data/sig/whop_sdk/models/card_brands.rbs +44 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +87 -0
- data/sig/whop_sdk/models/course.rbs +171 -0
- data/sig/whop_sdk/models/course_chapter.rbs +49 -0
- data/sig/whop_sdk/models/course_chapter_create_params.rbs +28 -0
- data/sig/whop_sdk/models/course_chapter_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/course_chapter_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/course_chapter_list_params.rbs +46 -0
- data/sig/whop_sdk/models/course_chapter_list_response.rbs +18 -0
- data/sig/whop_sdk/models/course_chapter_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/course_chapter_update_params.rbs +23 -0
- data/sig/whop_sdk/models/course_create_params.rbs +58 -0
- data/sig/whop_sdk/models/course_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/course_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_create_params.rbs +46 -0
- data/sig/whop_sdk/models/course_lesson_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/course_lesson_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_list_params.rbs +51 -0
- data/sig/whop_sdk/models/course_lesson_list_response.rbs +50 -0
- data/sig/whop_sdk/models/course_lesson_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/course_lesson_update_params.rbs +162 -0
- data/sig/whop_sdk/models/course_list_params.rbs +51 -0
- data/sig/whop_sdk/models/course_list_response.rbs +102 -0
- data/sig/whop_sdk/models/course_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/course_update_params.rbs +137 -0
- data/sig/whop_sdk/models/experience_duplicate_params.rbs +23 -0
- data/sig/whop_sdk/models/forum_post.rbs +10 -0
- data/sig/whop_sdk/models/forum_post_list_response.rbs +10 -0
- data/sig/whop_sdk/models/forum_post_update_params.rbs +53 -0
- data/sig/whop_sdk/models/languages.rbs +56 -0
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +20 -1
- data/sig/whop_sdk/models/lesson.rbs +248 -0
- data/sig/whop_sdk/models/lesson_types.rbs +19 -0
- data/sig/whop_sdk/models/lesson_visibilities.rbs +14 -0
- data/sig/whop_sdk/models/member_list_params.rbs +6 -1
- data/sig/whop_sdk/models/membership.rbs +17 -0
- data/sig/whop_sdk/models/membership_list_params.rbs +11 -6
- data/sig/whop_sdk/models/membership_list_response.rbs +17 -0
- data/sig/whop_sdk/models/message_update_params.rbs +48 -0
- data/sig/whop_sdk/models/payment.rbs +12 -12
- data/sig/whop_sdk/models/payment_list_params.rbs +4 -25
- data/sig/whop_sdk/models/payment_list_response.rbs +12 -12
- data/sig/whop_sdk/models/payment_method_types.rbs +180 -0
- data/sig/whop_sdk/models/plan.rbs +15 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +20 -0
- data/sig/whop_sdk/models/plan_list_response.rbs +15 -0
- data/sig/whop_sdk/models/plan_update_params.rbs +20 -0
- data/sig/whop_sdk/models/product.rbs +5 -0
- data/sig/whop_sdk/models/product_create_params.rbs +0 -22
- data/sig/whop_sdk/models/product_list_item.rbs +5 -0
- data/sig/whop_sdk/models/product_update_params.rbs +17 -0
- data/sig/whop_sdk/models/promo_code.rbs +134 -0
- data/sig/whop_sdk/models/promo_code_create_params.rbs +96 -0
- data/sig/whop_sdk/models/promo_code_delete_params.rbs +15 -0
- data/sig/whop_sdk/models/promo_code_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/promo_code_list_params.rbs +61 -0
- data/sig/whop_sdk/models/promo_code_list_response.rbs +117 -0
- data/sig/whop_sdk/models/promo_code_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/promo_code_status.rbs +15 -0
- data/sig/whop_sdk/models/promo_duration.rbs +15 -0
- data/sig/whop_sdk/models/review_list_params.rbs +56 -0
- data/sig/whop_sdk/models/review_list_response.rbs +116 -0
- data/sig/whop_sdk/models/review_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/review_retrieve_response.rbs +152 -0
- data/sig/whop_sdk/models/review_status.rbs +15 -0
- data/sig/whop_sdk/models.rbs +76 -0
- data/sig/whop_sdk/resources/course_chapters.rbs +35 -0
- data/sig/whop_sdk/resources/course_lessons.rbs +47 -0
- data/sig/whop_sdk/resources/courses.rbs +47 -0
- data/sig/whop_sdk/resources/experiences.rbs +6 -0
- data/sig/whop_sdk/resources/forum_posts.rbs +9 -0
- data/sig/whop_sdk/resources/members.rbs +1 -0
- data/sig/whop_sdk/resources/memberships.rbs +2 -1
- data/sig/whop_sdk/resources/messages.rbs +8 -0
- data/sig/whop_sdk/resources/payments.rbs +1 -1
- data/sig/whop_sdk/resources/plans.rbs +8 -0
- data/sig/whop_sdk/resources/products.rbs +1 -2
- data/sig/whop_sdk/resources/promo_codes.rbs +45 -0
- data/sig/whop_sdk/resources/reviews.rbs +23 -0
- metadata +189 -2
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class CourseLessons
|
|
6
|
+
# Creates a new course lesson
|
|
7
|
+
#
|
|
8
|
+
# Required permissions:
|
|
9
|
+
#
|
|
10
|
+
# - `courses:update`
|
|
11
|
+
#
|
|
12
|
+
# @overload create(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, title: nil, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param chapter_id [String] The ID of the chapter to create the lesson in
|
|
15
|
+
#
|
|
16
|
+
# @param lesson_type [Symbol, WhopSDK::Models::LessonTypes] The type of the lesson
|
|
17
|
+
#
|
|
18
|
+
# @param content [String, nil] The content of the lesson
|
|
19
|
+
#
|
|
20
|
+
# @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
|
|
21
|
+
#
|
|
22
|
+
# @param title [String, nil] The title of the lesson
|
|
23
|
+
#
|
|
24
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
25
|
+
#
|
|
26
|
+
# @return [WhopSDK::Models::Lesson]
|
|
27
|
+
#
|
|
28
|
+
# @see WhopSDK::Models::CourseLessonCreateParams
|
|
29
|
+
def create(params)
|
|
30
|
+
parsed, options = WhopSDK::CourseLessonCreateParams.dump_request(params)
|
|
31
|
+
@client.request(
|
|
32
|
+
method: :post,
|
|
33
|
+
path: "course_lessons",
|
|
34
|
+
body: parsed,
|
|
35
|
+
model: WhopSDK::Lesson,
|
|
36
|
+
options: options
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Retrieves a course lesson by ID
|
|
41
|
+
#
|
|
42
|
+
# Required permissions:
|
|
43
|
+
#
|
|
44
|
+
# - `courses:read`
|
|
45
|
+
#
|
|
46
|
+
# @overload retrieve(id, request_options: {})
|
|
47
|
+
#
|
|
48
|
+
# @param id [String]
|
|
49
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
50
|
+
#
|
|
51
|
+
# @return [WhopSDK::Models::Lesson]
|
|
52
|
+
#
|
|
53
|
+
# @see WhopSDK::Models::CourseLessonRetrieveParams
|
|
54
|
+
def retrieve(id, params = {})
|
|
55
|
+
@client.request(
|
|
56
|
+
method: :get,
|
|
57
|
+
path: ["course_lessons/%1$s", id],
|
|
58
|
+
model: WhopSDK::Lesson,
|
|
59
|
+
options: params[:request_options]
|
|
60
|
+
)
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# Some parameter documentations has been truncated, see
|
|
64
|
+
# {WhopSDK::Models::CourseLessonUpdateParams} for more details.
|
|
65
|
+
#
|
|
66
|
+
# Updates a course lesson
|
|
67
|
+
#
|
|
68
|
+
# Required permissions:
|
|
69
|
+
#
|
|
70
|
+
# - `courses:update`
|
|
71
|
+
#
|
|
72
|
+
# @overload update(id, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, lesson_type: nil, main_pdf: nil, mux_asset_id: nil, title: nil, visibility: nil, request_options: {})
|
|
73
|
+
#
|
|
74
|
+
# @param id [String]
|
|
75
|
+
#
|
|
76
|
+
# @param assessment_questions [Array<WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion>, nil] Assessment questions for quiz/knowledge check lessons. Replaces all existing que
|
|
77
|
+
#
|
|
78
|
+
# @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment>, nil] General attachments for the lesson (PDFs, files, etc). Replaces all existing att
|
|
79
|
+
#
|
|
80
|
+
# @param content [String, nil] The content of the lesson
|
|
81
|
+
#
|
|
82
|
+
# @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
|
|
83
|
+
#
|
|
84
|
+
# @param lesson_type [Symbol, WhopSDK::Models::LessonTypes, nil] The available types for a lesson
|
|
85
|
+
#
|
|
86
|
+
# @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf, nil] The main PDF file for this lesson
|
|
87
|
+
#
|
|
88
|
+
# @param mux_asset_id [String, nil] The ID of the Mux asset to attach to this lesson for video lessons
|
|
89
|
+
#
|
|
90
|
+
# @param title [String, nil] The title of the lesson
|
|
91
|
+
#
|
|
92
|
+
# @param visibility [Symbol, WhopSDK::Models::LessonVisibilities, nil] The available visibilities for a lesson. Determines how / whether a lesson is vi
|
|
93
|
+
#
|
|
94
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
|
+
#
|
|
96
|
+
# @return [WhopSDK::Models::Lesson]
|
|
97
|
+
#
|
|
98
|
+
# @see WhopSDK::Models::CourseLessonUpdateParams
|
|
99
|
+
def update(id, params = {})
|
|
100
|
+
parsed, options = WhopSDK::CourseLessonUpdateParams.dump_request(params)
|
|
101
|
+
@client.request(
|
|
102
|
+
method: :patch,
|
|
103
|
+
path: ["course_lessons/%1$s", id],
|
|
104
|
+
body: parsed,
|
|
105
|
+
model: WhopSDK::Lesson,
|
|
106
|
+
options: options
|
|
107
|
+
)
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Lists lessons for a course or chapter
|
|
111
|
+
#
|
|
112
|
+
# Required permissions:
|
|
113
|
+
#
|
|
114
|
+
# - `courses:read`
|
|
115
|
+
#
|
|
116
|
+
# @overload list(after: nil, before: nil, chapter_id: nil, course_id: nil, first: nil, last: nil, request_options: {})
|
|
117
|
+
#
|
|
118
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
119
|
+
#
|
|
120
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
121
|
+
#
|
|
122
|
+
# @param chapter_id [String, nil] The ID of the chapter (returns lessons only for this chapter)
|
|
123
|
+
#
|
|
124
|
+
# @param course_id [String, nil] The ID of the course (returns all lessons across all chapters)
|
|
125
|
+
#
|
|
126
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
127
|
+
#
|
|
128
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
129
|
+
#
|
|
130
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
131
|
+
#
|
|
132
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseLessonListResponse>]
|
|
133
|
+
#
|
|
134
|
+
# @see WhopSDK::Models::CourseLessonListParams
|
|
135
|
+
def list(params = {})
|
|
136
|
+
parsed, options = WhopSDK::CourseLessonListParams.dump_request(params)
|
|
137
|
+
@client.request(
|
|
138
|
+
method: :get,
|
|
139
|
+
path: "course_lessons",
|
|
140
|
+
query: parsed,
|
|
141
|
+
page: WhopSDK::Internal::CursorPage,
|
|
142
|
+
model: WhopSDK::Models::CourseLessonListResponse,
|
|
143
|
+
options: options
|
|
144
|
+
)
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Deletes a course lesson
|
|
148
|
+
#
|
|
149
|
+
# Required permissions:
|
|
150
|
+
#
|
|
151
|
+
# - `courses:update`
|
|
152
|
+
#
|
|
153
|
+
# @overload delete(id, request_options: {})
|
|
154
|
+
#
|
|
155
|
+
# @param id [String]
|
|
156
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
157
|
+
#
|
|
158
|
+
# @return [Boolean]
|
|
159
|
+
#
|
|
160
|
+
# @see WhopSDK::Models::CourseLessonDeleteParams
|
|
161
|
+
def delete(id, params = {})
|
|
162
|
+
@client.request(
|
|
163
|
+
method: :delete,
|
|
164
|
+
path: ["course_lessons/%1$s", id],
|
|
165
|
+
model: WhopSDK::Internal::Type::Boolean,
|
|
166
|
+
options: params[:request_options]
|
|
167
|
+
)
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# @api private
|
|
171
|
+
#
|
|
172
|
+
# @param client [WhopSDK::Client]
|
|
173
|
+
def initialize(client:)
|
|
174
|
+
@client = client
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Courses
|
|
6
|
+
# Creates a new course module in an experience
|
|
7
|
+
#
|
|
8
|
+
# Required permissions:
|
|
9
|
+
#
|
|
10
|
+
# - `courses:update`
|
|
11
|
+
#
|
|
12
|
+
# @overload create(experience_id:, title:, cover_image: nil, tagline: nil, thumbnail: nil, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param experience_id [String] The ID of the experience to create the course in
|
|
15
|
+
#
|
|
16
|
+
# @param title [String] The title of the course
|
|
17
|
+
#
|
|
18
|
+
# @param cover_image [String, nil] The cover image URL of the course
|
|
19
|
+
#
|
|
20
|
+
# @param tagline [String, nil] The tagline of the course
|
|
21
|
+
#
|
|
22
|
+
# @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
|
|
23
|
+
#
|
|
24
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
25
|
+
#
|
|
26
|
+
# @return [WhopSDK::Models::Course]
|
|
27
|
+
#
|
|
28
|
+
# @see WhopSDK::Models::CourseCreateParams
|
|
29
|
+
def create(params)
|
|
30
|
+
parsed, options = WhopSDK::CourseCreateParams.dump_request(params)
|
|
31
|
+
@client.request(
|
|
32
|
+
method: :post,
|
|
33
|
+
path: "courses",
|
|
34
|
+
body: parsed,
|
|
35
|
+
model: WhopSDK::Course,
|
|
36
|
+
options: options
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Retrieves a course by ID
|
|
41
|
+
#
|
|
42
|
+
# Required permissions:
|
|
43
|
+
#
|
|
44
|
+
# - `courses:read`
|
|
45
|
+
#
|
|
46
|
+
# @overload retrieve(id, request_options: {})
|
|
47
|
+
#
|
|
48
|
+
# @param id [String]
|
|
49
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
50
|
+
#
|
|
51
|
+
# @return [WhopSDK::Models::Course]
|
|
52
|
+
#
|
|
53
|
+
# @see WhopSDK::Models::CourseRetrieveParams
|
|
54
|
+
def retrieve(id, params = {})
|
|
55
|
+
@client.request(
|
|
56
|
+
method: :get,
|
|
57
|
+
path: ["courses/%1$s", id],
|
|
58
|
+
model: WhopSDK::Course,
|
|
59
|
+
options: params[:request_options]
|
|
60
|
+
)
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# Some parameter documentations has been truncated, see
|
|
64
|
+
# {WhopSDK::Models::CourseUpdateParams} for more details.
|
|
65
|
+
#
|
|
66
|
+
# Updates a course
|
|
67
|
+
#
|
|
68
|
+
# Required permissions:
|
|
69
|
+
#
|
|
70
|
+
# - `courses:update`
|
|
71
|
+
#
|
|
72
|
+
# @overload update(id, certificate_after_completion_enabled: nil, chapters: nil, cover_image: nil, description: nil, language: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, request_options: {})
|
|
73
|
+
#
|
|
74
|
+
# @param id [String]
|
|
75
|
+
#
|
|
76
|
+
# @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
|
|
77
|
+
#
|
|
78
|
+
# @param chapters [Array<WhopSDK::Models::CourseUpdateParams::Chapter>, nil] The chapters and lessons to update
|
|
79
|
+
#
|
|
80
|
+
# @param cover_image [String, nil] The cover image URL of the course
|
|
81
|
+
#
|
|
82
|
+
# @param description [String, nil] A short description of the course
|
|
83
|
+
#
|
|
84
|
+
# @param language [Symbol, WhopSDK::Models::Languages, nil] The available languages for a course
|
|
85
|
+
#
|
|
86
|
+
# @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
|
|
87
|
+
#
|
|
88
|
+
# @param tagline [String, nil] A short tagline for the course
|
|
89
|
+
#
|
|
90
|
+
# @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
|
|
91
|
+
#
|
|
92
|
+
# @param title [String, nil] The title of the course
|
|
93
|
+
#
|
|
94
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
|
+
#
|
|
96
|
+
# @return [WhopSDK::Models::Course]
|
|
97
|
+
#
|
|
98
|
+
# @see WhopSDK::Models::CourseUpdateParams
|
|
99
|
+
def update(id, params = {})
|
|
100
|
+
parsed, options = WhopSDK::CourseUpdateParams.dump_request(params)
|
|
101
|
+
@client.request(
|
|
102
|
+
method: :patch,
|
|
103
|
+
path: ["courses/%1$s", id],
|
|
104
|
+
body: parsed,
|
|
105
|
+
model: WhopSDK::Course,
|
|
106
|
+
options: options
|
|
107
|
+
)
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Lists courses for an experience or company
|
|
111
|
+
#
|
|
112
|
+
# Required permissions:
|
|
113
|
+
#
|
|
114
|
+
# - `courses:read`
|
|
115
|
+
#
|
|
116
|
+
# @overload list(after: nil, before: nil, company_id: nil, experience_id: nil, first: nil, last: nil, request_options: {})
|
|
117
|
+
#
|
|
118
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
119
|
+
#
|
|
120
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
121
|
+
#
|
|
122
|
+
# @param company_id [String, nil] The ID of the company
|
|
123
|
+
#
|
|
124
|
+
# @param experience_id [String, nil] The ID of the experience
|
|
125
|
+
#
|
|
126
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
127
|
+
#
|
|
128
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
129
|
+
#
|
|
130
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
131
|
+
#
|
|
132
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseListResponse>]
|
|
133
|
+
#
|
|
134
|
+
# @see WhopSDK::Models::CourseListParams
|
|
135
|
+
def list(params = {})
|
|
136
|
+
parsed, options = WhopSDK::CourseListParams.dump_request(params)
|
|
137
|
+
@client.request(
|
|
138
|
+
method: :get,
|
|
139
|
+
path: "courses",
|
|
140
|
+
query: parsed,
|
|
141
|
+
page: WhopSDK::Internal::CursorPage,
|
|
142
|
+
model: WhopSDK::Models::CourseListResponse,
|
|
143
|
+
options: options
|
|
144
|
+
)
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
# Deletes a course
|
|
148
|
+
#
|
|
149
|
+
# Required permissions:
|
|
150
|
+
#
|
|
151
|
+
# - `courses:update`
|
|
152
|
+
#
|
|
153
|
+
# @overload delete(id, request_options: {})
|
|
154
|
+
#
|
|
155
|
+
# @param id [String]
|
|
156
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
157
|
+
#
|
|
158
|
+
# @return [Boolean]
|
|
159
|
+
#
|
|
160
|
+
# @see WhopSDK::Models::CourseDeleteParams
|
|
161
|
+
def delete(id, params = {})
|
|
162
|
+
@client.request(
|
|
163
|
+
method: :delete,
|
|
164
|
+
path: ["courses/%1$s", id],
|
|
165
|
+
model: WhopSDK::Internal::Type::Boolean,
|
|
166
|
+
options: params[:request_options]
|
|
167
|
+
)
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
# @api private
|
|
171
|
+
#
|
|
172
|
+
# @param client [WhopSDK::Client]
|
|
173
|
+
def initialize(client:)
|
|
174
|
+
@client = client
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|
|
@@ -204,6 +204,39 @@ module WhopSDK
|
|
|
204
204
|
)
|
|
205
205
|
end
|
|
206
206
|
|
|
207
|
+
# Duplicates an existing experience. The name will be copied, unless provided. The
|
|
208
|
+
# new experience will be attached to the same products as the original experience.
|
|
209
|
+
# If duplicating a Forum or Chat experience, the new experience will have the same
|
|
210
|
+
# settings as the original experience, e.g. who can post, who can comment, etc. No
|
|
211
|
+
# content, e.g. posts, messages, lessons from within the original experience will
|
|
212
|
+
# be copied.
|
|
213
|
+
#
|
|
214
|
+
# Required permissions:
|
|
215
|
+
#
|
|
216
|
+
# - `experience:create`
|
|
217
|
+
#
|
|
218
|
+
# @overload duplicate(id, name: nil, request_options: {})
|
|
219
|
+
#
|
|
220
|
+
# @param id [String]
|
|
221
|
+
#
|
|
222
|
+
# @param name [String, nil] The name of the new experience
|
|
223
|
+
#
|
|
224
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
225
|
+
#
|
|
226
|
+
# @return [WhopSDK::Models::Experience]
|
|
227
|
+
#
|
|
228
|
+
# @see WhopSDK::Models::ExperienceDuplicateParams
|
|
229
|
+
def duplicate(id, params = {})
|
|
230
|
+
parsed, options = WhopSDK::ExperienceDuplicateParams.dump_request(params)
|
|
231
|
+
@client.request(
|
|
232
|
+
method: :post,
|
|
233
|
+
path: ["experiences/%1$s/duplicate", id],
|
|
234
|
+
body: parsed,
|
|
235
|
+
model: WhopSDK::Experience,
|
|
236
|
+
options: options
|
|
237
|
+
)
|
|
238
|
+
end
|
|
239
|
+
|
|
207
240
|
# @api private
|
|
208
241
|
#
|
|
209
242
|
# @param client [WhopSDK::Client]
|
|
@@ -73,6 +73,39 @@ module WhopSDK
|
|
|
73
73
|
)
|
|
74
74
|
end
|
|
75
75
|
|
|
76
|
+
# Some parameter documentations has been truncated, see
|
|
77
|
+
# {WhopSDK::Models::ForumPostUpdateParams} for more details.
|
|
78
|
+
#
|
|
79
|
+
# Update an existing forum post
|
|
80
|
+
#
|
|
81
|
+
# @overload update(id, attachments: nil, content: nil, is_pinned: nil, title: nil, request_options: {})
|
|
82
|
+
#
|
|
83
|
+
# @param id [String]
|
|
84
|
+
#
|
|
85
|
+
# @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment>, nil] The attachments for this post
|
|
86
|
+
#
|
|
87
|
+
# @param content [String, nil] This is the main body of the post in Markdown format. Hidden if paywalled and us
|
|
88
|
+
#
|
|
89
|
+
# @param is_pinned [Boolean, nil] Whether the post is pinned. You can only pin a top level posts (not comments).
|
|
90
|
+
#
|
|
91
|
+
# @param title [String, nil] The title of the post. Only visible if paywalled.
|
|
92
|
+
#
|
|
93
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
94
|
+
#
|
|
95
|
+
# @return [WhopSDK::Models::ForumPost]
|
|
96
|
+
#
|
|
97
|
+
# @see WhopSDK::Models::ForumPostUpdateParams
|
|
98
|
+
def update(id, params = {})
|
|
99
|
+
parsed, options = WhopSDK::ForumPostUpdateParams.dump_request(params)
|
|
100
|
+
@client.request(
|
|
101
|
+
method: :patch,
|
|
102
|
+
path: ["forum_posts/%1$s", id],
|
|
103
|
+
body: parsed,
|
|
104
|
+
model: WhopSDK::ForumPost,
|
|
105
|
+
options: options
|
|
106
|
+
)
|
|
107
|
+
end
|
|
108
|
+
|
|
76
109
|
# Lists forum posts
|
|
77
110
|
#
|
|
78
111
|
# Required permissions:
|
|
@@ -39,7 +39,7 @@ module WhopSDK
|
|
|
39
39
|
# - `member:email:read`
|
|
40
40
|
# - `member:phone:read`
|
|
41
41
|
#
|
|
42
|
-
# @overload list(company_id:, access_level: nil, access_pass_ids: nil, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, most_recent_actions: nil, order: nil, plan_ids: nil, promo_code_ids: nil, query: nil, statuses: nil, request_options: {})
|
|
42
|
+
# @overload list(company_id:, access_level: nil, access_pass_ids: nil, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, most_recent_actions: nil, order: nil, plan_ids: nil, promo_code_ids: nil, query: nil, statuses: nil, user_ids: nil, request_options: {})
|
|
43
43
|
#
|
|
44
44
|
# @param company_id [String] The ID of the company to list members for
|
|
45
45
|
#
|
|
@@ -73,6 +73,8 @@ module WhopSDK
|
|
|
73
73
|
#
|
|
74
74
|
# @param statuses [Array<Symbol, WhopSDK::Models::MemberStatuses>, nil] The statuses to filter the members by
|
|
75
75
|
#
|
|
76
|
+
# @param user_ids [Array<String>, nil] The user IDs to filter the members by
|
|
77
|
+
#
|
|
76
78
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
77
79
|
#
|
|
78
80
|
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::MemberListResponse>]
|
|
@@ -61,9 +61,7 @@ module WhopSDK
|
|
|
61
61
|
#
|
|
62
62
|
# - `member:basic:read`
|
|
63
63
|
#
|
|
64
|
-
# @overload list(
|
|
65
|
-
#
|
|
66
|
-
# @param company_id [String] The ID of the company to list memberships for
|
|
64
|
+
# @overload list(access_pass_ids: nil, after: nil, before: nil, cancel_options: nil, company_id: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, promo_code_ids: nil, statuses: nil, user_ids: nil, request_options: {})
|
|
67
65
|
#
|
|
68
66
|
# @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the memberships by
|
|
69
67
|
#
|
|
@@ -73,6 +71,8 @@ module WhopSDK
|
|
|
73
71
|
#
|
|
74
72
|
# @param cancel_options [Array<Symbol, WhopSDK::Models::MembershipListParams::CancelOption>, nil] The cancel options to filter the memberships by
|
|
75
73
|
#
|
|
74
|
+
# @param company_id [String, nil] The ID of the company to list memberships for
|
|
75
|
+
#
|
|
76
76
|
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
77
77
|
#
|
|
78
78
|
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
@@ -91,12 +91,14 @@ module WhopSDK
|
|
|
91
91
|
#
|
|
92
92
|
# @param statuses [Array<Symbol, WhopSDK::Models::MembershipStatus>, nil] The membership status to filter the memberships by
|
|
93
93
|
#
|
|
94
|
+
# @param user_ids [Array<String>, nil] Only return memberships from these whop user ids
|
|
95
|
+
#
|
|
94
96
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
95
97
|
#
|
|
96
98
|
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::MembershipListResponse>]
|
|
97
99
|
#
|
|
98
100
|
# @see WhopSDK::Models::MembershipListParams
|
|
99
|
-
def list(params)
|
|
101
|
+
def list(params = {})
|
|
100
102
|
parsed, options = WhopSDK::MembershipListParams.dump_request(params)
|
|
101
103
|
@client.request(
|
|
102
104
|
method: :get,
|
|
@@ -58,6 +58,34 @@ module WhopSDK
|
|
|
58
58
|
)
|
|
59
59
|
end
|
|
60
60
|
|
|
61
|
+
# Updates an existing message
|
|
62
|
+
#
|
|
63
|
+
# @overload update(id, attachments: nil, content: nil, is_pinned: nil, request_options: {})
|
|
64
|
+
#
|
|
65
|
+
# @param id [String]
|
|
66
|
+
#
|
|
67
|
+
# @param attachments [Array<WhopSDK::Models::MessageUpdateParams::Attachment>, nil] The attachments for this message
|
|
68
|
+
#
|
|
69
|
+
# @param content [String, nil] The content of the message in Markdown format
|
|
70
|
+
#
|
|
71
|
+
# @param is_pinned [Boolean, nil] Whether this message is pinned
|
|
72
|
+
#
|
|
73
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
74
|
+
#
|
|
75
|
+
# @return [WhopSDK::Models::Message]
|
|
76
|
+
#
|
|
77
|
+
# @see WhopSDK::Models::MessageUpdateParams
|
|
78
|
+
def update(id, params = {})
|
|
79
|
+
parsed, options = WhopSDK::MessageUpdateParams.dump_request(params)
|
|
80
|
+
@client.request(
|
|
81
|
+
method: :patch,
|
|
82
|
+
path: ["messages/%1$s", id],
|
|
83
|
+
body: parsed,
|
|
84
|
+
model: WhopSDK::Message,
|
|
85
|
+
options: options
|
|
86
|
+
)
|
|
87
|
+
end
|
|
88
|
+
|
|
61
89
|
# Lists messages inside a channel
|
|
62
90
|
#
|
|
63
91
|
# Required permissions:
|
|
@@ -52,7 +52,7 @@ module WhopSDK
|
|
|
52
52
|
#
|
|
53
53
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
54
54
|
#
|
|
55
|
-
# @param billing_reasons [Array<Symbol, WhopSDK::Models::
|
|
55
|
+
# @param billing_reasons [Array<Symbol, WhopSDK::Models::BillingReasons>, nil] The billing reason for the payment
|
|
56
56
|
#
|
|
57
57
|
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
58
58
|
#
|
|
@@ -14,13 +14,13 @@ module WhopSDK
|
|
|
14
14
|
# - `access_pass:basic:read`
|
|
15
15
|
# - `plan:basic:read`
|
|
16
16
|
#
|
|
17
|
-
# @overload create(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil, request_options: {})
|
|
17
|
+
# @overload create(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, release_method: nil, renewal_price: nil, 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: {})
|
|
18
18
|
#
|
|
19
19
|
# @param company_id [String] The company the plan should be created for.
|
|
20
20
|
#
|
|
21
21
|
# @param product_id [String] The product the plan is related to.
|
|
22
22
|
#
|
|
23
|
-
# @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
|
|
23
|
+
# @param billing_period [Integer, nil] The interval in days at which the plan charges (renewal plans).
|
|
24
24
|
#
|
|
25
25
|
# @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
|
|
26
26
|
#
|
|
@@ -44,10 +44,18 @@ module WhopSDK
|
|
|
44
44
|
#
|
|
45
45
|
# @param renewal_price [Float, nil] The amount the customer is charged every billing period. Use only if a recurring
|
|
46
46
|
#
|
|
47
|
+
# @param stock [Integer, nil] The number of units available for purchase.
|
|
48
|
+
#
|
|
49
|
+
# @param strike_through_initial_price [Float, nil] The price to display with a strikethrough for the initial price. Provided as a n
|
|
50
|
+
#
|
|
51
|
+
# @param strike_through_renewal_price [Float, nil] The price to display with a strikethrough for the renewal price. Provided as a n
|
|
52
|
+
#
|
|
47
53
|
# @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
|
|
48
54
|
#
|
|
49
55
|
# @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
|
|
50
56
|
#
|
|
57
|
+
# @param unlimited_stock [Boolean, nil] Limits/doesn't limit the number of units available for purchase.
|
|
58
|
+
#
|
|
51
59
|
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
52
60
|
#
|
|
53
61
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -94,7 +102,7 @@ module WhopSDK
|
|
|
94
102
|
# - `access_pass:basic:read`
|
|
95
103
|
# - `plan:basic:read`
|
|
96
104
|
#
|
|
97
|
-
# @overload update(id, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil, request_options: {})
|
|
105
|
+
# @overload update(id, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, renewal_price: nil, 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: {})
|
|
98
106
|
#
|
|
99
107
|
# @param id [String]
|
|
100
108
|
#
|
|
@@ -120,10 +128,18 @@ module WhopSDK
|
|
|
120
128
|
#
|
|
121
129
|
# @param renewal_price [Float, nil] The amount the customer is charged every billing period.
|
|
122
130
|
#
|
|
131
|
+
# @param stock [Integer, nil] The number of units available for purchase.
|
|
132
|
+
#
|
|
133
|
+
# @param strike_through_initial_price [Float, nil] The price to display with a strikethrough for the initial price. Provided as a n
|
|
134
|
+
#
|
|
135
|
+
# @param strike_through_renewal_price [Float, nil] The price to display with a strikethrough for the renewal price. Provided as a n
|
|
136
|
+
#
|
|
123
137
|
# @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
|
|
124
138
|
#
|
|
125
139
|
# @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
|
|
126
140
|
#
|
|
141
|
+
# @param unlimited_stock [Boolean, nil] Limits/doesn't limit the number of units available for purchase.
|
|
142
|
+
#
|
|
127
143
|
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
128
144
|
#
|
|
129
145
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -13,16 +13,12 @@ module WhopSDK
|
|
|
13
13
|
# - `access_pass:create`
|
|
14
14
|
# - `access_pass:basic:read`
|
|
15
15
|
#
|
|
16
|
-
# @overload create(company_id:, title:,
|
|
16
|
+
# @overload create(company_id:, title:, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, experience_ids: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, plan_options: nil, product_highlights: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil, request_options: {})
|
|
17
17
|
#
|
|
18
18
|
# @param company_id [String] The ID of the company to create the product for.
|
|
19
19
|
#
|
|
20
20
|
# @param title [String] The title of the product.
|
|
21
21
|
#
|
|
22
|
-
# @param access_pass_type [Symbol, WhopSDK::Models::AccessPassType, nil] The different types an access pass can be.
|
|
23
|
-
#
|
|
24
|
-
# @param banner_image [WhopSDK::Models::ProductCreateParams::BannerImage, nil] A banner image for the product in png, jpeg format
|
|
25
|
-
#
|
|
26
22
|
# @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
|
|
27
23
|
#
|
|
28
24
|
# @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
|
|
@@ -111,7 +107,7 @@ module WhopSDK
|
|
|
111
107
|
# - `access_pass:update`
|
|
112
108
|
# - `access_pass:basic:read`
|
|
113
109
|
#
|
|
114
|
-
# @overload update(id, banner_image: nil, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, title: nil, visibility: nil, request_options: {})
|
|
110
|
+
# @overload update(id, banner_image: nil, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
|
|
115
111
|
#
|
|
116
112
|
# @param id [String]
|
|
117
113
|
#
|
|
@@ -148,6 +144,8 @@ module WhopSDK
|
|
|
148
144
|
#
|
|
149
145
|
# @param route [String, nil] The route of the product.
|
|
150
146
|
#
|
|
147
|
+
# @param store_page_config [WhopSDK::Models::ProductUpdateParams::StorePageConfig, nil] Configuration for a product on the company's store page.
|
|
148
|
+
#
|
|
151
149
|
# @param title [String, nil] The title of the product.
|
|
152
150
|
#
|
|
153
151
|
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|