whop_sdk 0.0.2 → 0.0.4

data/rbi/whop_sdk/resources/course_students.rbi

@@ -0,0 +1,65 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class CourseStudents
+      # Retrieves a course student by interaction ID
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      # - `course_analytics:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::CourseStudentRetrieveResponse)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists students for a course
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      # - `course_analytics:read`
+      sig do
+        params(
+          course_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          keyword: T.nilable(String),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[
+            WhopSDK::Models::CourseStudentListResponse
+          ]
+        )
+      end
+      def list(
+        # The ID of the course
+        course_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Filter students by name - returns students whose names match the keyword
+        keyword: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/courses.rbi

@@ -0,0 +1,172 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Courses
+      # Creates a new course module in an experience
+      #
+      # Required permissions:
+      #
+      # - `courses:update`
+      sig do
+        params(
+          experience_id: String,
+          title: String,
+          certificate_after_completion_enabled: T.nilable(T::Boolean),
+          cover_image: T.nilable(String),
+          require_completing_lessons_in_order: T.nilable(T::Boolean),
+          tagline: T.nilable(String),
+          thumbnail:
+            T.nilable(
+              T.any(
+                WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID::OrHash
+              )
+            ),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Course)
+      end
+      def create(
+        # The ID of the experience to create the course in
+        experience_id:,
+        # The title of the course
+        title:,
+        # Whether the course will award its students a PDF certificate after completing
+        # all lessons
+        certificate_after_completion_enabled: nil,
+        # The cover image URL of the course
+        cover_image: nil,
+        # Whether the course requires students to complete the previous lesson before
+        # moving on to the next one
+        require_completing_lessons_in_order: nil,
+        # The tagline of the course
+        tagline: nil,
+        # The thumbnail for the course in png, jpeg, or gif format
+        thumbnail: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a course by ID
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Course)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Updates a course
+      #
+      # Required permissions:
+      #
+      # - `courses:update`
+      sig do
+        params(
+          id: String,
+          certificate_after_completion_enabled: T.nilable(T::Boolean),
+          chapters:
+            T.nilable(T::Array[WhopSDK::CourseUpdateParams::Chapter::OrHash]),
+          cover_image: T.nilable(String),
+          description: T.nilable(String),
+          language: T.nilable(WhopSDK::Languages::OrSymbol),
+          require_completing_lessons_in_order: T.nilable(T::Boolean),
+          tagline: T.nilable(String),
+          thumbnail:
+            T.nilable(
+              T.any(
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID::OrHash
+              )
+            ),
+          title: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Course)
+      end
+      def update(
+        id,
+        # Whether the course will award its students a PDF certificate after completing
+        # all lessons
+        certificate_after_completion_enabled: nil,
+        # The chapters and lessons to update
+        chapters: nil,
+        # The cover image URL of the course
+        cover_image: nil,
+        # A short description of the course
+        description: nil,
+        # The available languages for a course
+        language: nil,
+        # Whether the course requires students to complete the previous lesson before
+        # moving on to the next one
+        require_completing_lessons_in_order: nil,
+        # A short tagline for the course
+        tagline: nil,
+        # The thumbnail for the course in png, jpeg, or gif format
+        thumbnail: nil,
+        # The title of the course
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists courses for an experience or company
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          company_id: T.nilable(String),
+          experience_id: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::CourseListResponse]
+        )
+      end
+      def list(
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The ID of the company
+        company_id: nil,
+        # The ID of the experience
+        experience_id: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      # Deletes a course
+      #
+      # Required permissions:
+      #
+      # - `courses:update`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/experiences.rbi

@@ -46,7 +46,13 @@ module WhopSDK
           id: String,
           access_level:
             T.nilable(WhopSDK::ExperienceUpdateParams::AccessLevel::OrSymbol),
-          logo: T.nilable(WhopSDK::ExperienceUpdateParams::Logo::OrHash),
+          logo:
+            T.nilable(
+              T.any(
+                WhopSDK::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::ExperienceUpdateParams::Logo::AttachmentInputWithID::OrHash
+              )
+            ),
           name: T.nilable(String),
           order: T.nilable(String),
           section_id: T.nilable(String),
@@ -161,6 +167,31 @@ module WhopSDK
       )
       end
 
