whop_sdk 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (185) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/client.rb +4 -0
  5. data/lib/whop_sdk/internal/transport/base_client.rb +7 -1
  6. data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +6 -2
  7. data/lib/whop_sdk/models/access_level.rb +1 -1
  8. data/lib/whop_sdk/models/access_pass_type.rb +2 -1
  9. data/lib/whop_sdk/models/access_token_create_params.rb +67 -0
  10. data/lib/whop_sdk/models/access_token_create_response.rb +27 -0
  11. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +4 -4
  12. data/lib/whop_sdk/models/course.rb +18 -1
  13. data/lib/whop_sdk/models/course_create_params.rb +20 -1
  14. data/lib/whop_sdk/models/course_lesson_create_params.rb +77 -1
  15. data/lib/whop_sdk/models/course_lesson_list_response.rb +43 -1
  16. data/lib/whop_sdk/models/course_lesson_update_params.rb +77 -1
  17. data/lib/whop_sdk/models/course_list_response.rb +18 -1
  18. data/lib/whop_sdk/models/course_update_params.rb +19 -1
  19. data/lib/whop_sdk/models/course_visibilities.rb +17 -0
  20. data/lib/whop_sdk/models/embed_type.rb +16 -0
  21. data/lib/whop_sdk/models/entry.rb +3 -3
  22. data/lib/whop_sdk/models/entry_list_response.rb +3 -3
  23. data/lib/whop_sdk/models/experience.rb +5 -6
  24. data/lib/whop_sdk/models/forum_post.rb +2 -2
  25. data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
  26. data/lib/whop_sdk/models/global_affiliate_status.rb +1 -1
  27. data/lib/whop_sdk/models/invoice_create_params.rb +2 -2
  28. data/lib/whop_sdk/models/invoice_list_params.rb +27 -40
  29. data/lib/whop_sdk/models/lesson.rb +43 -1
  30. data/lib/whop_sdk/models/member_list_params.rb +11 -11
  31. data/lib/whop_sdk/models/member_list_response.rb +3 -3
  32. data/lib/whop_sdk/models/member_retrieve_response.rb +3 -3
  33. data/lib/whop_sdk/models/membership_list_params.rb +9 -9
  34. data/lib/whop_sdk/models/message.rb +2 -2
  35. data/lib/whop_sdk/models/message_list_response.rb +2 -2
  36. data/lib/whop_sdk/models/payment.rb +3 -3
  37. data/lib/whop_sdk/models/payment_list_response.rb +3 -3
  38. data/lib/whop_sdk/models/plan.rb +6 -4
  39. data/lib/whop_sdk/models/plan_create_params.rb +2 -2
  40. data/lib/whop_sdk/models/plan_list_response.rb +6 -4
  41. data/lib/whop_sdk/models/plan_type.rb +1 -1
  42. data/lib/whop_sdk/models/product.rb +1 -1
  43. data/lib/whop_sdk/models/product_create_params.rb +6 -6
  44. data/lib/whop_sdk/models/product_list_item.rb +1 -1
  45. data/lib/whop_sdk/models/product_update_params.rb +4 -4
  46. data/lib/whop_sdk/models/promo_code.rb +3 -3
  47. data/lib/whop_sdk/models/promo_code_list_response.rb +3 -3
  48. data/lib/whop_sdk/models.rb +6 -0
  49. data/lib/whop_sdk/resources/access_tokens.rb +46 -0
  50. data/lib/whop_sdk/resources/app_builds.rb +4 -2
  51. data/lib/whop_sdk/resources/apps.rb +3 -2
  52. data/lib/whop_sdk/resources/authorized_users.rb +2 -1
  53. data/lib/whop_sdk/resources/chat_channels.rb +9 -2
  54. data/lib/whop_sdk/resources/checkout_configurations.rb +2 -1
  55. data/lib/whop_sdk/resources/companies.rb +2 -1
  56. data/lib/whop_sdk/resources/course_chapters.rb +5 -3
  57. data/lib/whop_sdk/resources/course_lesson_interactions.rb +2 -1
  58. data/lib/whop_sdk/resources/course_lessons.rb +19 -5
  59. data/lib/whop_sdk/resources/course_students.rb +2 -1
  60. data/lib/whop_sdk/resources/courses.rb +15 -5
  61. data/lib/whop_sdk/resources/entries.rb +6 -3
  62. data/lib/whop_sdk/resources/experiences.rb +8 -6
  63. data/lib/whop_sdk/resources/forum_posts.rb +3 -2
  64. data/lib/whop_sdk/resources/forums.rb +3 -2
  65. data/lib/whop_sdk/resources/invoices.rb +11 -5
  66. data/lib/whop_sdk/resources/ledger_accounts.rb +6 -2
  67. data/lib/whop_sdk/resources/members.rb +6 -5
  68. data/lib/whop_sdk/resources/memberships.rb +10 -8
  69. data/lib/whop_sdk/resources/messages.rb +3 -2
  70. data/lib/whop_sdk/resources/payments.rb +7 -4
  71. data/lib/whop_sdk/resources/plans.rb +6 -4
  72. data/lib/whop_sdk/resources/products.rb +9 -7
  73. data/lib/whop_sdk/resources/promo_codes.rb +4 -2
  74. data/lib/whop_sdk/resources/reactions.rb +2 -1
  75. data/lib/whop_sdk/resources/reviews.rb +2 -1
  76. data/lib/whop_sdk/resources/shipments.rb +2 -1
  77. data/lib/whop_sdk/resources/support_channels.rb +2 -1
  78. data/lib/whop_sdk/resources/transfers.rb +2 -1
  79. data/lib/whop_sdk/resources/users.rb +9 -3
  80. data/lib/whop_sdk/version.rb +1 -1
  81. data/lib/whop_sdk.rb +6 -0
  82. data/manifest.yaml +1 -0
  83. data/rbi/whop_sdk/client.rbi +3 -0
  84. data/rbi/whop_sdk/internal/transport/base_client.rbi +5 -0
  85. data/rbi/whop_sdk/internal/transport/pooled_net_requester.rbi +6 -2
  86. data/rbi/whop_sdk/internal/type/base_model.rbi +8 -4
  87. data/rbi/whop_sdk/models/access_level.rbi +1 -1
  88. data/rbi/whop_sdk/models/access_pass_type.rbi +2 -1
  89. data/rbi/whop_sdk/models/access_token_create_params.rbi +126 -0
  90. data/rbi/whop_sdk/models/access_token_create_response.rbi +37 -0
  91. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +4 -4
  92. data/rbi/whop_sdk/models/course.rbi +21 -3
  93. data/rbi/whop_sdk/models/course_create_params.rbi +22 -0
  94. data/rbi/whop_sdk/models/course_lesson_create_params.rbi +126 -0
  95. data/rbi/whop_sdk/models/course_lesson_list_response.rbi +68 -0
  96. data/rbi/whop_sdk/models/course_lesson_update_params.rbi +126 -0
  97. data/rbi/whop_sdk/models/course_list_response.rbi +21 -3
  98. data/rbi/whop_sdk/models/course_update_params.rbi +20 -0
  99. data/rbi/whop_sdk/models/course_visibilities.rbi +23 -0
  100. data/rbi/whop_sdk/models/embed_type.rbi +20 -0
  101. data/rbi/whop_sdk/models/entry.rbi +3 -3
  102. data/rbi/whop_sdk/models/entry_list_response.rbi +3 -3
  103. data/rbi/whop_sdk/models/experience.rbi +7 -9
  104. data/rbi/whop_sdk/models/forum_post.rbi +2 -2
  105. data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
  106. data/rbi/whop_sdk/models/global_affiliate_status.rbi +1 -1
  107. data/rbi/whop_sdk/models/invoice_create_params.rbi +2 -2
  108. data/rbi/whop_sdk/models/invoice_list_params.rbi +26 -71
  109. data/rbi/whop_sdk/models/lesson.rbi +54 -0
  110. data/rbi/whop_sdk/models/member_list_params.rbi +10 -10
  111. data/rbi/whop_sdk/models/member_list_response.rbi +6 -6
  112. data/rbi/whop_sdk/models/member_retrieve_response.rbi +6 -6
  113. data/rbi/whop_sdk/models/membership_list_params.rbi +8 -8
  114. data/rbi/whop_sdk/models/message.rbi +2 -2
  115. data/rbi/whop_sdk/models/message_list_response.rbi +2 -2
  116. data/rbi/whop_sdk/models/payment.rbi +3 -3
  117. data/rbi/whop_sdk/models/payment_list_response.rbi +3 -3
  118. data/rbi/whop_sdk/models/plan.rbi +6 -4
  119. data/rbi/whop_sdk/models/plan_create_params.rbi +2 -2
  120. data/rbi/whop_sdk/models/plan_list_response.rbi +6 -4
  121. data/rbi/whop_sdk/models/plan_type.rbi +1 -1
  122. data/rbi/whop_sdk/models/product.rbi +1 -1
  123. data/rbi/whop_sdk/models/product_create_params.rbi +6 -6
  124. data/rbi/whop_sdk/models/product_list_item.rbi +1 -1
  125. data/rbi/whop_sdk/models/product_update_params.rbi +4 -4
  126. data/rbi/whop_sdk/models/promo_code.rbi +3 -3
  127. data/rbi/whop_sdk/models/promo_code_list_response.rbi +3 -3
  128. data/rbi/whop_sdk/models.rbi +6 -0
  129. data/rbi/whop_sdk/resources/access_tokens.rbi +41 -0
  130. data/rbi/whop_sdk/resources/app_builds.rbi +10 -2
  131. data/rbi/whop_sdk/resources/apps.rbi +6 -1
  132. data/rbi/whop_sdk/resources/authorized_users.rbi +5 -1
  133. data/rbi/whop_sdk/resources/chat_channels.rbi +8 -1
  134. data/rbi/whop_sdk/resources/checkout_configurations.rbi +5 -1
  135. data/rbi/whop_sdk/resources/companies.rbi +5 -1
  136. data/rbi/whop_sdk/resources/course_chapters.rbi +11 -2
  137. data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +5 -1
  138. data/rbi/whop_sdk/resources/course_lessons.rbi +41 -2
  139. data/rbi/whop_sdk/resources/course_students.rbi +5 -1
  140. data/rbi/whop_sdk/resources/courses.rbi +28 -2
  141. data/rbi/whop_sdk/resources/entries.rbi +15 -3
  142. data/rbi/whop_sdk/resources/experiences.rbi +14 -2
  143. data/rbi/whop_sdk/resources/forum_posts.rbi +6 -1
  144. data/rbi/whop_sdk/resources/forums.rbi +6 -1
  145. data/rbi/whop_sdk/resources/invoices.rbi +20 -5
  146. data/rbi/whop_sdk/resources/ledger_accounts.rbi +7 -2
  147. data/rbi/whop_sdk/resources/members.rbi +9 -5
  148. data/rbi/whop_sdk/resources/memberships.rbi +16 -5
  149. data/rbi/whop_sdk/resources/messages.rbi +6 -1
  150. data/rbi/whop_sdk/resources/payments.rbi +16 -3
  151. data/rbi/whop_sdk/resources/plans.rbi +12 -3
  152. data/rbi/whop_sdk/resources/products.rbi +15 -6
  153. data/rbi/whop_sdk/resources/promo_codes.rbi +10 -2
  154. data/rbi/whop_sdk/resources/reactions.rbi +5 -1
  155. data/rbi/whop_sdk/resources/reviews.rbi +5 -1
  156. data/rbi/whop_sdk/resources/shipments.rbi +5 -1
  157. data/rbi/whop_sdk/resources/support_channels.rbi +5 -1
  158. data/rbi/whop_sdk/resources/transfers.rbi +5 -1
  159. data/rbi/whop_sdk/resources/users.rbi +13 -2
  160. data/sig/whop_sdk/client.rbs +2 -0
  161. data/sig/whop_sdk/internal/transport/base_client.rbs +2 -0
  162. data/sig/whop_sdk/internal/transport/pooled_net_requester.rbs +4 -1
  163. data/sig/whop_sdk/models/access_token_create_params.rbs +56 -0
  164. data/sig/whop_sdk/models/access_token_create_response.rbs +15 -0
  165. data/sig/whop_sdk/models/course.rbs +13 -3
  166. data/sig/whop_sdk/models/course_create_params.rbs +11 -1
  167. data/sig/whop_sdk/models/course_lesson_create_params.rbs +46 -0
  168. data/sig/whop_sdk/models/course_lesson_list_response.rbs +25 -0
  169. data/sig/whop_sdk/models/course_lesson_update_params.rbs +46 -0
  170. data/sig/whop_sdk/models/course_list_response.rbs +13 -3
  171. data/sig/whop_sdk/models/course_update_params.rbs +11 -1
  172. data/sig/whop_sdk/models/course_visibilities.rbs +14 -0
  173. data/sig/whop_sdk/models/embed_type.rbs +14 -0
  174. data/sig/whop_sdk/models/invoice_list_params.rbs +16 -33
  175. data/sig/whop_sdk/models/lesson.rbs +25 -0
  176. data/sig/whop_sdk/models/member_list_params.rbs +5 -5
  177. data/sig/whop_sdk/models/membership_list_params.rbs +5 -5
  178. data/sig/whop_sdk/models.rbs +6 -0
  179. data/sig/whop_sdk/resources/access_tokens.rbs +15 -0
  180. data/sig/whop_sdk/resources/course_lessons.rbs +6 -0
  181. data/sig/whop_sdk/resources/courses.rbs +4 -0
  182. data/sig/whop_sdk/resources/invoices.rbs +3 -1
  183. data/sig/whop_sdk/resources/members.rbs +1 -1
  184. data/sig/whop_sdk/resources/memberships.rbs +1 -1
  185. metadata +17 -2
