whop_sdk 0.0.3 → 0.0.4

data/lib/whop_sdk/models/course_student_retrieve_response.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseStudents#retrieve
+    class CourseStudentRetrieveResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the course student. Looks like crsi_XXX
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute completed_lessons_count
+      #   The number of lessons the student has completed
+      #
+      #   @return [Integer]
+      required :completed_lessons_count, Integer
+
+      # @!attribute completion_rate
+      #   The percentage of lessons completed (0-100)
+      #
+      #   @return [Float]
+      required :completion_rate, Float
+
+      # @!attribute course
+      #   The course the student is enrolled in
+      #
+      #   @return [WhopSDK::Models::CourseStudentRetrieveResponse::Course]
+      required :course, -> { WhopSDK::Models::CourseStudentRetrieveResponse::Course }
+
+      # @!attribute first_interaction_at
+      #   When the student first interacted with the course
+      #
+      #   @return [Time]
+      required :first_interaction_at, Time
+
+      # @!attribute last_interaction_at
+      #   When the student last interacted with the course
+      #
+      #   @return [Time]
+      required :last_interaction_at, Time
+
+      # @!attribute total_lessons_count
+      #   The total number of lessons the student has access to
+      #
+      #   @return [Integer]
+      required :total_lessons_count, Integer
+
+      # @!attribute user
+      #   The user who is enrolled in the course
+      #
+      #   @return [WhopSDK::Models::CourseStudentRetrieveResponse::User]
+      required :user, -> { WhopSDK::Models::CourseStudentRetrieveResponse::User }
+
+      # @!method initialize(id:, completed_lessons_count:, completion_rate:, course:, first_interaction_at:, last_interaction_at:, total_lessons_count:, user:)
+      #   A course student (enrollment of a student in a course)
+      #
+      #   @param id [String] The ID of the course student. Looks like crsi_XXX
+      #
+      #   @param completed_lessons_count [Integer] The number of lessons the student has completed
+      #
+      #   @param completion_rate [Float] The percentage of lessons completed (0-100)
+      #
+      #   @param course [WhopSDK::Models::CourseStudentRetrieveResponse::Course] The course the student is enrolled in
+      #
+      #   @param first_interaction_at [Time] When the student first interacted with the course
+      #
+      #   @param last_interaction_at [Time] When the student last interacted with the course
+      #
+      #   @param total_lessons_count [Integer] The total number of lessons the student has access to
+      #
+      #   @param user [WhopSDK::Models::CourseStudentRetrieveResponse::User] The user who is enrolled in the course
+
+      # @see WhopSDK::Models::CourseStudentRetrieveResponse#course
+      class Course < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the course. Looks like cors_XXX
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute experience
+        #   The experience that the course belongs to
+        #
+        #   @return [WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience]
+        required :experience, -> { WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience }
+
+        # @!attribute title
+        #   The title of the course
+        #
+        #   @return [String, nil]
+        required :title, String, nil?: true
+
+        # @!method initialize(id:, experience:, title:)
+        #   The course the student is enrolled in
+        #
+        #   @param id [String] The ID of the course. Looks like cors_XXX
+        #
+        #   @param experience [WhopSDK::Models::CourseStudentRetrieveResponse::Course::Experience] The experience that the course belongs to
+        #
+        #   @param title [String, nil] The title of the course
+
+        # @see WhopSDK::Models::CourseStudentRetrieveResponse::Course#experience
+        class Experience < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The unique ID representing this experience
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   The experience that the course belongs to
+          #
+          #   @param id [String] The unique ID representing this experience
+        end
+      end
+
+      # @see WhopSDK::Models::CourseStudentRetrieveResponse#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 is enrolled in the course
+        #
+        #   @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/course_update_params.rb

@@ -56,8 +56,8 @@ module WhopSDK
       # @!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
+      #   @return [WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithID, nil]
+      optional :thumbnail, union: -> { WhopSDK::CourseUpdateParams::Thumbnail }, nil?: true
 
       # @!attribute title
       #   The title of the course
@@ -83,7 +83,7 @@ module WhopSDK
       #
       #   @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 thumbnail [WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the course in png, jpeg, or gif format
       #
       #   @param title [String, nil] The title of the course
       #
@@ -165,32 +165,56 @@ module WhopSDK
         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
+      # The thumbnail for the course in png, jpeg, or gif format
+      module Thumbnail
+        extend WhopSDK::Internal::Type::Union
 
-        # @!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
+        # Input for an attachment
+        variant -> { WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID }
 
