whop_sdk 0.0.2 → 0.0.3

data/lib/whop_sdk/models/review_retrieve_response.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Reviews#retrieve
+    class ReviewRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the review.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute attachments
+      #   The attachments attached to the review.
+      #
+      #   @return [Array<WhopSDK::Models::ReviewRetrieveResponse::Attachment>]
+      required :attachments,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::ReviewRetrieveResponse::Attachment] }
+
+      # @!attribute company
+      #   The company the review is for.
+      #
+      #   @return [WhopSDK::Models::ReviewRetrieveResponse::Company]
+      required :company, -> { WhopSDK::Models::ReviewRetrieveResponse::Company }
+
+      # @!attribute created_at
+      #   The timestamp of when the review was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description of the review.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute joined_at
+      #   The timestamp of when the user joined the product.
+      #
+      #   @return [Time, nil]
+      required :joined_at, Time, nil?: true
+
+      # @!attribute paid_for_product
+      #   Whether or not the user paid for the product. If null, the payment status is
+      #   unknown.
+      #
+      #   @return [Boolean, nil]
+      required :paid_for_product, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute product
+      #   The product the review is for.
+      #
+      #   @return [WhopSDK::Models::ReviewRetrieveResponse::Product]
+      required :product, -> { WhopSDK::Models::ReviewRetrieveResponse::Product }
+
+      # @!attribute published_at
+      #   The timestamp of when the review was published.
+      #
+      #   @return [Time, nil]
+      required :published_at, Time, nil?: true
+
+      # @!attribute stars
+      #   The number of stars the user gave the product.
+      #
+      #   @return [Integer]
+      required :stars, Integer
+
+      # @!attribute status
+      #   The status of the review.
+      #
+      #   @return [Symbol, WhopSDK::Models::ReviewStatus]
+      required :status, enum: -> { WhopSDK::ReviewStatus }
+
+      # @!attribute title
+      #   The title of the review.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the review was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user account that performed the action.
+      #
+      #   @return [WhopSDK::Models::ReviewRetrieveResponse::User]
+      required :user, -> { WhopSDK::Models::ReviewRetrieveResponse::User }
+
+      # @!method initialize(id:, attachments:, company:, created_at:, description:, joined_at:, paid_for_product:, product:, published_at:, stars:, status:, title:, updated_at:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::ReviewRetrieveResponse} for more details.
+      #
+      #   An object representing a user review of a company.
+      #
+      #   @param id [String] The internal ID of the review.
+      #
+      #   @param attachments [Array<WhopSDK::Models::ReviewRetrieveResponse::Attachment>] The attachments attached to the review.
+      #
+      #   @param company [WhopSDK::Models::ReviewRetrieveResponse::Company] The company the review is for.
+      #
+      #   @param created_at [Time] The timestamp of when the review was created.
+      #
+      #   @param description [String, nil] The description of the review.
+      #
+      #   @param joined_at [Time, nil] The timestamp of when the user joined the product.
+      #
+      #   @param paid_for_product [Boolean, nil] Whether or not the user paid for the product. If null, the payment status is unk
+      #
+      #   @param product [WhopSDK::Models::ReviewRetrieveResponse::Product] The product the review is for.
+      #
+      #   @param published_at [Time, nil] The timestamp of when the review was published.
+      #
+      #   @param stars [Integer] The number of stars the user gave the product.
+      #
+      #   @param status [Symbol, WhopSDK::Models::ReviewStatus] The status of the review.
+      #
+      #   @param title [String, nil] The title of the review.
+      #
+      #   @param updated_at [Time] The timestamp of when the review was last updated.
+      #
+      #   @param user [WhopSDK::Models::ReviewRetrieveResponse::User] The user account that performed the action.
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the attachment
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute content_type
+        #   The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @return [String, nil]
+        required :content_type, String, nil?: true
+
+        # @!attribute filename
+        #   The name of the file
+        #
+        #   @return [String, nil]
+        required :filename, String, nil?: true
+
+        # @!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(id:, content_type:, filename:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::ReviewRetrieveResponse::Attachment} for more details.
+        #
+        #   Represents an image attachment
+        #
+        #   @param id [String] The ID of the attachment
+        #
+        #   @param content_type [String, nil] The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @param filename [String, nil] The name of the file
+        #
+        #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+      end
+
+      # @see WhopSDK::Models::ReviewRetrieveResponse#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 the review is for.
+        #
+        #   @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::ReviewRetrieveResponse#product
+      class Product < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the public product.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the product. Use for Whop 4.0.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The product the review is for.
+        #
+        #   @param id [String] The internal ID of the public product.
+        #
+        #   @param title [String] The title of the product. Use for Whop 4.0.
+      end
+
+      # @see WhopSDK::Models::ReviewRetrieveResponse#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 account that performed the action.
+        #
+        #   @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/review_status.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The statuses a review can have
+    module ReviewStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      PENDING = :pending
+      PUBLISHED = :published
+      REMOVED = :removed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models.rb

