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
|
@@ -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
|
|
@@ -339,6 +363,24 @@ module WhopSDK
|
|
|
339
363
|
# @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
|
|
340
364
|
end
|
|
341
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
|
+
|
|
342
384
|
# @see WhopSDK::Models::Lesson#video_asset
|
|
343
385
|
class VideoAsset < WhopSDK::Internal::Type::BaseModel
|
|
344
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 }
|
|
@@ -7,12 +7,6 @@ module WhopSDK
|
|
|
7
7
|
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include WhopSDK::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute access_pass_ids
|
|
11
|
-
# The access pass IDs to filter the memberships by
|
|
12
|
-
#
|
|
13
|
-
# @return [Array<String>, nil]
|
|
14
|
-
optional :access_pass_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
15
|
-
|
|
16
10
|
# @!attribute after
|
|
17
11
|
# Returns the elements in the list that come after the specified cursor.
|
|
18
12
|
#
|
|
@@ -81,6 +75,12 @@ module WhopSDK
|
|
|
81
75
|
# @return [Array<String>, nil]
|
|
82
76
|
optional :plan_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
83
77
|
|
|
78
|
+
# @!attribute product_ids
|
|
79
|
+
# The product IDs to filter the memberships by
|
|
80
|
+
#
|
|
81
|
+
# @return [Array<String>, nil]
|
|
82
|
+
optional :product_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
83
|
+
|
|
84
84
|
# @!attribute promo_code_ids
|
|
85
85
|
# The promo code IDs to filter the memberships by
|
|
86
86
|
#
|
|
@@ -99,9 +99,7 @@ module WhopSDK
|
|
|
99
99
|
# @return [Array<String>, nil]
|
|
100
100
|
optional :user_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
101
101
|
|
|
102
|
-
# @!method initialize(
|
|
103
|
-
# @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the memberships by
|
|
104
|
-
#
|
|
102
|
+
# @!method initialize(after: nil, before: nil, cancel_options: nil, company_id: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, promo_code_ids: nil, statuses: nil, user_ids: nil, request_options: {})
|
|
105
103
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
106
104
|
#
|
|
107
105
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
@@ -124,6 +122,8 @@ module WhopSDK
|
|
|
124
122
|
#
|
|
125
123
|
# @param plan_ids [Array<String>, nil] The plan IDs to filter the memberships by
|
|
126
124
|
#
|
|
125
|
+
# @param product_ids [Array<String>, nil] The product IDs to filter the memberships by
|
|
126
|
+
#
|
|
127
127
|
# @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the memberships by
|
|
128
128
|
#
|
|
129
129
|
# @param statuses [Array<Symbol, WhopSDK::Models::MembershipStatus>, nil] The membership status to filter the memberships by
|
|
@@ -4,7 +4,7 @@ module WhopSDK
|
|
|
4
4
|
module Models
|
|
5
5
|
class Message < WhopSDK::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute id
|
|
7
|
-
# The unique identifier
|
|
7
|
+
# The unique identifier of the resource.
|
|
8
8
|
#
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :id, String
|
|
@@ -84,7 +84,7 @@ module WhopSDK
|
|
|
84
84
|
# @!method initialize(id:, content:, created_at:, is_edited:, is_pinned:, message_type:, poll:, poll_votes:, reaction_counts:, replying_to_message_id:, updated_at:, user:, view_count:)
|
|
85
85
|
# Represents a message in a DM channel
|
|
86
86
|
#
|
|
87
|
-
# @param id [String] The unique identifier
|
|
87
|
+
# @param id [String] The unique identifier of the resource.
|
|
88
88
|
#
|
|
89
89
|
# @param content [String, nil] The content of the message in Markdown format
|
|
90
90
|
#
|
|
@@ -5,7 +5,7 @@ module WhopSDK
|
|
|
5
5
|
# @see WhopSDK::Resources::Messages#list
|
|
6
6
|
class MessageListResponse < 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
|
|
@@ -87,7 +87,7 @@ module WhopSDK
|
|
|
87
87
|
# @!method initialize(id:, content:, created_at:, is_edited:, is_pinned:, message_type:, poll:, poll_votes:, reaction_counts:, replying_to_message_id:, updated_at:, user:, view_count:)
|
|
88
88
|
# Represents a message in a DM channel
|
|
89
89
|
#
|
|
90
|
-
# @param id [String] The unique identifier
|
|
90
|
+
# @param id [String] The unique identifier of the resource.
|
|
91
91
|
#
|
|
92
92
|
# @param content [String, nil] The content of the message in Markdown format
|
|
93
93
|
#
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Notifications#create
|
|
6
|
+
class NotificationCreateParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute company_id
|
|
11
|
+
# The id of the company to target. Only team members of this company will receive
|
|
12
|
+
# the notification. When clicked will take the user to your dashboard app view.
|
|
13
|
+
#
|
|
14
|
+
# @return [String]
|
|
15
|
+
required :company_id, String
|
|
16
|
+
|
|
17
|
+
# @!attribute content
|
|
18
|
+
# The content of the notification
|
|
19
|
+
#
|
|
20
|
+
# @return [String]
|
|
21
|
+
required :content, String
|
|
22
|
+
|
|
23
|
+
# @!attribute title
|
|
24
|
+
# The title of the notification
|
|
25
|
+
#
|
|
26
|
+
# @return [String]
|
|
27
|
+
required :title, String
|
|
28
|
+
|
|
29
|
+
# @!attribute icon_user_id
|
|
30
|
+
# Optional: ID of a Whop user whose profile picture will be used as the
|
|
31
|
+
# notification icon. If not provided, defaults to the experience or company
|
|
32
|
+
# avatar.
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :icon_user_id, String, nil?: true
|
|
36
|
+
|
|
37
|
+
# @!attribute rest_path
|
|
38
|
+
# The rest path to append to the generated deep link that opens your app. Use
|
|
39
|
+
# [restPath] in your app path in the dashboard to read this parameter.
|
|
40
|
+
#
|
|
41
|
+
# @return [String, nil]
|
|
42
|
+
optional :rest_path, String, nil?: true
|
|
43
|
+
|
|
44
|
+
# @!attribute subtitle
|
|
45
|
+
# The subtitle of the notification
|
|
46
|
+
#
|
|
47
|
+
# @return [String, nil]
|
|
48
|
+
optional :subtitle, String, nil?: true
|
|
49
|
+
|
|
50
|
+
# @!attribute user_ids
|
|
51
|
+
# If provided, this will only send to these users if they are also in the main
|
|
52
|
+
# scope (experience or company)
|
|
53
|
+
#
|
|
54
|
+
# @return [Array<String>, nil]
|
|
55
|
+
optional :user_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
|
|
56
|
+
|
|
57
|
+
# @!attribute experience_id
|
|
58
|
+
# The id of the experience to target. All users with access to this experience
|
|
59
|
+
# (customers and admins) will receive the notification. When clicked, open your
|
|
60
|
+
# experience view.
|
|
61
|
+
#
|
|
62
|
+
# @return [String]
|
|
63
|
+
required :experience_id, String
|
|
64
|
+
|
|
65
|
+
# @!method initialize(company_id:, content:, title:, experience_id:, icon_user_id: nil, rest_path: nil, subtitle: nil, user_ids: nil, request_options: {})
|
|
66
|
+
# Some parameter documentations has been truncated, see
|
|
67
|
+
# {WhopSDK::Models::NotificationCreateParams} for more details.
|
|
68
|
+
#
|
|
69
|
+
# @param company_id [String] The id of the company to target. Only team members of this company will receive
|
|
70
|
+
#
|
|
71
|
+
# @param content [String] The content of the notification
|
|
72
|
+
#
|
|
73
|
+
# @param title [String] The title of the notification
|
|
74
|
+
#
|
|
75
|
+
# @param experience_id [String] The id of the experience to target. All users with access to this experience (cu
|
|
76
|
+
#
|
|
77
|
+
# @param icon_user_id [String, nil] Optional: ID of a Whop user whose profile picture will be used as the notificati
|
|
78
|
+
#
|
|
79
|
+
# @param rest_path [String, nil] The rest path to append to the generated deep link that opens your app. Use [res
|
|
80
|
+
#
|
|
81
|
+
# @param subtitle [String, nil] The subtitle of the notification
|
|
82
|
+
#
|
|
83
|
+
# @param user_ids [Array<String>, nil] If provided, this will only send to these users if they are also in the main sco
|
|
84
|
+
#
|
|
85
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Notifications#create
|
|
6
|
+
class NotificationCreateResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute success
|
|
8
|
+
# Whether the notification was successfully queued for delivery
|
|
9
|
+
#
|
|
10
|
+
# @return [Boolean]
|
|
11
|
+
required :success, WhopSDK::Internal::Type::Boolean
|
|
12
|
+
|
|
13
|
+
# @!method initialize(success:)
|
|
14
|
+
# Response from queuing a notification
|
|
15
|
+
#
|
|
16
|
+
# @param success [Boolean] Whether the notification was successfully queued for delivery
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -119,7 +119,7 @@ module WhopSDK
|
|
|
119
119
|
required :plan, -> { WhopSDK::Payment::Plan }, nil?: true
|
|
120
120
|
|
|
121
121
|
# @!attribute product
|
|
122
|
-
# The
|
|
122
|
+
# The product this payment was made for
|
|
123
123
|
#
|
|
124
124
|
# @return [WhopSDK::Models::Payment::Product, nil]
|
|
125
125
|
required :product, -> { WhopSDK::Payment::Product }, nil?: true
|
|
@@ -244,7 +244,7 @@ module WhopSDK
|
|
|
244
244
|
#
|
|
245
245
|
# @param plan [WhopSDK::Models::Payment::Plan, nil] The plan attached to this payment.
|
|
246
246
|
#
|
|
247
|
-
# @param product [WhopSDK::Models::Payment::Product, nil] The
|
|
247
|
+
# @param product [WhopSDK::Models::Payment::Product, nil] The product this payment was made for
|
|
248
248
|
#
|
|
249
249
|
# @param promo_code [WhopSDK::Models::Payment::PromoCode, nil] The promo code used for this payment.
|
|
250
250
|
#
|
|
@@ -441,7 +441,7 @@ module WhopSDK
|
|
|
441
441
|
required :title, String
|
|
442
442
|
|
|
443
443
|
# @!method initialize(id:, route:, title:)
|
|
444
|
-
# The
|
|
444
|
+
# The product this payment was made for
|
|
445
445
|
#
|
|
446
446
|
# @param id [String] The internal ID of the public product.
|
|
447
447
|
#
|
|
@@ -120,7 +120,7 @@ module WhopSDK
|
|
|
120
120
|
required :plan, -> { WhopSDK::Models::PaymentListResponse::Plan }, nil?: true
|
|
121
121
|
|
|
122
122
|
# @!attribute product
|
|
123
|
-
# The
|
|
123
|
+
# The product this payment was made for
|
|
124
124
|
#
|
|
125
125
|
# @return [WhopSDK::Models::PaymentListResponse::Product, nil]
|
|
126
126
|
required :product, -> { WhopSDK::Models::PaymentListResponse::Product }, nil?: true
|
|
@@ -245,7 +245,7 @@ module WhopSDK
|
|
|
245
245
|
#
|
|
246
246
|
# @param plan [WhopSDK::Models::PaymentListResponse::Plan, nil] The plan attached to this payment.
|
|
247
247
|
#
|
|
248
|
-
# @param product [WhopSDK::Models::PaymentListResponse::Product, nil] The
|
|
248
|
+
# @param product [WhopSDK::Models::PaymentListResponse::Product, nil] The product this payment was made for
|
|
249
249
|
#
|
|
250
250
|
# @param promo_code [WhopSDK::Models::PaymentListResponse::PromoCode, nil] The promo code used for this payment.
|
|
251
251
|
#
|
|
@@ -442,7 +442,7 @@ module WhopSDK
|
|
|
442
442
|
required :title, String
|
|
443
443
|
|
|
444
444
|
# @!method initialize(id:, route:, title:)
|
|
445
|
-
# The
|
|
445
|
+
# The product this payment was made for
|
|
446
446
|
#
|
|
447
447
|
# @param id [String] The internal ID of the public product.
|
|
448
448
|
#
|
data/lib/whop_sdk/models/plan.rb
CHANGED
|
@@ -94,7 +94,7 @@ module WhopSDK
|
|
|
94
94
|
required :plan_type, enum: -> { WhopSDK::PlanType }
|
|
95
95
|
|
|
96
96
|
# @!attribute product
|
|
97
|
-
# The
|
|
97
|
+
# The product that this plan belongs to.
|
|
98
98
|
#
|
|
99
99
|
# @return [WhopSDK::Models::Plan::Product, nil]
|
|
100
100
|
required :product, -> { WhopSDK::Plan::Product }, nil?: true
|
|
@@ -160,7 +160,9 @@ module WhopSDK
|
|
|
160
160
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
161
161
|
|
|
162
162
|
# @!method initialize(id:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, tax_type:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
163
|
-
#
|
|
163
|
+
# A plan for an product. Plans define the core parameters that define a checkout
|
|
164
|
+
# and payment on whop. Use plans to create different ways to price your products
|
|
165
|
+
# (Eg renewal / one_time)
|
|
164
166
|
#
|
|
165
167
|
# @param id [String] The internal ID of the plan.
|
|
166
168
|
#
|
|
@@ -192,7 +194,7 @@ module WhopSDK
|
|
|
192
194
|
#
|
|
193
195
|
# @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
|
|
194
196
|
#
|
|
195
|
-
# @param product [WhopSDK::Models::Plan::Product, nil] The
|
|
197
|
+
# @param product [WhopSDK::Models::Plan::Product, nil] The product that this plan belongs to.
|
|
196
198
|
#
|
|
197
199
|
# @param purchase_url [String] The direct link to purchase the product.
|
|
198
200
|
#
|
|
@@ -357,7 +359,7 @@ module WhopSDK
|
|
|
357
359
|
required :title, String
|
|
358
360
|
|
|
359
361
|
# @!method initialize(id:, title:)
|
|
360
|
-
# The
|
|
362
|
+
# The product that this plan belongs to.
|
|
361
363
|
#
|
|
362
364
|
# @param id [String] The internal ID of the public product.
|
|
363
365
|
#
|
|
@@ -88,7 +88,7 @@ module WhopSDK
|
|
|
88
88
|
nil?: true
|
|
89
89
|
|
|
90
90
|
# @!attribute plan_type
|
|
91
|
-
# The type of plan that can be attached to
|
|
91
|
+
# The type of plan that can be attached to a product
|
|
92
92
|
#
|
|
93
93
|
# @return [Symbol, WhopSDK::Models::PlanType, nil]
|
|
94
94
|
optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
|
|
@@ -178,7 +178,7 @@ module WhopSDK
|
|
|
178
178
|
#
|
|
179
179
|
# @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
|
|
180
180
|
#
|
|
181
|
-
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to
|
|
181
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
|
|
182
182
|
#
|
|
183
183
|
# @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
|
|
184
184
|
#
|
|
@@ -85,7 +85,7 @@ module WhopSDK
|
|
|
85
85
|
required :plan_type, enum: -> { WhopSDK::PlanType }
|
|
86
86
|
|
|
87
87
|
# @!attribute product
|
|
88
|
-
# The
|
|
88
|
+
# The product that this plan belongs to.
|
|
89
89
|
#
|
|
90
90
|
# @return [WhopSDK::Models::PlanListResponse::Product, nil]
|
|
91
91
|
required :product, -> { WhopSDK::Models::PlanListResponse::Product }, nil?: true
|
|
@@ -145,7 +145,9 @@ module WhopSDK
|
|
|
145
145
|
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
146
146
|
|
|
147
147
|
# @!method initialize(id:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
148
|
-
#
|
|
148
|
+
# A plan for an product. Plans define the core parameters that define a checkout
|
|
149
|
+
# and payment on whop. Use plans to create different ways to price your products
|
|
150
|
+
# (Eg renewal / one_time)
|
|
149
151
|
#
|
|
150
152
|
# @param id [String] The internal ID of the plan.
|
|
151
153
|
#
|
|
@@ -173,7 +175,7 @@ module WhopSDK
|
|
|
173
175
|
#
|
|
174
176
|
# @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
|
|
175
177
|
#
|
|
176
|
-
# @param product [WhopSDK::Models::PlanListResponse::Product, nil] The
|
|
178
|
+
# @param product [WhopSDK::Models::PlanListResponse::Product, nil] The product that this plan belongs to.
|
|
177
179
|
#
|
|
178
180
|
# @param purchase_url [String] The direct link to purchase the product.
|
|
179
181
|
#
|
|
@@ -284,7 +286,7 @@ module WhopSDK
|
|
|
284
286
|
required :title, String
|
|
285
287
|
|
|
286
288
|
# @!method initialize(id:, title:)
|
|
287
|
-
# The
|
|
289
|
+
# The product that this plan belongs to.
|
|
288
290
|
#
|
|
289
291
|
# @param id [String] The internal ID of the public product.
|
|
290
292
|
#
|
|
@@ -155,7 +155,7 @@ module WhopSDK
|
|
|
155
155
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Product}
|
|
156
156
|
# for more details.
|
|
157
157
|
#
|
|
158
|
-
#
|
|
158
|
+
# Represents a product on whop. Use products to sell anything on the platform.
|
|
159
159
|
#
|
|
160
160
|
# @param id [String] The internal ID of the public product.
|
|
161
161
|
#
|
|
@@ -70,7 +70,7 @@ module WhopSDK
|
|
|
70
70
|
optional :global_affiliate_percentage, Float, nil?: true
|
|
71
71
|
|
|
72
72
|
# @!attribute global_affiliate_status
|
|
73
|
-
# The different statuses of the global affiliate program for
|
|
73
|
+
# The different statuses of the global affiliate program for a product.
|
|
74
74
|
#
|
|
75
75
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
76
76
|
optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
@@ -94,7 +94,7 @@ module WhopSDK
|
|
|
94
94
|
optional :member_affiliate_percentage, Float, nil?: true
|
|
95
95
|
|
|
96
96
|
# @!attribute member_affiliate_status
|
|
97
|
-
# The different statuses of the global affiliate program for
|
|
97
|
+
# The different statuses of the global affiliate program for a product.
|
|
98
98
|
#
|
|
99
99
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
100
100
|
optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
@@ -162,7 +162,7 @@ module WhopSDK
|
|
|
162
162
|
#
|
|
163
163
|
# @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
|
|
164
164
|
#
|
|
165
|
-
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for
|
|
165
|
+
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
166
166
|
#
|
|
167
167
|
# @param headline [String, nil] The headline of the product.
|
|
168
168
|
#
|
|
@@ -170,7 +170,7 @@ module WhopSDK
|
|
|
170
170
|
#
|
|
171
171
|
# @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
|
|
172
172
|
#
|
|
173
|
-
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for
|
|
173
|
+
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
174
174
|
#
|
|
175
175
|
# @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] The details to assign an autogenerated plan.
|
|
176
176
|
#
|
|
@@ -216,7 +216,7 @@ module WhopSDK
|
|
|
216
216
|
optional :initial_price, Float, nil?: true
|
|
217
217
|
|
|
218
218
|
# @!attribute plan_type
|
|
219
|
-
# The type of plan that can be attached to
|
|
219
|
+
# The type of plan that can be attached to a product
|
|
220
220
|
#
|
|
221
221
|
# @return [Symbol, WhopSDK::Models::PlanType, nil]
|
|
222
222
|
optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
|
|
@@ -250,7 +250,7 @@ module WhopSDK
|
|
|
250
250
|
#
|
|
251
251
|
# @param initial_price [Float, nil] An additional amount charged upon first purchase.
|
|
252
252
|
#
|
|
253
|
-
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to
|
|
253
|
+
# @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
|
|
254
254
|
#
|
|
255
255
|
# @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
|
|
256
256
|
#
|
|
@@ -87,7 +87,7 @@ module WhopSDK
|
|
|
87
87
|
# Some parameter documentations has been truncated, see
|
|
88
88
|
# {WhopSDK::Models::ProductListItem} for more details.
|
|
89
89
|
#
|
|
90
|
-
#
|
|
90
|
+
# Represents a product on whop. Use products to sell anything on the platform.
|
|
91
91
|
#
|
|
92
92
|
# @param id [String] The internal ID of the public product.
|
|
93
93
|
#
|
|
@@ -58,7 +58,7 @@ module WhopSDK
|
|
|
58
58
|
optional :global_affiliate_percentage, Float, nil?: true
|
|
59
59
|
|
|
60
60
|
# @!attribute global_affiliate_status
|
|
61
|
-
# The different statuses of the global affiliate program for
|
|
61
|
+
# The different statuses of the global affiliate program for a product.
|
|
62
62
|
#
|
|
63
63
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
64
64
|
optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
@@ -82,7 +82,7 @@ module WhopSDK
|
|
|
82
82
|
optional :member_affiliate_percentage, Float, nil?: true
|
|
83
83
|
|
|
84
84
|
# @!attribute member_affiliate_status
|
|
85
|
-
# The different statuses of the global affiliate program for
|
|
85
|
+
# The different statuses of the global affiliate program for a product.
|
|
86
86
|
#
|
|
87
87
|
# @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
|
|
88
88
|
optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
|
|
@@ -144,7 +144,7 @@ module WhopSDK
|
|
|
144
144
|
#
|
|
145
145
|
# @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
|
|
146
146
|
#
|
|
147
|
-
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for
|
|
147
|
+
# @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
148
148
|
#
|
|
149
149
|
# @param headline [String, nil] The headline of the product.
|
|
150
150
|
#
|
|
@@ -152,7 +152,7 @@ module WhopSDK
|
|
|
152
152
|
#
|
|
153
153
|
# @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
|
|
154
154
|
#
|
|
155
|
-
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for
|
|
155
|
+
# @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
|
|
156
156
|
#
|
|
157
157
|
# @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
|
|
158
158
|
#
|