whop_sdk 0.0.2 → 0.0.3

data/lib/whop_sdk/models/course_update_params.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Courses#update
+    class CourseUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute certificate_after_completion_enabled
+      #   Whether the course will award its students a PDF certificate after completing
+      #   all lessons
+      #
+      #   @return [Boolean, nil]
+      optional :certificate_after_completion_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute chapters
+      #   The chapters and lessons to update
+      #
+      #   @return [Array<WhopSDK::Models::CourseUpdateParams::Chapter>, nil]
+      optional :chapters,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CourseUpdateParams::Chapter] },
+               nil?: true
+
+      # @!attribute cover_image
+      #   The cover image URL of the course
+      #
+      #   @return [String, nil]
+      optional :cover_image, String, nil?: true
+
+      # @!attribute description
+      #   A short description of the course
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute language
+      #   The available languages for a course
+      #
+      #   @return [Symbol, WhopSDK::Models::Languages, nil]
+      optional :language, enum: -> { WhopSDK::Languages }, nil?: true
+
+      # @!attribute require_completing_lessons_in_order
+      #   Whether the course requires students to complete the previous lesson before
+      #   moving on to the next one
+      #
+      #   @return [Boolean, nil]
+      optional :require_completing_lessons_in_order, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute tagline
+      #   A short tagline for the course
+      #
+      #   @return [String, nil]
+      optional :tagline, String, nil?: true
+
+      # @!attribute thumbnail
+      #   The thumbnail for the course in png, jpeg, or gif format
+      #
+      #   @return [WhopSDK::Models::CourseUpdateParams::Thumbnail, nil]
+      optional :thumbnail, -> { WhopSDK::CourseUpdateParams::Thumbnail }, nil?: true
+
+      # @!attribute title
+      #   The title of the course
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(certificate_after_completion_enabled: nil, chapters: nil, cover_image: nil, description: nil, language: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CourseUpdateParams} for more details.
+      #
+      #   @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
+      #
+      #   @param chapters [Array<WhopSDK::Models::CourseUpdateParams::Chapter>, nil] The chapters and lessons to update
+      #
+      #   @param cover_image [String, nil] The cover image URL of the course
+      #
+      #   @param description [String, nil] A short description of the course
+      #
+      #   @param language [Symbol, WhopSDK::Models::Languages, nil] The available languages for a course
+      #
+      #   @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
+      #
+      #   @param tagline [String, nil] A short tagline for the course
+      #
+      #   @param thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
+      #
+      #   @param title [String, nil] The title of the course
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class Chapter < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the chapter to update
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute order
+        #   The order of the chapter within its course
+        #
+        #   @return [Integer]
+        required :order, Integer
+
+        # @!attribute title
+        #   The title of the chapter
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!attribute lessons
+        #   The lessons to update within this chapter
+        #
+        #   @return [Array<WhopSDK::Models::CourseUpdateParams::Chapter::Lesson>, nil]
+        optional :lessons,
+                 -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CourseUpdateParams::Chapter::Lesson] },
+                 nil?: true
+
+        # @!method initialize(id:, order:, title:, lessons: nil)
+        #   Input for updating a chapter while updating a course
+        #
+        #   @param id [String] The ID of the chapter to update
+        #
+        #   @param order [Integer] The order of the chapter within its course
+        #
+        #   @param title [String] The title of the chapter
+        #
+        #   @param lessons [Array<WhopSDK::Models::CourseUpdateParams::Chapter::Lesson>, nil] The lessons to update within this chapter
+
+        class Lesson < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the lesson to update
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute chapter_id
+          #   The ID of the chapter this lesson belongs to (for moving between chapters)
+          #
+          #   @return [String]
+          required :chapter_id, String
+
+          # @!attribute order
+          #   The order of the lesson within its chapter
+          #
+          #   @return [Integer]
+          required :order, Integer
+
+          # @!attribute title
+          #   The title of the lesson
+          #
+          #   @return [String]
+          required :title, String
+
+          # @!method initialize(id:, chapter_id:, order:, title:)
+          #   Input for updating a lesson while updating a course
+          #
+          #   @param id [String] The ID of the lesson to update
+          #
+          #   @param chapter_id [String] The ID of the chapter this lesson belongs to (for moving between chapters)
+          #
+          #   @param order [Integer] The order of the lesson within its chapter
+          #
+          #   @param title [String] The title of the lesson
+        end
+      end
+
+      class Thumbnail < 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::CourseUpdateParams::Thumbnail} for more details.
+        #
+        #   The thumbnail for the course in png, jpeg, or gif format
+        #
+        #   @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/experience_duplicate_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Experiences#duplicate
+    class ExperienceDuplicateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   The name of the new experience
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(name: nil, request_options: {})
+      #   @param name [String, nil] The name of the new experience
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/forum_post.rb