@@ -71,14 +71,20 @@ module WhopSDK
 
   AppViewType = WhopSDK::Models::AppViewType
 
+  AssessmentQuestionTypes = WhopSDK::Models::AssessmentQuestionTypes
+
   AuthorizedUserListParams = WhopSDK::Models::AuthorizedUserListParams
 
   AuthorizedUserRetrieveParams = WhopSDK::Models::AuthorizedUserRetrieveParams
 
   AuthorizedUserRoles = WhopSDK::Models::AuthorizedUserRoles
 
+  BillingReasons = WhopSDK::Models::BillingReasons
+
   BusinessTypes = WhopSDK::Models::BusinessTypes
 
+  CardBrands = WhopSDK::Models::CardBrands
+
   ChatChannel = WhopSDK::Models::ChatChannel
 
   ChatChannelListParams = WhopSDK::Models::ChatChannelListParams
@@ -101,6 +107,28 @@ module WhopSDK
 
   CompanyRetrieveParams = WhopSDK::Models::CompanyRetrieveParams
 
+  Course = WhopSDK::Models::Course
+
+  CourseChapter = WhopSDK::Models::CourseChapter
+
+  CourseChapterCreateParams = WhopSDK::Models::CourseChapterCreateParams
+
+  CourseChapterDeleteParams = WhopSDK::Models::CourseChapterDeleteParams
+
+  CourseChapterListParams = WhopSDK::Models::CourseChapterListParams
+
+  CourseChapterRetrieveParams = WhopSDK::Models::CourseChapterRetrieveParams
+
+  CourseChapterUpdateParams = WhopSDK::Models::CourseChapterUpdateParams
+
+  CourseCreateParams = WhopSDK::Models::CourseCreateParams
+
+  CourseDeleteParams = WhopSDK::Models::CourseDeleteParams
+
+  CourseLessonCreateParams = WhopSDK::Models::CourseLessonCreateParams
+
+  CourseLessonDeleteParams = WhopSDK::Models::CourseLessonDeleteParams
+
   CourseLessonInteraction = WhopSDK::Models::CourseLessonInteraction
 
   CourseLessonInteractionCompletedWebhookEvent =
@@ -112,6 +140,18 @@ module WhopSDK
 
   CourseLessonInteractionRetrieveParams = WhopSDK::Models::CourseLessonInteractionRetrieveParams
 
+  CourseLessonListParams = WhopSDK::Models::CourseLessonListParams
+
+  CourseLessonRetrieveParams = WhopSDK::Models::CourseLessonRetrieveParams
+
+  CourseLessonUpdateParams = WhopSDK::Models::CourseLessonUpdateParams
+
+  CourseListParams = WhopSDK::Models::CourseListParams
+
+  CourseRetrieveParams = WhopSDK::Models::CourseRetrieveParams
+
+  CourseUpdateParams = WhopSDK::Models::CourseUpdateParams
+
   Currency = WhopSDK::Models::Currency
 
   CustomCta = WhopSDK::Models::CustomCta
@@ -152,6 +192,8 @@ module WhopSDK
 
   ExperienceDetachParams = WhopSDK::Models::ExperienceDetachParams
 
+  ExperienceDuplicateParams = WhopSDK::Models::ExperienceDuplicateParams
+
   ExperienceListParams = WhopSDK::Models::ExperienceListParams
 
   ExperienceRetrieveParams = WhopSDK::Models::ExperienceRetrieveParams
@@ -170,6 +212,8 @@ module WhopSDK
 
   ForumPostRetrieveParams = WhopSDK::Models::ForumPostRetrieveParams
 
+  ForumPostUpdateParams = WhopSDK::Models::ForumPostUpdateParams
+
   ForumRetrieveParams = WhopSDK::Models::ForumRetrieveParams
 
   ForumUpdateParams = WhopSDK::Models::ForumUpdateParams
@@ -202,8 +246,16 @@ module WhopSDK
 
   InvoiceVoidParams = WhopSDK::Models::InvoiceVoidParams
 
+  Languages = WhopSDK::Models::Languages
+
   LedgerAccountRetrieveParams = WhopSDK::Models::LedgerAccountRetrieveParams
 
+  Lesson = WhopSDK::Models::Lesson
+
+  LessonTypes = WhopSDK::Models::LessonTypes
+
+  LessonVisibilities = WhopSDK::Models::LessonVisibilities
+
   MemberListParams = WhopSDK::Models::MemberListParams
 
   MemberMostRecentActions = WhopSDK::Models::MemberMostRecentActions
@@ -240,6 +292,8 @@ module WhopSDK
 
   MessageRetrieveParams = WhopSDK::Models::MessageRetrieveParams
 
