whop_sdk 0.0.4 → 0.0.5

data/lib/whop_sdk/resources/course_lessons.rb

@@ -9,7 +9,7 @@ module WhopSDK
       #
       # - `courses:update`
       #
-      # @overload create(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, title: nil, request_options: {})
+      # @overload create(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, thumbnail: nil, title: nil, request_options: {})
       #
       # @param chapter_id [String] The ID of the chapter to create the lesson in
       #
@@ -19,6 +19,12 @@ module WhopSDK
       #
       # @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
       #
+      # @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
+      #
+      # @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
+      #
+      # @param thumbnail [WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the lesson in png, jpeg, or gif format
+      #
       # @param title [String, nil] The title of the lesson
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -45,7 +51,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the lesson
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Lesson]
@@ -69,9 +76,9 @@ module WhopSDK
       #
       # - `courses:update`
       #
-      # @overload update(id, assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, title: nil, visibility: nil, request_options: {})
+      # @overload update(id, assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the lesson to update
       #
       # @param assessment_completion_requirement [WhopSDK::Models::CourseLessonUpdateParams::AssessmentCompletionRequirement, nil] Completion requirements for quiz/knowledge check lessons
       #
@@ -83,6 +90,10 @@ module WhopSDK
       #
       # @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
       #
+      # @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
+      #
+      # @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
+      #
       # @param lesson_type [Symbol, WhopSDK::Models::LessonTypes, nil] The available types for a lesson
       #
       # @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID, nil] The main PDF file for this lesson
@@ -91,6 +102,8 @@ module WhopSDK
       #
       # @param mux_asset_id [String, nil] The ID of the Mux asset to attach to this lesson for video lessons
       #
+      # @param thumbnail [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the lesson in png, jpeg, or gif format
+      #
       # @param title [String, nil] The title of the lesson
       #
       # @param visibility [Symbol, WhopSDK::Models::LessonVisibilities, nil] The available visibilities for a lesson. Determines how / whether a lesson is vi
@@ -156,7 +169,8 @@ module WhopSDK
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the lesson to delete
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Boolean]

data/lib/whop_sdk/resources/course_students.rb

@@ -12,7 +12,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the course student interaction
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::CourseStudentRetrieveResponse]

data/lib/whop_sdk/resources/courses.rb

@@ -12,7 +12,7 @@ module WhopSDK
       #
       # - `courses:update`
       #
-      # @overload create(experience_id:, title:, certificate_after_completion_enabled: nil, cover_image: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, request_options: {})
+      # @overload create(experience_id:, title:, certificate_after_completion_enabled: nil, cover_image: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, visibility: nil, request_options: {})
       #
       # @param experience_id [String] The ID of the experience to create the course in
       #
@@ -22,12 +22,16 @@ module WhopSDK
       #
       # @param cover_image [String, nil] The cover image URL of the course
       #
+      # @param order [String, nil] The decimal order position of the course within its experience. If not provided,
+      #
       # @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
       #
       # @param tagline [String, nil] The tagline of the course
       #
       # @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the course in png, jpeg, or gif format
       #
+      # @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Course]
@@ -52,7 +56,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the course
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Course]
@@ -76,9 +81,9 @@ module WhopSDK
       #
       # - `courses:update`
       #
-      # @overload update(id, certificate_after_completion_enabled: nil, chapters: nil, cover_image: nil, description: nil, language: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, request_options: {})
+      # @overload update(id, certificate_after_completion_enabled: nil, chapters: nil, cover_image: nil, description: nil, language: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the course to update
       #
       # @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
       #
@@ -90,6 +95,8 @@ module WhopSDK
       #
       # @param language [Symbol, WhopSDK::Models::Languages, nil] The available languages for a course
       #
+      # @param order [String, nil] The decimal order position of the course within its experience. Use fractional v
+      #
       # @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
       #
       # @param tagline [String, nil] A short tagline for the course
@@ -98,6 +105,8 @@ module WhopSDK
       #
       # @param title [String, nil] The title of the course
       #
+      # @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Course]
@@ -159,7 +168,8 @@ module WhopSDK
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the course to delete
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Boolean]

data/lib/whop_sdk/resources/entries.rb

@@ -12,7 +12,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the entry
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Entry]
@@ -81,7 +82,8 @@ module WhopSDK
       #
       # @overload approve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the entry to approve.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::EntryApproveResponse]
@@ -106,7 +108,8 @@ module WhopSDK
       #
       # @overload deny(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the entry
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Entry]

data/lib/whop_sdk/resources/experiences.rb

@@ -37,7 +37,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the experience
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Experience]
@@ -58,7 +59,7 @@ module WhopSDK
       #
       # @overload update(id, access_level: nil, logo: nil, name: nil, order: nil, section_id: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The id of the experience to update.
       #
       # @param access_level [Symbol, WhopSDK::Models::ExperienceUpdateParams::AccessLevel, nil] The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
       #
@@ -131,7 +132,8 @@ module WhopSDK
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The internal ID of the experience to delete.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Boolean]
@@ -155,7 +157,7 @@ module WhopSDK
       #
       # @overload attach(id, product_id:, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the Experience to be added to an Access Pass.
       #
       # @param product_id [String] The ID of the Access Pass to add the Experience to.
       #