@@ -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 access pass. If its customer, the member has a valid
16
- # membership to the access pass. If its no_access, the member does not have access
17
- # to the access pass.
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(access_pass_ids: nil, after: nil, before: nil, cancel_options: nil, company_id: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, promo_code_ids: nil, statuses: nil, user_ids: nil, request_options: {})
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 for the entity
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 for the entity
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 for the entity
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 for the entity
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
  #
@@ -119,7 +119,7 @@ module WhopSDK
119
119
  required :plan, -> { WhopSDK::Payment::Plan }, nil?: true
120
120
 
121
121
  # @!attribute product
122
- # The access pass attached to this payment.
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 access pass attached to this payment.
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 access pass attached to this payment.
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 access pass attached to this payment.
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 access pass attached to this payment.
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 access pass attached to this payment.
445
+ # The product this payment was made for
446
446
  #
447
447
  # @param id [String] The internal ID of the public product.
448
448
  #
@@ -94,7 +94,7 @@ module WhopSDK
94
94
  required :plan_type, enum: -> { WhopSDK::PlanType }
95
95
 
96
96
  # @!attribute product
97
- # The access pass for the plan.
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
- # An object representing a (sanitized) plan of an access pass.
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 access pass for the plan.
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 access pass for the plan.
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 an access pass
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 an access pass
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 access pass for the plan.
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
- # An object representing a (sanitized) plan of an access pass.
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 access pass for the plan.
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 access pass for the plan.
289
+ # The product that this plan belongs to.
288
290
  #