+  MessageUpdateParams = WhopSDK::Models::MessageUpdateParams
+
   PageInfo = WhopSDK::Models::PageInfo
 
   Payment = WhopSDK::Models::Payment
@@ -248,6 +302,8 @@ module WhopSDK
 
   PaymentListParams = WhopSDK::Models::PaymentListParams
 
+  PaymentMethodTypes = WhopSDK::Models::PaymentMethodTypes
+
   PaymentPendingWebhookEvent = WhopSDK::Models::PaymentPendingWebhookEvent
 
   PaymentRefundParams = WhopSDK::Models::PaymentRefundParams
@@ -288,6 +344,20 @@ module WhopSDK
 
   ProductUpdateParams = WhopSDK::Models::ProductUpdateParams
 
+  PromoCode = WhopSDK::Models::PromoCode
+
+  PromoCodeCreateParams = WhopSDK::Models::PromoCodeCreateParams
+
+  PromoCodeDeleteParams = WhopSDK::Models::PromoCodeDeleteParams
+
+  PromoCodeListParams = WhopSDK::Models::PromoCodeListParams
+
+  PromoCodeRetrieveParams = WhopSDK::Models::PromoCodeRetrieveParams
+
+  PromoCodeStatus = WhopSDK::Models::PromoCodeStatus
+
+  PromoDuration = WhopSDK::Models::PromoDuration
+
   PromoType = WhopSDK::Models::PromoType
 
   Reaction = WhopSDK::Models::Reaction
@@ -302,6 +372,12 @@ module WhopSDK
 
   ReleaseMethod = WhopSDK::Models::ReleaseMethod
 
+  ReviewListParams = WhopSDK::Models::ReviewListParams
+
+  ReviewRetrieveParams = WhopSDK::Models::ReviewRetrieveParams
+
+  ReviewStatus = WhopSDK::Models::ReviewStatus
+
   Shipment = WhopSDK::Models::Shipment
 
   ShipmentCarrier = WhopSDK::Models::ShipmentCarrier

data/lib/whop_sdk/resources/checkout_configurations.rb

@@ -9,6 +9,8 @@ module WhopSDK
       #
       # - `checkout_configuration:create`
       # - `plan:create`
+      # - `access_pass:create`
+      # - `access_pass:update`
       #
       # @overload create(affiliate_code: nil, metadata: nil, plan: nil, plan_id: nil, redirect_url: nil, request_options: {})
       #

data/lib/whop_sdk/resources/course_chapters.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class CourseChapters
+      # Creates a new course chapter
+      #
+      # Required permissions:
+      #
+      # - `courses:update`
+      #
+      # @overload create(course_id:, title: nil, request_options: {})
+      #
+      # @param course_id [String] The ID of the course to create the chapter in
+      #
+      # @param title [String, nil] The title of the chapter
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::CourseChapter]
+      #
+      # @see WhopSDK::Models::CourseChapterCreateParams
+      def create(params)
+        parsed, options = WhopSDK::CourseChapterCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "course_chapters",
+          body: parsed,
+          model: WhopSDK::CourseChapter,
+          options: options
+        )
+      end
+
+      # Retrieves a course chapter by ID
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::CourseChapter]
+      #
+      # @see WhopSDK::Models::CourseChapterRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["course_chapters/%1$s", id],
+          model: WhopSDK::CourseChapter,
+          options: params[:request_options]
+        )
+      end
+
+      # Updates a course chapter
+      #
+      # Required permissions:
+      #
+      # - `courses:update`
+      #
+      # @overload update(id, title:, request_options: {})
+      #
+      # @param id [String]
+      #
+      # @param title [String] The title of the chapter
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::CourseChapter]
+      #
+      # @see WhopSDK::Models::CourseChapterUpdateParams
+      def update(id, params)
+        parsed, options = WhopSDK::CourseChapterUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["course_chapters/%1$s", id],
+          body: parsed,
+          model: WhopSDK::CourseChapter,
+          options: options
+        )
+      end
+
+      # Lists chapters for a course
+      #
+      # Required permissions:
+      #
+      # - `courses:read`
+      #
+      # @overload list(course_id:, after: nil, before: nil, first: nil, last: nil, request_options: {})
+      #
+      # @param course_id [String] The ID of the course
+      #
+      # @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 request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::CourseChapterListResponse>]
+      #
+      # @see WhopSDK::Models::CourseChapterListParams
+      def list(params)
+        parsed, options = WhopSDK::CourseChapterListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "course_chapters",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::CourseChapterListResponse,
+          options: options
+        )
+      end
+
+      # Deletes a course chapter
+      #
+      # Required permissions:
+      #
+      # - `courses:update`
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Boolean]
+      #
+      # @see WhopSDK::Models::CourseChapterDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["course_chapters/%1$s", id],
+          model: WhopSDK::Internal::Type::Boolean,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end