@@ -184,7 +186,7 @@ module WhopSDK
       #
       # @overload detach(id, product_id:, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the Experience to be added to an Access Pass.
       #
       # @param product_id [String] The ID of the Access Pass to add the Experience to.
       #
@@ -217,7 +219,7 @@ module WhopSDK
       #
       # @overload duplicate(id, name: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the experience to duplicate
       #
       # @param name [String, nil] The name of the new experience
       #

data/lib/whop_sdk/resources/forum_posts.rb

@@ -58,7 +58,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the forum post
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::ForumPost]
@@ -80,7 +81,7 @@ module WhopSDK
       #
       # @overload update(id, attachments: nil, content: nil, is_pinned: nil, title: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the forum post to update
       #
       # @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID>, nil] The attachments for this post
       #

data/lib/whop_sdk/resources/forums.rb

@@ -11,7 +11,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the forum to fetch, it can be an experience ID or a forum ID
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Forum]
@@ -34,7 +35,7 @@ module WhopSDK
       #
       # @overload update(id, email_notification_preference: nil, who_can_comment: nil, who_can_post: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] Experience ID (exp\_\*) or Forum external ID
       #
       # @param email_notification_preference [Symbol, WhopSDK::Models::EmailNotificationPreferences, nil] Email notification preference option for a forum feed
       #

data/lib/whop_sdk/resources/invoices.rb

@@ -62,7 +62,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the invoice or a token
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Invoice]
@@ -84,7 +85,7 @@ module WhopSDK
       # - `invoice:basic:read`
       # - `plan:basic:read`
       #
-      # @overload list(company_id:, after: nil, before: nil, direction: nil, filters: nil, first: nil, last: nil, order: nil, request_options: {})
+      # @overload list(company_id:, after: nil, before: nil, collection_methods: nil, direction: nil, first: nil, last: nil, order: nil, product_ids: nil, statuses: nil, request_options: {})
       #
       # @param company_id [String] The ID of the company to list invoices for
       #
@@ -92,9 +93,9 @@ module WhopSDK
       #
       # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
       #
-      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      # @param collection_methods [Array<Symbol, WhopSDK::Models::CollectionMethod>, nil] Filter invoices by their collection method
       #
-      # @param filters [WhopSDK::Models::InvoiceListParams::Filters, nil] The filters to apply to the invoices
+      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
       #
       # @param first [Integer, nil] Returns the first _n_ elements from the list.
       #
@@ -102,6 +103,10 @@ module WhopSDK
       #
       # @param order [Symbol, WhopSDK::Models::InvoiceListParams::Order, nil] Which columns can be used to sort.
       #
+      # @param product_ids [Array<String>, nil] Return only invoices created for these specific product ids
+      #
+      # @param statuses [Array<Symbol, WhopSDK::Models::InvoiceStatus>, nil] The statuses to filter the invoices by
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::InvoiceListItem>]
@@ -127,7 +132,8 @@ module WhopSDK
       #
       # @overload void(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the invoice to void
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Boolean]

data/lib/whop_sdk/resources/ledger_accounts.rb

@@ -3,7 +3,10 @@
 module WhopSDK
   module Resources
     class LedgerAccounts
-      # Retrieves a ledger account by ID
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::LedgerAccountRetrieveParams} for more details.
+      #
+      # Retrieves a ledger account by its ID, company ID or user ID
       #
       # Required permissions:
       #
@@ -11,7 +14,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] Either a User ID, Company ID, or LedgerAccount ID (user_xxx, biz_xxx, or ldgr_xx
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::LedgerAccountRetrieveResponse]

data/lib/whop_sdk/resources/members.rb

@@ -13,7 +13,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the member
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::MemberRetrieveResponse]
@@ -39,13 +40,11 @@ module WhopSDK
       # - `member:email:read`
       # - `member:phone:read`
       #
-      # @overload list(company_id:, access_level: nil, access_pass_ids: 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, promo_code_ids: nil, query: nil, statuses: nil, user_ids: nil, request_options: {})
+      # @overload list(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: {})
       #
       # @param company_id [String] The ID of the company to list members for
       #
-      # @param access_level [Symbol, WhopSDK::Models::AccessLevel, nil] The access level a given user (or company) has to an access pass or company.
-      #
-      # @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the members by
+      # @param access_level [Symbol, WhopSDK::Models::AccessLevel, nil] The access level a given user (or company) has to a product or company.
       #
       # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
       #
@@ -67,6 +66,8 @@ module WhopSDK
       #
       # @param plan_ids [Array<String>, nil] The plan IDs to filter the members by
       #
+      # @param product_ids [Array<String>, nil] The product IDs to filter the members by
+      #
       # @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the members by
       #
       # @param query [String, nil] The name, username, or email to filter the members by. The email filter will onl

data/lib/whop_sdk/resources/memberships.rb

@@ -11,7 +11,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the membership or a license key
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Membership]
@@ -35,7 +36,7 @@ module WhopSDK
       #
       # @overload update(id, metadata: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the membership.
       #
       # @param metadata [Hash{Symbol=>Object}, nil] The metadata to update the membership with.
       #
