whop_sdk 0.0.2

data/rbi/whop_sdk/resources/chat_channels.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class ChatChannels
+      # Retrieves a chat channel
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::ChatChannel)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Updates a chat channel
+      #
+      # Required permissions:
+      #
+      # - `chat:moderate`
+      sig do
+        params(
+          id: String,
+          ban_media: T.nilable(T::Boolean),
+          ban_urls: T.nilable(T::Boolean),
+          banned_words: T.nilable(T::Array[String]),
+          user_posts_cooldown_seconds: T.nilable(Integer),
+          who_can_post: T.nilable(WhopSDK::WhoCanPost::OrSymbol),
+          who_can_react: T.nilable(WhopSDK::WhoCanReact::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::ChatChannel)
+      end
+      def update(
+        id,
+        # Whether media uploads are banned in this chat
+        ban_media: nil,
+        # Whether URLs are banned in this chat
+        ban_urls: nil,
+        # List of banned words for this chat
+        banned_words: nil,
+        # The cooldown period in seconds between user posts
+        user_posts_cooldown_seconds: nil,
+        # Who can post on a chat feed
+        who_can_post: nil,
+        # Who can react on a chat feed
+        who_can_react: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists chat channels inside a company
+      #
+      # Required permissions:
+      #
+      # - `chat:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          product_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[
+            WhopSDK::Models::ChatChannelListResponse
+          ]
+        )
+      end
+      def list(
+        # The ID of the company to list chat channels for
+        company_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,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # If provided, only chat channels connected to this product are returned
+        product_id: 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/checkout_configurations.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class CheckoutConfigurations
+      # Creates a new checkout configuration
+      #
+      # Required permissions:
+      #
+      # - `checkout_configuration:create`
+      # - `plan:create`
+      sig do
+        params(
+          affiliate_code: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          plan:
+            T.nilable(WhopSDK::CheckoutConfigurationCreateParams::Plan::OrHash),
+          plan_id: T.nilable(String),
+          redirect_url: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::CheckoutConfiguration)
+      end
+      def create(
+        # The affiliate code to use for the checkout configuration
+        affiliate_code: nil,
+        # The metadata to use for the checkout configuration
+        metadata: nil,
+        # Pass this object to create a new plan for this checkout configuration
+        plan: nil,
+        # The ID of the plan to use for the checkout configuration
+        plan_id: nil,
+        # The URL to redirect the user to after the checkout configuration is created
+        redirect_url: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a checkout configuration by ID
+      #
+      # Required permissions:
+      #
+      # - `checkout_configuration:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::CheckoutConfiguration)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists checkout configurations
+      #
+      # Required permissions:
+      #
+      # - `checkout_configuration:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          plan_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[
+            WhopSDK::Models::CheckoutConfigurationListResponse
+          ]
+        )
+      end
+      def list(
+        # The ID of the company to list checkout configurations for
+        company_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,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ID of the plan to filter checkout configurations by
+        plan_id: 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/companies.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Companies
+      # Retrieves an company by ID or its url route
+      #
+      # Required permissions:
+      #
+      # - `company:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Company)
+      end
+      def retrieve(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/course_lesson_interactions.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class CourseLessonInteractions
+      # Retrieves a course lesson interaction by ID
+      #
+      # Required permissions:
+      #
+      # - `course_lesson_interaction:read`
+      # - `courses:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::CourseLessonInteraction)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists course lesson interactions
+      #
+      # Required permissions:
+      #
+      # - `course_lesson_interaction:read`
+      # - `courses:read`
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          completed: T.nilable(T::Boolean),
+          course_id: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          lesson_id: T.nilable(String),
+          user_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[
+            WhopSDK::CourseLessonInteractionListItem
+          ]
+        )
+      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,
+        # Whether the lesson has been completed by the user
+        completed: nil,
+        # The ID of the course to list course lesson interactions for
+        course_id: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ID of the lesson to list course lesson interactions for
+        lesson_id: nil,
+        # The ID of the user to list course lesson interactions for
+        user_id: 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/entries.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Entries
+      # Retrieves an entry by ID
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:read`
+      # - `member:email:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Entry)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists entries for a company
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:read`
+      # - `member:email:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::EntryListParams::Order::OrSymbol),
+          plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
+          statuses: T.nilable(T::Array[WhopSDK::EntryStatus::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::EntryListResponse]
+        )
+      end
+      def list(
+        # The ID of the company
+        company_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,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # Which columns can be used to sort.
+        order: nil,
+        # The plan IDs to filter the entries by
+        plan_ids: nil,
+        # The product IDs to filter the entries by
+        product_ids: nil,
+        # The statuses to filter the entries by
+        statuses: nil,
+        request_options: {}
+      )
+      end
+
+      # Approve an entry
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:manage`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::EntryApproveResponse)
+      end
+      def approve(id, request_options: {})
+      end
+
+      # Deny an entry
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:manage`
+      # - `plan:basic:read`
+      # - `member:email:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Entry)
+      end
+      def deny(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

@@ -0,0 +1,170 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Experiences
+      # Required permissions:
+      #
+      # - `experience:create`
+      sig do
+        params(
+          app_id: String,
+          company_id: String,
+          name: T.nilable(String),
+          section_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Experience)
+      end
+      def create(
+        # The ID of the app to create the experience for
+        app_id:,
+        # The ID of the company to create the experience for
+        company_id:,
+        # The name of the experience
+        name: nil,
+        # The ID of the section to create the experience in
+        section_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves an experience by ID
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Experience)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Required permissions:
+      #
+      # - `experience:update`
+      sig do
+        params(
+          id: String,
+          access_level:
+            T.nilable(WhopSDK::ExperienceUpdateParams::AccessLevel::OrSymbol),
+          logo: T.nilable(WhopSDK::ExperienceUpdateParams::Logo::OrHash),
+          name: T.nilable(String),
+          order: T.nilable(String),
+          section_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Experience)
+      end
+      def update(
+        id,
+        # The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
+        access_level: nil,
+        # The logo for the experience
+        logo: nil,
+        # The name of the experience.
+        name: nil,
+        # The order of the experience in the section.
+        order: nil,
+        # The ID of the section to update.
+        section_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists experiences for a company
+      #
+      # Required permissions:
+      #
+      # - `experience:hidden_experience:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          app_id: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          product_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::ExperienceListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to filter experiences by
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # The ID of the app to filter experiences by
+        app_id: 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,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ID of the product to filter experiences by
+        product_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Required permissions:
+      #
+      # - `experience:delete`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(id, request_options: {})
+      end
+
+      # Adds an experience to an product, making it accessible to the product's
+      # customers.
+      #
+      # Required permissions:
+      #
+      # - `experience:attach`
+      sig do
+        params(
+          id: String,
+          product_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Experience)
+      end
+      def attach(
+        id,
+        # The ID of the Access Pass to add the Experience to.
+        product_id:,
+        request_options: {}
+      )
+      end
+
+      # Removes an experience from an product, making it inaccessible to the product's
+      # customers.
+      #
+      # Required permissions:
+      #
+      # - `experience:detach`
+      sig do
+        params(
+          id: String,
+          product_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Experience)
+      end
+      def detach(
+        id,
+        # The ID of the Access Pass to add the Experience to.
+        product_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/forum_posts.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class ForumPosts
+      # Create a new forum post
+      #
+      # Required permissions:
+      #
+      # - `forum:post:create`
+      sig do
+        params(
+          experience_id: String,
+          attachments:
+            T.nilable(
+              T::Array[WhopSDK::ForumPostCreateParams::Attachment::OrHash]
+            ),
+          content: T.nilable(String),
+          is_mention: T.nilable(T::Boolean),
+          parent_id: T.nilable(String),
+          paywall_amount: T.nilable(Float),
+          paywall_currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          pinned: T.nilable(T::Boolean),
+          poll: T.nilable(WhopSDK::ForumPostCreateParams::Poll::OrHash),
+          title: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::ForumPost)
+      end
+      def create(
+        # The experience to create this post in
+        experience_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,
+        # This is used to determine if the post should be sent as a 'mention' notification
+        # to all of the users who are in the experience. This means that anyone with
+        # 'mentions' enabled will receive a notification about this post.
+        is_mention: nil,
+        # The ID of the parent post. Set it to the ID of the post you want to comment on
+        # or don't include it if its a top level post.
+        parent_id: nil,
+        # The amount to paywall this post by. A paywalled post requires the user to
+        # purchase it in order to view its content.
+        paywall_amount: nil,
+        # The available currencies on the platform
+        paywall_currency: nil,
+        # Whether the post should be pinned
+        pinned: nil,
+        # The poll for this post
+        poll: nil,
+        # The title of the post. Only visible if paywalled.
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a forum post by ID
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::ForumPost)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists forum posts
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      sig do
+        params(
+          experience_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          parent_id: T.nilable(String),
+          pinned: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::ForumPostListResponse]
+        )
+      end
+      def list(
+        # The ID of the experience to list forum posts for
+        experience_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,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ID of the parent post to list forum post comments for
+        parent_id: nil,
+        # Set to true to only return pinned posts
+        pinned: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end