289
291
  # @param id [String] The internal ID of the public product.
290
292
  #
@@ -2,7 +2,7 @@
2
2
 
3
3
  module WhopSDK
4
4
  module Models
5
- # The type of plan that can be attached to an access pass
5
+ # The type of plan that can be attached to a product
6
6
  module PlanType
7
7
  extend WhopSDK::Internal::Type::Enum
8
8
 
@@ -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
- # An object representing a (sanitized) access pass.
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 an access pass.
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 an access pass.
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 an access pass.
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 an access pass.
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 an access pass
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 an access pass
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
- # An object representing a (sanitized) access pass.
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 an access pass.
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 an access pass.
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 an access pass.
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 an access pass.
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
  #
@@ -78,7 +78,7 @@ module WhopSDK
78
78
  required :one_per_customer, WhopSDK::Internal::Type::Boolean
79
79
 
80
80
  # @!attribute product
81
- # The access pass associated with the promo code.
81
+ # The product this promo code applies to
82
82
  #
83
83
  # @return [WhopSDK::Models::PromoCode::Product, nil]
84
84
  required :product, -> { WhopSDK::PromoCode::Product }, nil?: true
@@ -149,7 +149,7 @@ module WhopSDK
149
149
  #
150
150
  # @param one_per_customer [Boolean] Restricts promo use to only be applied once per customer.