@@ -21,6 +21,12 @@ module WhopSDK
       #   @return [String, nil]
       required :content, String, nil?: true
 
+      # @!attribute created_at
+      #   The timestamp when the post was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
       # @!attribute is_edited
       #   Whether the forum post has been edited
       #
@@ -57,6 +63,12 @@ module WhopSDK
       #   @return [String, nil]
       required :title, String, nil?: true
 
+      # @!attribute updated_at
+      #   The timestamp when the post was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
       # @!attribute user
       #   The user who created this forum post
       #
@@ -69,7 +81,7 @@ module WhopSDK
       #   @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:)
+      # @!method initialize(id:, comment_count:, content:, created_at:, is_edited:, is_pinned:, is_poster_admin:, like_count:, parent_id:, title:, updated_at:, user:, view_count:)
       #   Represents a post in forum
       #
       #   @param id [String] The unique identifier for the entity
@@ -78,6 +90,8 @@ module WhopSDK
       #
       #   @param content [String, nil] The content of the forum post in Markdown format
       #
+      #   @param created_at [Time] The timestamp when the post was created
+      #
       #   @param is_edited [Boolean] Whether the forum post has been edited
       #
       #   @param is_pinned [Boolean] Whether this forum post is pinned
@@ -90,6 +104,8 @@ module WhopSDK
       #
       #   @param title [String, nil] The title of the forum post
       #
+      #   @param updated_at [Time] The timestamp when the post was last updated
+      #
       #   @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

data/lib/whop_sdk/models/forum_post_list_response.rb

@@ -22,6 +22,12 @@ module WhopSDK
       #   @return [String, nil]
       required :content, String, nil?: true
 
+      # @!attribute created_at
+      #   The timestamp when the post was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
       # @!attribute is_edited
       #   Whether the forum post has been edited
       #
@@ -58,6 +64,12 @@ module WhopSDK
       #   @return [String, nil]
       required :title, String, nil?: true
 
+      # @!attribute updated_at
+      #   The timestamp when the post was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
       # @!attribute user
       #   The user who created this forum post
       #
@@ -70,7 +82,7 @@ module WhopSDK
       #   @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:)
+      # @!method initialize(id:, comment_count:, content:, created_at:, is_edited:, is_pinned:, is_poster_admin:, like_count:, parent_id:, title:, updated_at:, user:, view_count:)
       #   Represents a post in forum
       #
       #   @param id [String] The unique identifier for the entity
@@ -79,6 +91,8 @@ module WhopSDK
       #
       #   @param content [String, nil] The content of the forum post in Markdown format
       #
+      #   @param created_at [Time] The timestamp when the post was created
+      #
       #   @param is_edited [Boolean] Whether the forum post has been edited
       #
       #   @param is_pinned [Boolean] Whether this forum post is pinned
@@ -91,6 +105,8 @@ module WhopSDK
       #
       #   @param title [String, nil] The title of the forum post
       #
+      #   @param updated_at [Time] The timestamp when the post was last updated
+      #
       #   @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

data/lib/whop_sdk/models/forum_post_update_params.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::ForumPosts#update
+    class ForumPostUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute attachments
+      #   The attachments for this post
+      #
+      #   @return [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment>, nil]
+      optional :attachments,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ForumPostUpdateParams::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_pinned
+      #   Whether the post is pinned. You can only pin a top level posts (not comments).
+      #
+      #   @return [Boolean, nil]
+      optional :is_pinned, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute title
+      #   The title of the post. Only visible if paywalled.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(attachments: nil, content: nil, is_pinned: nil, title: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::ForumPostUpdateParams} for more details.
+      #
+      #   @param attachments [Array<WhopSDK::Models::ForumPostUpdateParams::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_pinned [Boolean, nil] Whether the post is pinned. You can only pin a top level posts (not comments).
+      #
+      #   @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::ForumPostUpdateParams::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
+    end
+  end
+end

