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
|
@@ -5,7 +5,7 @@ module WhopSDK
|
|
|
5
5
|
# @see WhopSDK::Resources::ForumPosts#list
|
|
6
6
|
class ForumPostListResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
|
-
# The unique identifier
|
|
8
|
+
# The unique identifier of the resource.
|
|
9
9
|
#
|
|
10
10
|
# @return [String]
|
|
11
11
|
required :id, String
|
|
@@ -85,7 +85,7 @@ module WhopSDK
|
|
|
85
85
|
# @!method initialize(id:, comment_count:, content:, created_at:, is_edited:, is_pinned:, is_poster_admin:, like_count:, parent_id:, title:, updated_at:, user:, view_count:)
|
|
86
86
|
# Represents a post in forum
|
|
87
87
|
#
|
|
88
|
-
# @param id [String] The unique identifier
|
|
88
|
+
# @param id [String] The unique identifier of the resource.
|
|
89
89
|
#
|
|
90
90
|
# @param comment_count [Integer] The amount of comments on this post
|
|
91
91
|
#
|
|
@@ -10,9 +10,9 @@ module WhopSDK
|
|
|
10
10
|
# @!attribute attachments
|
|
11
11
|
# The attachments for this post
|
|
12
12
|
#
|
|
13
|
-
# @return [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment>, nil]
|
|
13
|
+
# @return [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID>, nil]
|
|
14
14
|
optional :attachments,
|
|
15
|
-
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ForumPostUpdateParams::Attachment] },
|
|
15
|
+
-> { WhopSDK::Internal::Type::ArrayOf[union: WhopSDK::ForumPostUpdateParams::Attachment] },
|
|
16
16
|
nil?: true
|
|
17
17
|
|
|
18
18
|
# @!attribute content
|
|
@@ -38,7 +38,7 @@ module WhopSDK
|
|
|
38
38
|
# Some parameter documentations has been truncated, see
|
|
39
39
|
# {WhopSDK::Models::ForumPostUpdateParams} for more details.
|
|
40
40
|
#
|
|
41
|
-
# @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment>, nil] The attachments for this post
|
|
41
|
+
# @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID>, nil] The attachments for this post
|
|
42
42
|
#
|
|
43
43
|
# @param content [String, nil] This is the main body of the post in Markdown format. Hidden if paywalled and us
|
|
44
44
|
#
|
|
@@ -48,32 +48,56 @@ module WhopSDK
|
|
|
48
48
|
#
|
|
49
49
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
50
50
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
55
|
-
# doing.
|
|
56
|
-
#
|
|
57
|
-
# @return [String, nil]
|
|
58
|
-
optional :id, String, nil?: true
|
|
51
|
+
# Input for an attachment
|
|
52
|
+
module Attachment
|
|
53
|
+
extend WhopSDK::Internal::Type::Union
|
|
59
54
|
|
|
60
|
-
#
|
|
61
|
-
|
|
62
|
-
# the direct upload that was created when uploading the file to S3 via the
|
|
63
|
-
# mediaDirectUpload mutation.
|
|
64
|
-
#
|
|
65
|
-
# @return [String, nil]
|
|
66
|
-
optional :direct_upload_id, String, nil?: true
|
|
55
|
+
# Input for an attachment
|
|
56
|
+
variant -> { WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID }
|
|
67
57
|
|
|
68
|
-
#
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
58
|
+
# Input for an attachment
|
|
59
|
+
variant -> { WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithID }
|
|
60
|
+
|
|
61
|
+
class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
|
|
62
|
+
# @!attribute direct_upload_id
|
|
63
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
64
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
65
|
+
# mediaDirectUpload mutation.
|
|
66
|
+
#
|
|
67
|
+
# @return [String]
|
|
68
|
+
required :direct_upload_id, String
|
|
69
|
+
|
|
70
|
+
# @!method initialize(direct_upload_id:)
|
|
71
|
+
# Some parameter documentations has been truncated, see
|
|
72
|
+
# {WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID}
|
|
73
|
+
# for more details.
|
|
74
|
+
#
|
|
75
|
+
# Input for an attachment
|
|
76
|
+
#
|
|
77
|
+
# @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
|
|
81
|
+
# @!attribute id
|
|
82
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
83
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
84
|
+
# doing.
|
|
85
|
+
#
|
|
86
|
+
# @return [String]
|
|
87
|
+
required :id, String
|
|
88
|
+
|
|
89
|
+
# @!method initialize(id:)
|
|
90
|
+
# Some parameter documentations has been truncated, see
|
|
91
|
+
# {WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID} for
|
|
92
|
+
# more details.
|
|
93
|
+
#
|
|
94
|
+
# Input for an attachment
|
|
95
|
+
#
|
|
96
|
+
# @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# @!method self.variants
|
|
100
|
+
# @return [Array(WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID)]
|
|
77
101
|
end
|
|
78
102
|
end
|
|
79
103
|
end
|
|
@@ -26,12 +26,27 @@ module WhopSDK
|
|
|
26
26
|
# @return [Time]
|
|
27
27
|
required :due_date, Time
|
|
28
28
|
|
|
29
|
+
# @!attribute member_id
|
|
30
|
+
# The member ID to create this invoice for. Include this if you want to create an
|
|
31
|
+
# invoice for an existing member. If you do not have a member ID, you must provide
|
|
32
|
+
# an email_address and customer_name.
|
|
33
|
+
#
|
|
34
|
+
# @return [String]
|
|
35
|
+
required :member_id, String
|
|
36
|
+
|
|
29
37
|
# @!attribute plan
|
|
30
38
|
# The properties of the plan to create for this invoice.
|
|
31
39
|
#
|
|
32
40
|
# @return [WhopSDK::Models::InvoiceCreateParams::Plan]
|
|
33
41
|
required :plan, -> { WhopSDK::InvoiceCreateParams::Plan }
|
|
34
42
|
|
|
43
|
+
# @!attribute product
|
|
44
|
+
# The properties of the product to create for this invoice. Include this if you
|
|
45
|
+
# want to create an invoice for a new product.
|
|
46
|
+
#
|
|
47
|
+
# @return [WhopSDK::Models::InvoiceCreateParams::Product]
|
|
48
|
+
required :product, -> { WhopSDK::InvoiceCreateParams::Product }
|
|
49
|
+
|
|
35
50
|
# @!attribute charge_buyer_fee
|
|
36
51
|
# Whether or not to charge the customer a buyer fee.
|
|
37
52
|
#
|
|
@@ -46,21 +61,6 @@ module WhopSDK
|
|
|
46
61
|
# @return [String, nil]
|
|
47
62
|
optional :customer_name, String, nil?: true
|
|
48
63
|
|
|
49
|
-
# @!attribute email_address
|
|
50
|
-
# The email address to create this invoice for. This is required if you want to
|
|
51
|
-
# create an invoice for a user who does not have a member of your company yet.
|
|
52
|
-
#
|
|
53
|
-
# @return [String, nil]
|
|
54
|
-
optional :email_address, String, nil?: true
|
|
55
|
-
|
|
56
|
-
# @!attribute member_id
|
|
57
|
-
# The member ID to create this invoice for. Include this if you want to create an
|
|
58
|
-
# invoice for an existing member. If you do not have a member ID, you must provide
|
|
59
|
-
# an email_address and customer_name.
|
|
60
|
-
#
|
|
61
|
-
# @return [String, nil]
|
|
62
|
-
optional :member_id, String, nil?: true
|
|
63
|
-
|
|
64
64
|
# @!attribute payment_token_id
|
|
65
65
|
# The payment token ID to use for this invoice. If using charge_automatically, you
|
|
66
66
|
# must provide a payment_token.
|
|
@@ -68,21 +68,21 @@ module WhopSDK
|
|
|
68
68
|
# @return [String, nil]
|
|
69
69
|
optional :payment_token_id, String, nil?: true
|
|
70
70
|
|
|
71
|
-
# @!attribute
|
|
72
|
-
# The
|
|
73
|
-
#
|
|
71
|
+
# @!attribute email_address
|
|
72
|
+
# The email address to create this invoice for. This is required if you want to
|
|
73
|
+
# create an invoice for a user who does not have a member of your company yet.
|
|
74
74
|
#
|
|
75
|
-
# @return [
|
|
76
|
-
|
|
75
|
+
# @return [String]
|
|
76
|
+
required :email_address, String
|
|
77
77
|
|
|
78
78
|
# @!attribute product_id
|
|
79
79
|
# The product ID to create this invoice for. Include this if you want to create an
|
|
80
80
|
# invoice for an existing product.
|
|
81
81
|
#
|
|
82
|
-
# @return [String
|
|
83
|
-
|
|
82
|
+
# @return [String]
|
|
83
|
+
required :product_id, String
|
|
84
84
|
|
|
85
|
-
# @!method initialize(collection_method:, company_id:, due_date:, plan:,
|
|
85
|
+
# @!method initialize(collection_method:, company_id:, due_date:, member_id:, plan:, product:, email_address:, product_id:, charge_buyer_fee: nil, customer_name: nil, payment_token_id: nil, request_options: {})
|
|
86
86
|
# Some parameter documentations has been truncated, see
|
|
87
87
|
# {WhopSDK::Models::InvoiceCreateParams} for more details.
|
|
88
88
|
#
|
|
@@ -92,21 +92,21 @@ module WhopSDK
|
|
|
92
92
|
#
|
|
93
93
|
# @param due_date [Time] The date the invoice is due, if applicable.
|
|
94
94
|
#
|
|
95
|
-
# @param
|
|
95
|
+
# @param member_id [String] The member ID to create this invoice for. Include this if you want to create an
|
|
96
96
|
#
|
|
97
|
-
# @param
|
|
97
|
+
# @param plan [WhopSDK::Models::InvoiceCreateParams::Plan] The properties of the plan to create for this invoice.
|
|
98
98
|
#
|
|
99
|
-
# @param
|
|
99
|
+
# @param product [WhopSDK::Models::InvoiceCreateParams::Product] The properties of the product to create for this invoice. Include this if you wa
|
|
100
100
|
#
|
|
101
|
-
# @param email_address [String
|
|
101
|
+
# @param email_address [String] The email address to create this invoice for. This is required if you want to cr
|
|
102
102
|
#
|
|
103
|
-
# @param
|
|
103
|
+
# @param product_id [String] The product ID to create this invoice for. Include this if you want to create an
|
|
104
104
|
#
|
|
105
|
-
# @param
|
|
105
|
+
# @param charge_buyer_fee [Boolean, nil] Whether or not to charge the customer a buyer fee.
|
|
106
106
|
#
|
|
107
|
-
# @param
|
|
107
|
+
# @param customer_name [String, nil] The name of the customer to create this invoice for. This is required if you wan
|
|
108
108
|
#
|
|
109
|
-
# @param
|
|
109
|
+
# @param payment_token_id [String, nil] The payment token ID to use for this invoice. If using charge_automatically, you
|
|
110
110
|
#
|
|
111
111
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
112
112
|
|
|
@@ -152,7 +152,7 @@ module WhopSDK
|
|
|
152
152
|
optional :internal_notes, String, nil?: true
|
|
153
153
|
|
|
154
154
|
# @!attribute plan_type
|
|
155
|
-
# The type of plan that can be attached to
|
|
155
|
+
# The type of plan that can be attached to a product
|
|
156
156
|
#
|
|
157
157
|
# @return [Symbol, WhopSDK::Models::PlanType, nil]
|
|
158
158
|
optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
|
|
@@ -170,19 +170,31 @@ module WhopSDK
|
|
|
170
170
|
# @return [Float, nil]
|
|
171
171
|
optional :renewal_price, Float, nil?: true
|
|
172
172
|
|
|
173
|
+
# @!attribute stock
|
|
174
|
+
# The number of units available for purchase.
|
|
175
|
+
#
|
|
176
|
+
# @return [Integer, nil]
|
|
177
|
+
optional :stock, Integer, nil?: true
|
|
178
|
+
|
|
173
179
|
# @!attribute trial_period_days
|
|
174
180
|
# The number of free trial days added before a renewal plan.
|
|
175
181
|
#
|
|
176
182
|
# @return [Integer, nil]
|
|
177
183
|
optional :trial_period_days, Integer, nil?: true
|
|
178
184
|
|
|
185
|
+
# @!attribute unlimited_stock
|
|
186
|
+
# Limits/doesn't limit the number of units available for purchase.
|
|
187
|
+
#
|
|
188
|
+
# @return [Boolean, nil]
|
|
189
|
+
optional :unlimited_stock, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
190
|
+
|
|
179
191
|
# @!attribute visibility
|
|
180
192
|
# Visibility of a resource
|
|
181
193
|
#
|
|
182
194
|
# @return [Symbol, WhopSDK::Models::Visibility, nil]
|
|
183
195
|
optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
|
|
184
196
|
|
|
185
|
-
# @!method initialize(billing_period: nil, custom_fields: nil, description: nil, expiration_days: nil, initial_price: nil, internal_notes: nil, plan_type: nil, release_method: nil, renewal_price: nil, trial_period_days: nil, visibility: nil)
|
|
197
|
+
# @!method initialize(billing_period: nil, custom_fields: nil, description: nil, expiration_days: nil, initial_price: nil, internal_notes: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil)
|
|
186
198
|
# Some parameter documentations has been truncated, see
|
|
187
199
|
# {WhopSDK::Models::InvoiceCreateParams::Plan} for more details.
|
|
188
200
|
#
|
|
@@ -200,14 +212,18 @@ module WhopSDK
|
|
|
200
212
|
#
|
|
201
213
|
# @param internal_notes [String, nil] A personal description or notes section for the business.
|
|
202
214
|
#
|
|
203
|
-
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to
|
|
215
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
|
|
204
216
|
#
|
|
205
217
|
# @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
|
|
206
218
|
#
|
|
207
219
|
# @param renewal_price [Float, nil] The amount the customer is charged every billing period. Use only if a recurring
|
|
208
220
|
#
|
|
221
|
+
# @param stock [Integer, nil] The number of units available for purchase.
|
|
222
|
+
#
|
|
209
223
|
# @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
|
|
210
224
|
#
|
|
225
|
+
# @param unlimited_stock [Boolean, nil] Limits/doesn't limit the number of units available for purchase.
|
|
226
|
+
#
|
|
211
227
|
# @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
|
|
212
228
|
|
|
213
229
|
class CustomField < WhopSDK::Internal::Type::BaseModel
|
|
@@ -25,18 +25,20 @@ module WhopSDK
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :before, String, nil?: true
|
|
27
27
|
|
|
28
|
+
# @!attribute collection_methods
|
|
29
|
+
# Filter invoices by their collection method
|
|
30
|
+
#
|
|
31
|
+
# @return [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil]
|
|
32
|
+
optional :collection_methods,
|
|
33
|
+
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::CollectionMethod] },
|
|
34
|
+
nil?: true
|
|
35
|
+
|
|
28
36
|
# @!attribute direction
|
|
29
37
|
# The direction of the sort.
|
|
30
38
|
#
|
|
31
39
|
# @return [Symbol, WhopSDK::Models::Direction, nil]
|
|
32
40
|
optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
|
|
33
41
|
|
|
34
|
-
# @!attribute filters
|
|
35
|
-
# The filters to apply to the invoices
|
|
36
|
-
#
|
|
37
|
-
# @return [WhopSDK::Models::InvoiceListParams::Filters, nil]
|
|
38
|
-
optional :filters, -> { WhopSDK::InvoiceListParams::Filters }, nil?: true
|
|
39
|
-
|
|
40
42
|
# @!attribute first
|
|
41
43
|
# Returns the first _n_ elements from the list.
|
|
42
44
|
#
|
|
@@ -55,16 +57,28 @@ module WhopSDK
|
|
|
55
57
|
# @return [Symbol, WhopSDK::Models::InvoiceListParams::Order, nil]
|
|
56
58
|
optional :order, enum: -> { WhopSDK::InvoiceListParams::Order }, nil?: true
|
|
57
59
|
|
|
58
|
-
# @!
|
|
60
|
+
# @!attribute product_ids
|
|
61
|
+
# Return only invoices created for these specific product ids
|
|
62
|
+
#
|
|
63
|
+
# @return [Array<String>, nil]
|
|
64
|
+
optional :product_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
65
|
+
|
|
66
|
+
# @!attribute statuses
|
|
67
|
+
# The statuses to filter the invoices by
|
|
68
|
+
#
|
|
69
|
+
# @return [Array<Symbol, WhopSDK::Models::InvoiceStatus>, nil]
|
|
70
|
+
optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::InvoiceStatus] }, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!method initialize(company_id:, after: nil, before: nil, collection_methods: nil, direction: nil, first: nil, last: nil, order: nil, product_ids: nil, statuses: nil, request_options: {})
|
|
59
73
|
# @param company_id [String] The ID of the company to list invoices for
|
|
60
74
|
#
|
|
61
75
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
62
76
|
#
|
|
63
77
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
64
78
|
#
|
|
65
|
-
# @param
|
|
79
|
+
# @param collection_methods [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil] Filter invoices by their collection method
|
|
66
80
|
#
|
|
67
|
-
# @param
|
|
81
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
68
82
|
#
|
|
69
83
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
70
84
|
#
|
|
@@ -72,39 +86,12 @@ module WhopSDK
|
|
|
72
86
|
#
|
|
73
87
|
# @param order [Symbol, WhopSDK::Models::InvoiceListParams::Order, nil] Which columns can be used to sort.
|
|
74
88
|
#
|
|
89
|
+
# @param product_ids [Array<String>, nil] Return only invoices created for these specific product ids
|
|
90
|
+
#
|
|
91
|
+
# @param statuses [Array<Symbol, WhopSDK::Models::InvoiceStatus>, nil] The statuses to filter the invoices by
|
|
92
|
+
#
|
|
75
93
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
76
94
|
|
|
77
|
-
class Filters < WhopSDK::Internal::Type::BaseModel
|
|
78
|
-
# @!attribute access_pass_ids
|
|
79
|
-
# The access pass IDs to filter the invoices by
|
|
80
|
-
#
|
|
81
|
-
# @return [Array<String>, nil]
|
|
82
|
-
optional :access_pass_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
83
|
-
|
|
84
|
-
# @!attribute collection_methods
|
|
85
|
-
# The collection methods to filter the invoices by
|
|
86
|
-
#
|
|
87
|
-
# @return [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil]
|
|
88
|
-
optional :collection_methods,
|
|
89
|
-
-> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::CollectionMethod] },
|
|
90
|
-
nil?: true
|
|
91
|
-
|
|
92
|
-
# @!attribute statuses
|
|
93
|
-
# The statuses to filter the invoices by
|
|
94
|
-
#
|
|
95
|
-
# @return [Array<Symbol, WhopSDK::Models::InvoiceStatus>, nil]
|
|
96
|
-
optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::InvoiceStatus] }, nil?: true
|
|
97
|
-
|
|
98
|
-
# @!method initialize(access_pass_ids: nil, collection_methods: nil, statuses: nil)
|
|
99
|
-
# The filters to apply to the invoices
|
|
100
|
-
#
|
|
101
|
-
# @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the invoices by
|
|
102
|
-
#
|
|
103
|
-
# @param collection_methods [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil] The collection methods to filter the invoices by
|
|
104
|
-
#
|
|
105
|
-
# @param statuses [Array<Symbol, WhopSDK::Models::InvoiceStatus>, nil] The statuses to filter the invoices by
|
|
106
|
-
end
|
|
107
|
-
|
|
108
95
|
# Which columns can be used to sort.
|
|
109
96
|
module Order
|
|
110
97
|
extend WhopSDK::Internal::Type::Enum
|
|
@@ -35,6 +35,18 @@ module WhopSDK
|
|
|
35
35
|
# @return [Integer, nil]
|
|
36
36
|
required :days_from_course_start_until_unlock, Integer, nil?: true
|
|
37
37
|
|
|
38
|
+
# @!attribute embed_id
|
|
39
|
+
# ID for the embed (YouTube video ID or Loom share ID)
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
required :embed_id, String, nil?: true
|
|
43
|
+
|
|
44
|
+
# @!attribute embed_type
|
|
45
|
+
# The type of embed for a lesson
|
|
46
|
+
#
|
|
47
|
+
# @return [Symbol, WhopSDK::Models::EmbedType, nil]
|
|
48
|
+
required :embed_type, enum: -> { WhopSDK::EmbedType }, nil?: true
|
|
49
|
+
|
|
38
50
|
# @!attribute lesson_type
|
|
39
51
|
# The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
|
|
40
52
|
#
|
|
@@ -53,6 +65,12 @@ module WhopSDK
|
|
|
53
65
|
# @return [Integer]
|
|
54
66
|
required :order, Integer
|
|
55
67
|
|
|
68
|
+
# @!attribute thumbnail
|
|
69
|
+
# The thumbnail for the lesson
|
|
70
|
+
#
|
|
71
|
+
# @return [WhopSDK::Models::Lesson::Thumbnail, nil]
|
|
72
|
+
required :thumbnail, -> { WhopSDK::Lesson::Thumbnail }, nil?: true
|
|
73
|
+
|
|
56
74
|
# @!attribute title
|
|
57
75
|
# The title of the lesson
|
|
58
76
|
#
|
|
@@ -72,7 +90,7 @@ module WhopSDK
|
|
|
72
90
|
# @return [Symbol, WhopSDK::Models::LessonVisibilities]
|
|
73
91
|
required :visibility, enum: -> { WhopSDK::LessonVisibilities }
|
|
74
92
|
|
|
75
|
-
# @!method initialize(id:, assessment_questions:, attachments:, content:, days_from_course_start_until_unlock:, lesson_type:, main_pdf:, order:, title:, video_asset:, visibility:)
|
|
93
|
+
# @!method initialize(id:, assessment_questions:, attachments:, content:, days_from_course_start_until_unlock:, embed_id:, embed_type:, lesson_type:, main_pdf:, order:, thumbnail:, title:, video_asset:, visibility:)
|
|
76
94
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Lesson}
|
|
77
95
|
# for more details.
|
|
78
96
|
#
|
|
@@ -88,12 +106,18 @@ module WhopSDK
|
|
|
88
106
|
#
|
|
89
107
|
# @param days_from_course_start_until_unlock [Integer, nil] Number of days from course start until the lesson is unlocked
|
|
90
108
|
#
|
|
109
|
+
# @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
|
|
110
|
+
#
|
|
111
|
+
# @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
|
|
112
|
+
#
|
|
91
113
|
# @param lesson_type [Symbol, WhopSDK::Models::LessonTypes] The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
|
|
92
114
|
#
|
|
93
115
|
# @param main_pdf [WhopSDK::Models::Lesson::MainPdf, nil] The main PDF file for this lesson
|
|
94
116
|
#
|
|
95
117
|
# @param order [Integer] The order of the lesson within its chapter
|
|
96
118
|
#
|
|
119
|
+
# @param thumbnail [WhopSDK::Models::Lesson::Thumbnail, nil] The thumbnail for the lesson
|
|
120
|
+
#
|
|
97
121
|
# @param title [String] The title of the lesson
|
|
98
122
|
#
|
|
99
123
|
# @param video_asset [WhopSDK::Models::Lesson::VideoAsset, nil] The associated Mux asset for video lessons
|
|
@@ -108,10 +132,11 @@ module WhopSDK
|
|
|
108
132
|
required :id, String
|
|
109
133
|
|
|
110
134
|
# @!attribute correct_answer
|
|
111
|
-
# The correct answer for the question. Used for short answer questions
|
|
135
|
+
# The correct answer for the question. Used for short answer questions. Only
|
|
136
|
+
# visible to admins (users with courses:update permission)
|
|
112
137
|
#
|
|
113
|
-
# @return [String]
|
|
114
|
-
required :correct_answer, String
|
|
138
|
+
# @return [String, nil]
|
|
139
|
+
required :correct_answer, String, nil?: true
|
|
115
140
|
|
|
116
141
|
# @!attribute created_at
|
|
117
142
|
# When the question was created
|
|
@@ -150,11 +175,14 @@ module WhopSDK
|
|
|
150
175
|
required :question_type, enum: -> { WhopSDK::AssessmentQuestionTypes }
|
|
151
176
|
|
|
152
177
|
# @!method initialize(id:, correct_answer:, created_at:, image:, options:, order:, question_text:, question_type:)
|
|
178
|
+
# Some parameter documentations has been truncated, see
|
|
179
|
+
# {WhopSDK::Models::Lesson::AssessmentQuestion} for more details.
|
|
180
|
+
#
|
|
153
181
|
# An assessment question in a course quiz or knowledge check
|
|
154
182
|
#
|
|
155
183
|
# @param id [String] The ID of the assessment question
|
|
156
184
|
#
|
|
157
|
-
# @param correct_answer [String] The correct answer for the question. Used for short answer questions
|
|
185
|
+
# @param correct_answer [String, nil] The correct answer for the question. Used for short answer questions. Only visib
|
|
158
186
|
#
|
|
159
187
|
# @param created_at [Time] When the question was created
|
|
160
188
|
#
|
|
@@ -218,10 +246,11 @@ module WhopSDK
|
|
|
218
246
|
required :id, String
|
|
219
247
|
|
|
220
248
|
# @!attribute is_correct
|
|
221
|
-
# Whether this option is a correct answer
|
|
249
|
+
# Whether this option is a correct answer. Only visible to admins (users with
|
|
250
|
+
# courses:update permission)
|
|
222
251
|
#
|
|
223
|
-
# @return [Boolean]
|
|
224
|
-
required :is_correct, WhopSDK::Internal::Type::Boolean
|
|
252
|
+
# @return [Boolean, nil]
|
|
253
|
+
required :is_correct, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
225
254
|
|
|
226
255
|
# @!attribute option_text
|
|
227
256
|
# The text of the answer option
|
|
@@ -236,11 +265,14 @@ module WhopSDK
|
|
|
236
265
|
required :order, Integer
|
|
237
266
|
|
|
238
267
|
# @!method initialize(id:, is_correct:, option_text:, order:)
|
|
268
|
+
# Some parameter documentations has been truncated, see
|
|
269
|
+
# {WhopSDK::Models::Lesson::AssessmentQuestion::Option} for more details.
|
|
270
|
+
#
|
|
239
271
|
# An answer option for a multiple choice or multiple select assessment question
|
|
240
272
|
#
|
|
241
273
|
# @param id [String] The ID of the assessment question option
|
|
242
274
|
#
|
|
243
|
-
# @param is_correct [Boolean] Whether this option is a correct answer
|
|
275
|
+
# @param is_correct [Boolean, nil] Whether this option is a correct answer. Only visible to admins (users with cour
|
|
244
276
|
#
|
|
245
277
|
# @param option_text [String] The text of the answer option
|
|
246
278
|
#
|
|
@@ -331,6 +363,24 @@ module WhopSDK
|
|
|
331
363
|
# @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
|
|
332
364
|
end
|
|
333
365
|
|
|
366
|
+
# @see WhopSDK::Models::Lesson#thumbnail
|
|
367
|
+
class Thumbnail < WhopSDK::Internal::Type::BaseModel
|
|
368
|
+
# @!attribute url
|
|
369
|
+
# This is the URL you use to render optimized attachments on the client. This
|
|
370
|
+
# should be used for apps.
|
|
371
|
+
#
|
|
372
|
+
# @return [String, nil]
|
|
373
|
+
required :url, String, nil?: true
|
|
374
|
+
|
|
375
|
+
# @!method initialize(url:)
|
|
376
|
+
# Some parameter documentations has been truncated, see
|
|
377
|
+
# {WhopSDK::Models::Lesson::Thumbnail} for more details.
|
|
378
|
+
#
|
|
379
|
+
# The thumbnail for the lesson
|
|
380
|
+
#
|
|
381
|
+
# @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
|
|
382
|
+
end
|
|
383
|
+
|
|
334
384
|
# @see WhopSDK::Models::Lesson#video_asset
|
|
335
385
|
class VideoAsset < WhopSDK::Internal::Type::BaseModel
|
|
336
386
|
# @!attribute id
|
|
@@ -14,17 +14,11 @@ module WhopSDK
|
|
|
14
14
|
required :company_id, String
|
|
15
15
|
|
|
16
16
|
# @!attribute access_level
|
|
17
|
-
# The access level a given user (or company) has to
|
|
17
|
+
# The access level a given user (or company) has to a product or company.
|
|
18
18
|
#
|
|
19
19
|
# @return [Symbol, WhopSDK::Models::AccessLevel, nil]
|
|
20
20
|
optional :access_level, enum: -> { WhopSDK::AccessLevel }, nil?: true
|
|
21
21
|
|
|
22
|
-
# @!attribute access_pass_ids
|
|
23
|
-
# The access pass IDs to filter the members by
|
|
24
|
-
#
|
|
25
|
-
# @return [Array<String>, nil]
|
|
26
|
-
optional :access_pass_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
27
|
-
|
|
28
22
|
# @!attribute after
|
|
29
23
|
# Returns the elements in the list that come after the specified cursor.
|
|
30
24
|
#
|
|
@@ -87,6 +81,12 @@ module WhopSDK
|
|
|
87
81
|
# @return [Array<String>, nil]
|
|
88
82
|
optional :plan_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
89
83
|
|
|
84
|
+
# @!attribute product_ids
|
|
85
|
+
# The product IDs to filter the members by
|
|
86
|
+
#
|
|
87
|
+
# @return [Array<String>, nil]
|
|
88
|
+
optional :product_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
89
|
+
|
|
90
90
|
# @!attribute promo_code_ids
|
|
91
91
|
# The promo code IDs to filter the members by
|
|
92
92
|
#
|
|
@@ -112,15 +112,13 @@ module WhopSDK
|
|
|
112
112
|
# @return [Array<String>, nil]
|
|
113
113
|
optional :user_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
114
114
|
|
|
115
|
-
# @!method initialize(company_id:, access_level: nil,
|
|
115
|
+
# @!method initialize(company_id:, access_level: 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, product_ids: nil, promo_code_ids: nil, query: nil, statuses: nil, user_ids: nil, request_options: {})
|
|
116
116
|
# Some parameter documentations has been truncated, see
|
|
117
117
|
# {WhopSDK::Models::MemberListParams} for more details.
|
|
118
118
|
#
|
|
119
119
|
# @param company_id [String] The ID of the company to list members for
|
|
120
120
|
#
|
|
121
|
-
# @param access_level [Symbol, WhopSDK::Models::AccessLevel, nil] The access level a given user (or company) has to
|
|
122
|
-
#
|
|
123
|
-
# @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the members by
|
|
121
|
+
# @param access_level [Symbol, WhopSDK::Models::AccessLevel, nil] The access level a given user (or company) has to a product or company.
|
|
124
122
|
#
|
|
125
123
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
126
124
|
#
|
|
@@ -142,6 +140,8 @@ module WhopSDK
|
|
|
142
140
|
#
|
|
143
141
|
# @param plan_ids [Array<String>, nil] The plan IDs to filter the members by
|
|
144
142
|
#
|
|
143
|
+
# @param product_ids [Array<String>, nil] The product IDs to filter the members by
|
|
144
|
+
#
|
|
145
145
|
# @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the members by
|
|
146
146
|
#
|
|
147
147
|
# @param query [String, nil] The name, username, or email to filter the members by. The email filter will onl
|
|
@@ -12,9 +12,9 @@ module WhopSDK
|
|
|
12
12
|
|
|
13
13
|
# @!attribute access_level
|
|
14
14
|
# The access level of the product member. If its admin, the member is an
|
|
15
|
-
# authorized user of the
|
|
16
|
-
# membership to the
|
|
17
|
-
# to the
|
|
15
|
+
# authorized user of the company. If its customer, the member has a valid
|
|
16
|
+
# membership to any product on the company. If its no_access, the member does not
|
|
17
|
+
# have access to the product.
|
|
18
18
|
#
|
|
19
19
|
# @return [Symbol, WhopSDK::Models::AccessLevel]
|
|
20
20
|
required :access_level, enum: -> { WhopSDK::AccessLevel }
|
|
@@ -12,9 +12,9 @@ module WhopSDK
|
|
|
12
12
|
|
|
13
13
|
# @!attribute access_level
|
|
14
14
|
# The access level of the product member. If its admin, the member is an
|
|
15
|
-
# authorized user of the
|
|
16
|
-
# membership to the
|
|
17
|
-
# to the
|
|
15
|
+
# authorized user of the company. If its customer, the member has a valid
|
|
16
|
+
# membership to any product on the company. If its no_access, the member does not
|
|
17
|
+
# have access to the product.
|
|
18
18
|
#
|
|
19
19
|
# @return [Symbol, WhopSDK::Models::AccessLevel]
|
|
20
20
|
required :access_level, enum: -> { WhopSDK::AccessLevel }
|