whop_sdk 0.0.2

data/rbi/whop_sdk/models/experience.rbi

@@ -0,0 +1,292 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class Experience < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(WhopSDK::Experience, WhopSDK::Internal::AnyHash) }
+
+      # The unique ID representing this experience
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The experience interface for this experience.
+      sig { returns(WhopSDK::Experience::App) }
+      attr_reader :app
+
+      sig { params(app: WhopSDK::Experience::App::OrHash).void }
+      attr_writer :app
+
+      # The company that owns this experience.
+      sig { returns(WhopSDK::Experience::Company) }
+      attr_reader :company
+
+      sig { params(company: WhopSDK::Experience::Company::OrHash).void }
+      attr_writer :company
+
+      # The timestamp of when this experience was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The logo for the experience.
+      sig { returns(T.nilable(WhopSDK::Experience::Image)) }
+      attr_reader :image
+
+      sig { params(image: T.nilable(WhopSDK::Experience::Image::OrHash)).void }
+      attr_writer :image
+
+      # The written name of the description.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # The order of the experience in the section
+      sig { returns(T.nilable(String)) }
+      attr_accessor :order
+
+      # The access passes that are associated with this experience. This should not be
+      # used unless you are trying to list all access passes the experience has, for
+      # some reason. You probably don't want to use this though and should be using
+      # accessPass.
+      sig { returns(T::Array[WhopSDK::Experience::Product]) }
+      attr_accessor :products
+
+      # An object representing an experience belonging to a company.
+      sig do
+        params(
+          id: String,
+          app: WhopSDK::Experience::App::OrHash,
+          company: WhopSDK::Experience::Company::OrHash,
+          created_at: Time,
+          image: T.nilable(WhopSDK::Experience::Image::OrHash),
+          name: String,
+          order: T.nilable(String),
+          products: T::Array[WhopSDK::Experience::Product::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The unique ID representing this experience
+        id:,
+        # The experience interface for this experience.
+        app:,
+        # The company that owns this experience.
+        company:,
+        # The timestamp of when this experience was created.
+        created_at:,
+        # The logo for the experience.
+        image:,
+        # The written name of the description.
+        name:,
+        # The order of the experience in the section
+        order:,
+        # The access passes that are associated with this experience. This should not be
+        # used unless you are trying to list all access passes the experience has, for
+        # some reason. You probably don't want to use this though and should be using
+        # accessPass.
+        products:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            app: WhopSDK::Experience::App,
+            company: WhopSDK::Experience::Company,
+            created_at: Time,
+            image: T.nilable(WhopSDK::Experience::Image),
+            name: String,
+            order: T.nilable(String),
+            products: T::Array[WhopSDK::Experience::Product]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class App < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Experience::App, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID of the app
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The icon for the app. This icon is shown on discovery, on the product page, on
+        # checkout, and as a default icon for the experiences.
+        sig { returns(T.nilable(WhopSDK::Experience::App::Icon)) }
+        attr_reader :icon
+
+        sig do
+          params(icon: T.nilable(WhopSDK::Experience::App::Icon::OrHash)).void
+        end
+        attr_writer :icon
+
+        # The name of the app
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The experience interface for this experience.
+        sig do
+          params(
+            id: String,
+            icon: T.nilable(WhopSDK::Experience::App::Icon::OrHash),
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the app
+          id:,
+          # The icon for the app. This icon is shown on discovery, on the product page, on
+          # checkout, and as a default icon for the experiences.
+          icon:,
+          # The name of the app
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              icon: T.nilable(WhopSDK::Experience::App::Icon),
+              name: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Icon < WhopSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(WhopSDK::Experience::App::Icon, 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 icon for the app. This icon is shown on discovery, on the product page, on
+          # checkout, and as a default icon for the experiences.
+          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
+      end
+
+      class Company < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Experience::Company, WhopSDK::Internal::AnyHash)
+          end
+
+        # The ID (tag) of the company.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # 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 company that owns this experience.
+        sig do
+          params(id: String, route: String, title: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID (tag) of the company.
+          id:,
+          # The slug/route of the company on the Whop site.
+          route:,
+          # The title of the company.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, route: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class Image < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Experience::Image, 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 logo for the experience.
+        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 Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(WhopSDK::Experience::Product, WhopSDK::Internal::AnyHash)
+          end
+
+        # The internal ID of the public product.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # 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
+
+        # An object representing a (sanitized) access pass.
+        sig do
+          params(id: String, route: String, title: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The internal ID of the public product.
+          id:,
+          # The route of the product.
+          route:,
+          # The title of the product. Use for Whop 4.0.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, route: String, title: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/experience_attach_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceAttachParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceAttachParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the Access Pass to add the Experience to.
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      sig do
+        params(
+          product_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the Access Pass to add the Experience to.
+        product_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { product_id: String, request_options: WhopSDK::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/experience_create_params.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceCreateParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the app to create the experience for
+      sig { returns(String) }
+      attr_accessor :app_id
+
+      # The ID of the company to create the experience for
+      sig { returns(String) }
+      attr_accessor :company_id
+
+      # The name of the experience
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The ID of the section to create the experience in
+      sig { returns(T.nilable(String)) }
+      attr_accessor :section_id
+
+      sig do
+        params(
+          app_id: String,
+          company_id: String,
+          name: T.nilable(String),
+          section_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the app to create the experience for
+        app_id:,
+        # The ID of the company to create the experience for
+        company_id:,
+        # The name of the experience
+        name: nil,
+        # The ID of the section to create the experience in
+        section_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            app_id: String,
+            company_id: String,
+            name: T.nilable(String),
+            section_id: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/experience_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceDeleteParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceDeleteParams, 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/experience_delete_response.rbi

@@ -0,0 +1,8 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    ExperienceDeleteResponse =
+      T.let(T::Boolean, WhopSDK::Internal::Type::Converter)
+  end
+end

data/rbi/whop_sdk/models/experience_detach_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceDetachParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceDetachParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the Access Pass to add the Experience to.
+      sig { returns(String) }
+      attr_accessor :product_id
+
+      sig do
+        params(
+          product_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the Access Pass to add the Experience to.
+        product_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { product_id: String, request_options: WhopSDK::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/experience_list_params.rbi

@@ -0,0 +1,91 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class ExperienceListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::ExperienceListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to filter experiences 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
+
+      # The ID of the app to filter experiences by
+      sig { returns(T.nilable(String)) }
+      attr_accessor :app_id
+
+      # Returns the elements in the list that come before the specified cursor.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :before
+
+      # 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 ID of the product to filter experiences by
+      sig { returns(T.nilable(String)) }
+      attr_accessor :product_id
+
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          app_id: T.nilable(String),
+          before: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          product_id: T.nilable(String),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company to filter experiences by
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # The ID of the app to filter experiences by
+        app_id: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ID of the product to filter experiences by
+        product_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            after: T.nilable(String),
+            app_id: T.nilable(String),
+            before: T.nilable(String),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            product_id: T.nilable(String),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end