whop_sdk 0.0.2 → 0.0.4

data/lib/whop_sdk/models/course_create_params.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Courses#create
+    class CourseCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute experience_id
+      #   The ID of the experience to create the course in
+      #
+      #   @return [String]
+      required :experience_id, String
+
+      # @!attribute title
+      #   The title of the course
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!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 cover_image
+      #   The cover image URL of the course
+      #
+      #   @return [String, nil]
+      optional :cover_image, String, 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
+      #   The tagline of 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::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil]
+      optional :thumbnail, union: -> { WhopSDK::CourseCreateParams::Thumbnail }, nil?: true
+
+      # @!method initialize(experience_id:, title:, certificate_after_completion_enabled: nil, cover_image: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CourseCreateParams} for more details.
+      #
+      #   @param experience_id [String] The ID of the experience to create the course in
+      #
+      #   @param title [String] The title of the course
+      #
+      #   @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
+      #
+      #   @param cover_image [String, nil] The cover image URL of the 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] The tagline of the course
+      #
+      #   @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the course in png, jpeg, or gif format
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The thumbnail for the course in png, jpeg, or gif format
+      module Thumbnail
+        extend WhopSDK::Internal::Type::Union
+
+        # Input for an attachment
+        variant -> { WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID }
+
+        # Input for an attachment
+        variant -> { WhopSDK::CourseCreateParams::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::CourseCreateParams::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::CourseCreateParams::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::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID)]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/course_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Courses#delete
+    class CourseDeleteParams < 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/course_delete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @type [WhopSDK::Internal::Type::Converter]
+    CourseDeleteResponse = WhopSDK::Internal::Type::Boolean
+  end
+end

data/lib/whop_sdk/models/course_lesson_create_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseLessons#create
+    class CourseLessonCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute chapter_id
+      #   The ID of the chapter to create the lesson in
+      #
+      #   @return [String]
+      required :chapter_id, String
+
+      # @!attribute lesson_type
+      #   The type of the lesson
+      #
+      #   @return [Symbol, WhopSDK::Models::LessonTypes]
+      required :lesson_type, enum: -> { WhopSDK::LessonTypes }
+
+      # @!attribute content
+      #   The content of the lesson
+      #
+      #   @return [String, nil]
+      optional :content, String, nil?: true
+
+      # @!attribute days_from_course_start_until_unlock
+      #   Days from course start until unlock
+      #
+      #   @return [Integer, nil]
+      optional :days_from_course_start_until_unlock, Integer, nil?: true
+
+      # @!attribute title
+      #   The title of the lesson
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, title: nil, request_options: {})
+      #   @param chapter_id [String] The ID of the chapter to create the lesson in
+      #
+      #   @param lesson_type [Symbol, WhopSDK::Models::LessonTypes] The type of the lesson
+      #
+      #   @param content [String, nil] The content of the lesson
+      #
+      #   @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
+      #
+      #   @param title [String, nil] The title of the lesson
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/course_lesson_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseLessons#delete
+    class CourseLessonDeleteParams < 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/course_lesson_delete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @type [WhopSDK::Internal::Type::Converter]
+    CourseLessonDeleteResponse = WhopSDK::Internal::Type::Boolean
+  end
+end

data/lib/whop_sdk/models/course_lesson_list_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseLessons#list
+    class CourseLessonListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!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 chapter_id
+      #   The ID of the chapter (returns lessons only for this chapter)
+      #
+      #   @return [String, nil]
+      optional :chapter_id, String, nil?: true
+
+      # @!attribute course_id
+      #   The ID of the course (returns all lessons across all chapters)
+      #
+      #   @return [String, nil]
+      optional :course_id, 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
+
+      # @!method initialize(after: nil, before: nil, chapter_id: nil, course_id: nil, first: nil, last: nil, request_options: {})
+      #   @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 chapter_id [String, nil] The ID of the chapter (returns lessons only for this chapter)
+      #
+      #   @param course_id [String, nil] The ID of the course (returns all lessons across all chapters)
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/whop_sdk/models/course_lesson_list_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseLessons#list
+    class CourseLessonListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the lesson
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute content
+      #   The content of the lesson
+      #
+      #   @return [String, nil]
+      required :content, String, nil?: true
+
+      # @!attribute days_from_course_start_until_unlock
+      #   Number of days from course start until the lesson is unlocked
+      #
+      #   @return [Integer, nil]
+      required :days_from_course_start_until_unlock, Integer, nil?: true
+
+      # @!attribute lesson_type
+      #   The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+      #
+      #   @return [Symbol, WhopSDK::Models::LessonTypes]
+      required :lesson_type, enum: -> { WhopSDK::LessonTypes }
+
+      # @!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
+
+      # @!attribute visibility
+      #   The visibility of the lesson. Determines how / whether this lesson is visible to
+      #   users.
+      #
+      #   @return [Symbol, WhopSDK::Models::LessonVisibilities]
+      required :visibility, enum: -> { WhopSDK::LessonVisibilities }
+
+      # @!method initialize(id:, content:, days_from_course_start_until_unlock:, lesson_type:, order:, title:, visibility:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CourseLessonListResponse} for more details.
+      #
+      #   A lesson from the courses app
+      #
+      #   @param id [String] The ID of the lesson
+      #
+      #   @param content [String, nil] The content of the lesson
+      #
+      #   @param days_from_course_start_until_unlock [Integer, nil] Number of days from course start until the lesson is unlocked
+      #
+      #   @param lesson_type [Symbol, WhopSDK::Models::LessonTypes] The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+      #
+      #   @param order [Integer] The order of the lesson within its chapter
+      #
+      #   @param title [String] The title of the lesson
+      #
+      #   @param visibility [Symbol, WhopSDK::Models::LessonVisibilities] The visibility of the lesson. Determines how / whether this lesson is visible to
+    end
+  end
+end

data/lib/whop_sdk/models/course_lesson_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseLessons#retrieve
+    class CourseLessonRetrieveParams < 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