151
151
  #
152
- # @param product [WhopSDK::Models::PromoCode::Product, nil] The access pass associated with the promo code.
152
+ # @param product [WhopSDK::Models::PromoCode::Product, nil] The product this promo code applies to
153
153
  #
154
154
  # @param promo_duration_months [Integer, nil] The number of months the promo is applied for.
155
155
  #
@@ -200,7 +200,7 @@ module WhopSDK
200
200
  required :title, String
201
201
 
202
202
  # @!method initialize(id:, title:)
203
- # The access pass associated with the promo code.
203
+ # The product this promo code applies to
204
204
  #
205
205
  # @param id [String] The internal ID of the public product.
206
206
  #
@@ -72,7 +72,7 @@ module WhopSDK
72
72
  required :one_per_customer, WhopSDK::Internal::Type::Boolean
73
73
 
74
74
  # @!attribute product
75
- # The access pass associated with the promo code.
75
+ # The product this promo code applies to
76
76
  #
77
77
  # @return [WhopSDK::Models::PromoCodeListResponse::Product, nil]
78
78
  required :product, -> { WhopSDK::Models::PromoCodeListResponse::Product }, nil?: true
@@ -141,7 +141,7 @@ module WhopSDK
141
141
  #
142
142
  # @param one_per_customer [Boolean] Restricts promo use to only be applied once per customer.
