whop_sdk 0.0.4 → 0.0.6
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 +40 -0
- data/README.md +4 -7
- data/lib/whop_sdk/client.rb +21 -6
- 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/checkout_configuration_create_params.rb +4 -4
- data/lib/whop_sdk/models/company.rb +1 -0
- data/lib/whop_sdk/models/course.rb +18 -1
- data/lib/whop_sdk/models/course_create_params.rb +20 -1
- 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 +77 -1
- data/lib/whop_sdk/models/course_list_response.rb +18 -1
- data/lib/whop_sdk/models/course_update_params.rb +19 -1
- data/lib/whop_sdk/models/course_visibilities.rb +17 -0
- data/lib/whop_sdk/models/dispute.rb +672 -0
- data/lib/whop_sdk/models/dispute_created_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/dispute_list_params.rb +62 -0
- data/lib/whop_sdk/models/dispute_list_response.rb +187 -0
- data/lib/whop_sdk/models/dispute_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/dispute_statuses.rb +23 -0
- data/lib/whop_sdk/models/dispute_submit_evidence_params.rb +14 -0
- data/lib/whop_sdk/models/dispute_update_evidence_params.rb +342 -0
- data/lib/whop_sdk/models/dispute_updated_webhook_event.rb +48 -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/forum_post.rb +2 -2
- data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
- data/lib/whop_sdk/models/global_affiliate_status.rb +1 -1
- data/lib/whop_sdk/models/invoice_create_params.rb +2 -2
- data/lib/whop_sdk/models/invoice_list_params.rb +27 -40
- data/lib/whop_sdk/models/lesson.rb +43 -1
- 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_list_response.rb +2 -2
- data/lib/whop_sdk/models/notification_create_params.rb +88 -0
- data/lib/whop_sdk/models/notification_create_response.rb +19 -0
- data/lib/whop_sdk/models/payment.rb +3 -3
- data/lib/whop_sdk/models/payment_list_response.rb +3 -3
- data/lib/whop_sdk/models/plan.rb +6 -4
- data/lib/whop_sdk/models/plan_create_params.rb +2 -2
- data/lib/whop_sdk/models/plan_list_response.rb +6 -4
- data/lib/whop_sdk/models/plan_type.rb +1 -1
- 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 +4 -4
- 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/unwrap_webhook_event.rb +5 -1
- data/lib/whop_sdk/models.rb +24 -0
- data/lib/whop_sdk/resources/access_tokens.rb +46 -0
- data/lib/whop_sdk/resources/app_builds.rb +4 -2
- data/lib/whop_sdk/resources/apps.rb +3 -2
- 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 +2 -1
- data/lib/whop_sdk/resources/companies.rb +2 -1
- data/lib/whop_sdk/resources/course_chapters.rb +5 -3
- data/lib/whop_sdk/resources/course_lesson_interactions.rb +2 -1
- data/lib/whop_sdk/resources/course_lessons.rb +19 -5
- data/lib/whop_sdk/resources/course_students.rb +2 -1
- data/lib/whop_sdk/resources/courses.rb +15 -5
- data/lib/whop_sdk/resources/disputes.rb +182 -0
- data/lib/whop_sdk/resources/entries.rb +6 -3
- data/lib/whop_sdk/resources/experiences.rb +8 -6
- data/lib/whop_sdk/resources/forum_posts.rb +3 -2
- data/lib/whop_sdk/resources/forums.rb +3 -2
- data/lib/whop_sdk/resources/invoices.rb +11 -5
- 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 +3 -2
- data/lib/whop_sdk/resources/notifications.rb +53 -0
- data/lib/whop_sdk/resources/payments.rb +7 -4
- data/lib/whop_sdk/resources/plans.rb +6 -4
- data/lib/whop_sdk/resources/products.rb +9 -7
- 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 +2 -1
- data/lib/whop_sdk/resources/users.rb +9 -3
- data/lib/whop_sdk/resources/webhooks.rb +1 -1
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +19 -0
- data/manifest.yaml +1 -0
- data/rbi/whop_sdk/client.rbi +14 -2
- 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/checkout_configuration_create_params.rbi +4 -4
- data/rbi/whop_sdk/models/company.rbi +2 -0
- data/rbi/whop_sdk/models/course.rbi +21 -3
- data/rbi/whop_sdk/models/course_create_params.rbi +22 -0
- 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 +126 -0
- data/rbi/whop_sdk/models/course_list_response.rbi +21 -3
- data/rbi/whop_sdk/models/course_update_params.rbi +20 -0
- data/rbi/whop_sdk/models/course_visibilities.rbi +23 -0
- data/rbi/whop_sdk/models/dispute.rbi +938 -0
- data/rbi/whop_sdk/models/dispute_created_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/dispute_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/dispute_list_response.rbi +287 -0
- data/rbi/whop_sdk/models/dispute_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/dispute_statuses.rbi +32 -0
- data/rbi/whop_sdk/models/dispute_submit_evidence_params.rbi +30 -0
- data/rbi/whop_sdk/models/dispute_update_evidence_params.rbi +566 -0
- data/rbi/whop_sdk/models/dispute_updated_webhook_event.rbi +72 -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/forum_post.rbi +2 -2
- data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/global_affiliate_status.rbi +1 -1
- data/rbi/whop_sdk/models/invoice_create_params.rbi +2 -2
- data/rbi/whop_sdk/models/invoice_list_params.rbi +26 -71
- data/rbi/whop_sdk/models/lesson.rbi +54 -0
- 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_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/notification_create_params.rbi +113 -0
- data/rbi/whop_sdk/models/notification_create_response.rbi +31 -0
- data/rbi/whop_sdk/models/payment.rbi +3 -3
- data/rbi/whop_sdk/models/payment_list_response.rbi +3 -3
- data/rbi/whop_sdk/models/plan.rbi +6 -4
- data/rbi/whop_sdk/models/plan_create_params.rbi +2 -2
- data/rbi/whop_sdk/models/plan_list_response.rbi +6 -4
- data/rbi/whop_sdk/models/plan_type.rbi +1 -1
- 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 +4 -4
- 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/unwrap_webhook_event.rbi +3 -1
- data/rbi/whop_sdk/models.rbi +24 -0
- data/rbi/whop_sdk/resources/access_tokens.rbi +41 -0
- data/rbi/whop_sdk/resources/app_builds.rbi +10 -2
- data/rbi/whop_sdk/resources/apps.rbi +6 -1
- 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 +5 -1
- data/rbi/whop_sdk/resources/companies.rbi +5 -1
- data/rbi/whop_sdk/resources/course_chapters.rbi +11 -2
- data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +5 -1
- data/rbi/whop_sdk/resources/course_lessons.rbi +41 -2
- data/rbi/whop_sdk/resources/course_students.rbi +5 -1
- data/rbi/whop_sdk/resources/courses.rbi +28 -2
- data/rbi/whop_sdk/resources/disputes.rbi +194 -0
- data/rbi/whop_sdk/resources/entries.rbi +15 -3
- data/rbi/whop_sdk/resources/experiences.rbi +14 -2
- data/rbi/whop_sdk/resources/forum_posts.rbi +6 -1
- data/rbi/whop_sdk/resources/forums.rbi +6 -1
- data/rbi/whop_sdk/resources/invoices.rbi +20 -5
- 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 +6 -1
- data/rbi/whop_sdk/resources/notifications.rbi +54 -0
- data/rbi/whop_sdk/resources/payments.rbi +16 -3
- data/rbi/whop_sdk/resources/plans.rbi +12 -3
- data/rbi/whop_sdk/resources/products.rbi +15 -6
- 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 +5 -1
- data/rbi/whop_sdk/resources/users.rbi +13 -2
- data/rbi/whop_sdk/resources/webhooks.rbi +3 -1
- data/sig/whop_sdk/client.rbs +7 -1
- 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/company.rbs +2 -0
- data/sig/whop_sdk/models/course.rbs +13 -3
- data/sig/whop_sdk/models/course_create_params.rbs +11 -1
- 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 +46 -0
- data/sig/whop_sdk/models/course_list_response.rbs +13 -3
- data/sig/whop_sdk/models/course_update_params.rbs +11 -1
- data/sig/whop_sdk/models/course_visibilities.rbs +14 -0
- data/sig/whop_sdk/models/dispute.rbs +437 -0
- data/sig/whop_sdk/models/dispute_created_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/dispute_list_params.rbs +51 -0
- data/sig/whop_sdk/models/dispute_list_response.rbs +124 -0
- data/sig/whop_sdk/models/dispute_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/dispute_statuses.rbs +30 -0
- data/sig/whop_sdk/models/dispute_submit_evidence_params.rbs +15 -0
- data/sig/whop_sdk/models/dispute_update_evidence_params.rbs +215 -0
- data/sig/whop_sdk/models/dispute_updated_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/embed_type.rbs +14 -0
- data/sig/whop_sdk/models/invoice_list_params.rbs +16 -33
- data/sig/whop_sdk/models/lesson.rbs +25 -0
- 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/notification_create_params.rbs +61 -0
- data/sig/whop_sdk/models/notification_create_response.rbs +13 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +2 -0
- data/sig/whop_sdk/models.rbs +24 -0
- data/sig/whop_sdk/resources/access_tokens.rbs +15 -0
- data/sig/whop_sdk/resources/course_lessons.rbs +6 -0
- data/sig/whop_sdk/resources/courses.rbs +4 -0
- data/sig/whop_sdk/resources/disputes.rbs +46 -0
- data/sig/whop_sdk/resources/invoices.rbs +3 -1
- data/sig/whop_sdk/resources/members.rbs +1 -1
- data/sig/whop_sdk/resources/memberships.rbs +1 -1
- data/sig/whop_sdk/resources/notifications.rbs +19 -0
- data/sig/whop_sdk/resources/webhooks.rbs +3 -1
- metadata +56 -2
|
@@ -45,6 +45,18 @@ module WhopSDK
|
|
|
45
45
|
# @return [Integer, nil]
|
|
46
46
|
optional :days_from_course_start_until_unlock, Integer, nil?: true
|
|
47
47
|
|
|
48
|
+
# @!attribute embed_id
|
|
49
|
+
# ID for the embed (YouTube video ID or Loom share ID)
|
|
50
|
+
#
|
|
51
|
+
# @return [String, nil]
|
|
52
|
+
optional :embed_id, String, nil?: true
|
|
53
|
+
|
|
54
|
+
# @!attribute embed_type
|
|
55
|
+
# The type of embed for a lesson
|
|
56
|
+
#
|
|
57
|
+
# @return [Symbol, WhopSDK::Models::EmbedType, nil]
|
|
58
|
+
optional :embed_type, enum: -> { WhopSDK::EmbedType }, nil?: true
|
|
59
|
+
|
|
48
60
|
# @!attribute lesson_type
|
|
49
61
|
# The available types for a lesson
|
|
50
62
|
#
|
|
@@ -69,6 +81,12 @@ module WhopSDK
|
|
|
69
81
|
# @return [String, nil]
|
|
70
82
|
optional :mux_asset_id, String, nil?: true
|
|
71
83
|
|
|
84
|
+
# @!attribute thumbnail
|
|
85
|
+
# The thumbnail for the lesson in png, jpeg, or gif format
|
|
86
|
+
#
|
|
87
|
+
# @return [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID, nil]
|
|
88
|
+
optional :thumbnail, union: -> { WhopSDK::CourseLessonUpdateParams::Thumbnail }, nil?: true
|
|
89
|
+
|
|
72
90
|
# @!attribute title
|
|
73
91
|
# The title of the lesson
|
|
74
92
|
#
|
|
@@ -82,7 +100,7 @@ module WhopSDK
|
|
|
82
100
|
# @return [Symbol, WhopSDK::Models::LessonVisibilities, nil]
|
|
83
101
|
optional :visibility, enum: -> { WhopSDK::LessonVisibilities }, nil?: true
|
|
84
102
|
|
|
85
|
-
# @!method initialize(assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, title: nil, visibility: nil, request_options: {})
|
|
103
|
+
# @!method initialize(assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
|
|
86
104
|
# Some parameter documentations has been truncated, see
|
|
87
105
|
# {WhopSDK::Models::CourseLessonUpdateParams} for more details.
|
|
88
106
|
#
|
|
@@ -96,6 +114,10 @@ module WhopSDK
|
|
|
96
114
|
#
|
|
97
115
|
# @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
|
|
98
116
|
#
|
|
117
|
+
# @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
|
|
118
|
+
#
|
|
119
|
+
# @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
|
|
120
|
+
#
|
|
99
121
|
# @param lesson_type [Symbol, WhopSDK::Models::LessonTypes, nil] The available types for a lesson
|
|
100
122
|
#
|
|
101
123
|
# @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID, nil] The main PDF file for this lesson
|
|
@@ -104,6 +126,8 @@ module WhopSDK
|
|
|
104
126
|
#
|
|
105
127
|
# @param mux_asset_id [String, nil] The ID of the Mux asset to attach to this lesson for video lessons
|
|
106
128
|
#
|
|
129
|
+
# @param thumbnail [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the lesson in png, jpeg, or gif format
|
|
130
|
+
#
|
|
107
131
|
# @param title [String, nil] The title of the lesson
|
|
108
132
|
#
|
|
109
133
|
# @param visibility [Symbol, WhopSDK::Models::LessonVisibilities, nil] The available visibilities for a lesson. Determines how / whether a lesson is vi
|
|
@@ -394,6 +418,58 @@ module WhopSDK
|
|
|
394
418
|
# @!method self.variants
|
|
395
419
|
# @return [Array(WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID)]
|
|
396
420
|
end
|
|
421
|
+
|
|
422
|
+
# The thumbnail for the lesson in png, jpeg, or gif format
|
|
423
|
+
module Thumbnail
|
|
424
|
+
extend WhopSDK::Internal::Type::Union
|
|
425
|
+
|
|
426
|
+
# Input for an attachment
|
|
427
|
+
variant -> { WhopSDK::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID }
|
|
428
|
+
|
|
429
|
+
# Input for an attachment
|
|
430
|
+
variant -> { WhopSDK::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID }
|
|
431
|
+
|
|
432
|
+
class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
|
|
433
|
+
# @!attribute direct_upload_id
|
|
434
|
+
# This ID should be used the first time you upload an attachment. It is the ID of
|
|
435
|
+
# the direct upload that was created when uploading the file to S3 via the
|
|
436
|
+
# mediaDirectUpload mutation.
|
|
437
|
+
#
|
|
438
|
+
# @return [String]
|
|
439
|
+
required :direct_upload_id, String
|
|
440
|
+
|
|
441
|
+
# @!method initialize(direct_upload_id:)
|
|
442
|
+
# Some parameter documentations has been truncated, see
|
|
443
|
+
# {WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID}
|
|
444
|
+
# for more details.
|
|
445
|
+
#
|
|
446
|
+
# Input for an attachment
|
|
447
|
+
#
|
|
448
|
+
# @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
|
|
452
|
+
# @!attribute id
|
|
453
|
+
# The ID of an existing attachment object. Use this when updating a resource and
|
|
454
|
+
# keeping a subset of the attachments. Don't use this unless you know what you're
|
|
455
|
+
# doing.
|
|
456
|
+
#
|
|
457
|
+
# @return [String]
|
|
458
|
+
required :id, String
|
|
459
|
+
|
|
460
|
+
# @!method initialize(id:)
|
|
461
|
+
# Some parameter documentations has been truncated, see
|
|
462
|
+
# {WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID}
|
|
463
|
+
# for more details.
|
|
464
|
+
#
|
|
465
|
+
# Input for an attachment
|
|
466
|
+
#
|
|
467
|
+
# @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
|
|
468
|
+
end
|
|
469
|
+
|
|
470
|
+
# @!method self.variants
|
|
471
|
+
# @return [Array(WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID)]
|
|
472
|
+
end
|
|
397
473
|
end
|
|
398
474
|
end
|
|
399
475
|
end
|
|
@@ -36,6 +36,12 @@ module WhopSDK
|
|
|
36
36
|
# @return [Symbol, WhopSDK::Models::Languages]
|
|
37
37
|
required :language, enum: -> { WhopSDK::Languages }
|
|
38
38
|
|
|
39
|
+
# @!attribute order
|
|
40
|
+
# The order of the course within its experience
|
|
41
|
+
#
|
|
42
|
+
# @return [String]
|
|
43
|
+
required :order, String
|
|
44
|
+
|
|
39
45
|
# @!attribute require_completing_lessons_in_order
|
|
40
46
|
# Whether the course requires students to complete the previous lesson before
|
|
41
47
|
# moving on to the next one
|
|
@@ -67,7 +73,14 @@ module WhopSDK
|
|
|
67
73
|
# @return [Time]
|
|
68
74
|
required :updated_at, Time
|
|
69
75
|
|
|
70
|
-
# @!
|
|
76
|
+
# @!attribute visibility
|
|
77
|
+
# The visibility of the course. Determines how / whether this course is visible to
|
|
78
|
+
# users.
|
|
79
|
+
#
|
|
80
|
+
# @return [Symbol, WhopSDK::Models::CourseVisibilities]
|
|
81
|
+
required :visibility, enum: -> { WhopSDK::CourseVisibilities }
|
|
82
|
+
|
|
83
|
+
# @!method initialize(id:, certificate_after_completion_enabled:, created_at:, description:, language:, order:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:, visibility:)
|
|
71
84
|
# Some parameter documentations has been truncated, see
|
|
72
85
|
# {WhopSDK::Models::CourseListResponse} for more details.
|
|
73
86
|
#
|
|
@@ -83,6 +96,8 @@ module WhopSDK
|
|
|
83
96
|
#
|
|
84
97
|
# @param language [Symbol, WhopSDK::Models::Languages] The language spoken in the video content of the course, used to generate closed
|
|
85
98
|
#
|
|
99
|
+
# @param order [String] The order of the course within its experience
|
|
100
|
+
#
|
|
86
101
|
# @param require_completing_lessons_in_order [Boolean] Whether the course requires students to complete the previous lesson before movi
|
|
87
102
|
#
|
|
88
103
|
# @param tagline [String, nil] A short tagline for the course. It is displayed under the course title in the UI
|
|
@@ -92,6 +107,8 @@ module WhopSDK
|
|
|
92
107
|
# @param title [String, nil] The title of the course
|
|
93
108
|
#
|
|
94
109
|
# @param updated_at [Time] The timestamp of when the course was last updated
|
|
110
|
+
#
|
|
111
|
+
# @param visibility [Symbol, WhopSDK::Models::CourseVisibilities] The visibility of the course. Determines how / whether this course is visible to
|
|
95
112
|
|
|
96
113
|
# @see WhopSDK::Models::CourseListResponse#thumbnail
|
|
97
114
|
class Thumbnail < WhopSDK::Internal::Type::BaseModel
|
|
@@ -40,6 +40,13 @@ module WhopSDK
|
|
|
40
40
|
# @return [Symbol, WhopSDK::Models::Languages, nil]
|
|
41
41
|
optional :language, enum: -> { WhopSDK::Languages }, nil?: true
|
|
42
42
|
|
|
43
|
+
# @!attribute order
|
|
44
|
+
# The decimal order position of the course within its experience. Use fractional
|
|
45
|
+
# values (e.g., 1.5) to place between existing courses.
|
|
46
|
+
#
|
|
47
|
+
# @return [String, nil]
|
|
48
|
+
optional :order, String, nil?: true
|
|
49
|
+
|
|
43
50
|
# @!attribute require_completing_lessons_in_order
|
|
44
51
|
# Whether the course requires students to complete the previous lesson before
|
|
45
52
|
# moving on to the next one
|
|
@@ -65,7 +72,14 @@ module WhopSDK
|
|
|
65
72
|
# @return [String, nil]
|
|
66
73
|
optional :title, String, nil?: true
|
|
67
74
|
|
|
68
|
-
# @!
|
|
75
|
+
# @!attribute visibility
|
|
76
|
+
# The available visibilities for a course. Determines how / whether a course is
|
|
77
|
+
# visible to users.
|
|
78
|
+
#
|
|
79
|
+
# @return [Symbol, WhopSDK::Models::CourseVisibilities, nil]
|
|
80
|
+
optional :visibility, enum: -> { WhopSDK::CourseVisibilities }, nil?: true
|
|
81
|
+
|
|
82
|
+
# @!method initialize(certificate_after_completion_enabled: nil, chapters: nil, cover_image: nil, description: nil, language: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
|
|
69
83
|
# Some parameter documentations has been truncated, see
|
|
70
84
|
# {WhopSDK::Models::CourseUpdateParams} for more details.
|
|
71
85
|
#
|
|
@@ -79,6 +93,8 @@ module WhopSDK
|
|
|
79
93
|
#
|
|
80
94
|
# @param language [Symbol, WhopSDK::Models::Languages, nil] The available languages for a course
|
|
81
95
|
#
|
|
96
|
+
# @param order [String, nil] The decimal order position of the course within its experience. Use fractional v
|
|
97
|
+
#
|
|
82
98
|
# @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
|
|
83
99
|
#
|
|
84
100
|
# @param tagline [String, nil] A short tagline for the course
|
|
@@ -87,6 +103,8 @@ module WhopSDK
|
|
|
87
103
|
#
|
|
88
104
|
# @param title [String, nil] The title of the course
|
|
89
105
|
#
|
|
106
|
+
# @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
|
|
107
|
+
#
|
|
90
108
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
91
109
|
|
|
92
110
|
class Chapter < WhopSDK::Internal::Type::BaseModel
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# The available visibilities for a course. Determines how / whether a course is
|
|
6
|
+
# visible to users.
|
|
7
|
+
module CourseVisibilities
|
|
8
|
+
extend WhopSDK::Internal::Type::Enum
|
|
9
|
+
|
|
10
|
+
VISIBLE = :visible
|
|
11
|
+
HIDDEN = :hidden
|
|
12
|
+
|
|
13
|
+
# @!method self.values
|
|
14
|
+
# @return [Array<Symbol>]
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|