whop_sdk 0.0.3 → 0.0.4

data/lib/whop_sdk/models/company_list_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Companies#list
+    class CompanyListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute parent_company_id
+      #   The ID of the parent company to list sub companies for
+      #
+      #   @return [String]
+      required :parent_company_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 direction
+      #   The direction of the sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::Direction }, 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(parent_company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
+      #   @param parent_company_id [String] The ID of the parent company to list sub companies for
+      #
+      #   @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 direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      #   @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/company_list_response.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Companies#list
+    class CompanyListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID (tag) of the company.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute business_type
+      #   The different business types a company can be.
+      #
+      #   @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
+      required :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
+
+      # @!attribute created_at
+      #   When the company was created (signed up)
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The creator pitch for the company.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute industry_type
+      #   The different industry types a company can be in.
+      #
+      #   @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
+      required :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
+
+      # @!attribute logo
+      #   The company's logo.
+      #
+      #   @return [WhopSDK::Models::CompanyListResponse::Logo, nil]
+      required :logo, -> { WhopSDK::Models::CompanyListResponse::Logo }, nil?: true
+
+      # @!attribute member_count
+      #   The number of members in the company.
+      #
+      #   @return [Integer]
+      required :member_count, Integer
+
+      # @!attribute metadata
+      #   A key-value store of data for the account, created/updated by the platform that
+      #   made the account.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+      # @!attribute owner_user
+      #   The user who owns this company
+      #
+      #   @return [WhopSDK::Models::CompanyListResponse::OwnerUser]
+      required :owner_user, -> { WhopSDK::Models::CompanyListResponse::OwnerUser }
+
+      # @!attribute published_reviews_count
+      #   The number of reviews that have been published for the company.
+      #
+      #   @return [Integer]
+      required :published_reviews_count, Integer
+
+      # @!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
+
+      # @!attribute updated_at
+      #   The time the company was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute verified
+      #   If the company is Whop Verified
+      #
+      #   @return [Boolean]
+      required :verified, WhopSDK::Internal::Type::Boolean
+
+      # @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, title:, updated_at:, verified:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CompanyListResponse} for more details.
+      #
+      #   An object representing a (sanitized) company.
+      #
+      #   @param id [String] The ID (tag) of the company.
+      #
+      #   @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
+      #
+      #   @param created_at [Time] When the company was created (signed up)
+      #
+      #   @param description [String, nil] The creator pitch for the company.
+      #
+      #   @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
+      #
+      #   @param logo [WhopSDK::Models::CompanyListResponse::Logo, nil] The company's logo.
+      #
+      #   @param member_count [Integer] The number of members in the company.
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] A key-value store of data for the account, created/updated by the platform that
+      #
+      #   @param owner_user [WhopSDK::Models::CompanyListResponse::OwnerUser] The user who owns this company
+      #
+      #   @param published_reviews_count [Integer] The number of reviews that have been published for the company.
+      #
+      #   @param route [String] The slug/route of the company on the Whop site.
+      #
+      #   @param title [String] The title of the company.
+      #
+      #   @param updated_at [Time] The time the company was last updated.
+      #
+      #   @param verified [Boolean] If the company is Whop Verified
+
+      # @see WhopSDK::Models::CompanyListResponse#logo
+      class Logo < WhopSDK::Internal::Type::BaseModel
+        # @!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(url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::CompanyListResponse::Logo} for more details.
+        #
+        #   The company's logo.
+        #
+        #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+      end
+
+      # @see WhopSDK::Models::CompanyListResponse#owner_user
+      class OwnerUser < 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 owns this company
+        #
+        #   @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_create_params.rb

@@ -19,12 +19,26 @@ module WhopSDK
       #   @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
       #
@@ -34,48 +48,79 @@ module WhopSDK
       # @!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
+      #   @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:, cover_image: nil, tagline: nil, thumbnail: nil, request_options: {})
+      # @!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, nil] The thumbnail for the course in png, jpeg, or gif format
+      #   @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}]
 
-      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
+      # 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