143
143
  #
144
- # @param product [WhopSDK::Models::PromoCodeListResponse::Product, nil] The access pass associated with the promo code.
144
+ # @param product [WhopSDK::Models::PromoCodeListResponse::Product, nil] The product this promo code applies to
145
145
  #
146
146
  # @param promo_duration_months [Integer, nil] The number of months the promo is applied for.
147
147
  #
@@ -170,7 +170,7 @@ module WhopSDK
170
170
  required :title, String
171
171
 
172
172
  # @!method initialize(id:, title:)
173
- # The access pass associated with the promo code.
173
+ # The product this promo code applies to
174
174
  #
175
175
  # @param id [String] The internal ID of the public product.
176
176
  #
@@ -43,6 +43,8 @@ module WhopSDK
43
43
 
44
44
  AccessPassType = WhopSDK::Models::AccessPassType
45
45
 
46
+ AccessTokenCreateParams = WhopSDK::Models::AccessTokenCreateParams
47
+
46
48
  App = WhopSDK::Models::App
47
49
 
48
50
  AppBuild = WhopSDK::Models::AppBuild
@@ -160,6 +162,8 @@ module WhopSDK
160
162
 
161
163
  CourseUpdateParams = WhopSDK::Models::CourseUpdateParams
162
164
 
165
+ CourseVisibilities = WhopSDK::Models::CourseVisibilities
166
+
163
167
  Currency = WhopSDK::Models::Currency
164
168
 
165
169
  CustomCta = WhopSDK::Models::CustomCta
