whop_sdk 0.0.2 → 0.0.3

data/lib/whop_sdk/models/course.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Courses#create
+    class Course < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the course. Looks like cors_XXX
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute certificate_after_completion_enabled
+      #   Whether the course will award its students a PDF certificate after completing
+      #   all lessons
+      #
+      #   @return [Boolean, nil]
+      required :certificate_after_completion_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute chapters
+      #   The chapters in this course
+      #
+      #   @return [Array<WhopSDK::Models::Course::Chapter>]
+      required :chapters, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Course::Chapter] }
+
+      # @!attribute created_at
+      #   The timestamp of when the course was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   A short description of the course
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute language
+      #   The language spoken in the video content of the course, used to generate closed
+      #   captions in the right language
+      #
+      #   @return [Symbol, WhopSDK::Models::Languages]
+      required :language, enum: -> { WhopSDK::Languages }
+
+      # @!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]
+      required :require_completing_lessons_in_order, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute tagline
+      #   A short tagline for the course. It is displayed under the course title in the UI
+      #
+      #   @return [String, nil]
+      required :tagline, String, nil?: true
+
+      # @!attribute thumbnail
+      #   The thumbnail for the course
+      #
+      #   @return [WhopSDK::Models::Course::Thumbnail, nil]
+      required :thumbnail, -> { WhopSDK::Course::Thumbnail }, nil?: true
+
+      # @!attribute title
+      #   The title of the course
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the course was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, certificate_after_completion_enabled:, chapters:, created_at:, description:, language:, require_completing_lessons_in_order:, tagline:, thumbnail:, title:, updated_at:)
+      #   Some parameter documentations has been truncated, see {WhopSDK::Models::Course}
+      #   for more details.
+      #
+      #   A course from the courses app
+      #
+      #   @param id [String] The ID of the course. Looks like cors_XXX
+      #
+      #   @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::Course::Chapter>] The chapters in this course
+      #
+      #   @param created_at [Time] The timestamp of when the course was created
+      #
+      #   @param description [String, nil] A short description of the course
+      #
+      #   @param language [Symbol, WhopSDK::Models::Languages] The language spoken in the video content of the course, used to generate closed
+      #
+      #   @param require_completing_lessons_in_order [Boolean] Whether the course requires students to complete the previous lesson before movi
+      #
+      #   @param tagline [String, nil] A short tagline for the course. It is displayed under the course title in the UI
+      #
+      #   @param thumbnail [WhopSDK::Models::Course::Thumbnail, nil] The thumbnail for the course
+      #
+      #   @param title [String, nil] The title of the course
+      #
+      #   @param updated_at [Time] The timestamp of when the course was last updated
+
+      class Chapter < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the chapter. Looks like chap_XXX
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute lessons
+        #   The lessons in this chapter
+        #
+        #   @return [Array<WhopSDK::Models::Course::Chapter::Lesson>]
+        required :lessons, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Course::Chapter::Lesson] }
+
+        # @!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
+
+        # @!method initialize(id:, lessons:, order:, title:)
+        #   A chapter from the courses app
+        #
+        #   @param id [String] The ID of the chapter. Looks like chap_XXX
+        #
+        #   @param lessons [Array<WhopSDK::Models::Course::Chapter::Lesson>] The lessons in this chapter
+        #
+        #   @param order [Integer] The order of the chapter within its course
+        #
+        #   @param title [String] The title of the chapter
+
+        class Lesson < WhopSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the lesson
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!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
+
+          # @!method initialize(id:, lesson_type:, order:, title:)
+          #   A lesson from the courses app
+          #
+          #   @param id [String] The ID of the lesson
+          #
+          #   @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
+        end
+      end
+
+      # @see WhopSDK::Models::Course#thumbnail
+      class Thumbnail < 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 optimized_url
+        #   This is the URL you use to render optimized attachments on the client. This
+        #   should be used for apps.
+        #
+        #   @return [String, nil]
+        required :optimized_url, String, nil?: true
+
+        # @!attribute source_url
+        #   The original URL of the attachment, such as a direct link to S3. This should
+        #   never be displayed on the client and always passed to an Imgproxy transformer.
+        #
+        #   @return [String, nil]
+        required :source_url, String, nil?: true
+
+        # @!method initialize(id:, content_type:, filename:, optimized_url:, source_url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Course::Thumbnail} for more details.
+        #
+        #   The thumbnail for the course
+        #
+        #   @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 optimized_url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+        #
+        #   @param source_url [String, nil] The original URL of the attachment, such as a direct link to S3. This should nev
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/course_chapter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseChapters#create
+    class CourseChapter < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the chapter. Looks like chap_XXX
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute lessons
+      #   The lessons in this chapter
+      #
+      #   @return [Array<WhopSDK::Models::CourseChapter::Lesson>]
+      required :lessons, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::CourseChapter::Lesson] }
+
+      # @!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
+
+      # @!method initialize(id:, lessons:, order:, title:)
+      #   A chapter from the courses app
+      #
+      #   @param id [String] The ID of the chapter. Looks like chap_XXX
+      #
+      #   @param lessons [Array<WhopSDK::Models::CourseChapter::Lesson>] The lessons in this chapter
+      #
+      #   @param order [Integer] The order of the chapter within its course
+      #
+      #   @param title [String] The title of the chapter
+
+      class Lesson < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the lesson
+        #
+        #   @return [String]
+        required :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:, order:, title:)
+        #   A lesson from the courses app
+        #
+        #   @param id [String] The ID of the lesson
+        #
+        #   @param order [Integer] The order of the lesson within its chapter
+        #
+        #   @param title [String] The title of the lesson
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/course_chapter_create_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseChapters#create
+    class CourseChapterCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute course_id
+      #   The ID of the course to create the chapter in
+      #
+      #   @return [String]
+      required :course_id, String
+
+      # @!attribute title
+      #   The title of the chapter
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/whop_sdk/models/course_chapter_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseChapters#delete
+    class CourseChapterDeleteParams < 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_chapter_delete_response.rb

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

