whop_sdk 0.0.2

data/rbi/whop_sdk/models/experience_list_response.rbi

@@ -0,0 +1,279 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::ExperienceListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The unique ID representing this experience
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The experience interface for this experience.
+      sig { returns(WhopSDK::Models::ExperienceListResponse::App) }
+      attr_reader :app
+
+      sig do
+        params(app: WhopSDK::Models::ExperienceListResponse::App::OrHash).void
+      end
+      attr_writer :app
+
+      # The company that owns this experience.
+      sig { returns(WhopSDK::Models::ExperienceListResponse::Company) }
+      attr_reader :company
+
+      sig do
+        params(
+          company: WhopSDK::Models::ExperienceListResponse::Company::OrHash
+        ).void
+      end
+      attr_writer :company
+
+      # The timestamp of when this experience was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The logo for the experience.
+      sig { returns(T.nilable(WhopSDK::Models::ExperienceListResponse::Image)) }
+      attr_reader :image
+
+      sig do
+        params(
+          image:
+            T.nilable(WhopSDK::Models::ExperienceListResponse::Image::OrHash)
+        ).void
+      end
+      attr_writer :image
+
+      # The written name of the description.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The order of the experience in the section
+      sig { returns(T.nilable(String)) }
+      attr_accessor :order
+
+      # An object representing an experience belonging to a company.
+      sig do
+        params(
+          id: String,
+          app: WhopSDK::Models::ExperienceListResponse::App::OrHash,
+          company: WhopSDK::Models::ExperienceListResponse::Company::OrHash,
+          created_at: Time,
+          image:
+            T.nilable(WhopSDK::Models::ExperienceListResponse::Image::OrHash),
+          name: String,
+          order: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique ID representing this experience
+        id:,
+        # The experience interface for this experience.
+        app:,
+        # The company that owns this experience.
+        company:,
+        # The timestamp of when this experience was created.
+        created_at:,
+        # The logo for the experience.
+        image:,
+        # The written name of the description.
+        name:,
+        # The order of the experience in the section
+        order:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            app: WhopSDK::Models::ExperienceListResponse::App,
+            company: WhopSDK::Models::ExperienceListResponse::Company,
+            created_at: Time,
+            image: T.nilable(WhopSDK::Models::ExperienceListResponse::Image),
+            name: String,
+            order: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class App < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::ExperienceListResponse::App,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the app
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The icon for the app. This icon is shown on discovery, on the product page, on
+        # checkout, and as a default icon for the experiences.
+        sig do
+          returns(T.nilable(WhopSDK::Models::ExperienceListResponse::App::Icon))
+        end
+        attr_reader :icon
+
+        sig do
+          params(
+            icon:
+              T.nilable(
+                WhopSDK::Models::ExperienceListResponse::App::Icon::OrHash
+              )
+          ).void
+        end
+        attr_writer :icon
+
+        # The name of the app
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The experience interface for this experience.
+        sig do
+          params(
+            id: String,
+            icon:
+              T.nilable(
+                WhopSDK::Models::ExperienceListResponse::App::Icon::OrHash
+              ),
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the app
+          id:,
+          # The icon for the app. This icon is shown on discovery, on the product page, on
+          # checkout, and as a default icon for the experiences.
+          icon:,
+          # The name of the app
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              icon:
+                T.nilable(WhopSDK::Models::ExperienceListResponse::App::Icon),
+              name: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Icon < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Models::ExperienceListResponse::App::Icon,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :url
+
+          # The icon for the app. This icon is shown on discovery, on the product page, on
+          # checkout, and as a default icon for the experiences.
+          sig { params(url: T.nilable(String)).returns(T.attached_class) }
+          def self.new(
+            # This is the URL you use to render optimized attachments on the client. This
+            # should be used for apps.
+            url:
+          )
+          end
+
+          sig { override.returns({ url: T.nilable(String) }) }
+          def to_hash
+          end
+        end
+      end
+
+      class Company < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::ExperienceListResponse::Company,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID (tag) of the company.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The slug/route of the company on the Whop site.
+        sig { returns(String) }
+        attr_accessor :route
+
+        # The title of the company.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The company that owns this experience.
+        sig do
+          params(id: String, route: String, title: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID (tag) of the company.
+          id:,
+          # The slug/route of the company on the Whop site.
+          route:,
+          # The title of the company.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, route: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class Image < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::ExperienceListResponse::Image,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # The logo for the experience.
+        sig { params(url: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          url:
+        )
+        end
+
+        sig { override.returns({ url: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/experience_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceRetrieveParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/experience_update_params.rbi

@@ -0,0 +1,167 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
+      sig do
+        returns(
+          T.nilable(WhopSDK::ExperienceUpdateParams::AccessLevel::OrSymbol)
+        )
+      end
+      attr_accessor :access_level
+
+      # The logo for the experience
+      sig { returns(T.nilable(WhopSDK::ExperienceUpdateParams::Logo)) }
+      attr_reader :logo
+
+      sig do
+        params(
+          logo: T.nilable(WhopSDK::ExperienceUpdateParams::Logo::OrHash)
+        ).void
+      end
+      attr_writer :logo
+
+      # The name of the experience.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The order of the experience in the section.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :order
+
+      # The ID of the section to update.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :section_id
+
+      sig do
+        params(
+          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(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            access_level:
+              T.nilable(WhopSDK::ExperienceUpdateParams::AccessLevel::OrSymbol),
+            logo: T.nilable(WhopSDK::ExperienceUpdateParams::Logo),
+            name: T.nilable(String),
+            order: T.nilable(String),
+            section_id: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
+      module AccessLevel
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::ExperienceUpdateParams::AccessLevel)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PUBLIC =
+          T.let(
+            :public,
+            WhopSDK::ExperienceUpdateParams::AccessLevel::TaggedSymbol
+          )
+        PRIVATE =
+          T.let(
+            :private,
+            WhopSDK::ExperienceUpdateParams::AccessLevel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::ExperienceUpdateParams::AccessLevel::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Logo < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::ExperienceUpdateParams::Logo,
+              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
+
+        # The logo for the experience
+        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
+    end
+  end
+end

data/rbi/whop_sdk/models/forum.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Forum < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Forum, WhopSDK::Internal::AnyHash) }
+
+      # 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::Forum::Experience) }
+      attr_reader :experience
+
+      sig { params(experience: WhopSDK::Forum::Experience::OrHash).void }
+      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::Forum::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::Forum::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::Forum::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_list_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ForumListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ForumListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to list forums for
+      sig { returns(String) }
+      attr_accessor :company_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
+
+      # If provided, only forums connected to this product are returned
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_id
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company to list forums 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 forums connected to this product are returned
+        product_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end