data/lib/whop_sdk/models/invoice.rb

@@ -34,7 +34,8 @@ module WhopSDK
       required :email_address, String, nil?: true
 
       # @!attribute fetch_invoice_token
-      #   The token to fetch the invoice.
+      #   A signed token that allows fetching the invoice data publically without being
+      #   authenticated.
       #
       #   @return [String]
       required :fetch_invoice_token, String
@@ -58,6 +59,9 @@ module WhopSDK
       required :user, -> { WhopSDK::Invoice::User }, nil?: true
 
       # @!method initialize(id:, created_at:, current_plan:, due_date:, email_address:, fetch_invoice_token:, number:, status:, user:)
+      #   Some parameter documentations has been truncated, see {WhopSDK::Models::Invoice}
+      #   for more details.
+      #
       #   A statement that defines an amount due by a customer.
       #
       #   @param id [String] The ID of the invoice.
@@ -70,7 +74,7 @@ module WhopSDK
       #
       #   @param email_address [String, nil] The email address that the invoice was created for.
       #
-      #   @param fetch_invoice_token [String] The token to fetch the invoice.
+      #   @param fetch_invoice_token [String] A signed token that allows fetching the invoice data publically without being au
       #
       #   @param number [String] The number of the invoice.
       #

data/lib/whop_sdk/models/invoice_list_item.rb

@@ -34,7 +34,8 @@ module WhopSDK
       required :email_address, String, nil?: true
 
       # @!attribute fetch_invoice_token
-      #   The token to fetch the invoice.
+      #   A signed token that allows fetching the invoice data publically without being
+      #   authenticated.
       #
       #   @return [String]
       required :fetch_invoice_token, String
@@ -58,6 +59,9 @@ module WhopSDK
       required :user, -> { WhopSDK::InvoiceListItem::User }, nil?: true
 
       # @!method initialize(id:, created_at:, current_plan:, due_date:, email_address:, fetch_invoice_token:, number:, status:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::InvoiceListItem} for more details.
+      #
       #   A statement that defines an amount due by a customer.
       #
       #   @param id [String] The ID of the invoice.
@@ -70,7 +74,7 @@ module WhopSDK
       #
       #   @param email_address [String, nil] The email address that the invoice was created for.
       #
-      #   @param fetch_invoice_token [String] The token to fetch the invoice.
+      #   @param fetch_invoice_token [String] A signed token that allows fetching the invoice data publically without being au
       #
       #   @param number [String] The number of the invoice.
       #

data/lib/whop_sdk/models/languages.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The available languages for a course
+    module Languages
+      extend WhopSDK::Internal::Type::Enum
+
+      EN = :en
+      ES = :es
+      IT = :it
+      PT = :pt
+      DE = :de
+      FR = :fr
+      PL = :pl
+      RU = :ru
+      NL = :nl
+      CA = :ca
+      TR = :tr
+      SV = :sv
+      UK = :uk
+      NO = :no
+      FI = :fi
+      SK = :sk
+      EL = :el
+      CS = :cs
+      HR = :hr
+      DA = :da
+      RO = :ro
+      BG = :bg
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/ledger_account_retrieve_response.rb

@@ -111,8 +111,17 @@ module WhopSDK
       module LedgerAccountAuditStatus
         extend WhopSDK::Internal::Type::Enum
 
+        PENDING = :pending
+        APPROVED = :approved
         RESERVES_IMPOSED = :reserves_imposed
+        SUSPENDED = :suspended
+        IGNORED = :ignored
+        REJECTED = :rejected
         REQUESTED_MORE_INFORMATION = :requested_more_information
+        INFORMATION_SUBMITTED = :information_submitted
+        REQUESTED_TOS_VIOLATION_CORRECTION = :requested_tos_violation_correction
+        CLAWBACK_ATTEMPTED = :clawback_attempted
+        AWAITING_SALES_REVIEW = :awaiting_sales_review
 
         # @!method self.values
         #   @return [Array<Symbol>]