-        # @!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
+        # Input for an attachment
+        variant -> { WhopSDK::CourseUpdateParams::Thumbnail::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!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]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < 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]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithID} for more
+          #   details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseUpdateParams::Thumbnail::AttachmentInputWithID)]
       end
     end
   end

data/lib/whop_sdk/models/experience_update_params.rb

@@ -16,8 +16,8 @@ module WhopSDK
       # @!attribute logo
       #   The logo for the experience
       #
-      #   @return [WhopSDK::Models::ExperienceUpdateParams::Logo, nil]
-      optional :logo, -> { WhopSDK::ExperienceUpdateParams::Logo }, nil?: true
+      #   @return [WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID, WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithID, nil]
+      optional :logo, union: -> { WhopSDK::ExperienceUpdateParams::Logo }, nil?: true
 
       # @!attribute name
       #   The name of the experience.
@@ -40,7 +40,7 @@ module WhopSDK
       # @!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 logo [WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID, WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithID, nil] The logo for the experience
       #
       #   @param name [String, nil] The name of the experience.
       #
@@ -61,32 +61,56 @@ module WhopSDK
         #   @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
+      # The logo for the experience
+      module Logo
+        extend WhopSDK::Internal::Type::Union
+
+        # Input for an attachment
+        variant -> { WhopSDK::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID }
+
+        # Input for an attachment
+        variant -> { WhopSDK::ExperienceUpdateParams::Logo::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!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]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < 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]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithID} for more
+          #   details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithDirectUploadID, WhopSDK::Models::ExperienceUpdateParams::Logo::AttachmentInputWithID)]
       end
     end
   end

data/lib/whop_sdk/models/forum_post_create_params.rb

@@ -16,9 +16,9 @@ module WhopSDK
       # @!attribute attachments
       #   The attachments for this post
       #
-      #   @return [Array<WhopSDK::Models::ForumPostCreateParams::Attachment>, nil]
+      #   @return [Array<WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithID>, nil]
       optional :attachments,
-               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ForumPostCreateParams::Attachment] },
+               -> { WhopSDK::Internal::Type::ArrayOf[union: WhopSDK::ForumPostCreateParams::Attachment] },
                nil?: true
 
       # @!attribute content
@@ -80,7 +80,7 @@ module WhopSDK
       #
       #   @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 attachments [Array<WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithID>, 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
       #
@@ -100,32 +100,56 @@ module WhopSDK
       #
       #   @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
+      # Input for an attachment
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
 
-        # @!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
+        # Input for an attachment
+        variant -> { WhopSDK::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID }
 
-        # @!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
+        # Input for an attachment
+        variant -> { WhopSDK::ForumPostCreateParams::Attachment::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!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]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < 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]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithID} for
+          #   more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostCreateParams::Attachment::AttachmentInputWithID)]
       end
 
       class Poll < WhopSDK::Internal::Type::BaseModel

data/lib/whop_sdk/models/forum_post_update_params.rb

@@ -10,9 +10,9 @@ module WhopSDK
       # @!attribute attachments
       #   The attachments for this post
       #
-      #   @return [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment>, nil]
+      #   @return [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID>, nil]
       optional :attachments,
-               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ForumPostUpdateParams::Attachment] },
+               -> { WhopSDK::Internal::Type::ArrayOf[union: WhopSDK::ForumPostUpdateParams::Attachment] },
                nil?: true
 
       # @!attribute content
@@ -38,7 +38,7 @@ module WhopSDK
       #   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 attachments [Array<WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID>, 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
       #
@@ -48,32 +48,56 @@ module WhopSDK
       #
       #   @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
+      # Input for an attachment
+      module Attachment
+        extend WhopSDK::Internal::Type::Union
 
-        # @!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
+        # Input for an attachment
+        variant -> { WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID }
 
-        # @!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
+        # Input for an attachment
+        variant -> { WhopSDK::ForumPostUpdateParams::Attachment::AttachmentInputWithID }
+
+        class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+          # @!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]
+          required :direct_upload_id, String
+
+          # @!method initialize(direct_upload_id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID}
+          #   for more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+        end
+
+        class AttachmentInputWithID < 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]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID} for
+          #   more details.
+          #
+          #   Input for an attachment
+          #
+          #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+        end
+
+        # @!method self.variants
+        #   @return [Array(WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::ForumPostUpdateParams::Attachment::AttachmentInputWithID)]
       end
     end
   end