whop_sdk 0.0.2 → 0.0.4

data/rbi/whop_sdk/models/company_list_params.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CompanyListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::CompanyListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the parent company to list sub companies for
+      sig { returns(String) }
+      attr_accessor :parent_company_id
+
+      # Returns the elements in the list that come after the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # The direction of the sort.
+      sig { returns(T.nilable(WhopSDK::Direction::OrSymbol)) }
+      attr_accessor :direction
+
+      # Returns the first _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :first
+
+      # Returns the last _n_ elements from the list.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last
+
+      sig do
+        params(
+          parent_company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the parent company to list sub companies for
+        parent_company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            parent_company_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            direction: T.nilable(WhopSDK::Direction::OrSymbol),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/company_list_response.rbi

@@ -0,0 +1,235 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class CompanyListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::CompanyListResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # The ID (tag) of the company.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The different business types a company can be.
+      sig { returns(T.nilable(WhopSDK::BusinessTypes::TaggedSymbol)) }
+      attr_accessor :business_type
+
+      # When the company was created (signed up)
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The creator pitch for the company.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The different industry types a company can be in.
+      sig { returns(T.nilable(WhopSDK::IndustryTypes::TaggedSymbol)) }
+      attr_accessor :industry_type
+
+      # The company's logo.
+      sig { returns(T.nilable(WhopSDK::Models::CompanyListResponse::Logo)) }
+      attr_reader :logo
+
+      sig do
+        params(
+          logo: T.nilable(WhopSDK::Models::CompanyListResponse::Logo::OrHash)
+        ).void
+      end
+      attr_writer :logo
+
+      # The number of members in the company.
+      sig { returns(Integer) }
+      attr_accessor :member_count
+
+      # A key-value store of data for the account, created/updated by the platform that
+      # made the account.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
+      # The user who owns this company
+      sig { returns(WhopSDK::Models::CompanyListResponse::OwnerUser) }
+      attr_reader :owner_user
+
+      sig do
+        params(
+          owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser::OrHash
+        ).void
+      end
+      attr_writer :owner_user
+
+      # The number of reviews that have been published for the company.
+      sig { returns(Integer) }
+      attr_accessor :published_reviews_count
+
+      # The slug/route of the company on the Whop site.
+      sig { returns(String) }
+      attr_accessor :route
+
+      # The title of the company.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # The time the company was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # If the company is Whop Verified
+      sig { returns(T::Boolean) }
+      attr_accessor :verified
+
+      # An object representing a (sanitized) company.
+      sig do
+        params(
+          id: String,
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          created_at: Time,
+          description: T.nilable(String),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+          logo: T.nilable(WhopSDK::Models::CompanyListResponse::Logo::OrHash),
+          member_count: Integer,
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser::OrHash,
+          published_reviews_count: Integer,
+          route: String,
+          title: String,
+          updated_at: Time,
+          verified: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID (tag) of the company.
+        id:,
+        # The different business types a company can be.
+        business_type:,
+        # When the company was created (signed up)
+        created_at:,
+        # The creator pitch for the company.
+        description:,
+        # The different industry types a company can be in.
+        industry_type:,
+        # The company's logo.
+        logo:,
+        # The number of members in the company.
+        member_count:,
+        # A key-value store of data for the account, created/updated by the platform that
+        # made the account.
+        metadata:,
+        # The user who owns this company
+        owner_user:,
+        # The number of reviews that have been published for the company.
+        published_reviews_count:,
+        # The slug/route of the company on the Whop site.
+        route:,
+        # The title of the company.
+        title:,
+        # The time the company was last updated.
+        updated_at:,
+        # If the company is Whop Verified
+        verified:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            business_type: T.nilable(WhopSDK::BusinessTypes::TaggedSymbol),
+            created_at: Time,
+            description: T.nilable(String),
+            industry_type: T.nilable(WhopSDK::IndustryTypes::TaggedSymbol),
+            logo: T.nilable(WhopSDK::Models::CompanyListResponse::Logo),
+            member_count: Integer,
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            owner_user: WhopSDK::Models::CompanyListResponse::OwnerUser,
+            published_reviews_count: Integer,
+            route: String,
+            title: String,
+            updated_at: Time,
+            verified: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Logo < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CompanyListResponse::Logo,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # The company's logo.
+        sig { params(url: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          url:
+        )
+        end
+
+        sig { override.returns({ url: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+
+      class OwnerUser < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::CompanyListResponse::OwnerUser,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The name of the user from their Whop account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The username of the user from their Whop account.
+        sig { returns(String) }
+        attr_accessor :username
+
+        # The user who owns this company
+        sig do
+          params(id: String, name: T.nilable(String), username: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The name of the user from their Whop account.
+          name:,
+          # The username of the user from their Whop account.
+          username:
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, name: T.nilable(String), username: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/course.rbi

@@ -0,0 +1,313 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Course < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Course, WhopSDK::Internal::AnyHash) }
+
+      # The ID of the course. Looks like cors_XXX
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Whether the course will award its students a PDF certificate after completing
+      # all lessons
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :certificate_after_completion_enabled
+
+      # The chapters in this course
+      sig { returns(T::Array[WhopSDK::Course::Chapter]) }
+      attr_accessor :chapters
+
+      # The timestamp of when the course was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # A short description of the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The language spoken in the video content of the course, used to generate closed
+      # captions in the right language
+      sig { returns(WhopSDK::Languages::TaggedSymbol) }
+      attr_accessor :language
+
+      # Whether the course requires students to complete the previous lesson before
+      # moving on to the next one
+      sig { returns(T::Boolean) }
+      attr_accessor :require_completing_lessons_in_order
+
+      # A short tagline for the course. It is displayed under the course title in the UI
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tagline
+
+      # The thumbnail for the course
+      sig { returns(T.nilable(WhopSDK::Course::Thumbnail)) }
+      attr_reader :thumbnail
+
+      sig do
+        params(thumbnail: T.nilable(WhopSDK::Course::Thumbnail::OrHash)).void
+      end
+      attr_writer :thumbnail
+
+      # The title of the course
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # The timestamp of when the course was last updated
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # A course from the courses app
+      sig do
+        params(
+          id: String,
+          certificate_after_completion_enabled: T.nilable(T::Boolean),
+          chapters: T::Array[WhopSDK::Course::Chapter::OrHash],
+          created_at: Time,
+          description: T.nilable(String),
+          language: WhopSDK::Languages::OrSymbol,
+          require_completing_lessons_in_order: T::Boolean,
+          tagline: T.nilable(String),
+          thumbnail: T.nilable(WhopSDK::Course::Thumbnail::OrHash),
+          title: T.nilable(String),
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the course. Looks like cors_XXX
+        id:,
+        # Whether the course will award its students a PDF certificate after completing
+        # all lessons
+        certificate_after_completion_enabled:,
+        # The chapters in this course
+        chapters:,
+        # The timestamp of when the course was created
+        created_at:,
+        # A short description of the course
+        description:,
+        # The language spoken in the video content of the course, used to generate closed
+        # captions in the right language
+        language:,
+        # Whether the course requires students to complete the previous lesson before
+        # moving on to the next one
+        require_completing_lessons_in_order:,
+        # A short tagline for the course. It is displayed under the course title in the UI
+        tagline:,
+        # The thumbnail for the course
+        thumbnail:,
+        # The title of the course
+        title:,
+        # The timestamp of when the course was last updated
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            certificate_after_completion_enabled: T.nilable(T::Boolean),
+            chapters: T::Array[WhopSDK::Course::Chapter],
+            created_at: Time,
+            description: T.nilable(String),
+            language: WhopSDK::Languages::TaggedSymbol,
+            require_completing_lessons_in_order: T::Boolean,
+            tagline: T.nilable(String),
+            thumbnail: T.nilable(WhopSDK::Course::Thumbnail),
+            title: T.nilable(String),
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Chapter < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Course::Chapter, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the chapter. Looks like chap_XXX
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The lessons in this chapter
+        sig { returns(T::Array[WhopSDK::Course::Chapter::Lesson]) }
+        attr_accessor :lessons
+
+        # The order of the chapter within its course
+        sig { returns(Integer) }
+        attr_accessor :order
+
+        # The title of the chapter
+        sig { returns(String) }
+        attr_accessor :title
+
+        # A chapter from the courses app
+        sig do
+          params(
+            id: String,
+            lessons: T::Array[WhopSDK::Course::Chapter::Lesson::OrHash],
+            order: Integer,
+            title: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the chapter. Looks like chap_XXX
+          id:,
+          # The lessons in this chapter
+          lessons:,
+          # The order of the chapter within its course
+          order:,
+          # The title of the chapter
+          title:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              lessons: T::Array[WhopSDK::Course::Chapter::Lesson],
+              order: Integer,
+              title: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Lesson < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                WhopSDK::Course::Chapter::Lesson,
+                WhopSDK::Internal::AnyHash
+              )
+            end
+
+          # The ID of the lesson
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+          sig { returns(WhopSDK::LessonTypes::TaggedSymbol) }
+          attr_accessor :lesson_type
+
+          # The order of the lesson within its chapter
+          sig { returns(Integer) }
+          attr_accessor :order
+
+          # The title of the lesson
+          sig { returns(String) }
+          attr_accessor :title
+
+          # A lesson from the courses app
+          sig do
+            params(
+              id: String,
+              lesson_type: WhopSDK::LessonTypes::OrSymbol,
+              order: Integer,
+              title: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ID of the lesson
+            id:,
+            # The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+            lesson_type:,
+            # The order of the lesson within its chapter
+            order:,
+            # The title of the lesson
+            title:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                lesson_type: WhopSDK::LessonTypes::TaggedSymbol,
+                order: Integer,
+                title: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Thumbnail < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Course::Thumbnail, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the attachment
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The attachment's content type (e.g., image/jpg, video/mp4)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :content_type
+
+        # The name of the file
+        sig { returns(T.nilable(String)) }
+        attr_accessor :filename
+
+        # This is the URL you use to render optimized attachments on the client. This
+        # should be used for apps.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :optimized_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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :source_url
+
+        # The thumbnail for the course
+        sig do
+          params(
+            id: String,
+            content_type: T.nilable(String),
+            filename: T.nilable(String),
+            optimized_url: T.nilable(String),
+            source_url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the attachment
+          id:,
+          # The attachment's content type (e.g., image/jpg, video/mp4)
+          content_type:,
+          # The name of the file
+          filename:,
+          # This is the URL you use to render optimized attachments on the client. This
+          # should be used for apps.
+          optimized_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.
+          source_url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content_type: T.nilable(String),
+              filename: T.nilable(String),
+              optimized_url: T.nilable(String),
+              source_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end