whop_sdk 0.0.3 → 0.0.5

data/lib/whop_sdk/resources/course_lesson_interactions.rb

@@ -7,12 +7,13 @@ module WhopSDK
       #
       # Required permissions:
       #
-      # - `course_lesson_interaction:read`
       # - `courses:read`
+      # - `course_analytics:read`
       #
       # @overload retrieve(id, request_options: {})
       #
-      # @param id [String]
+      # @param id [String] The ID of the course lesson interaction
+      #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [WhopSDK::Models::CourseLessonInteraction]
@@ -31,8 +32,8 @@ module WhopSDK
       #
       # Required permissions:
       #
-      # - `course_lesson_interaction:read`
       # - `courses:read`
+      # - `course_analytics:read`
       #
       # @overload list(after: nil, before: nil, completed: nil, course_id: nil, first: nil, last: nil, lesson_id: nil, user_id: nil, request_options: {})
       #

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,24 +76,34 @@ module WhopSDK
       #
       # - `courses:update`
       #
-      # @overload update(id, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, lesson_type: nil, main_pdf: 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] The ID of the lesson to update
       #
-      # @param id [String]
+      # @param assessment_completion_requirement [WhopSDK::Models::CourseLessonUpdateParams::AssessmentCompletionRequirement, nil] Completion requirements for quiz/knowledge check lessons
       #
       # @param assessment_questions [Array<WhopSDK::Models::CourseLessonUpdateParams::AssessmentQuestion>, nil] Assessment questions for quiz/knowledge check lessons. Replaces all existing que
       #
-      # @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment>, nil] General attachments for the lesson (PDFs, files, etc). Replaces all existing att
+      # @param attachments [Array<WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Attachment::AttachmentInputWithID>, nil] General attachments for the lesson (PDFs, files, etc). Replaces all existing att
       #
       # @param content [String, nil] The content of the lesson
       #
       # @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, nil] The main PDF file for this lesson
+      # @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID, nil] The main PDF file for this lesson
+      #
+      # @param max_attempts [Integer, nil] Maximum number of attempts allowed for assessments
       #
       # @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
@@ -152,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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class CourseStudents
+      # Retrieves a course student by interaction ID
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      # - `course_analytics:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the course student interaction
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::CourseStudentRetrieveResponse]
+      #
+      # @see WhopSDK::Models::CourseStudentRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["course_students/%1$s", id],
+          model: WhopSDK::Models::CourseStudentRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists students for a course
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      # - `course_analytics:read`
+      #
+      # @overload list(course_id:, after: nil, before: nil, first: nil, keyword: nil, last: nil, request_options: {})
+      #
+      # @param course_id [String] The ID of the course
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param keyword [String, nil] Filter students by name - returns students whose names match the keyword
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseStudentListResponse>]
+      #
+      # @see WhopSDK::Models::CourseStudentListParams
+      def list(params)
+        parsed, options = WhopSDK::CourseStudentListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "course_students",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::CourseStudentListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/courses.rb

@@ -3,23 +3,34 @@
 module WhopSDK
   module Resources
     class Courses
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::CourseCreateParams} for more details.
+      #
       # Creates a new course module in an experience
       #
       # Required permissions:
       #
       # - `courses:update`
       #
-      # @overload create(experience_id:, title:, cover_image: 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
       #
       # @param title [String] The title of the course
       #
+      # @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
+      #
       # @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, nil] The thumbnail for the course in png, jpeg, or gif format
+      # @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]
       #
@@ -45,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]
@@ -69,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
       #
@@ -83,14 +95,18 @@ 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
       #
-      # @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
+      # @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the course in png, jpeg, or gif format
       #
       # @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]
@@ -152,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,11 +59,11 @@ 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).
       #
-      # @param logo [WhopSDK::Models::ExperienceUpdateParams::Logo, nil] The logo for the experience
+      # @param logo [WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID, WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithID, nil] The logo for the experience
       #
       # @param name [String, nil] The name of the experience.
       #
@@ -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

@@ -16,7 +16,7 @@ module WhopSDK
       #
       # @param experience_id [String] The experience to create this post in
       #
-      # @param attachments [Array<WhopSDK::Models::ForumPostCreateParams::Attachment>, nil] The attachments for this post
+      # @param attachments [Array<WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithID>, nil] The attachments for this post
       #
       # @param content [String, nil] This is the main body of the post in Markdown format. Hidden if paywalled and us
       #
@@ -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,9 +81,9 @@ 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>, nil] The attachments for this post
+      # @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID>, nil] The attachments for this post
       #
       # @param content [String, nil] This is the main body of the post in Markdown format. Hidden if paywalled and us
       #

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

@@ -13,7 +13,7 @@ module WhopSDK
       # - `invoice:create`
       # - `plan:basic:read`
       #
-      # @overload create(collection_method:, company_id:, due_date:, plan:, charge_buyer_fee: nil, customer_name: nil, email_address: nil, member_id: nil, payment_token_id: nil, product: nil, product_id: nil, request_options: {})
+      # @overload create(collection_method:, company_id:, due_date:, member_id:, plan:, product:, email_address:, product_id:, charge_buyer_fee: nil, customer_name: nil, payment_token_id: nil, request_options: {})
       #
       # @param collection_method [Symbol, WhopSDK::Models::CollectionMethod] The method of collection for this invoice. If using charge_automatically, you mu
       #
@@ -21,25 +21,25 @@ module WhopSDK
       #
       # @param due_date [Time] The date the invoice is due, if applicable.
       #
-      # @param plan [WhopSDK::Models::InvoiceCreateParams::Plan] The properties of the plan to create for this invoice.
+      # @param member_id [String] The member ID to create this invoice for. Include this if you want to create an
       #
-      # @param charge_buyer_fee [Boolean, nil] Whether or not to charge the customer a buyer fee.
+      # @param plan [WhopSDK::Models::InvoiceCreateParams::Plan] The properties of the plan to create for this invoice.
       #
-      # @param customer_name [String, nil] The name of the customer to create this invoice for. This is required if you wan
+      # @param product [WhopSDK::Models::InvoiceCreateParams::Product] The properties of the product to create for this invoice. Include this if you wa
       #
-      # @param email_address [String, nil] The email address to create this invoice for. This is required if you want to cr
+      # @param email_address [String] The email address to create this invoice for. This is required if you want to cr
       #
-      # @param member_id [String, nil] The member ID to create this invoice for. Include this if you want to create an
+      # @param product_id [String] The product ID to create this invoice for. Include this if you want to create an
       #
-      # @param payment_token_id [String, nil] The payment token ID to use for this invoice. If using charge_automatically, you
+      # @param charge_buyer_fee [Boolean, nil] Whether or not to charge the customer a buyer fee.
       #
-      # @param product [WhopSDK::Models::InvoiceCreateParams::Product, nil] The properties of the product to create for this invoice. Include this if you wa
+      # @param customer_name [String, nil] The name of the customer to create this invoice for. This is required if you wan
       #
-      # @param product_id [String, nil] The product ID to create this invoice for. Include this if you want to create an
+      # @param payment_token_id [String, nil] The payment token ID to use for this invoice. If using charge_automatically, you
       #
       # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [WhopSDK::Models::InvoiceCreateResponse]
+      # @return [WhopSDK::Models::Invoice]
       #
       # @see WhopSDK::Models::InvoiceCreateParams
       def create(params)
@@ -48,7 +48,7 @@ module WhopSDK
           method: :post,
           path: "invoices",
           body: parsed,
-          model: WhopSDK::Models::InvoiceCreateResponse,
+          model: WhopSDK::Invoice,
           options: options
         )
       end
@@ -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]