+      # Duplicates an existing experience. The name will be copied, unless provided. The
+      # new experience will be attached to the same products as the original experience.
+      # If duplicating a Forum or Chat experience, the new experience will have the same
+      # settings as the original experience, e.g. who can post, who can comment, etc. No
+      # content, e.g. posts, messages, lessons from within the original experience will
+      # be copied.
+      #
+      # Required permissions:
+      #
+      # - `experience:create`
+      sig do
+        params(
+          id: String,
+          name: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Experience)
+      end
+      def duplicate(
+        id,
+        # The name of the new experience
+        name: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: WhopSDK::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/whop_sdk/resources/forum_posts.rbi

@@ -13,7 +13,12 @@ module WhopSDK
           experience_id: String,
           attachments:
             T.nilable(
-              T::Array[WhopSDK::ForumPostCreateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::ForumPostCreateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           content: T.nilable(String),
           is_mention: T.nilable(T::Boolean),
@@ -70,6 +75,40 @@ module WhopSDK
       def retrieve(id, request_options: {})
       end
 
+      # Update an existing forum post
+      sig do
+        params(
+          id: String,
+          attachments:
+            T.nilable(
+              T::Array[
+                T.any(
+                  WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
+            ),
+          content: T.nilable(String),
+          is_pinned: T.nilable(T::Boolean),
+          title: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::ForumPost)
+      end
+      def update(
+        id,
+        # The attachments for this post
+        attachments: nil,
+        # This is the main body of the post in Markdown format. Hidden if paywalled and
+        # user hasn't purchased access to it.
+        content: nil,
+        # Whether the post is pinned. You can only pin a top level posts (not comments).
+        is_pinned: nil,
+        # The title of the post. Only visible if paywalled.
+        title: nil,
+        request_options: {}
+      )
+      end
+
       # Lists forum posts
       #
       # Required permissions:

data/rbi/whop_sdk/resources/invoices.rbi

@@ -14,16 +14,16 @@ module WhopSDK
           collection_method: WhopSDK::CollectionMethod::OrSymbol,
           company_id: String,
           due_date: Time,
+          member_id: String,
           plan: WhopSDK::InvoiceCreateParams::Plan::OrHash,
+          product: WhopSDK::InvoiceCreateParams::Product::OrHash,
+          email_address: String,
+          product_id: String,
           charge_buyer_fee: T.nilable(T::Boolean),
           customer_name: T.nilable(String),
-          email_address: T.nilable(String),
-          member_id: T.nilable(String),
           payment_token_id: T.nilable(String),
-          product: T.nilable(WhopSDK::InvoiceCreateParams::Product::OrHash),
-          product_id: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Models::InvoiceCreateResponse)
+        ).returns(WhopSDK::Invoice)
       end
       def create(
         # The method of collection for this invoice. If using charge_automatically, you
@@ -33,30 +33,30 @@ module WhopSDK
         company_id:,
         # The date the invoice is due, if applicable.
         due_date:,
+        # The member ID to create this invoice for. Include this if you want to create an
+        # invoice for an existing member. If you do not have a member ID, you must provide
+        # an email_address and customer_name.
+        member_id:,
         # The properties of the plan to create for this invoice.
         plan:,
+        # The properties of the product to create for this invoice. Include this if you
+        # want to create an invoice for a new product.
+        product:,
+        # The email address to create this invoice for. This is required if you want to
+        # create an invoice for a user who does not have a member of your company yet.
+        email_address:,
+        # The product ID to create this invoice for. Include this if you want to create an
+        # invoice for an existing product.
+        product_id:,
         # Whether or not to charge the customer a buyer fee.
         charge_buyer_fee: nil,
         # The name of the customer to create this invoice for. This is required if you
         # want to create an invoice for a customer who does not have a member of your
         # company yet.
         customer_name: nil,
-        # The email address to create this invoice for. This is required if you want to
-        # create an invoice for a user who does not have a member of your company yet.
-        email_address: nil,
-        # The member ID to create this invoice for. Include this if you want to create an
-        # invoice for an existing member. If you do not have a member ID, you must provide
-        # an email_address and customer_name.
-        member_id: nil,
         # The payment token ID to use for this invoice. If using charge_automatically, you
         # must provide a payment_token.
         payment_token_id: nil,
-        # The properties of the product to create for this invoice. Include this if you
-        # want to create an invoice for a new product.
-        product: nil,
-        # The product ID to create this invoice for. Include this if you want to create an
-        # invoice for an existing product.
-        product_id: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/members.rbi

@@ -45,6 +45,7 @@ module WhopSDK
           promo_code_ids: T.nilable(T::Array[String]),
           query: T.nilable(String),
           statuses: T.nilable(T::Array[WhopSDK::MemberStatuses::OrSymbol]),
+          user_ids: T.nilable(T::Array[String]),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[WhopSDK::Models::MemberListResponse]
@@ -84,6 +85,8 @@ module WhopSDK
         query: nil,
         # The statuses to filter the members by
         statuses: nil,
+        # The user IDs to filter the members by
+        user_ids: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/memberships.rbi

@@ -45,7 +45,6 @@ module WhopSDK
       # - `member:basic:read`
       sig do
         params(
-          company_id: String,
           access_pass_ids: T.nilable(T::Array[String]),
           after: T.nilable(String),
           before: T.nilable(String),
@@ -53,6 +52,7 @@ module WhopSDK
             T.nilable(
               T::Array[WhopSDK::MembershipListParams::CancelOption::OrSymbol]
             ),
+          company_id: T.nilable(String),
           created_after: T.nilable(Time),
           created_before: T.nilable(Time),
           direction: T.nilable(WhopSDK::Direction::OrSymbol),
@@ -62,14 +62,13 @@ module WhopSDK
           plan_ids: T.nilable(T::Array[String]),
           promo_code_ids: T.nilable(T::Array[String]),
           statuses: T.nilable(T::Array[WhopSDK::MembershipStatus::OrSymbol]),
+          user_ids: T.nilable(T::Array[String]),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[WhopSDK::Models::MembershipListResponse]
         )
       end
       def list(
-        # The ID of the company to list memberships for
-        company_id:,
         # The access pass IDs to filter the memberships by
         access_pass_ids: nil,
         # Returns the elements in the list that come after the specified cursor.
@@ -78,6 +77,8 @@ module WhopSDK
         before: nil,
         # The cancel options to filter the memberships by
         cancel_options: nil,
+        # The ID of the company to list memberships for
+        company_id: nil,
         # The minimum creation date to filter by
         created_after: nil,
         # The maximum creation date to filter by
@@ -96,6 +97,8 @@ module WhopSDK
         promo_code_ids: nil,
         # The membership status to filter the memberships by
         statuses: nil,
+        # Only return memberships from these whop user ids
+        user_ids: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/messages.rbi

@@ -14,7 +14,12 @@ module WhopSDK
           content: String,
           attachments:
             T.nilable(
-              T::Array[WhopSDK::MessageCreateParams::Attachment::OrHash]
+              T::Array[
+                T.any(
+                  WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::MessageCreateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
             ),
           poll: T.nilable(WhopSDK::MessageCreateParams::Poll::OrHash),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -47,6 +52,36 @@ module WhopSDK
       def retrieve(id, request_options: {})
       end
 
+      # Updates an existing message
+      sig do
+        params(
+          id: String,
+          attachments:
+            T.nilable(
+              T::Array[
+                T.any(
+                  WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithDirectUploadID::OrHash,
+                  WhopSDK::MessageUpdateParams::Attachment::AttachmentInputWithID::OrHash
+                )
+              ]
+            ),
+          content: T.nilable(String),
+          is_pinned: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Message)
+      end
+      def update(
+        id,
+        # The attachments for this message
+        attachments: nil,
+        # The content of the message in Markdown format
+        content: nil,
+        # Whether this message is pinned
+        is_pinned: nil,
+        request_options: {}
+      )
+      end
+
       # Lists messages inside a channel
       #
       # Required permissions:

data/rbi/whop_sdk/resources/payments.rbi

@@ -40,9 +40,7 @@ module WhopSDK
           after: T.nilable(String),
           before: T.nilable(String),
           billing_reasons:
-            T.nilable(
-              T::Array[WhopSDK::PaymentListParams::BillingReason::OrSymbol]
-            ),
+            T.nilable(T::Array[WhopSDK::BillingReasons::OrSymbol]),
           created_after: T.nilable(Time),
           created_before: T.nilable(Time),
           currencies: T.nilable(T::Array[WhopSDK::Currency::OrSymbol]),

data/rbi/whop_sdk/resources/plans.rbi

@@ -20,15 +20,29 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::PlanCreateParams::CustomField::OrHash]),
           description: T.nilable(String),
           expiration_days: T.nilable(Integer),
-          image: T.nilable(WhopSDK::PlanCreateParams::Image::OrHash),
+          image:
+            T.nilable(
+              T.any(
+                WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::PlanCreateParams::Image::AttachmentInputWithID::OrHash
+              )
+            ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanCreateParams::PaymentMethodConfiguration::OrHash
+            ),
           plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
           release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
           renewal_price: T.nilable(Float),
+          stock: T.nilable(Integer),
+          strike_through_initial_price: T.nilable(Float),
+          strike_through_renewal_price: T.nilable(Float),
           title: T.nilable(String),
           trial_period_days: T.nilable(Integer),
+          unlimited_stock: T.nilable(T::Boolean),
           visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Plan)
@@ -38,7 +52,7 @@ module WhopSDK
         company_id:,
         # The product the plan is related to.
         product_id:,
-        # The interval at which the plan charges (renewal plans).
+        # The interval in days at which the plan charges (renewal plans).
         billing_period: nil,
         # The available currencies on the platform
         currency: nil,
@@ -59,6 +73,9 @@ module WhopSDK
         # Whether or not the tax is included in a plan's price (or if it hasn't been set
         # up)
         override_tax_type: nil,
+        # The explicit payment method configuration for the plan. If not provided, the
+        # platform or company's defaults will apply.
+        payment_method_configuration: nil,
         # The type of plan that can be attached to an access pass
         plan_type: nil,
         # The methods of how a plan can be released.
@@ -66,10 +83,20 @@ module WhopSDK
         # The amount the customer is charged every billing period. Use only if a recurring
         # payment. Provided as a number in dollars. Eg: 10.43 for $10.43
         renewal_price: nil,
+        # The number of units available for purchase.
+        stock: nil,
+        # The price to display with a strikethrough for the initial price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_initial_price: nil,
+        # The price to display with a strikethrough for the renewal price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_renewal_price: nil,
         # The title of the plan. This will be visible on the product page to customers.
         title: nil,
         # The number of free trial days added before a renewal plan.
         trial_period_days: nil,
+        # Limits/doesn't limit the number of units available for purchase.
+        unlimited_stock: nil,
         # Visibility of a resource
         visibility: nil,
         request_options: {}
@@ -106,14 +133,28 @@ module WhopSDK
             T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField::OrHash]),
           description: T.nilable(String),
           expiration_days: T.nilable(Integer),
-          image: T.nilable(WhopSDK::PlanUpdateParams::Image::OrHash),
+          image:
+            T.nilable(
+              T.any(
+                WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID::OrHash,
+                WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID::OrHash
+              )
+            ),
           initial_price: T.nilable(Float),
           internal_notes: T.nilable(String),
           offer_cancel_discount: T.nilable(T::Boolean),
           override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          payment_method_configuration:
+            T.nilable(
+              WhopSDK::PlanUpdateParams::PaymentMethodConfiguration::OrHash
+            ),
           renewal_price: T.nilable(Float),
+          stock: T.nilable(Integer),
+          strike_through_initial_price: T.nilable(Float),
+          strike_through_renewal_price: T.nilable(Float),
           title: T.nilable(String),
           trial_period_days: T.nilable(Integer),
+          unlimited_stock: T.nilable(T::Boolean),
           visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Plan)
@@ -141,12 +182,25 @@ module WhopSDK
         # Whether or not the tax is included in a plan's price (or if it hasn't been set
         # up)
         override_tax_type: nil,
+        # The explicit payment method configuration for the plan. If sent as null, the
+        # custom configuration will be removed.
+        payment_method_configuration: nil,
         # The amount the customer is charged every billing period.
         renewal_price: nil,
+        # The number of units available for purchase.
+        stock: nil,
+        # The price to display with a strikethrough for the initial price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_initial_price: nil,
+        # The price to display with a strikethrough for the renewal price. Provided as a
+        # number in dollars. Eg: 19.99 for $19.99
+        strike_through_renewal_price: nil,
         # The title of the plan. This will be visible on the product page to customers.
         title: nil,
         # The number of free trial days added before a renewal plan.
         trial_period_days: nil,
+        # Limits/doesn't limit the number of units available for purchase.
+        unlimited_stock: nil,
         # Visibility of a resource
         visibility: nil,
         request_options: {}