whop_sdk 0.0.2

data/rbi/whop_sdk/models/forum_list_response.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::ForumListResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The unique identifier for the entity
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The email notification preference for this forum
+      sig { returns(WhopSDK::EmailNotificationPreferences::TaggedSymbol) }
+      attr_accessor :email_notification_preference
+
+      # The experience for this forum
+      sig { returns(WhopSDK::Models::ForumListResponse::Experience) }
+      attr_reader :experience
+
+      sig do
+        params(
+          experience: WhopSDK::Models::ForumListResponse::Experience::OrHash
+        ).void
+      end
+      attr_writer :experience
+
+      # Who can comment on this forum
+      sig { returns(WhopSDK::WhoCanCommentTypes::TaggedSymbol) }
+      attr_accessor :who_can_comment
+
+      # Who can post on this forum
+      sig { returns(WhopSDK::WhoCanPostTypes::TaggedSymbol) }
+      attr_accessor :who_can_post
+
+      # Represents a forum feed
+      sig do
+        params(
+          id: String,
+          email_notification_preference:
+            WhopSDK::EmailNotificationPreferences::OrSymbol,
+          experience: WhopSDK::Models::ForumListResponse::Experience::OrHash,
+          who_can_comment: WhopSDK::WhoCanCommentTypes::OrSymbol,
+          who_can_post: WhopSDK::WhoCanPostTypes::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the entity
+        id:,
+        # The email notification preference for this forum
+        email_notification_preference:,
+        # The experience for this forum
+        experience:,
+        # Who can comment on this forum
+        who_can_comment:,
+        # Who can post on this forum
+        who_can_post:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            email_notification_preference:
+              WhopSDK::EmailNotificationPreferences::TaggedSymbol,
+            experience: WhopSDK::Models::ForumListResponse::Experience,
+            who_can_comment: WhopSDK::WhoCanCommentTypes::TaggedSymbol,
+            who_can_post: WhopSDK::WhoCanPostTypes::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Experience < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::ForumListResponse::Experience,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The unique ID representing this experience
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The written name of the description.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The experience for this forum
+        sig { params(id: String, name: String).returns(T.attached_class) }
+        def self.new(
+          # The unique ID representing this experience
+          id:,
+          # The written name of the description.
+          name:
+        )
+        end
+
+        sig { override.returns({ id: String, name: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/forum_post.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumPost < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::ForumPost, WhopSDK::Internal::AnyHash) }
+
+      # The unique identifier for the entity
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The amount of comments on this post
+      sig { returns(Integer) }
+      attr_accessor :comment_count
+
+      # The content of the forum post in Markdown format
+      sig { returns(T.nilable(String)) }
+      attr_accessor :content
+
+      # Whether the forum post has been edited
+      sig { returns(T::Boolean) }
+      attr_accessor :is_edited
+
+      # Whether this forum post is pinned
+      sig { returns(T::Boolean) }
+      attr_accessor :is_pinned
+
+      # Whether the user that sent the post is an admin of the company
+      sig { returns(T::Boolean) }
+      attr_accessor :is_poster_admin
+
+      # The number of likes this post has received
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :like_count
+
+      # The ID of the parent forum post, if applicable
+      sig { returns(T.nilable(String)) }
+      attr_accessor :parent_id
+
+      # The title of the forum post
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # The user who created this forum post
+      sig { returns(WhopSDK::ForumPost::User) }
+      attr_reader :user
+
+      sig { params(user: WhopSDK::ForumPost::User::OrHash).void }
+      attr_writer :user
+
+      # The number of times this message has been viewed
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :view_count
+
+      # Represents a post in forum
+      sig do
+        params(
+          id: String,
+          comment_count: Integer,
+          content: T.nilable(String),
+          is_edited: T::Boolean,
+          is_pinned: T::Boolean,
+          is_poster_admin: T::Boolean,
+          like_count: T.nilable(Integer),
+          parent_id: T.nilable(String),
+          title: T.nilable(String),
+          user: WhopSDK::ForumPost::User::OrHash,
+          view_count: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the entity
+        id:,
+        # The amount of comments on this post
+        comment_count:,
+        # The content of the forum post in Markdown format
+        content:,
+        # Whether the forum post has been edited
+        is_edited:,
+        # Whether this forum post is pinned
+        is_pinned:,
+        # Whether the user that sent the post is an admin of the company
+        is_poster_admin:,
+        # The number of likes this post has received
+        like_count:,
+        # The ID of the parent forum post, if applicable
+        parent_id:,
+        # The title of the forum post
+        title:,
+        # The user who created this forum post
+        user:,
+        # The number of times this message has been viewed
+        view_count:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            comment_count: Integer,
+            content: T.nilable(String),
+            is_edited: T::Boolean,
+            is_pinned: T::Boolean,
+            is_poster_admin: T::Boolean,
+            like_count: T.nilable(Integer),
+            parent_id: T.nilable(String),
+            title: T.nilable(String),
+            user: WhopSDK::ForumPost::User,
+            view_count: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::ForumPost::User, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user who created this forum post
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/forum_post_create_params.rbi

@@ -0,0 +1,254 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumPostCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ForumPostCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The experience to create this post in
+      sig { returns(String) }
+      attr_accessor :experience_id
+
+      # The attachments for this post
+      sig do
+        returns(T.nilable(T::Array[WhopSDK::ForumPostCreateParams::Attachment]))
+      end
+      attr_accessor :attachments
+
+      # This is the main body of the post in Markdown format. Hidden if paywalled and
+      # user hasn't purchased access to it.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :content
+
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_mention
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :parent_id
+
+      # The amount to paywall this post by. A paywalled post requires the user to
+      # purchase it in order to view its content.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :paywall_amount
+
+      # The available currencies on the platform
+      sig { returns(T.nilable(WhopSDK::Currency::OrSymbol)) }
+      attr_accessor :paywall_currency
+
+      # Whether the post should be pinned
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :pinned
+
+      # The poll for this post
+      sig { returns(T.nilable(WhopSDK::ForumPostCreateParams::Poll)) }
+      attr_reader :poll
+
+      sig do
+        params(
+          poll: T.nilable(WhopSDK::ForumPostCreateParams::Poll::OrHash)
+        ).void
+      end
+      attr_writer :poll
+
+      # The title of the post. Only visible if paywalled.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            experience_id: String,
+            attachments:
+              T.nilable(T::Array[WhopSDK::ForumPostCreateParams::Attachment]),
+            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),
+            title: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::ForumPostCreateParams::Attachment,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of an existing attachment object. Use this when updating a resource and
+        # keeping a subset of the attachments. Don't use this unless you know what you're
+        # doing.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # This ID should be used the first time you upload an attachment. It is the ID of
+        # the direct upload that was created when uploading the file to S3 via the
+        # mediaDirectUpload mutation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :direct_upload_id
+
+        # Input for an attachment
+        sig do
+          params(
+            id: T.nilable(String),
+            direct_upload_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of an existing attachment object. Use this when updating a resource and
+          # keeping a subset of the attachments. Don't use this unless you know what you're
+          # doing.
+          id: nil,
+          # This ID should be used the first time you upload an attachment. It is the ID of
+          # the direct upload that was created when uploading the file to S3 via the
+          # mediaDirectUpload mutation.
+          direct_upload_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Poll < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::ForumPostCreateParams::Poll,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The options for the poll. Must have sequential IDs starting from 1
+        sig { returns(T::Array[WhopSDK::ForumPostCreateParams::Poll::Option]) }
+        attr_accessor :options
+
+        # The poll for this post
+        sig do
+          params(
+            options:
+              T::Array[WhopSDK::ForumPostCreateParams::Poll::Option::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The options for the poll. Must have sequential IDs starting from 1
+          options:
+        )
+        end
+
+        sig do
+          override.returns(
+            { options: T::Array[WhopSDK::ForumPostCreateParams::Poll::Option] }
+          )
+        end
+        def to_hash
+        end
+
+        class Option < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::ForumPostCreateParams::Poll::Option,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # Sequential ID for the poll option (starting from '1')
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The text of the poll option
+          sig { returns(String) }
+          attr_accessor :text
+
+          # Input type for a single poll option
+          sig { params(id: String, text: String).returns(T.attached_class) }
+          def self.new(
+            # Sequential ID for the poll option (starting from '1')
+            id:,
+            # The text of the poll option
+            text:
+          )
+          end
+
+          sig { override.returns({ id: String, text: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/forum_post_list_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumPostListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ForumPostListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the experience to list forum posts for
+      sig { returns(String) }
+      attr_accessor :experience_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      # The ID of the parent post to list forum post comments for
+      sig { returns(T.nilable(String)) }
+      attr_accessor :parent_id
+
+      # Set to true to only return pinned posts
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :pinned
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end