whop_sdk 0.0.2

data/rbi/whop_sdk/models/product_list_item.rbi

@@ -0,0 +1,126 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ProductListItem < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ProductListItem, WhopSDK::Internal::AnyHash)
+        end
+
+      # The internal ID of the public product.
+      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 product was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The headline of the product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :headline
+
+      # The different industry types a company can be in.
+      sig { returns(T.nilable(WhopSDK::IndustryTypes::TaggedSymbol)) }
+      attr_accessor :industry_type
+
+      # The number of active users for this product.
+      sig { returns(Integer) }
+      attr_accessor :member_count
+
+      # The number of reviews that have been published for the product.
+      sig { returns(Integer) }
+      attr_accessor :published_reviews_count
+
+      # The route of the product.
+      sig { returns(String) }
+      attr_accessor :route
+
+      # The title of the product. Use for Whop 4.0.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # When the product was updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Whether this product is Whop verified.
+      sig { returns(T::Boolean) }
+      attr_accessor :verified
+
+      # This product will/will not be displayed publicly.
+      sig { returns(WhopSDK::Visibility::TaggedSymbol) }
+      attr_accessor :visibility
+
+      # An object representing a (sanitized) access pass.
+      sig do
+        params(
+          id: String,
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          created_at: Time,
+          headline: T.nilable(String),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+          member_count: Integer,
+          published_reviews_count: Integer,
+          route: String,
+          title: String,
+          updated_at: Time,
+          verified: T::Boolean,
+          visibility: WhopSDK::Visibility::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The internal ID of the public product.
+        id:,
+        # The different business types a company can be.
+        business_type:,
+        # When the product was created.
+        created_at:,
+        # The headline of the product.
+        headline:,
+        # The different industry types a company can be in.
+        industry_type:,
+        # The number of active users for this product.
+        member_count:,
+        # The number of reviews that have been published for the product.
+        published_reviews_count:,
+        # The route of the product.
+        route:,
+        # The title of the product. Use for Whop 4.0.
+        title:,
+        # When the product was updated.
+        updated_at:,
+        # Whether this product is Whop verified.
+        verified:,
+        # This product will/will not be displayed publicly.
+        visibility:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            business_type: T.nilable(WhopSDK::BusinessTypes::TaggedSymbol),
+            created_at: Time,
+            headline: T.nilable(String),
+            industry_type: T.nilable(WhopSDK::IndustryTypes::TaggedSymbol),
+            member_count: Integer,
+            published_reviews_count: Integer,
+            route: String,
+            title: String,
+            updated_at: Time,
+            verified: T::Boolean,
+            visibility: WhopSDK::Visibility::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/product_list_params.rbi

@@ -0,0 +1,142 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ProductListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ProductListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to filter products by
+      sig { returns(String) }
+      attr_accessor :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
+
+      # The ways a relation of AccessPasses can be ordered
+      sig { returns(T.nilable(WhopSDK::ProductListParams::Order::OrSymbol)) }
+      attr_accessor :order
+
+      # The type of products to filter by
+      sig { returns(T.nilable(T::Array[WhopSDK::AccessPassType::OrSymbol])) }
+      attr_accessor :product_types
+
+      # The visibility of the products to filter by
+      sig { returns(T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol])) }
+      attr_accessor :visibilities
+
+      sig do
+        params(
+          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),
+          order: T.nilable(WhopSDK::ProductListParams::Order::OrSymbol),
+          product_types: T.nilable(T::Array[WhopSDK::AccessPassType::OrSymbol]),
+          visibilities:
+            T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company to filter products by
+        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,
+        # The ways a relation of AccessPasses can be ordered
+        order: nil,
+        # The type of products to filter by
+        product_types: nil,
+        # The visibility of the products to filter by
+        visibilities: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            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),
+            order: T.nilable(WhopSDK::ProductListParams::Order::OrSymbol),
+            product_types:
+              T.nilable(T::Array[WhopSDK::AccessPassType::OrSymbol]),
+            visibilities:
+              T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The ways a relation of AccessPasses can be ordered
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::ProductListParams::Order) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE_MEMBERSHIPS_COUNT =
+          T.let(
+            :active_memberships_count,
+            WhopSDK::ProductListParams::Order::TaggedSymbol
+          )
+        CREATED_AT =
+          T.let(:created_at, WhopSDK::ProductListParams::Order::TaggedSymbol)
+        USD_GMV =
+          T.let(:usd_gmv, WhopSDK::ProductListParams::Order::TaggedSymbol)
+        USD_GMV_30_DAYS =
+          T.let(
+            :usd_gmv_30_days,
+            WhopSDK::ProductListParams::Order::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::ProductListParams::Order::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/product_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ProductRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ProductRetrieveParams, WhopSDK::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: WhopSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: WhopSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/product_update_params.rbi

@@ -0,0 +1,245 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ProductUpdateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ProductUpdateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # A banner image for the product in png, jpeg format
+      sig { returns(T.nilable(WhopSDK::ProductUpdateParams::BannerImage)) }
+      attr_reader :banner_image
+
+      sig do
+        params(
+          banner_image:
+            T.nilable(WhopSDK::ProductUpdateParams::BannerImage::OrHash)
+        ).void
+      end
+      attr_writer :banner_image
+
+      # The different business types a company can be.
+      sig { returns(T.nilable(WhopSDK::BusinessTypes::OrSymbol)) }
+      attr_accessor :business_type
+
+      # Whether or not to collect shipping information at checkout from the customer.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :collect_shipping_address
+
+      # The different types of custom CTAs that can be selected.
+      sig { returns(T.nilable(WhopSDK::CustomCta::OrSymbol)) }
+      attr_accessor :custom_cta
+
+      # The custom call to action URL for the product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :custom_cta_url
+
+      # The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+      # between 5 and 22 characters, contain at least one letter, and not contain any of
+      # the following characters: <, >, \, ', "
+      sig { returns(T.nilable(String)) }
+      attr_accessor :custom_statement_descriptor
+
+      # A written description of the product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # The percentage of the revenue that goes to the global affiliate program.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :global_affiliate_percentage
+
+      # The different statuses of the global affiliate program for an access pass.
+      sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
+      attr_accessor :global_affiliate_status
+
+      # The headline of the product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :headline
+
+      # The different industry types a company can be in.
+      sig { returns(T.nilable(WhopSDK::IndustryTypes::OrSymbol)) }
+      attr_accessor :industry_type
+
+      # The percentage of the revenue that goes to the member affiliate program.
+      sig { returns(T.nilable(Float)) }
+      attr_accessor :member_affiliate_percentage
+
+      # The different statuses of the global affiliate program for an access pass.
+      sig { returns(T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol)) }
+      attr_accessor :member_affiliate_status
+
+      # The ID of the product tax code to apply to this product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_tax_code_id
+
+      # The URL to redirect the customer to after a purchase.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :redirect_purchase_url
+
+      # The route of the product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :route
+
+      # The title of the product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :title
+
+      # Visibility of a resource
+      sig { returns(T.nilable(WhopSDK::Visibility::OrSymbol)) }
+      attr_accessor :visibility
+
+      sig do
+        params(
+          banner_image:
+            T.nilable(WhopSDK::ProductUpdateParams::BannerImage::OrHash),
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          collect_shipping_address: T.nilable(T::Boolean),
+          custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
+          custom_cta_url: T.nilable(String),
+          custom_statement_descriptor: T.nilable(String),
+          description: T.nilable(String),
+          global_affiliate_percentage: T.nilable(Float),
+          global_affiliate_status:
+            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          headline: T.nilable(String),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+          member_affiliate_percentage: T.nilable(Float),
+          member_affiliate_status:
+            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          product_tax_code_id: T.nilable(String),
+          redirect_purchase_url: T.nilable(String),
+          route: T.nilable(String),
+          title: T.nilable(String),
+          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A banner image for the product in png, jpeg format
+        banner_image: nil,
+        # The different business types a company can be.
+        business_type: nil,
+        # Whether or not to collect shipping information at checkout from the customer.
+        collect_shipping_address: nil,
+        # The different types of custom CTAs that can be selected.
+        custom_cta: nil,
+        # The custom call to action URL for the product.
+        custom_cta_url: nil,
+        # The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+        # between 5 and 22 characters, contain at least one letter, and not contain any of
+        # the following characters: <, >, \, ', "
+        custom_statement_descriptor: nil,
+        # A written description of the product.
+        description: nil,
+        # The percentage of the revenue that goes to the global affiliate program.
+        global_affiliate_percentage: nil,
+        # The different statuses of the global affiliate program for an access pass.
+        global_affiliate_status: nil,
+        # The headline of the product.
+        headline: nil,
+        # The different industry types a company can be in.
+        industry_type: nil,
+        # The percentage of the revenue that goes to the member affiliate program.
+        member_affiliate_percentage: nil,
+        # The different statuses of the global affiliate program for an access pass.
+        member_affiliate_status: nil,
+        # The ID of the product tax code to apply to this product.
+        product_tax_code_id: nil,
+        # The URL to redirect the customer to after a purchase.
+        redirect_purchase_url: nil,
+        # The route of the product.
+        route: nil,
+        # The title of the product.
+        title: nil,
+        # Visibility of a resource
+        visibility: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            banner_image: T.nilable(WhopSDK::ProductUpdateParams::BannerImage),
+            business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+            collect_shipping_address: T.nilable(T::Boolean),
+            custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
+            custom_cta_url: T.nilable(String),
+            custom_statement_descriptor: T.nilable(String),
+            description: T.nilable(String),
+            global_affiliate_percentage: T.nilable(Float),
+            global_affiliate_status:
+              T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+            headline: T.nilable(String),
+            industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+            member_affiliate_percentage: T.nilable(Float),
+            member_affiliate_status:
+              T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+            product_tax_code_id: T.nilable(String),
+            redirect_purchase_url: T.nilable(String),
+            route: T.nilable(String),
+            title: T.nilable(String),
+            visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class BannerImage < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::ProductUpdateParams::BannerImage,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :direct_upload_id
+
+        # A banner image for the product in png, jpeg format
+        sig do
+          params(
+            id: T.nilable(String),
+            direct_upload_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          id: nil,
+          # 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.
+          direct_upload_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: T.nilable(String), direct_upload_id: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/promo_type.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    # The type of promo code used to discount a plan
+    module PromoType
+      extend WhopSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::PromoType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      PERCENTAGE = T.let(:percentage, WhopSDK::PromoType::TaggedSymbol)
+      FLAT_AMOUNT = T.let(:flat_amount, WhopSDK::PromoType::TaggedSymbol)
+
+      sig { override.returns(T::Array[WhopSDK::PromoType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/reaction.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Reaction < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Reaction, WhopSDK::Internal::AnyHash) }
+
+      # The unique identifier for the entity
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The emoji that was used in shortcode format (:heart:)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :emoji
+
+      # The ID of the post this reaction belongs to
+      sig { returns(String) }
+      attr_accessor :resource_id
+
+      # The user who reacted to the post
+      sig { returns(WhopSDK::Reaction::User) }
+      attr_reader :user
+
+      sig { params(user: WhopSDK::Reaction::User::OrHash).void }
+      attr_writer :user
+
+      # Represents a reaction to a feed post
+      sig do
+        params(
+          id: String,
+          emoji: T.nilable(String),
+          resource_id: String,
+          user: WhopSDK::Reaction::User::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique identifier for the entity
+        id:,
+        # The emoji that was used in shortcode format (:heart:)
+        emoji:,
+        # The ID of the post this reaction belongs to
+        resource_id:,
+        # The user who reacted to the post
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            emoji: T.nilable(String),
+            resource_id: String,
+            user: WhopSDK::Reaction::User
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Reaction::User, 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 reacted to the post
+        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