whop_sdk 0.0.2

data/lib/whop_sdk/models/forum_post_create_params.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ForumPosts#create
+    class ForumPostCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute experience_id
+      #   The experience to create this post in
+      #
+      #   @return [String]
+      required :experience_id, String
+
+      # @!attribute attachments
+      #   The attachments for this post
+      #
+      #   @return [Array<WhopSDK::Models::ForumPostCreateParams::Attachment>, nil]
+      optional :attachments,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ForumPostCreateParams::Attachment] },
+               nil?: true
+
+      # @!attribute content
+      #   This is the main body of the post in Markdown format. Hidden if paywalled and
+      #   user hasn't purchased access to it.
+      #
+      #   @return [String, nil]
+      optional :content, String, nil?: true
+
+      # @!attribute is_mention
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :is_mention, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute parent_id
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :parent_id, String, nil?: true
+
+      # @!attribute paywall_amount
+      #   The amount to paywall this post by. A paywalled post requires the user to
+      #   purchase it in order to view its content.
+      #
+      #   @return [Float, nil]
+      optional :paywall_amount, Float, nil?: true
+
+      # @!attribute paywall_currency
+      #   The available currencies on the platform
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency, nil]
+      optional :paywall_currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+      # @!attribute pinned
+      #   Whether the post should be pinned
+      #
+      #   @return [Boolean, nil]
+      optional :pinned, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute poll
+      #   The poll for this post
+      #
+      #   @return [WhopSDK::Models::ForumPostCreateParams::Poll, nil]
+      optional :poll, -> { WhopSDK::ForumPostCreateParams::Poll }, nil?: true
+
+      # @!attribute title
+      #   The title of the post. Only visible if paywalled.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::ForumPostCreateParams} for more details.
+      #
+      #   @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}]
+
+      class Attachment < 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::ForumPostCreateParams::Attachment} for more details.
+        #
+        #   Input for an attachment
+        #
+        #   @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
+
+      class Poll < WhopSDK::Internal::Type::BaseModel
+        # @!attribute options
+        #   The options for the poll. Must have sequential IDs starting from 1
+        #
+        #   @return [Array<WhopSDK::Models::ForumPostCreateParams::Poll::Option>]
+        required :options, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ForumPostCreateParams::Poll::Option] }
+
+        # @!method initialize(options:)
+        #   The poll for this post
+        #
+        #   @param options [Array<WhopSDK::Models::ForumPostCreateParams::Poll::Option>] The options for the poll. Must have sequential IDs starting from 1
+
+        class Option < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   Sequential ID for the poll option (starting from '1')
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute text
+          #   The text of the poll option
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!method initialize(id:, text:)
+          #   Input type for a single poll option
+          #
+          #   @param id [String] Sequential ID for the poll option (starting from '1')
+          #
+          #   @param text [String] The text of the poll option
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/forum_post_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ForumPosts#list
+    class ForumPostListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute experience_id
+      #   The ID of the experience to list forum posts for
+      #
+      #   @return [String]
+      required :experience_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 parent_id
+      #   The ID of the parent post to list forum post comments for
+      #
+      #   @return [String, nil]
+      optional :parent_id, String, nil?: true
+
+      # @!attribute pinned
+      #   Set to true to only return pinned posts
+      #
+      #   @return [Boolean, nil]
+      optional :pinned, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/whop_sdk/models/forum_post_list_response.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ForumPosts#list
+    class ForumPostListResponse < 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::ForumPostListResponse::User]
+      required :user, -> { WhopSDK::Models::ForumPostListResponse::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::ForumPostListResponse::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::ForumPostListResponse#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

data/lib/whop_sdk/models/forum_post_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ForumPosts#retrieve
+    class ForumPostRetrieveParams < 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/forum_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Forums#retrieve
+    class ForumRetrieveParams < 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/forum_update_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Forums#update
+    class ForumUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute email_notification_preference
+      #   Email notification preference option for a forum feed
+      #
+      #   @return [Symbol, WhopSDK::Models::EmailNotificationPreferences, nil]
+      optional :email_notification_preference, enum: -> { WhopSDK::EmailNotificationPreferences }, nil?: true
+
+      # @!attribute who_can_comment
+      #   Who can comment on a forum feed
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanCommentTypes, nil]
+      optional :who_can_comment, enum: -> { WhopSDK::WhoCanCommentTypes }, nil?: true
+
+      # @!attribute who_can_post
+      #   Who can post on a forum feed
+      #
+      #   @return [Symbol, WhopSDK::Models::WhoCanPostTypes, nil]
+      optional :who_can_post, enum: -> { WhopSDK::WhoCanPostTypes }, nil?: true
+
+      # @!method initialize(email_notification_preference: nil, who_can_comment: nil, who_can_post: nil, request_options: {})
+      #   @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}]
+    end
+  end
+end

