whop_sdk 0.0.2

data/lib/whop_sdk/resources/course_lesson_interactions.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class CourseLessonInteractions
+      # Retrieves a course lesson interaction by ID
+      #
+      # Required permissions:
+      #
+      # - `course_lesson_interaction:read`
+      # - `courses:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::CourseLessonInteraction]
+      #
+      # @see WhopSDK::Models::CourseLessonInteractionRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["course_lesson_interactions/%1$s", id],
+          model: WhopSDK::CourseLessonInteraction,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists course lesson interactions
+      #
+      # Required permissions:
+      #
+      # - `course_lesson_interaction:read`
+      # - `courses:read`
+      #
+      # @overload list(after: nil, before: nil, completed: nil, course_id: nil, first: nil, last: nil, lesson_id: nil, user_id: nil, request_options: {})
+      #
+      # @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 completed [Boolean, nil] Whether the lesson has been completed by the user
+      #
+      # @param course_id [String, nil] The ID of the course to list course lesson interactions for
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param lesson_id [String, nil] The ID of the lesson to list course lesson interactions for
+      #
+      # @param user_id [String, nil] The ID of the user to list course lesson interactions for
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseLessonInteractionListItem>]
+      #
+      # @see WhopSDK::Models::CourseLessonInteractionListParams
+      def list(params = {})
+        parsed, options = WhopSDK::CourseLessonInteractionListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "course_lesson_interactions",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::CourseLessonInteractionListItem,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/entries.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Entries
+      # Retrieves an entry by ID
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:read`
+      # - `member:email:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Entry]
+      #
+      # @see WhopSDK::Models::EntryRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["entries/%1$s", id],
+          model: WhopSDK::Entry,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists entries for a company
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:read`
+      # - `member:email:read`
+      #
+      # @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company
+      #
+      # @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 direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param order [Symbol, WhopSDK::Models::EntryListParams::Order, nil] Which columns can be used to sort.
+      #
+      # @param plan_ids [Array<String>, nil] The plan IDs to filter the entries by
+      #
+      # @param product_ids [Array<String>, nil] The product IDs to filter the entries by
+      #
+      # @param statuses [Array<Symbol, WhopSDK::Models::EntryStatus>, nil] The statuses to filter the entries by
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::EntryListResponse>]
+      #
+      # @see WhopSDK::Models::EntryListParams
+      def list(params)
+        parsed, options = WhopSDK::EntryListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "entries",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::EntryListResponse,
+          options: options
+        )
+      end
+
+      # Approve an entry
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:manage`
+      #
+      # @overload approve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::EntryApproveResponse]
+      #
+      # @see WhopSDK::Models::EntryApproveParams
+      def approve(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["entries/%1$s/approve", id],
+          model: WhopSDK::Models::EntryApproveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Deny an entry
+      #
+      # Required permissions:
+      #
+      # - `plan:waitlist:manage`
+      # - `plan:basic:read`
+      # - `member:email:read`
+      #
+      # @overload deny(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Entry]
+      #
+      # @see WhopSDK::Models::EntryDenyParams
+      def deny(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["entries/%1$s/deny", id],
+          model: WhopSDK::Entry,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/experiences.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Experiences
+      # Required permissions:
+      #
+      # - `experience:create`
+      #
+      # @overload create(app_id:, company_id:, name: nil, section_id: nil, request_options: {})
+      #
+      # @param app_id [String] The ID of the app to create the experience for
+      #
+      # @param company_id [String] The ID of the company to create the experience for
+      #
+      # @param name [String, nil] The name of the experience
+      #
+      # @param section_id [String, nil] The ID of the section to create the experience in
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Experience]
+      #
+      # @see WhopSDK::Models::ExperienceCreateParams
+      def create(params)
+        parsed, options = WhopSDK::ExperienceCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "experiences",
+          body: parsed,
+          model: WhopSDK::Experience,
+          options: options
+        )
+      end
+
+      # Retrieves an experience by ID
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Experience]
+      #
+      # @see WhopSDK::Models::ExperienceRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["experiences/%1$s", id],
+          model: WhopSDK::Experience,
+          options: params[:request_options]
+        )
+      end
+
+      # Required permissions:
+      #
+      # - `experience:update`
+      #
+      # @overload update(id, access_level: nil, logo: nil, name: nil, order: nil, section_id: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @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 name [String, nil] The name of the experience.
+      #
+      # @param order [String, nil] The order of the experience in the section.
+      #
+      # @param section_id [String, nil] The ID of the section to update.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Experience]
+      #
+      # @see WhopSDK::Models::ExperienceUpdateParams
+      def update(id, params = {})
+        parsed, options = WhopSDK::ExperienceUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["experiences/%1$s", id],
+          body: parsed,
+          model: WhopSDK::Experience,
+          options: options
+        )
+      end
+
+      # Lists experiences for a company
+      #
+      # Required permissions:
+      #
+      # - `experience:hidden_experience:read`
+      #
+      # @overload list(company_id:, after: nil, app_id: nil, before: nil, first: nil, last: nil, product_id: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to filter experiences by
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param app_id [String, nil] The ID of the app to filter experiences by
+      #
+      # @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 last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param product_id [String, nil] The ID of the product to filter experiences by
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::ExperienceListResponse>]
+      #
+      # @see WhopSDK::Models::ExperienceListParams
+      def list(params)
+        parsed, options = WhopSDK::ExperienceListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "experiences",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::ExperienceListResponse,
+          options: options
+        )
+      end
+
+      # Required permissions:
+      #
+      # - `experience:delete`
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Boolean]
+      #
+      # @see WhopSDK::Models::ExperienceDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["experiences/%1$s", id],
+          model: WhopSDK::Internal::Type::Boolean,
+          options: params[:request_options]
+        )
+      end
+
+      # Adds an experience to an product, making it accessible to the product's
+      # customers.
+      #
+      # Required permissions:
+      #
+      # - `experience:attach`
+      #
+      # @overload attach(id, product_id:, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param product_id [String] The ID of the Access Pass to add the Experience to.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Experience]
+      #
+      # @see WhopSDK::Models::ExperienceAttachParams
+      def attach(id, params)
+        parsed, options = WhopSDK::ExperienceAttachParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["experiences/%1$s/attach", id],
+          body: parsed,
+          model: WhopSDK::Experience,
+          options: options
+        )
+      end
+
+      # Removes an experience from an product, making it inaccessible to the product's
+      # customers.
+      #
+      # Required permissions:
+      #
+      # - `experience:detach`
+      #
+      # @overload detach(id, product_id:, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param product_id [String] The ID of the Access Pass to add the Experience to.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Experience]
+      #
+      # @see WhopSDK::Models::ExperienceDetachParams
+      def detach(id, params)
+        parsed, options = WhopSDK::ExperienceDetachParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["experiences/%1$s/detach", id],
+          body: parsed,
+          model: WhopSDK::Experience,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/forum_posts.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class ForumPosts
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::ForumPostCreateParams} for more details.
+      #
+      # Create a new forum post
+      #
+      # Required permissions:
+      #
+      # - `forum:post:create`
+      #
+      # @overload create(experience_id:, attachments: nil, content: nil, is_mention: nil, parent_id: nil, paywall_amount: nil, paywall_currency: nil, pinned: nil, poll: nil, title: nil, request_options: {})
+      #
+      # @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 content [String, nil] This is the main body of the post in Markdown format. Hidden if paywalled and us
+      #
+      # @param is_mention [Boolean, nil] This is used to determine if the post should be sent as a 'mention' notification
+      #
+      # @param parent_id [String, nil] The ID of the parent post. Set it to the ID of the post you want to comment on o
+      #
+      # @param paywall_amount [Float, nil] The amount to paywall this post by. A paywalled post requires the user to purcha
+      #
+      # @param paywall_currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #
+      # @param pinned [Boolean, nil] Whether the post should be pinned
+      #
+      # @param poll [WhopSDK::Models::ForumPostCreateParams::Poll, nil] The poll for this post
+      #
+      # @param title [String, nil] The title of the post. Only visible if paywalled.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::ForumPost]
+      #
+      # @see WhopSDK::Models::ForumPostCreateParams
+      def create(params)
+        parsed, options = WhopSDK::ForumPostCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "forum_posts",
+          body: parsed,
+          model: WhopSDK::ForumPost,
+          options: options
+        )
+      end
+
+      # Retrieves a forum post by ID
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::ForumPost]
+      #
+      # @see WhopSDK::Models::ForumPostRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["forum_posts/%1$s", id],
+          model: WhopSDK::ForumPost,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists forum posts
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      #
+      # @overload list(experience_id:, after: nil, before: nil, first: nil, last: nil, parent_id: nil, pinned: nil, request_options: {})
+      #
+      # @param experience_id [String] The ID of the experience to list forum posts for
+      #
+      # @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 last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param parent_id [String, nil] The ID of the parent post to list forum post comments for
+      #
+      # @param pinned [Boolean, nil] Set to true to only return pinned posts
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::ForumPostListResponse>]
+      #
+      # @see WhopSDK::Models::ForumPostListParams
+      def list(params)
+        parsed, options = WhopSDK::ForumPostListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "forum_posts",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::ForumPostListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/forums.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Forums
+      # Retrieves a forum
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Forum]
+      #
+      # @see WhopSDK::Models::ForumRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["forums/%1$s", id],
+          model: WhopSDK::Forum,
+          options: params[:request_options]
+        )
+      end
+
+      # Updates a forum
+      #
+      # Required permissions:
+      #
+      # - `forum:moderate`
+      #
+      # @overload update(id, email_notification_preference: nil, who_can_comment: nil, who_can_post: nil, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param email_notification_preference [Symbol, WhopSDK::Models::EmailNotificationPreferences, nil] Email notification preference option for a forum feed
+      #
+      # @param who_can_comment [Symbol, WhopSDK::Models::WhoCanCommentTypes, nil] Who can comment on a forum feed
+      #
+      # @param who_can_post [Symbol, WhopSDK::Models::WhoCanPostTypes, nil] Who can post on a forum feed
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Forum]
+      #
+      # @see WhopSDK::Models::ForumUpdateParams
+      def update(id, params = {})
+        parsed, options = WhopSDK::ForumUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["forums/%1$s", id],
+          body: parsed,
+          model: WhopSDK::Forum,
+          options: options
+        )
+      end
+
+      # Lists forums inside a company
+      #
+      # Required permissions:
+      #
+      # - `forum:read`
+      #
+      # @overload list(company_id:, after: nil, before: nil, first: nil, last: nil, product_id: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to list forums for
+      #
+      # @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 last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param product_id [String, nil] If provided, only forums connected to this product are returned
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::ForumListResponse>]
+      #
+      # @see WhopSDK::Models::ForumListParams
+      def list(params)
+        parsed, options = WhopSDK::ForumListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "forums",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::ForumListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end