@@ -170,6 +174,8 @@ module WhopSDK
170
174
 
171
175
  EmailNotificationPreferences = WhopSDK::Models::EmailNotificationPreferences
172
176
 
177
+ EmbedType = WhopSDK::Models::EmbedType
178
+
173
179
  Entry = WhopSDK::Models::Entry
174
180
 
175
181
  EntryApprovedWebhookEvent = WhopSDK::Models::EntryApprovedWebhookEvent
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Resources
5
+ class AccessTokens
6
+ # Some parameter documentations has been truncated, see
7
+ # {WhopSDK::Models::AccessTokenCreateParams} for more details.
8
+ #
9
+ # Creates an access token for a user to access a specific resource. These access
10
+ # tokens are designed to be used with Whop's embedded components.
11
+ #
12
+ # @overload create(scoped_actions:, target_resource_id:, target_resource_type:, expires_at: nil, request_options: {})
13
+ #
14
+ # @param scoped_actions [Array<String>] Array of desired scoped actions for the access token. This list must be a subset
15
+ #
16
+ # @param target_resource_id [String] The ID of the target resource (Company, User, etc.) for which the access token i
17
+ #
18
+ # @param target_resource_type [Symbol, WhopSDK::Models::AccessTokenCreateParams::TargetResourceType] The type of the target resource (company, user, product, experience, etc.).
19
+ #
20
+ # @param expires_at [Time, nil] The expiration timestamp for the access token. If not provided, a default expira
21
+ #
22
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
23
+ #
24
+ # @return [WhopSDK::Models::AccessTokenCreateResponse]
25
+ #
26
+ # @see WhopSDK::Models::AccessTokenCreateParams
27
+ def create(params)
28
+ parsed, options = WhopSDK::AccessTokenCreateParams.dump_request(params)
29
+ @client.request(
30
+ method: :post,
31
+ path: "access_tokens",
32
+ body: parsed,
33
+ model: WhopSDK::Models::AccessTokenCreateResponse,
34
+ options: options
35
+ )
36
+ end
37
+
38
+ # @api private
39
+ #
40
+ # @param client [WhopSDK::Client]
41
+ def initialize(client:)
42
+ @client = client
43
+ end
44
+ end
45
+ end
46
+ end
@@ -48,7 +48,8 @@ module WhopSDK
48
48
  #
49
49
  # @overload retrieve(id, request_options: {})
50
50
  #
51
- # @param id [String]
51
+ # @param id [String] The ID of the app build
52
+ #
52
53
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
53
54
  #
54
55
  # @return [WhopSDK::Models::AppBuild]
@@ -110,7 +111,8 @@ module WhopSDK
110
111
  #
111
112
  # @overload promote(id, request_options: {})
112
113
  #
113
- # @param id [String]
114
+ # @param id [String] The ID of the app build to promote.
115
+ #
114
116
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
115
117
  #
116
118
  # @return [WhopSDK::Models::AppBuild]
@@ -36,7 +36,8 @@ module WhopSDK
36
36
  #
37
37
  # @overload retrieve(id, request_options: {})
38
38
  #
39
- # @param id [String]
39
+ # @param id [String] The ID of the app
40
+ #
40
41
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
41
42
  #
42
43
  # @return [WhopSDK::Models::App]
@@ -60,7 +61,7 @@ module WhopSDK
60
61
  #
61
62
  # @overload update(id, app_store_description: nil, base_url: nil, dashboard_path: nil, description: nil, discover_path: nil, experience_path: nil, icon: nil, name: nil, required_scopes: nil, status: nil, request_options: {})
62
63
  #
63
- # @param id [String]
64
+ # @param id [String] The ID of the app
64
65
  #
65
66
  # @param app_store_description [String, nil] The description of the app for the app store in-depth app view.
66
67
  #
@@ -12,7 +12,8 @@ module WhopSDK
12
12
  #
13
13
  # @overload retrieve(id, request_options: {})
14
14
  #