data/lib/whop_sdk/models/friendly_receipt_status.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The friendly status of a receipt
+    module FriendlyReceiptStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      AUTO_REFUNDED = :auto_refunded
+      REFUNDED = :refunded
+      PARTIALLY_REFUNDED = :partially_refunded
+      DISPUTE_WARNING = :dispute_warning
+      OPEN_RESOLUTION = :open_resolution
+      OPEN_DISPUTE = :open_dispute
+      FAILED = :failed
+      PRICE_TOO_LOW = :price_too_low
+      SUCCEEDED = :succeeded
+      DRAFTED = :drafted
+      UNCOLLECTIBLE = :uncollectible
+      UNRESOLVED = :unresolved
+      PAST_DUE = :past_due
+      PENDING = :pending
+      INCOMPLETE = :incomplete
+      CANCELED = :canceled
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/global_affiliate_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different statuses of the global affiliate program for an access pass.
+    module GlobalAffiliateStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      ENABLED = :enabled
+      DISABLED = :disabled
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/industry_types.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The different industry types a company can be in.
+    module IndustryTypes
+      extend WhopSDK::Internal::Type::Enum
+
+      TRADING = :trading
+      SPORTS_BETTING = :sports_betting
+      RESELLING = :reselling
+      FITNESS = :fitness
+      AMAZON_FBA = :amazon_fba
+      REAL_ESTATE = :real_estate
+      KINDLE_BOOK_PUBLISHING = :kindle_book_publishing
+      DATING = :dating
+      AGENCIES = :agencies
+      HEALTH_AND_WELLNESS = :health_and_wellness
+      SOCIAL_MEDIA = :social_media
+      SALES = :sales
+      BUSINESS = :business
+      ECOMMERCE = :ecommerce
+      VIDEO_GAMES = :video_games
+      HOME_SERVICES = :home_services
+      AI = :ai
+      PUBLIC_SPEAKING = :public_speaking
+      PERSONAL_FINANCE = :personal_finance
+      CAREERS = :careers
+      TRAVEL = :travel
+      CLIPPING = :clipping
+      SPIRITUALITY = :spirituality
+      VAS = :vas
+      PERSONAL_DEVELOPMENT = :personal_development
+      SOFTWARE = :software
+      OTHER = :other
+      MARKETING_AGENCY = :marketing_agency
+      SALES_AGENCY = :sales_agency
+      AI_AGENCY = :ai_agency
+      DESIGN_AGENCY = :design_agency
+      COACHING_AGENCY = :coaching_agency
+      DEVELOPMENT_AGENCY = :development_agency
+      RECRUITING_AGENCY = :recruiting_agency
+      CUSTOMER_SUPPORT_AGENCY = :customer_support_agency
+      CLIPPING_AGENCY = :clipping_agency
+      CLOTHING = :clothing
+      SUPPLEMENTS = :supplements
+      BEAUTY_AND_PERSONAL_CARE = :beauty_and_personal_care
+      FITNESS_GEAR = :fitness_gear
+      ACCESSORIES = :accessories
+      HOME_GOODS = :home_goods
+      ELECTRONICS_AND_GADGETS = :electronics_and_gadgets
+      FOOD_AND_BEVERAGES = :food_and_beverages
+      GYM = :gym
+      RESTAURANT = :restaurant
+      RETAIL_STORE = :retail_store
+      COFFEE_SHOP = :coffee_shop
+      SALON_SPA = :salon_spa
+      MEDICAL_DENTIST_OFFICE = :medical_dentist_office
+      HOTEL_LODGING = :hotel_lodging
+      AUTO_REPAIR_SHOP = :auto_repair_shop
+      MASTERMINDS = :masterminds
+      WEBINARS = :webinars
+      BOOTCAMPS = :bootcamps
+      CONVENTION = :convention
+      CONCERTS = :concerts
+      MEETUPS = :meetups
+      PARTIES = :parties
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end