data/lib/whop_sdk/models/course_chapter_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseChapters#list
+    class CourseChapterListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute course_id
+      #   The ID of the course
+      #
+      #   @return [String]
+      required :course_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
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/whop_sdk/models/course_chapter_list_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseChapters#list
+    class CourseChapterListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the chapter. Looks like chap_XXX
+      #
+      #   @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
+
+      # @!method initialize(id:, order:, title:)
+      #   A chapter from the courses app
+      #
+      #   @param id [String] The ID of the chapter. Looks like chap_XXX
+      #
+      #   @param order [Integer] The order of the chapter within its course
+      #
+      #   @param title [String] The title of the chapter
+    end
+  end
+end

data/lib/whop_sdk/models/course_chapter_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseChapters#retrieve
+    class CourseChapterRetrieveParams < 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_chapter_update_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseChapters#update
+    class CourseChapterUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute title
+      #   The title of the chapter
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!method initialize(title:, request_options: {})
+      #   @param title [String] The title of the chapter
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/course_create_params.rb

@@ -0,0 +1,82 @@
+# 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 cover_image
+      #   The cover image URL of the course
+      #
+      #   @return [String, nil]
+      optional :cover_image, String, 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, nil]
+      optional :thumbnail, -> { WhopSDK::CourseCreateParams::Thumbnail }, nil?: true
+
+      # @!method initialize(experience_id:, title:, cover_image: nil, tagline: nil, thumbnail: nil, request_options: {})
+      #   @param experience_id [String] The ID of the experience to create the course in
+      #
+      #   @param title [String] The title of the course
+      #
+      #   @param cover_image [String, nil] The cover image URL of the course
+      #
+      #   @param tagline [String, nil] The tagline of the course
+      #
+      #   @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      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::CourseCreateParams::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/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