@@ -61,9 +62,7 @@ module WhopSDK
       #
       # - `member:basic:read`
       #
-      # @overload list(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: {})
-      #
-      # @param access_pass_ids [Array<String>, nil] The access pass IDs to filter the memberships by
+      # @overload list(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: {})
       #
       # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
       #
@@ -87,6 +86,8 @@ module WhopSDK
       #
       # @param plan_ids [Array<String>, nil] The plan IDs to filter the memberships by
       #
+      # @param product_ids [Array<String>, nil] The product IDs to filter the memberships by
+      #
       # @param promo_code_ids [Array<String>, nil] The promo code IDs to filter the memberships by
       #
       # @param statuses [Array<Symbol, WhopSDK::Models::MembershipStatus>, nil] The membership status to filter the memberships by
@@ -120,7 +121,7 @@ module WhopSDK
       #
       # @overload cancel(id, cancellation_mode: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the membership.
       #
       # @param cancellation_mode [Symbol, WhopSDK::Models::MembershipCancelParams::CancellationMode, nil] The mode of cancellation for a membership
       #
@@ -152,7 +153,7 @@ module WhopSDK
       #
       # @overload pause(id, void_payments: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the membership you want to pause.
       #
       # @param void_payments [Boolean, nil] Whether to void past_due payments associated with the membership to prevent futu
       #
@@ -181,7 +182,8 @@ module WhopSDK
       #
       # @overload resume(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the membership you want to resume.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Membership]

data/lib/whop_sdk/resources/messages.rb

@@ -43,7 +43,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the message
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Message]
@@ -62,7 +63,7 @@ module WhopSDK
       #
       # @overload update(id, attachments: nil, content: nil, is_pinned: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the message to update
       #
       # @param attachments [Array<WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::MessageUpdateParams::Attachment::AttachmentInputWithID>, nil] The attachments for this message
       #

data/lib/whop_sdk/resources/payments.rb

@@ -17,7 +17,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the payment
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Payment]
@@ -109,7 +110,7 @@ module WhopSDK
       #
       # @overload refund(id, partial_amount: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the payment you want to update or take action upon.
       #
       # @param partial_amount [Float, nil] An amount if the refund is supposed to be partial.
       #
@@ -143,7 +144,8 @@ module WhopSDK
       #
       # @overload retry_(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the payment
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Payment]
@@ -172,7 +174,8 @@ module WhopSDK
       #
       # @overload void(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the payment you want to void.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Payment]

data/lib/whop_sdk/resources/plans.rb

@@ -40,7 +40,7 @@ module WhopSDK
       #
       # @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
       #
-      # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
+      # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
       #
       # @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
       #
@@ -78,7 +78,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the plan
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Plan]
@@ -106,7 +107,7 @@ module WhopSDK
       #
       # @overload update(id, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID
       #
       # @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
       #
@@ -217,7 +218,8 @@ module WhopSDK
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the plan to delete.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Boolean]

data/lib/whop_sdk/resources/products.rb

@@ -36,7 +36,7 @@ module WhopSDK
       #
       # @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
       #
-      # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
+      # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
       #
       # @param headline [String, nil] The headline of the product.
       #
@@ -44,7 +44,7 @@ module WhopSDK
       #
       # @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
       #
-      # @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
+      # @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
       #
       # @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] The details to assign an autogenerated plan.
       #
@@ -82,7 +82,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID or route of the product
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Product]
@@ -109,7 +110,7 @@ module WhopSDK
       #
       # @overload update(id, banner_image: nil, business_type: nil, collect_shipping_address: nil, custom_cta: nil, custom_cta_url: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, member_affiliate_percentage: nil, member_affiliate_status: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, store_page_config: nil, title: nil, visibility: nil, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID (tag) of the product
       #
       # @param banner_image [WhopSDK::Models::ProductUpdateParams::BannerImage::AttachmentInputWithDirectUploadID, WhopSDK::Models::ProductUpdateParams::BannerImage::AttachmentInputWithID, nil] A banner image for the product in png, jpeg format
       #
@@ -128,7 +129,7 @@ module WhopSDK
       #
       # @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
       #
-      # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
+      # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
       #
       # @param headline [String, nil] The headline of the product.
       #
@@ -136,7 +137,7 @@ module WhopSDK
       #
       # @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
       #
-      # @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
+      # @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
       #
       # @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
       #
@@ -217,7 +218,8 @@ module WhopSDK
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The internal ID (tag) of the product to delete.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Boolean]

data/lib/whop_sdk/resources/promo_codes.rb

@@ -70,7 +70,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the promo code to retrieve
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::PromoCode]
@@ -135,7 +136,8 @@ module WhopSDK
       #
       # @overload delete(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The internal ID of the promo code to archive.
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Boolean]

data/lib/whop_sdk/resources/reactions.rb

@@ -42,7 +42,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the reaction
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::Reaction]

data/lib/whop_sdk/resources/reviews.rb

@@ -7,7 +7,8 @@ module WhopSDK
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the review
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::ReviewRetrieveResponse]