whop_sdk 0.0.2

data/lib/whop_sdk/models/experience_list_response.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#list
+    class ExperienceListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique ID representing this experience
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute app
+      #   The experience interface for this experience.
+      #
+      #   @return [WhopSDK::Models::ExperienceListResponse::App]
+      required :app, -> { WhopSDK::Models::ExperienceListResponse::App }
+
+      # @!attribute company
+      #   The company that owns this experience.
+      #
+      #   @return [WhopSDK::Models::ExperienceListResponse::Company]
+      required :company, -> { WhopSDK::Models::ExperienceListResponse::Company }
+
+      # @!attribute created_at
+      #   The timestamp of when this experience was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute image
+      #   The logo for the experience.
+      #
+      #   @return [WhopSDK::Models::ExperienceListResponse::Image, nil]
+      required :image, -> { WhopSDK::Models::ExperienceListResponse::Image }, nil?: true
+
+      # @!attribute name
+      #   The written name of the description.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute order
+      #   The order of the experience in the section
+      #
+      #   @return [String, nil]
+      required :order, String, nil?: true
+
+      # @!method initialize(id:, app:, company:, created_at:, image:, name:, order:)
+      #   An object representing an experience belonging to a company.
+      #
+      #   @param id [String] The unique ID representing this experience
+      #
+      #   @param app [WhopSDK::Models::ExperienceListResponse::App] The experience interface for this experience.
+      #
+      #   @param company [WhopSDK::Models::ExperienceListResponse::Company] The company that owns this experience.
+      #
+      #   @param created_at [Time] The timestamp of when this experience was created.
+      #
+      #   @param image [WhopSDK::Models::ExperienceListResponse::Image, nil] The logo for the experience.
+      #
+      #   @param name [String] The written name of the description.
+      #
+      #   @param order [String, nil] The order of the experience in the section
+
+      # @see WhopSDK::Models::ExperienceListResponse#app
+      class App < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the app
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute icon
+        #   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.
+        #
+        #   @return [WhopSDK::Models::ExperienceListResponse::App::Icon, nil]
+        required :icon, -> { WhopSDK::Models::ExperienceListResponse::App::Icon }, nil?: true
+
+        # @!attribute name
+        #   The name of the app
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, icon:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::ExperienceListResponse::App} for more details.
+        #
+        #   The experience interface for this experience.
+        #
+        #   @param id [String] The ID of the app
+        #
+        #   @param icon [WhopSDK::Models::ExperienceListResponse::App::Icon, nil] The icon for the app. This icon is shown on discovery, on the product page, on c
+        #
+        #   @param name [String] The name of the app
+
+        # @see WhopSDK::Models::ExperienceListResponse::App#icon
+        class Icon < WhopSDK::Internal::Type::BaseModel
+          # @!attribute url
+          #   This is the URL you use to render optimized attachments on the client. This
+          #   should be used for apps.
+          #
+          #   @return [String, nil]
+          required :url, String, nil?: true
+
+          # @!method initialize(url:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::ExperienceListResponse::App::Icon} for more details.
+          #
+          #   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.
+          #
+          #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+        end
+      end
+
+      # @see WhopSDK::Models::ExperienceListResponse#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID (tag) of the company.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute route
+        #   The slug/route of the company on the Whop site.
+        #
+        #   @return [String]
+        required :route, String
+
+        # @!attribute title
+        #   The title of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, route:, title:)
+        #   The company that owns this experience.
+        #
+        #   @param id [String] The ID (tag) of the company.
+        #
+        #   @param route [String] The slug/route of the company on the Whop site.
+        #
+        #   @param title [String] The title of the company.
+      end
+
+      # @see WhopSDK::Models::ExperienceListResponse#image
+      class Image < WhopSDK::Internal::Type::BaseModel
+        # @!attribute url
+        #   This is the URL you use to render optimized attachments on the client. This
+        #   should be used for apps.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::ExperienceListResponse::Image} for more details.
+        #
+        #   The logo for the experience.
+        #
+        #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/experience_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#retrieve
+    class ExperienceRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/experience_update_params.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#update
+    class ExperienceUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute access_level
+      #   The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
+      #
+      #   @return [Symbol, WhopSDK::Models::ExperienceUpdateParams::AccessLevel, nil]
+      optional :access_level, enum: -> { WhopSDK::ExperienceUpdateParams::AccessLevel }, nil?: true
+
+      # @!attribute logo
+      #   The logo for the experience
+      #
+      #   @return [WhopSDK::Models::ExperienceUpdateParams::Logo, nil]
+      optional :logo, -> { WhopSDK::ExperienceUpdateParams::Logo }, nil?: true
+
+      # @!attribute name
+      #   The name of the experience.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute order
+      #   The order of the experience in the section.
+      #
+      #   @return [String, nil]
+      optional :order, String, nil?: true
+
+      # @!attribute section_id
+      #   The ID of the section to update.
+      #
+      #   @return [String, nil]
+      optional :section_id, String, nil?: true
+
+      # @!method initialize(access_level: nil, logo: nil, name: nil, order: nil, section_id: nil, request_options: {})
+      #   @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}]
+
+      # The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).
+      module AccessLevel
+        extend WhopSDK::Internal::Type::Enum
+
+        PUBLIC = :public
+        PRIVATE = :private
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Logo < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute direct_upload_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.
+        #
+        #   @return [String, nil]
+        optional :direct_upload_id, String, nil?: true
+
+        # @!method initialize(id: nil, direct_upload_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::ExperienceUpdateParams::Logo} for more details.
+        #
+        #   The logo for the experience
+        #
+        #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
+        #
+        #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/forum.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Forum < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute email_notification_preference
+      #   The email notification preference for this forum
+      #
+      #   @return [Symbol, WhopSDK::Models::EmailNotificationPreferences]
+      required :email_notification_preference, enum: -> { WhopSDK::EmailNotificationPreferences }
+
+      # @!attribute experience
+      #   The experience for this forum
+      #
+      #   @return [WhopSDK::Models::Forum::Experience]
+      required :experience, -> { WhopSDK::Forum::Experience }
+
+      # @!attribute who_can_comment
+      #   Who can comment on this forum
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanCommentTypes]
+      required :who_can_comment, enum: -> { WhopSDK::WhoCanCommentTypes }
+
+      # @!attribute who_can_post
+      #   Who can post on this forum
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanPostTypes]
+      required :who_can_post, enum: -> { WhopSDK::WhoCanPostTypes }
+
+      # @!method initialize(id:, email_notification_preference:, experience:, who_can_comment:, who_can_post:)
+      #   Represents a forum feed
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param email_notification_preference [Symbol, WhopSDK::Models::EmailNotificationPreferences] The email notification preference for this forum
+      #
+      #   @param experience [WhopSDK::Models::Forum::Experience] The experience for this forum
+      #
+      #   @param who_can_comment [Symbol, WhopSDK::Models::WhoCanCommentTypes] Who can comment on this forum
+      #
+      #   @param who_can_post [Symbol, WhopSDK::Models::WhoCanPostTypes] Who can post on this forum
+
+      # @see WhopSDK::Models::Forum#experience
+      class Experience < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID representing this experience
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The written name of the description.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, name:)
+        #   The experience for this forum
+        #
+        #   @param id [String] The unique ID representing this experience
+        #
+        #   @param name [String] The written name of the description.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/forum_list_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Forums#list
+    class ForumListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list forums for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute product_id
+      #   If provided, only forums connected to this product are returned
+      #
+      #   @return [String, nil]
+      optional :product_id, String, nil?: true
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/whop_sdk/models/forum_list_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Forums#list
+    class ForumListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute email_notification_preference
+      #   The email notification preference for this forum
+      #
+      #   @return [Symbol, WhopSDK::Models::EmailNotificationPreferences]
+      required :email_notification_preference, enum: -> { WhopSDK::EmailNotificationPreferences }
+
+      # @!attribute experience
+      #   The experience for this forum
+      #
+      #   @return [WhopSDK::Models::ForumListResponse::Experience]
+      required :experience, -> { WhopSDK::Models::ForumListResponse::Experience }
+
+      # @!attribute who_can_comment
+      #   Who can comment on this forum
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanCommentTypes]
+      required :who_can_comment, enum: -> { WhopSDK::WhoCanCommentTypes }
+
+      # @!attribute who_can_post
+      #   Who can post on this forum
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanPostTypes]
+      required :who_can_post, enum: -> { WhopSDK::WhoCanPostTypes }
+
+      # @!method initialize(id:, email_notification_preference:, experience:, who_can_comment:, who_can_post:)
+      #   Represents a forum feed
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param email_notification_preference [Symbol, WhopSDK::Models::EmailNotificationPreferences] The email notification preference for this forum
+      #
+      #   @param experience [WhopSDK::Models::ForumListResponse::Experience] The experience for this forum
+      #
+      #   @param who_can_comment [Symbol, WhopSDK::Models::WhoCanCommentTypes] Who can comment on this forum
+      #
+      #   @param who_can_post [Symbol, WhopSDK::Models::WhoCanPostTypes] Who can post on this forum
+
+      # @see WhopSDK::Models::ForumListResponse#experience
+      class Experience < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID representing this experience
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The written name of the description.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, name:)
+        #   The experience for this forum
+        #
+        #   @param id [String] The unique ID representing this experience
+        #
+        #   @param name [String] The written name of the description.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/forum_post.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class ForumPost < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute comment_count
+      #   The amount of comments on this post
+      #
+      #   @return [Integer]
+      required :comment_count, Integer
+
+      # @!attribute content
+      #   The content of the forum post in Markdown format
+      #
+      #   @return [String, nil]
+      required :content, String, nil?: true
+
+      # @!attribute is_edited
+      #   Whether the forum post has been edited
+      #
+      #   @return [Boolean]
+      required :is_edited, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute is_pinned
+      #   Whether this forum post is pinned
+      #
+      #   @return [Boolean]
+      required :is_pinned, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute is_poster_admin
+      #   Whether the user that sent the post is an admin of the company
+      #
+      #   @return [Boolean]
+      required :is_poster_admin, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute like_count
+      #   The number of likes this post has received
+      #
+      #   @return [Integer, nil]
+      required :like_count, Integer, nil?: true
+
+      # @!attribute parent_id
+      #   The ID of the parent forum post, if applicable
+      #
+      #   @return [String, nil]
+      required :parent_id, String, nil?: true
+
+      # @!attribute title
+      #   The title of the forum post
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute user
+      #   The user who created this forum post
+      #
+      #   @return [WhopSDK::Models::ForumPost::User]
+      required :user, -> { WhopSDK::ForumPost::User }
+
+      # @!attribute view_count
+      #   The number of times this message has been viewed
+      #
+      #   @return [Integer, nil]
+      required :view_count, Integer, nil?: true
+
+      # @!method initialize(id:, comment_count:, content:, is_edited:, is_pinned:, is_poster_admin:, like_count:, parent_id:, title:, user:, view_count:)
+      #   Represents a post in forum
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param comment_count [Integer] The amount of comments on this post
+      #
+      #   @param content [String, nil] The content of the forum post in Markdown format
+      #
+      #   @param is_edited [Boolean] Whether the forum post has been edited
+      #
+      #   @param is_pinned [Boolean] Whether this forum post is pinned
+      #
+      #   @param is_poster_admin [Boolean] Whether the user that sent the post is an admin of the company
+      #
+      #   @param like_count [Integer, nil] The number of likes this post has received
+      #
+      #   @param parent_id [String, nil] The ID of the parent forum post, if applicable
+      #
+      #   @param title [String, nil] The title of the forum post
+      #
+      #   @param user [WhopSDK::Models::ForumPost::User] The user who created this forum post
+      #
+      #   @param view_count [Integer, nil] The number of times this message has been viewed
+
+      # @see WhopSDK::Models::ForumPost#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the user from their Whop account.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The user who created this forum post
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param name [String, nil] The name of the user from their Whop account.
+        #
+        #   @param username [String] The username of the user from their Whop account.
+      end
+    end
+  end
+end