15
- # @param id [String]
15
+ # @param id [String] The ID of the authorized user
16
+ #
16
17
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
17
18
  #
18
19
  # @return [WhopSDK::Models::AuthorizedUserRetrieveResponse]
@@ -3,6 +3,9 @@
3
3
  module WhopSDK
4
4
  module Resources
5
5
  class ChatChannels
6
+ # Some parameter documentations has been truncated, see
7
+ # {WhopSDK::Models::ChatChannelRetrieveParams} for more details.
8
+ #
6
9
  # Retrieves a chat channel
7
10
  #
8
11
  # Required permissions:
@@ -11,7 +14,8 @@ module WhopSDK
11
14
  #
12
15
  # @overload retrieve(id, request_options: {})
13
16
  #
14
- # @param id [String]
17
+ # @param id [String] The ID of the chat channel to fetch, it can be an experience ID or a chat channe
18
+ #
15
19
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
16
20
  #
17
21
  # @return [WhopSDK::Models::ChatChannel]
@@ -26,6 +30,9 @@ module WhopSDK
26
30
  )
27
31
  end
28
32
 
33
+ # Some parameter documentations has been truncated, see
34
+ # {WhopSDK::Models::ChatChannelUpdateParams} for more details.
35
+ #
29
36
  # Updates a chat channel
30
37
  #
31
38
  # Required permissions:
@@ -34,7 +41,7 @@ module WhopSDK
34
41
  #
35
42
  # @overload update(id, ban_media: nil, ban_urls: nil, banned_words: nil, user_posts_cooldown_seconds: nil, who_can_post: nil, who_can_react: nil, request_options: {})
36
43
  #
37
- # @param id [String]
44
+ # @param id [String] The ID of the chat channel to update. Can be an experience ID or a chat feed ext
38
45
  #
39
46
  # @param ban_media [Boolean, nil] Whether media uploads are banned in this chat
40
47
  #
@@ -48,7 +48,8 @@ module WhopSDK
48
48
  #
49
49
  # @overload retrieve(id, request_options: {})
50
50
  #
51
- # @param id [String]
51
+ # @param id [String] The ID of the checkout configuration
52
+ #
52
53
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
53
54
  #
54
55
  # @return [WhopSDK::Models::CheckoutConfiguration]
@@ -44,7 +44,8 @@ module WhopSDK
44
44
  #
45
45
  # @overload retrieve(id, request_options: {})
46
46
  #
47
- # @param id [String]
47
+ # @param id [String] The ID or route of the company
48
+ #
48
49
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
49
50
  #
50
51
  # @return [WhopSDK::Models::Company]
@@ -39,7 +39,8 @@ module WhopSDK
39
39
  #
40
40
  # @overload retrieve(id, request_options: {})
41
41
  #
42
- # @param id [String]
42
+ # @param id [String] The ID of the chapter
43
+ #
43
44
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
44
45
  #
45
46
  # @return [WhopSDK::Models::CourseChapter]
@@ -62,7 +63,7 @@ module WhopSDK
62
63
  #
63
64
  # @overload update(id, title:, request_options: {})
64
65
  #
65
- # @param id [String]
66
+ # @param id [String] The ID of the chapter to update
66
67
  #
67
68
  # @param title [String] The title of the chapter
68
69
  #
@@ -125,7 +126,8 @@ module WhopSDK
125
126
  #
126
127
  # @overload delete(id, request_options: {})
127
128
  #
128
- # @param id [String]
129
+ # @param id [String] The ID of the chapter to delete
130
+ #
129
131
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
130
132
  #
131
133
  # @return [Boolean]
@@ -12,7 +12,8 @@ module WhopSDK
12
12
  #
13
13
  # @overload retrieve(id, request_options: {})
14
14
  #
15
- # @param id [String]
15
+ # @param id [String] The ID of the course lesson interaction
16
+ #
16
17
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
17
18
  #
18
19
  # @return [WhopSDK::Models::CourseLessonInteraction]