whop_sdk 0.0.2

data/lib/whop_sdk/models/collection_method.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The method of collection for an invoice.
+    module CollectionMethod
+      extend WhopSDK::Internal::Type::Enum
+
+      SEND_INVOICE = :send_invoice
+      CHARGE_AUTOMATICALLY = :charge_automatically
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/company.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Company < 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::Company::Logo, nil]
+      required :logo, -> { WhopSDK::Company::Logo }, nil?: true
+
+      # @!attribute member_count
+      #   The number of members in the company.
+      #
+      #   @return [Integer]
+      required :member_count, Integer
+
+      # @!attribute owner_user
+      #   The user who owns this company
+      #
+      #   @return [WhopSDK::Models::Company::OwnerUser]
+      required :owner_user, -> { WhopSDK::Company::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 social_links
+      #   The social media accounts of the company
+      #
+      #   @return [Array<WhopSDK::Models::Company::SocialLink>]
+      required :social_links, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Company::SocialLink] }
+
+      # @!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:, owner_user:, published_reviews_count:, route:, social_links:, title:, updated_at:, verified:)
+      #   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::Company::Logo, nil] The company's logo.
+      #
+      #   @param member_count [Integer] The number of members in the company.
+      #
+      #   @param owner_user [WhopSDK::Models::Company::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 social_links [Array<WhopSDK::Models::Company::SocialLink>] The social media accounts of the company
+      #
+      #   @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::Company#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::Company::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::Company#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
+
+      class SocialLink < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute url
+        #   The URL
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute website
+        #   The website
+        #
+        #   @return [Symbol, WhopSDK::Models::Company::SocialLink::Website]
+        required :website, enum: -> { WhopSDK::Company::SocialLink::Website }
+
+        # @!method initialize(id:, url:, website:)
+        #   A social link attached to a resource on the site.
+        #
+        #   @param id [String] The ID
+        #
+        #   @param url [String] The URL
+        #
+        #   @param website [Symbol, WhopSDK::Models::Company::SocialLink::Website] The website
+
+        # The website
+        #
+        # @see WhopSDK::Models::Company::SocialLink#website
+        module Website
+          extend WhopSDK::Internal::Type::Enum
+
+          X = :x
+          INSTAGRAM = :instagram
+          FACEBOOK = :facebook
+          TIKTOK = :tiktok
+          YOUTUBE = :youtube
+          LINKEDIN = :linkedin
+          TWITCH = :twitch
+          WEBSITE = :website
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/company_retrieve_params.rb

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

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class CourseLessonInteraction < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the lesson interaction
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute completed
+      #   Whether the lesson has been completed by the user
+      #
+      #   @return [Boolean]
+      required :completed, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute course
+      #   The course for this lesson interaction
+      #
+      #   @return [WhopSDK::Models::CourseLessonInteraction::Course]
+      required :course, -> { WhopSDK::CourseLessonInteraction::Course }
+
+      # @!attribute created_at
+      #   When the interaction was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute lesson
+      #   The lesson this interaction is for
+      #
+      #   @return [WhopSDK::Models::CourseLessonInteraction::Lesson]
+      required :lesson, -> { WhopSDK::CourseLessonInteraction::Lesson }
+
+      # @!attribute user
+      #   The user who interacted with the lesson
+      #
+      #   @return [WhopSDK::Models::CourseLessonInteraction::User]
+      required :user, -> { WhopSDK::CourseLessonInteraction::User }
+
+      # @!method initialize(id:, completed:, course:, created_at:, lesson:, user:)
+      #   A lesson interaction tracking user progress in courses
+      #
+      #   @param id [String] The ID of the lesson interaction
+      #
+      #   @param completed [Boolean] Whether the lesson has been completed by the user
+      #
+      #   @param course [WhopSDK::Models::CourseLessonInteraction::Course] The course for this lesson interaction
+      #
+      #   @param created_at [Time] When the interaction was created
+      #
+      #   @param lesson [WhopSDK::Models::CourseLessonInteraction::Lesson] The lesson this interaction is for
+      #
+      #   @param user [WhopSDK::Models::CourseLessonInteraction::User] The user who interacted with the lesson
+
+      # @see WhopSDK::Models::CourseLessonInteraction#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::CourseLessonInteraction::Course::Experience]
+        required :experience, -> { WhopSDK::CourseLessonInteraction::Course::Experience }
+
+        # @!attribute title
+        #   The title of the course
+        #
+        #   @return [String, nil]
+        required :title, String, nil?: true
+
+        # @!method initialize(id:, experience:, title:)
+        #   The course for this lesson interaction
+        #
+        #   @param id [String] The ID of the course. Looks like cors_XXX
+        #
+        #   @param experience [WhopSDK::Models::CourseLessonInteraction::Course::Experience] The experience that the course belongs to
+        #
+        #   @param title [String, nil] The title of the course
+
+        # @see WhopSDK::Models::CourseLessonInteraction::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::CourseLessonInteraction#lesson
+      class Lesson < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the lesson
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the lesson
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The lesson this interaction is for
+        #
+        #   @param id [String] The ID of the lesson
+        #
+        #   @param title [String] The title of the lesson
+      end
+
+      # @see WhopSDK::Models::CourseLessonInteraction#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 interacted with the lesson
+        #
+        #   @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_lesson_interaction_completed_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class CourseLessonInteractionCompletedWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   A lesson interaction tracking user progress in courses
+      #
+      #   @return [WhopSDK::Models::CourseLessonInteraction]
+      required :data, -> { WhopSDK::CourseLessonInteraction }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"course_lesson_interaction.completed"]
+      required :type, const: :"course_lesson_interaction.completed"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"course_lesson_interaction.completed")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::CourseLessonInteraction] A lesson interaction tracking user progress in courses
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"course_lesson_interaction.completed"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/course_lesson_interaction_list_item.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class CourseLessonInteractionListItem < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the lesson interaction
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute completed
+      #   Whether the lesson has been completed by the user
+      #
+      #   @return [Boolean]
+      required :completed, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute created_at
+      #   When the interaction was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute lesson
+      #   The lesson this interaction is for
+      #
+      #   @return [WhopSDK::Models::CourseLessonInteractionListItem::Lesson]
+      required :lesson, -> { WhopSDK::CourseLessonInteractionListItem::Lesson }
+
+      # @!attribute user
+      #   The user who interacted with the lesson
+      #
+      #   @return [WhopSDK::Models::CourseLessonInteractionListItem::User]
+      required :user, -> { WhopSDK::CourseLessonInteractionListItem::User }
+
+      # @!method initialize(id:, completed:, created_at:, lesson:, user:)
+      #   A lesson interaction tracking user progress in courses
+      #
+      #   @param id [String] The ID of the lesson interaction
+      #
+      #   @param completed [Boolean] Whether the lesson has been completed by the user
+      #
+      #   @param created_at [Time] When the interaction was created
+      #
+      #   @param lesson [WhopSDK::Models::CourseLessonInteractionListItem::Lesson] The lesson this interaction is for
+      #
+      #   @param user [WhopSDK::Models::CourseLessonInteractionListItem::User] The user who interacted with the lesson
+
+      # @see WhopSDK::Models::CourseLessonInteractionListItem#lesson
+      class Lesson < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the lesson
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the lesson
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The lesson this interaction is for
+        #
+        #   @param id [String] The ID of the lesson
+        #
+        #   @param title [String] The title of the lesson
+      end
+
+      # @see WhopSDK::Models::CourseLessonInteractionListItem#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 interacted with the lesson
+        #
+        #   @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_lesson_interaction_list_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::CourseLessonInteractions#list
+    class CourseLessonInteractionListParams < 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 completed
+      #   Whether the lesson has been completed by the user
+      #
+      #   @return [Boolean, nil]
+      optional :completed, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute course_id
+      #   The ID of the course to list course lesson interactions for
+      #
+      #   @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
+
+      # @!attribute lesson_id
+      #   The ID of the lesson to list course lesson interactions for
+      #
+      #   @return [String, nil]
+      optional :lesson_id, String, nil?: true
+
+      # @!attribute user_id
+      #   The ID of the user to list course lesson interactions for
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(after: nil, before: nil, completed: nil, course_id: nil, first: nil, last: nil, lesson_id: nil, user_id: 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 completed [Boolean, nil] Whether the lesson has been completed by the user
+      #
+      #   @param course_id [String, nil] The ID of the course to list course lesson interactions for
+      #
+      #   @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 lesson_id [String, nil] The ID of the lesson to list course lesson interactions for
+      #
+      #   @param user_id [String, nil] The ID of the user to list course lesson interactions for
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/course_lesson_interaction_retrieve_params.rb

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