whop_sdk 0.0.7 → 0.0.9
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 +35 -0
- data/README.md +7 -7
- data/lib/whop_sdk/client.rb +12 -0
- data/lib/whop_sdk/internal/type/base_model.rb +1 -1
- data/lib/whop_sdk/models/account_link_create_params.rb +62 -0
- data/lib/whop_sdk/models/account_link_create_response.rb +28 -0
- data/lib/whop_sdk/models/app.rb +9 -1
- data/lib/whop_sdk/models/app_build_list_params.rb +17 -1
- data/lib/whop_sdk/models/app_list_params.rb +10 -1
- data/lib/whop_sdk/models/app_list_response.rb +9 -1
- data/lib/whop_sdk/models/app_type.rb +18 -0
- data/lib/whop_sdk/models/app_update_params.rb +9 -1
- data/lib/whop_sdk/models/authorized_user_list_params.rb +17 -1
- data/lib/whop_sdk/models/checkout_configuration.rb +69 -7
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +73 -1
- data/lib/whop_sdk/models/checkout_configuration_list_params.rb +17 -1
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +69 -7
- data/lib/whop_sdk/models/checkout_modes.rb +16 -0
- data/lib/whop_sdk/models/company_list_params.rb +17 -1
- data/lib/whop_sdk/models/course.rb +9 -1
- data/lib/whop_sdk/models/course_lesson_list_response.rb +9 -1
- data/lib/whop_sdk/models/course_lesson_mark_as_completed_params.rb +14 -0
- data/lib/whop_sdk/models/course_lesson_mark_as_completed_response.rb +8 -0
- data/lib/whop_sdk/models/course_lesson_start_params.rb +14 -0
- data/lib/whop_sdk/models/course_lesson_start_response.rb +8 -0
- data/lib/whop_sdk/models/course_lesson_submit_assessment_params.rb +52 -0
- data/lib/whop_sdk/models/course_lesson_submit_assessment_response.rb +151 -0
- data/lib/whop_sdk/models/course_list_response.rb +9 -1
- data/lib/whop_sdk/models/dispute_list_params.rb +17 -1
- data/lib/whop_sdk/models/entry_list_params.rb +17 -1
- data/lib/whop_sdk/models/experience_list_params.rb +17 -1
- data/lib/whop_sdk/models/forum_post_create_params.rb +3 -14
- data/lib/whop_sdk/models/forum_post_update_params.rb +3 -14
- data/lib/whop_sdk/models/forum_post_visibility_type.rb +16 -0
- data/lib/whop_sdk/models/invoice_list_params.rb +17 -1
- data/lib/whop_sdk/models/lesson.rb +104 -2
- data/lib/whop_sdk/models/payment_method_types.rb +1 -0
- data/lib/whop_sdk/models/payment_provider.rb +22 -0
- data/lib/whop_sdk/models/plan_create_params.rb +3 -21
- data/lib/whop_sdk/models/plan_list_params.rb +17 -1
- data/lib/whop_sdk/models/product_list_params.rb +17 -1
- data/lib/whop_sdk/models/product_update_params.rb +1 -61
- data/lib/whop_sdk/models/promo_code_list_params.rb +17 -1
- data/lib/whop_sdk/models/refund_created_webhook_event.rb +354 -0
- data/lib/whop_sdk/models/refund_list_params.rb +78 -0
- data/lib/whop_sdk/models/refund_list_response.rb +113 -0
- data/lib/whop_sdk/models/refund_reference_status.rb +17 -0
- data/lib/whop_sdk/models/refund_reference_type.rb +17 -0
- data/lib/whop_sdk/models/refund_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/refund_retrieve_response.rb +307 -0
- data/lib/whop_sdk/models/refund_status.rb +19 -0
- data/lib/whop_sdk/models/refund_updated_webhook_event.rb +354 -0
- data/lib/whop_sdk/models/review_list_params.rb +17 -1
- data/lib/whop_sdk/models/transfer_list_params.rb +17 -1
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +5 -1
- data/lib/whop_sdk/models/withdrawal_fee_types.rb +16 -0
- data/lib/whop_sdk/models/withdrawal_list_params.rb +78 -0
- data/lib/whop_sdk/models/withdrawal_list_response.rb +87 -0
- data/lib/whop_sdk/models/withdrawal_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +320 -0
- data/lib/whop_sdk/models/withdrawal_speeds.rb +16 -0
- data/lib/whop_sdk/models/withdrawal_status.rb +21 -0
- data/lib/whop_sdk/models/withdrawal_types.rb +16 -0
- data/lib/whop_sdk/models.rb +42 -0
- data/lib/whop_sdk/resources/account_links.rb +47 -0
- data/lib/whop_sdk/resources/app_builds.rb +5 -1
- data/lib/whop_sdk/resources/apps.rb +6 -2
- data/lib/whop_sdk/resources/authorized_users.rb +5 -1
- data/lib/whop_sdk/resources/checkout_configurations.rb +16 -2
- data/lib/whop_sdk/resources/companies.rb +5 -1
- data/lib/whop_sdk/resources/course_lessons.rb +64 -0
- data/lib/whop_sdk/resources/disputes.rb +5 -1
- data/lib/whop_sdk/resources/entries.rb +5 -1
- data/lib/whop_sdk/resources/experiences.rb +5 -1
- data/lib/whop_sdk/resources/forum_posts.rb +2 -2
- data/lib/whop_sdk/resources/invoices.rb +5 -1
- data/lib/whop_sdk/resources/plans.rb +7 -7
- data/lib/whop_sdk/resources/products.rb +6 -4
- data/lib/whop_sdk/resources/promo_codes.rb +5 -1
- data/lib/whop_sdk/resources/refunds.rb +82 -0
- data/lib/whop_sdk/resources/reviews.rb +5 -1
- data/lib/whop_sdk/resources/transfers.rb +5 -1
- data/lib/whop_sdk/resources/webhooks.rb +1 -1
- data/lib/whop_sdk/resources/withdrawals.rb +79 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +33 -0
- data/manifest.yaml +1 -0
- data/rbi/whop_sdk/client.rbi +9 -0
- data/rbi/whop_sdk/models/account_link_create_params.rbi +101 -0
- data/rbi/whop_sdk/models/account_link_create_response.rbi +38 -0
- data/rbi/whop_sdk/models/app.rbi +8 -0
- data/rbi/whop_sdk/models/app_build_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/app_list_params.rbi +13 -0
- data/rbi/whop_sdk/models/app_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/app_type.rbi +22 -0
- data/rbi/whop_sdk/models/app_update_params.rbi +8 -0
- data/rbi/whop_sdk/models/authorized_user_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +117 -7
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +116 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +127 -7
- data/rbi/whop_sdk/models/checkout_modes.rbi +20 -0
- data/rbi/whop_sdk/models/company_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/course.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_mark_as_completed_params.rbi +30 -0
- data/rbi/whop_sdk/models/course_lesson_mark_as_completed_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_start_params.rbi +27 -0
- data/rbi/whop_sdk/models/course_lesson_start_response.rbi +8 -0
- data/rbi/whop_sdk/models/course_lesson_submit_assessment_params.rbi +104 -0
- data/rbi/whop_sdk/models/course_lesson_submit_assessment_response.rbi +222 -0
- data/rbi/whop_sdk/models/course_list_response.rbi +8 -0
- data/rbi/whop_sdk/models/dispute_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/entry_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/experience_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/forum_post_create_params.rbi +3 -37
- data/rbi/whop_sdk/models/forum_post_update_params.rbi +3 -37
- data/rbi/whop_sdk/models/forum_post_visibility_type.rbi +27 -0
- data/rbi/whop_sdk/models/invoice_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/lesson.rbi +115 -3
- data/rbi/whop_sdk/models/payment_method_types.rbi +1 -0
- data/rbi/whop_sdk/models/payment_provider.rbi +27 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +2 -22
- data/rbi/whop_sdk/models/plan_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/product_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/product_update_params.rbi +0 -110
- data/rbi/whop_sdk/models/promo_code_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +561 -0
- data/rbi/whop_sdk/models/refund_list_params.rbi +99 -0
- data/rbi/whop_sdk/models/refund_list_response.rbi +155 -0
- data/rbi/whop_sdk/models/refund_reference_status.rbi +26 -0
- data/rbi/whop_sdk/models/refund_reference_type.rbi +36 -0
- data/rbi/whop_sdk/models/refund_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/refund_retrieve_response.rbi +484 -0
- data/rbi/whop_sdk/models/refund_status.rbi +24 -0
- data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +561 -0
- data/rbi/whop_sdk/models/review_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/transfer_list_params.rbi +16 -0
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +3 -1
- data/rbi/whop_sdk/models/withdrawal_fee_types.rbi +22 -0
- data/rbi/whop_sdk/models/withdrawal_list_params.rbi +99 -0
- data/rbi/whop_sdk/models/withdrawal_list_response.rbi +107 -0
- data/rbi/whop_sdk/models/withdrawal_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +713 -0
- data/rbi/whop_sdk/models/withdrawal_speeds.rbi +22 -0
- data/rbi/whop_sdk/models/withdrawal_status.rbi +28 -0
- data/rbi/whop_sdk/models/withdrawal_types.rbi +20 -0
- data/rbi/whop_sdk/models.rbi +44 -0
- data/rbi/whop_sdk/resources/account_links.rbi +39 -0
- data/rbi/whop_sdk/resources/app_builds.rbi +6 -0
- data/rbi/whop_sdk/resources/apps.rbi +6 -0
- data/rbi/whop_sdk/resources/authorized_users.rbi +6 -0
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +21 -0
- data/rbi/whop_sdk/resources/companies.rbi +6 -0
- data/rbi/whop_sdk/resources/course_lessons.rbi +48 -0
- data/rbi/whop_sdk/resources/disputes.rbi +6 -0
- data/rbi/whop_sdk/resources/entries.rbi +6 -0
- data/rbi/whop_sdk/resources/experiences.rbi +6 -0
- data/rbi/whop_sdk/resources/forum_posts.rbi +2 -4
- data/rbi/whop_sdk/resources/invoices.rbi +6 -0
- data/rbi/whop_sdk/resources/plans.rbi +7 -9
- data/rbi/whop_sdk/resources/products.rbi +6 -9
- data/rbi/whop_sdk/resources/promo_codes.rbi +6 -0
- data/rbi/whop_sdk/resources/refunds.rbi +74 -0
- data/rbi/whop_sdk/resources/reviews.rbi +6 -0
- data/rbi/whop_sdk/resources/transfers.rbi +6 -0
- data/rbi/whop_sdk/resources/webhooks.rbi +3 -1
- data/rbi/whop_sdk/resources/withdrawals.rbi +71 -0
- data/sig/whop_sdk/client.rbs +6 -0
- data/sig/whop_sdk/models/account_link_create_params.rbs +52 -0
- data/sig/whop_sdk/models/account_link_create_response.rbs +15 -0
- data/sig/whop_sdk/models/app.rbs +5 -0
- data/sig/whop_sdk/models/app_build_list_params.rbs +10 -0
- data/sig/whop_sdk/models/app_list_params.rbs +7 -0
- data/sig/whop_sdk/models/app_list_response.rbs +5 -0
- data/sig/whop_sdk/models/app_type.rbs +16 -0
- data/sig/whop_sdk/models/app_update_params.rbs +5 -0
- data/sig/whop_sdk/models/authorized_user_list_params.rbs +10 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +45 -8
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +43 -1
- data/sig/whop_sdk/models/checkout_configuration_list_params.rbs +10 -0
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +45 -8
- data/sig/whop_sdk/models/checkout_modes.rbs +14 -0
- data/sig/whop_sdk/models/company_list_params.rbs +10 -0
- data/sig/whop_sdk/models/course.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_list_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_mark_as_completed_params.rbs +15 -0
- data/sig/whop_sdk/models/course_lesson_mark_as_completed_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_start_params.rbs +15 -0
- data/sig/whop_sdk/models/course_lesson_start_response.rbs +5 -0
- data/sig/whop_sdk/models/course_lesson_submit_assessment_params.rbs +51 -0
- data/sig/whop_sdk/models/course_lesson_submit_assessment_response.rbs +96 -0
- data/sig/whop_sdk/models/course_list_response.rbs +5 -0
- data/sig/whop_sdk/models/dispute_list_params.rbs +10 -0
- data/sig/whop_sdk/models/entry_list_params.rbs +10 -0
- data/sig/whop_sdk/models/experience_list_params.rbs +10 -0
- data/sig/whop_sdk/models/forum_post_create_params.rbs +4 -15
- data/sig/whop_sdk/models/forum_post_update_params.rbs +4 -15
- data/sig/whop_sdk/models/forum_post_visibility_type.rbs +14 -0
- data/sig/whop_sdk/models/invoice_list_params.rbs +10 -0
- data/sig/whop_sdk/models/lesson.rbs +79 -3
- data/sig/whop_sdk/models/payment_method_types.rbs +2 -0
- data/sig/whop_sdk/models/payment_provider.rbs +28 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +0 -10
- data/sig/whop_sdk/models/plan_list_params.rbs +10 -0
- data/sig/whop_sdk/models/product_list_params.rbs +10 -0
- data/sig/whop_sdk/models/product_update_params.rbs +0 -36
- data/sig/whop_sdk/models/promo_code_list_params.rbs +10 -0
- data/sig/whop_sdk/models/refund_created_webhook_event.rbs +252 -0
- data/sig/whop_sdk/models/refund_list_params.rbs +61 -0
- data/sig/whop_sdk/models/refund_list_response.rbs +80 -0
- data/sig/whop_sdk/models/refund_reference_status.rbs +15 -0
- data/sig/whop_sdk/models/refund_reference_type.rbs +18 -0
- data/sig/whop_sdk/models/refund_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/refund_retrieve_response.rbs +215 -0
- data/sig/whop_sdk/models/refund_status.rbs +18 -0
- data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +252 -0
- data/sig/whop_sdk/models/review_list_params.rbs +10 -0
- data/sig/whop_sdk/models/transfer_list_params.rbs +10 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +2 -0
- data/sig/whop_sdk/models/withdrawal_fee_types.rbs +14 -0
- data/sig/whop_sdk/models/withdrawal_list_params.rbs +61 -0
- data/sig/whop_sdk/models/withdrawal_list_response.rbs +60 -0
- data/sig/whop_sdk/models/withdrawal_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +297 -0
- data/sig/whop_sdk/models/withdrawal_speeds.rbs +14 -0
- data/sig/whop_sdk/models/withdrawal_status.rbs +26 -0
- data/sig/whop_sdk/models/withdrawal_types.rbs +14 -0
- data/sig/whop_sdk/models.rbs +42 -0
- data/sig/whop_sdk/resources/account_links.rbs +15 -0
- data/sig/whop_sdk/resources/app_builds.rbs +2 -0
- data/sig/whop_sdk/resources/apps.rbs +2 -0
- data/sig/whop_sdk/resources/authorized_users.rbs +2 -0
- data/sig/whop_sdk/resources/checkout_configurations.rbs +5 -0
- data/sig/whop_sdk/resources/companies.rbs +2 -0
- data/sig/whop_sdk/resources/course_lessons.rbs +16 -0
- data/sig/whop_sdk/resources/disputes.rbs +2 -0
- data/sig/whop_sdk/resources/entries.rbs +2 -0
- data/sig/whop_sdk/resources/experiences.rbs +2 -0
- data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
- data/sig/whop_sdk/resources/invoices.rbs +2 -0
- data/sig/whop_sdk/resources/plans.rbs +2 -2
- data/sig/whop_sdk/resources/products.rbs +2 -1
- data/sig/whop_sdk/resources/promo_codes.rbs +2 -0
- data/sig/whop_sdk/resources/refunds.rbs +24 -0
- data/sig/whop_sdk/resources/reviews.rbs +2 -0
- data/sig/whop_sdk/resources/transfers.rbs +2 -0
- data/sig/whop_sdk/resources/webhooks.rbs +3 -1
- data/sig/whop_sdk/resources/withdrawals.rbs +24 -0
- metadata +98 -2
|
@@ -25,6 +25,18 @@ module WhopSDK
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :before, String, nil?: true
|
|
27
27
|
|
|
28
|
+
# @!attribute created_after
|
|
29
|
+
# The minimum creation date to filter by
|
|
30
|
+
#
|
|
31
|
+
# @return [Time, nil]
|
|
32
|
+
optional :created_after, Time, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute created_before
|
|
35
|
+
# The maximum creation date to filter by
|
|
36
|
+
#
|
|
37
|
+
# @return [Time, nil]
|
|
38
|
+
optional :created_before, Time, nil?: true
|
|
39
|
+
|
|
28
40
|
# @!attribute direction
|
|
29
41
|
# The direction of the sort.
|
|
30
42
|
#
|
|
@@ -49,13 +61,17 @@ module WhopSDK
|
|
|
49
61
|
# @return [String, nil]
|
|
50
62
|
optional :plan_id, String, nil?: true
|
|
51
63
|
|
|
52
|
-
# @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, plan_id: nil, request_options: {})
|
|
64
|
+
# @!method initialize(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, plan_id: nil, request_options: {})
|
|
53
65
|
# @param company_id [String] The ID of the company to list checkout configurations for
|
|
54
66
|
#
|
|
55
67
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
56
68
|
#
|
|
57
69
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
58
70
|
#
|
|
71
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
72
|
+
#
|
|
73
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
74
|
+
#
|
|
59
75
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
60
76
|
#
|
|
61
77
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -25,14 +25,30 @@ module WhopSDK
|
|
|
25
25
|
# @!attribute metadata
|
|
26
26
|
# The metadata to use for the checkout configuration
|
|
27
27
|
#
|
|
28
|
-
# @return [Hash{Symbol=>Object}]
|
|
29
|
-
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
|
|
28
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
29
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
|
|
30
|
+
|
|
31
|
+
# @!attribute mode
|
|
32
|
+
# The mode of the checkout session.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, WhopSDK::Models::CheckoutModes]
|
|
35
|
+
required :mode, enum: -> { WhopSDK::CheckoutModes }
|
|
36
|
+
|
|
37
|
+
# @!attribute payment_method_configuration
|
|
38
|
+
# The explicit payment method configuration for the session, if any. This
|
|
39
|
+
# currently only works in 'setup' mode. Use the plan's
|
|
40
|
+
# payment_method_configuration for payment method.
|
|
41
|
+
#
|
|
42
|
+
# @return [WhopSDK::Models::CheckoutConfigurationListResponse::PaymentMethodConfiguration, nil]
|
|
43
|
+
required :payment_method_configuration,
|
|
44
|
+
-> { WhopSDK::Models::CheckoutConfigurationListResponse::PaymentMethodConfiguration },
|
|
45
|
+
nil?: true
|
|
30
46
|
|
|
31
47
|
# @!attribute plan
|
|
32
48
|
# The plan to use for the checkout configuration
|
|
33
49
|
#
|
|
34
|
-
# @return [WhopSDK::Models::CheckoutConfigurationListResponse::Plan]
|
|
35
|
-
required :plan, -> { WhopSDK::Models::CheckoutConfigurationListResponse::Plan }
|
|
50
|
+
# @return [WhopSDK::Models::CheckoutConfigurationListResponse::Plan, nil]
|
|
51
|
+
required :plan, -> { WhopSDK::Models::CheckoutConfigurationListResponse::Plan }, nil?: true
|
|
36
52
|
|
|
37
53
|
# @!attribute purchase_url
|
|
38
54
|
# A URL you can send to customers to complete a checkout. It looks like
|
|
@@ -47,7 +63,7 @@ module WhopSDK
|
|
|
47
63
|
# @return [String, nil]
|
|
48
64
|
required :redirect_url, String, nil?: true
|
|
49
65
|
|
|
50
|
-
# @!method initialize(id:, affiliate_code:, company_id:, metadata:, plan:, purchase_url:, redirect_url:)
|
|
66
|
+
# @!method initialize(id:, affiliate_code:, company_id:, metadata:, mode:, payment_method_configuration:, plan:, purchase_url:, redirect_url:)
|
|
51
67
|
# Some parameter documentations has been truncated, see
|
|
52
68
|
# {WhopSDK::Models::CheckoutConfigurationListResponse} for more details.
|
|
53
69
|
#
|
|
@@ -62,14 +78,60 @@ module WhopSDK
|
|
|
62
78
|
#
|
|
63
79
|
# @param company_id [String] The ID of the company to use for the checkout configuration
|
|
64
80
|
#
|
|
65
|
-
# @param metadata [Hash{Symbol=>Object}] The metadata to use for the checkout configuration
|
|
81
|
+
# @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
|
|
82
|
+
#
|
|
83
|
+
# @param mode [Symbol, WhopSDK::Models::CheckoutModes] The mode of the checkout session.
|
|
66
84
|
#
|
|
67
|
-
# @param
|
|
85
|
+
# @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationListResponse::PaymentMethodConfiguration, nil] The explicit payment method configuration for the session, if any. This currentl
|
|
86
|
+
#
|
|
87
|
+
# @param plan [WhopSDK::Models::CheckoutConfigurationListResponse::Plan, nil] The plan to use for the checkout configuration
|
|
68
88
|
#
|
|
69
89
|
# @param purchase_url [String] A URL you can send to customers to complete a checkout. It looks like `/checkout
|
|
70
90
|
#
|
|
71
91
|
# @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
|
|
72
92
|
|
|
93
|
+
# @see WhopSDK::Models::CheckoutConfigurationListResponse#payment_method_configuration
|
|
94
|
+
class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
|
|
95
|
+
# @!attribute disabled
|
|
96
|
+
# An array of payment method identifiers that are explicitly disabled. Only
|
|
97
|
+
# applies if the include_platform_defaults is true.
|
|
98
|
+
#
|
|
99
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
100
|
+
required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
101
|
+
|
|
102
|
+
# @!attribute enabled
|
|
103
|
+
# An array of payment method identifiers that are explicitly enabled. This means
|
|
104
|
+
# these payment methods will be shown on checkout. Example use case is to only
|
|
105
|
+
# enable a specific payment method like cashapp, or extending the platform
|
|
106
|
+
# defaults with additional methods.
|
|
107
|
+
#
|
|
108
|
+
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
109
|
+
required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
110
|
+
|
|
111
|
+
# @!attribute include_platform_defaults
|
|
112
|
+
# Whether Whop's platform default payment method enablement settings are included
|
|
113
|
+
# in this configuration. The full list of default payment methods can be found in
|
|
114
|
+
# the documentation at docs.whop.com/payments.
|
|
115
|
+
#
|
|
116
|
+
# @return [Boolean]
|
|
117
|
+
required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
|
|
118
|
+
|
|
119
|
+
# @!method initialize(disabled:, enabled:, include_platform_defaults:)
|
|
120
|
+
# Some parameter documentations has been truncated, see
|
|
121
|
+
# {WhopSDK::Models::CheckoutConfigurationListResponse::PaymentMethodConfiguration}
|
|
122
|
+
# for more details.
|
|
123
|
+
#
|
|
124
|
+
# The explicit payment method configuration for the session, if any. This
|
|
125
|
+
# currently only works in 'setup' mode. Use the plan's
|
|
126
|
+
# payment_method_configuration for payment method.
|
|
127
|
+
#
|
|
128
|
+
# @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
|
|
129
|
+
#
|
|
130
|
+
# @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
|
|
131
|
+
#
|
|
132
|
+
# @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
|
|
133
|
+
end
|
|
134
|
+
|
|
73
135
|
# @see WhopSDK::Models::CheckoutConfigurationListResponse#plan
|
|
74
136
|
class Plan < WhopSDK::Internal::Type::BaseModel
|
|
75
137
|
# @!attribute id
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# The different modes a checkout can be set to.
|
|
6
|
+
module CheckoutModes
|
|
7
|
+
extend WhopSDK::Internal::Type::Enum
|
|
8
|
+
|
|
9
|
+
PAYMENT = :payment
|
|
10
|
+
SETUP = :setup
|
|
11
|
+
|
|
12
|
+
# @!method self.values
|
|
13
|
+
# @return [Array<Symbol>]
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -25,6 +25,18 @@ module WhopSDK
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :before, String, nil?: true
|
|
27
27
|
|
|
28
|
+
# @!attribute created_after
|
|
29
|
+
# The minimum creation date to filter by
|
|
30
|
+
#
|
|
31
|
+
# @return [Time, nil]
|
|
32
|
+
optional :created_after, Time, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute created_before
|
|
35
|
+
# The maximum creation date to filter by
|
|
36
|
+
#
|
|
37
|
+
# @return [Time, nil]
|
|
38
|
+
optional :created_before, Time, nil?: true
|
|
39
|
+
|
|
28
40
|
# @!attribute direction
|
|
29
41
|
# The direction of the sort.
|
|
30
42
|
#
|
|
@@ -43,13 +55,17 @@ module WhopSDK
|
|
|
43
55
|
# @return [Integer, nil]
|
|
44
56
|
optional :last, Integer, nil?: true
|
|
45
57
|
|
|
46
|
-
# @!method initialize(parent_company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
58
|
+
# @!method initialize(parent_company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
47
59
|
# @param parent_company_id [String] The ID of the parent company to list sub companies for
|
|
48
60
|
#
|
|
49
61
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
50
62
|
#
|
|
51
63
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
52
64
|
#
|
|
65
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
66
|
+
#
|
|
67
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
68
|
+
#
|
|
53
69
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
54
70
|
#
|
|
55
71
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -23,6 +23,12 @@ module WhopSDK
|
|
|
23
23
|
# @return [Array<WhopSDK::Models::Course::Chapter>]
|
|
24
24
|
required :chapters, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Course::Chapter] }
|
|
25
25
|
|
|
26
|
+
# @!attribute cover_image
|
|
27
|
+
# The URL of the course's cover image, which is shown in course preview cards
|
|
28
|
+
#
|
|
29
|
+
# @return [String, nil]
|
|
30
|
+
required :cover_image, String, nil?: true
|
|
31
|
+
|
|
26
32
|
# @!attribute created_at
|
|
27
33
|
# The timestamp of when the course was created
|
|
28
34
|
#
|
|
@@ -86,7 +92,7 @@ module WhopSDK
|
|
|
86
92
|
# @return [Symbol, WhopSDK::Models::CourseVisibilities]
|
|
87
93
|
required :visibility, enum: -> { WhopSDK::CourseVisibilities }
|
|
88
94
|
|
|
89
|
-
# @!method initialize(id:, certificate_after_completion_enabled:, chapters:, created_at:, description:, language:, order:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:, visibility:)
|
|
95
|
+
# @!method initialize(id:, certificate_after_completion_enabled:, chapters:, cover_image:, created_at:, description:, language:, order:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:, visibility:)
|
|
90
96
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Course}
|
|
91
97
|
# for more details.
|
|
92
98
|
#
|
|
@@ -98,6 +104,8 @@ module WhopSDK
|
|
|
98
104
|
#
|
|
99
105
|
# @param chapters [Array<WhopSDK::Models::Course::Chapter>] The chapters in this course
|
|
100
106
|
#
|
|
107
|
+
# @param cover_image [String, nil] The URL of the course's cover image, which is shown in course preview cards
|
|
108
|
+
#
|
|
101
109
|
# @param created_at [Time] The timestamp of when the course was created
|
|
102
110
|
#
|
|
103
111
|
# @param description [String, nil] A short description of the course
|
|
@@ -16,6 +16,12 @@ module WhopSDK
|
|
|
16
16
|
# @return [String, nil]
|
|
17
17
|
required :content, String, nil?: true
|
|
18
18
|
|
|
19
|
+
# @!attribute created_at
|
|
20
|
+
# The timestamp of when the lesson was created
|
|
21
|
+
#
|
|
22
|
+
# @return [Time]
|
|
23
|
+
required :created_at, Time
|
|
24
|
+
|
|
19
25
|
# @!attribute days_from_course_start_until_unlock
|
|
20
26
|
# Number of days from course start until the lesson is unlocked
|
|
21
27
|
#
|
|
@@ -65,7 +71,7 @@ module WhopSDK
|
|
|
65
71
|
# @return [Symbol, WhopSDK::Models::LessonVisibilities]
|
|
66
72
|
required :visibility, enum: -> { WhopSDK::LessonVisibilities }
|
|
67
73
|
|
|
68
|
-
# @!method initialize(id:, content:, days_from_course_start_until_unlock:, embed_id:, embed_type:, lesson_type:, order:, thumbnail:, title:, visibility:)
|
|
74
|
+
# @!method initialize(id:, content:, created_at:, days_from_course_start_until_unlock:, embed_id:, embed_type:, lesson_type:, order:, thumbnail:, title:, visibility:)
|
|
69
75
|
# Some parameter documentations has been truncated, see
|
|
70
76
|
# {WhopSDK::Models::CourseLessonListResponse} for more details.
|
|
71
77
|
#
|
|
@@ -75,6 +81,8 @@ module WhopSDK
|
|
|
75
81
|
#
|
|
76
82
|
# @param content [String, nil] The content of the lesson
|
|
77
83
|
#
|
|
84
|
+
# @param created_at [Time] The timestamp of when the lesson was created
|
|
85
|
+
#
|
|
78
86
|
# @param days_from_course_start_until_unlock [Integer, nil] Number of days from course start until the lesson is unlocked
|
|
79
87
|
#
|
|
80
88
|
# @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::CourseLessons#mark_as_completed
|
|
6
|
+
class CourseLessonMarkAsCompletedParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::CourseLessons#start
|
|
6
|
+
class CourseLessonStartParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!method initialize(request_options: {})
|
|
11
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::CourseLessons#submit_assessment
|
|
6
|
+
class CourseLessonSubmitAssessmentParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute answers
|
|
11
|
+
# The answers to the assessment questions
|
|
12
|
+
#
|
|
13
|
+
# @return [Array<WhopSDK::Models::CourseLessonSubmitAssessmentParams::Answer>]
|
|
14
|
+
required :answers,
|
|
15
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CourseLessonSubmitAssessmentParams::Answer] }
|
|
16
|
+
|
|
17
|
+
# @!method initialize(answers:, request_options: {})
|
|
18
|
+
# @param answers [Array<WhopSDK::Models::CourseLessonSubmitAssessmentParams::Answer>] The answers to the assessment questions
|
|
19
|
+
#
|
|
20
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
21
|
+
|
|
22
|
+
class Answer < WhopSDK::Internal::Type::BaseModel
|
|
23
|
+
# @!attribute question_id
|
|
24
|
+
# The ID of the question being answered
|
|
25
|
+
#
|
|
26
|
+
# @return [String]
|
|
27
|
+
required :question_id, String
|
|
28
|
+
|
|
29
|
+
# @!attribute answer_text
|
|
30
|
+
# The text answer provided by the user (for short answer questions)
|
|
31
|
+
#
|
|
32
|
+
# @return [String, nil]
|
|
33
|
+
optional :answer_text, String, nil?: true
|
|
34
|
+
|
|
35
|
+
# @!attribute selected_option_ids
|
|
36
|
+
# The IDs of the selected options (for multiple choice/select questions)
|
|
37
|
+
#
|
|
38
|
+
# @return [Array<String>, nil]
|
|
39
|
+
optional :selected_option_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
40
|
+
|
|
41
|
+
# @!method initialize(question_id:, answer_text: nil, selected_option_ids: nil)
|
|
42
|
+
# Input for a single question's answer in an assessment submission
|
|
43
|
+
#
|
|
44
|
+
# @param question_id [String] The ID of the question being answered
|
|
45
|
+
#
|
|
46
|
+
# @param answer_text [String, nil] The text answer provided by the user (for short answer questions)
|
|
47
|
+
#
|
|
48
|
+
# @param selected_option_ids [Array<String>, nil] The IDs of the selected options (for multiple choice/select questions)
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::CourseLessons#submit_assessment
|
|
6
|
+
class CourseLessonSubmitAssessmentResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The ID of the assessment result
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute created_at
|
|
14
|
+
# When the assessment was taken
|
|
15
|
+
#
|
|
16
|
+
# @return [Time]
|
|
17
|
+
required :created_at, Time
|
|
18
|
+
|
|
19
|
+
# @!attribute lesson
|
|
20
|
+
# The lesson this assessment result is for
|
|
21
|
+
#
|
|
22
|
+
# @return [WhopSDK::Models::CourseLessonSubmitAssessmentResponse::Lesson]
|
|
23
|
+
required :lesson, -> { WhopSDK::Models::CourseLessonSubmitAssessmentResponse::Lesson }
|
|
24
|
+
|
|
25
|
+
# @!attribute result_correct
|
|
26
|
+
# The number of correct answers
|
|
27
|
+
#
|
|
28
|
+
# @return [Integer]
|
|
29
|
+
required :result_correct, Integer
|
|
30
|
+
|
|
31
|
+
# @!attribute result_grade
|
|
32
|
+
# The grade achieved on the assessment
|
|
33
|
+
#
|
|
34
|
+
# @return [Float]
|
|
35
|
+
required :result_grade, Float
|
|
36
|
+
|
|
37
|
+
# @!attribute result_graded_questions
|
|
38
|
+
# Array of graded questions with details
|
|
39
|
+
#
|
|
40
|
+
# @return [Hash{Symbol=>Object}]
|
|
41
|
+
required :result_graded_questions, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
|
|
42
|
+
|
|
43
|
+
# @!attribute result_passing_grade
|
|
44
|
+
# Whether the user achieved a passing grade
|
|
45
|
+
#
|
|
46
|
+
# @return [Boolean]
|
|
47
|
+
required :result_passing_grade, WhopSDK::Internal::Type::Boolean
|
|
48
|
+
|
|
49
|
+
# @!attribute result_question_count
|
|
50
|
+
# The total number of questions in the assessment
|
|
51
|
+
#
|
|
52
|
+
# @return [Integer]
|
|
53
|
+
required :result_question_count, Integer
|
|
54
|
+
|
|
55
|
+
# @!attribute score_percent
|
|
56
|
+
# The percentage score achieved on the assessment
|
|
57
|
+
#
|
|
58
|
+
# @return [Float]
|
|
59
|
+
required :score_percent, Float
|
|
60
|
+
|
|
61
|
+
# @!attribute updated_at
|
|
62
|
+
# When the assessment result was last updated
|
|
63
|
+
#
|
|
64
|
+
# @return [Time]
|
|
65
|
+
required :updated_at, Time
|
|
66
|
+
|
|
67
|
+
# @!attribute user
|
|
68
|
+
# The user who took the assessment
|
|
69
|
+
#
|
|
70
|
+
# @return [WhopSDK::Models::CourseLessonSubmitAssessmentResponse::User]
|
|
71
|
+
required :user, -> { WhopSDK::Models::CourseLessonSubmitAssessmentResponse::User }
|
|
72
|
+
|
|
73
|
+
# @!method initialize(id:, created_at:, lesson:, result_correct:, result_grade:, result_graded_questions:, result_passing_grade:, result_question_count:, score_percent:, updated_at:, user:)
|
|
74
|
+
# The result of a user's assessment attempt
|
|
75
|
+
#
|
|
76
|
+
# @param id [String] The ID of the assessment result
|
|
77
|
+
#
|
|
78
|
+
# @param created_at [Time] When the assessment was taken
|
|
79
|
+
#
|
|
80
|
+
# @param lesson [WhopSDK::Models::CourseLessonSubmitAssessmentResponse::Lesson] The lesson this assessment result is for
|
|
81
|
+
#
|
|
82
|
+
# @param result_correct [Integer] The number of correct answers
|
|
83
|
+
#
|
|
84
|
+
# @param result_grade [Float] The grade achieved on the assessment
|
|
85
|
+
#
|
|
86
|
+
# @param result_graded_questions [Hash{Symbol=>Object}] Array of graded questions with details
|
|
87
|
+
#
|
|
88
|
+
# @param result_passing_grade [Boolean] Whether the user achieved a passing grade
|
|
89
|
+
#
|
|
90
|
+
# @param result_question_count [Integer] The total number of questions in the assessment
|
|
91
|
+
#
|
|
92
|
+
# @param score_percent [Float] The percentage score achieved on the assessment
|
|
93
|
+
#
|
|
94
|
+
# @param updated_at [Time] When the assessment result was last updated
|
|
95
|
+
#
|
|
96
|
+
# @param user [WhopSDK::Models::CourseLessonSubmitAssessmentResponse::User] The user who took the assessment
|
|
97
|
+
|
|
98
|
+
# @see WhopSDK::Models::CourseLessonSubmitAssessmentResponse#lesson
|
|
99
|
+
class Lesson < WhopSDK::Internal::Type::BaseModel
|
|
100
|
+
# @!attribute id
|
|
101
|
+
# The ID of the lesson
|
|
102
|
+
#
|
|
103
|
+
# @return [String]
|
|
104
|
+
required :id, String
|
|
105
|
+
|
|
106
|
+
# @!attribute title
|
|
107
|
+
# The title of the lesson
|
|
108
|
+
#
|
|
109
|
+
# @return [String]
|
|
110
|
+
required :title, String
|
|
111
|
+
|
|
112
|
+
# @!method initialize(id:, title:)
|
|
113
|
+
# The lesson this assessment result is for
|
|
114
|
+
#
|
|
115
|
+
# @param id [String] The ID of the lesson
|
|
116
|
+
#
|
|
117
|
+
# @param title [String] The title of the lesson
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# @see WhopSDK::Models::CourseLessonSubmitAssessmentResponse#user
|
|
121
|
+
class User < WhopSDK::Internal::Type::BaseModel
|
|
122
|
+
# @!attribute id
|
|
123
|
+
# The internal ID of the user.
|
|
124
|
+
#
|
|
125
|
+
# @return [String]
|
|
126
|
+
required :id, String
|
|
127
|
+
|
|
128
|
+
# @!attribute name
|
|
129
|
+
# The name of the user from their Whop account.
|
|
130
|
+
#
|
|
131
|
+
# @return [String, nil]
|
|
132
|
+
required :name, String, nil?: true
|
|
133
|
+
|
|
134
|
+
# @!attribute username
|
|
135
|
+
# The username of the user from their Whop account.
|
|
136
|
+
#
|
|
137
|
+
# @return [String]
|
|
138
|
+
required :username, String
|
|
139
|
+
|
|
140
|
+
# @!method initialize(id:, name:, username:)
|
|
141
|
+
# The user who took the assessment
|
|
142
|
+
#
|
|
143
|
+
# @param id [String] The internal ID of the user.
|
|
144
|
+
#
|
|
145
|
+
# @param name [String, nil] The name of the user from their Whop account.
|
|
146
|
+
#
|
|
147
|
+
# @param username [String] The username of the user from their Whop account.
|
|
148
|
+
end
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
end
|
|
@@ -17,6 +17,12 @@ module WhopSDK
|
|
|
17
17
|
# @return [Boolean, nil]
|
|
18
18
|
required :certificate_after_completion_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
19
19
|
|
|
20
|
+
# @!attribute cover_image
|
|
21
|
+
# The URL of the course's cover image, which is shown in course preview cards
|
|
22
|
+
#
|
|
23
|
+
# @return [String, nil]
|
|
24
|
+
required :cover_image, String, nil?: true
|
|
25
|
+
|
|
20
26
|
# @!attribute created_at
|
|
21
27
|
# The timestamp of when the course was created
|
|
22
28
|
#
|
|
@@ -80,7 +86,7 @@ module WhopSDK
|
|
|
80
86
|
# @return [Symbol, WhopSDK::Models::CourseVisibilities]
|
|
81
87
|
required :visibility, enum: -> { WhopSDK::CourseVisibilities }
|
|
82
88
|
|
|
83
|
-
# @!method initialize(id:, certificate_after_completion_enabled:, created_at:, description:, language:, order:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:, visibility:)
|
|
89
|
+
# @!method initialize(id:, certificate_after_completion_enabled:, cover_image:, created_at:, description:, language:, order:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:, visibility:)
|
|
84
90
|
# Some parameter documentations has been truncated, see
|
|
85
91
|
# {WhopSDK::Models::CourseListResponse} for more details.
|
|
86
92
|
#
|
|
@@ -90,6 +96,8 @@ module WhopSDK
|
|
|
90
96
|
#
|
|
91
97
|
# @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
|
|
92
98
|
#
|
|
99
|
+
# @param cover_image [String, nil] The URL of the course's cover image, which is shown in course preview cards
|
|
100
|
+
#
|
|
93
101
|
# @param created_at [Time] The timestamp of when the course was created
|
|
94
102
|
#
|
|
95
103
|
# @param description [String, nil] A short description of the course
|
|
@@ -25,6 +25,18 @@ module WhopSDK
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :before, String, nil?: true
|
|
27
27
|
|
|
28
|
+
# @!attribute created_after
|
|
29
|
+
# The minimum creation date to filter by
|
|
30
|
+
#
|
|
31
|
+
# @return [Time, nil]
|
|
32
|
+
optional :created_after, Time, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute created_before
|
|
35
|
+
# The maximum creation date to filter by
|
|
36
|
+
#
|
|
37
|
+
# @return [Time, nil]
|
|
38
|
+
optional :created_before, Time, nil?: true
|
|
39
|
+
|
|
28
40
|
# @!attribute direction
|
|
29
41
|
# The direction of the sort.
|
|
30
42
|
#
|
|
@@ -43,13 +55,17 @@ module WhopSDK
|
|
|
43
55
|
# @return [Integer, nil]
|
|
44
56
|
optional :last, Integer, nil?: true
|
|
45
57
|
|
|
46
|
-
# @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
58
|
+
# @!method initialize(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
47
59
|
# @param company_id [String] The ID of the company to list disputes for
|
|
48
60
|
#
|
|
49
61
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
50
62
|
#
|
|
51
63
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
52
64
|
#
|
|
65
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
66
|
+
#
|
|
67
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
68
|
+
#
|
|
53
69
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
54
70
|
#
|
|
55
71
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -25,6 +25,18 @@ module WhopSDK
|
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
optional :before, String, nil?: true
|
|
27
27
|
|
|
28
|
+
# @!attribute created_after
|
|
29
|
+
# The minimum creation date to filter by
|
|
30
|
+
#
|
|
31
|
+
# @return [Time, nil]
|
|
32
|
+
optional :created_after, Time, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute created_before
|
|
35
|
+
# The maximum creation date to filter by
|
|
36
|
+
#
|
|
37
|
+
# @return [Time, nil]
|
|
38
|
+
optional :created_before, Time, nil?: true
|
|
39
|
+
|
|
28
40
|
# @!attribute direction
|
|
29
41
|
# The direction of the sort.
|
|
30
42
|
#
|
|
@@ -67,13 +79,17 @@ module WhopSDK
|
|
|
67
79
|
# @return [Array<Symbol, WhopSDK::Models::EntryStatus>, nil]
|
|
68
80
|
optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::EntryStatus] }, nil?: true
|
|
69
81
|
|
|
70
|
-
# @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, request_options: {})
|
|
82
|
+
# @!method initialize(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, request_options: {})
|
|
71
83
|
# @param company_id [String] The ID of the company
|
|
72
84
|
#
|
|
73
85
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
74
86
|
#
|
|
75
87
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
76
88
|
#
|
|
89
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
90
|
+
#
|
|
91
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
92
|
+
#
|
|
77
93
|
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
78
94
|
#
|
|
79
95
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
@@ -31,6 +31,18 @@ module WhopSDK
|
|
|
31
31
|
# @return [String, nil]
|
|
32
32
|
optional :before, String, nil?: true
|
|
33
33
|
|
|
34
|
+
# @!attribute created_after
|
|
35
|
+
# The minimum creation date to filter by
|
|
36
|
+
#
|
|
37
|
+
# @return [Time, nil]
|
|
38
|
+
optional :created_after, Time, nil?: true
|
|
39
|
+
|
|
40
|
+
# @!attribute created_before
|
|
41
|
+
# The maximum creation date to filter by
|
|
42
|
+
#
|
|
43
|
+
# @return [Time, nil]
|
|
44
|
+
optional :created_before, Time, nil?: true
|
|
45
|
+
|
|
34
46
|
# @!attribute first
|
|
35
47
|
# Returns the first _n_ elements from the list.
|
|
36
48
|
#
|
|
@@ -49,7 +61,7 @@ module WhopSDK
|
|
|
49
61
|
# @return [String, nil]
|
|
50
62
|
optional :product_id, String, nil?: true
|
|
51
63
|
|
|
52
|
-
# @!method initialize(company_id:, after: nil, app_id: nil, before: nil, first: nil, last: nil, product_id: nil, request_options: {})
|
|
64
|
+
# @!method initialize(company_id:, after: nil, app_id: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, product_id: nil, request_options: {})
|
|
53
65
|
# @param company_id [String] The ID of the company to filter experiences by
|
|
54
66
|
#
|
|
55
67
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
@@ -58,6 +70,10 @@ module WhopSDK
|
|
|
58
70
|
#
|
|
59
71
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
60
72
|
#
|
|
73
|
+
# @param created_after [Time, nil] The minimum creation date to filter by
|
|
74
|
+
#
|
|
75
|
+
# @param created_before [Time, nil] The maximum creation date to filter by
|
|
76
|
+
#
|
|
61
77
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
62
78
|
#
|
|
63
79
|
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|