whop_sdk 0.0.19 → 0.0.22

data/rbi/whop_sdk/models/lead_create_response.rbi

@@ -0,0 +1,234 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class LeadCreateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::LeadCreateResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the lead.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The timestamp of when the lead was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The converted member, if any.
+      sig { returns(T.nilable(WhopSDK::Models::LeadCreateResponse::Member)) }
+      attr_reader :member
+
+      sig do
+        params(
+          member: T.nilable(WhopSDK::Models::LeadCreateResponse::Member::OrHash)
+        ).void
+      end
+      attr_writer :member
+
+      # Custom metadata for the lead.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
+      # The access pass the lead is interested in, if available.
+      sig { returns(T.nilable(WhopSDK::Models::LeadCreateResponse::Product)) }
+      attr_reader :product
+
+      sig do
+        params(
+          product:
+            T.nilable(WhopSDK::Models::LeadCreateResponse::Product::OrHash)
+        ).void
+      end
+      attr_writer :product
+
+      # The referrer URL that brought this lead.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :referrer
+
+      # The timestamp of when the lead was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # The user who is the lead.
+      sig { returns(WhopSDK::Models::LeadCreateResponse::User) }
+      attr_reader :user
+
+      sig do
+        params(user: WhopSDK::Models::LeadCreateResponse::User::OrHash).void
+      end
+      attr_writer :user
+
+      # An object representing a lead (someone who is interested in a whop).
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          member:
+            T.nilable(WhopSDK::Models::LeadCreateResponse::Member::OrHash),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          product:
+            T.nilable(WhopSDK::Models::LeadCreateResponse::Product::OrHash),
+          referrer: T.nilable(String),
+          updated_at: Time,
+          user: WhopSDK::Models::LeadCreateResponse::User::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the lead.
+        id:,
+        # The timestamp of when the lead was created.
+        created_at:,
+        # The converted member, if any.
+        member:,
+        # Custom metadata for the lead.
+        metadata:,
+        # The access pass the lead is interested in, if available.
+        product:,
+        # The referrer URL that brought this lead.
+        referrer:,
+        # The timestamp of when the lead was last updated.
+        updated_at:,
+        # The user who is the lead.
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            member: T.nilable(WhopSDK::Models::LeadCreateResponse::Member),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            product: T.nilable(WhopSDK::Models::LeadCreateResponse::Product),
+            referrer: T.nilable(String),
+            updated_at: Time,
+            user: WhopSDK::Models::LeadCreateResponse::User
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Member < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::LeadCreateResponse::Member,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the member
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The converted member, if any.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the member
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::LeadCreateResponse::Product,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the public product.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the product. Use for Whop 4.0.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The access pass the lead is interested in, if available.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The internal ID of the public product.
+          id:,
+          # The title of the product. Use for Whop 4.0.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::LeadCreateResponse::User,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The email of the user
+        sig { returns(T.nilable(String)) }
+        attr_accessor :email
+
+        # 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 is the lead.
+        sig do
+          params(
+            id: String,
+            email: T.nilable(String),
+            name: T.nilable(String),
+            username: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The email of the user
+          email:,
+          # 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,
+              email: T.nilable(String),
+              name: T.nilable(String),
+              username: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/lead_list_params.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class LeadListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::LeadListParams, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the company to list leads for
+      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 minimum creation date to filter by
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_after
+
+      # The maximum creation date to filter by
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_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 product IDs to filter the leads by
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :product_ids
+
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          created_after: T.nilable(Time),
+          created_before: T.nilable(Time),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          product_ids: T.nilable(T::Array[String]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the company to list leads for
+        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 minimum creation date to filter by
+        created_after: nil,
+        # The maximum creation date to filter by
+        created_before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The product IDs to filter the leads by
+        product_ids: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_id: String,
+            after: T.nilable(String),
+            before: T.nilable(String),
+            created_after: T.nilable(Time),
+            created_before: T.nilable(Time),
+            first: T.nilable(Integer),
+            last: T.nilable(Integer),
+            product_ids: T.nilable(T::Array[String]),
+            request_options: WhopSDK::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/lead_list_response.rbi

@@ -0,0 +1,230 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class LeadListResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(WhopSDK::Models::LeadListResponse, WhopSDK::Internal::AnyHash)
+        end
+
+      # The ID of the lead.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The timestamp of when the lead was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The converted member, if any.
+      sig { returns(T.nilable(WhopSDK::Models::LeadListResponse::Member)) }
+      attr_reader :member
+
+      sig do
+        params(
+          member: T.nilable(WhopSDK::Models::LeadListResponse::Member::OrHash)
+        ).void
+      end
+      attr_writer :member
+
+      # Custom metadata for the lead.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metadata
+
+      # The access pass the lead is interested in, if available.
+      sig { returns(T.nilable(WhopSDK::Models::LeadListResponse::Product)) }
+      attr_reader :product
+
+      sig do
+        params(
+          product: T.nilable(WhopSDK::Models::LeadListResponse::Product::OrHash)
+        ).void
+      end
+      attr_writer :product
+
+      # The referrer URL that brought this lead.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :referrer
+
+      # The timestamp of when the lead was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # The user who is the lead.
+      sig { returns(WhopSDK::Models::LeadListResponse::User) }
+      attr_reader :user
+
+      sig { params(user: WhopSDK::Models::LeadListResponse::User::OrHash).void }
+      attr_writer :user
+
+      # An object representing a lead (someone who is interested in a whop).
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          member: T.nilable(WhopSDK::Models::LeadListResponse::Member::OrHash),
+          metadata: T.nilable(T::Hash[Symbol, T.anything]),
+          product:
+            T.nilable(WhopSDK::Models::LeadListResponse::Product::OrHash),
+          referrer: T.nilable(String),
+          updated_at: Time,
+          user: WhopSDK::Models::LeadListResponse::User::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of the lead.
+        id:,
+        # The timestamp of when the lead was created.
+        created_at:,
+        # The converted member, if any.
+        member:,
+        # Custom metadata for the lead.
+        metadata:,
+        # The access pass the lead is interested in, if available.
+        product:,
+        # The referrer URL that brought this lead.
+        referrer:,
+        # The timestamp of when the lead was last updated.
+        updated_at:,
+        # The user who is the lead.
+        user:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            member: T.nilable(WhopSDK::Models::LeadListResponse::Member),
+            metadata: T.nilable(T::Hash[Symbol, T.anything]),
+            product: T.nilable(WhopSDK::Models::LeadListResponse::Product),
+            referrer: T.nilable(String),
+            updated_at: Time,
+            user: WhopSDK::Models::LeadListResponse::User
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Member < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::LeadListResponse::Member,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the member
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The converted member, if any.
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # The ID of the member
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+
+      class Product < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::LeadListResponse::Product,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the public product.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The title of the product. Use for Whop 4.0.
+        sig { returns(String) }
+        attr_accessor :title
+
+        # The access pass the lead is interested in, if available.
+        sig { params(id: String, title: String).returns(T.attached_class) }
+        def self.new(
+          # The internal ID of the public product.
+          id:,
+          # The title of the product. Use for Whop 4.0.
+          title:
+        )
+        end
+
+        sig { override.returns({ id: String, title: String }) }
+        def to_hash
+        end
+      end
+
+      class User < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::LeadListResponse::User,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The internal ID of the user.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The email of the user
+        sig { returns(T.nilable(String)) }
+        attr_accessor :email
+
+        # 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 is the lead.
+        sig do
+          params(
+            id: String,
+            email: T.nilable(String),
+            name: T.nilable(String),
+            username: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The internal ID of the user.
+          id:,
+          # The email of the user
+          email:,
+          # 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,
+              email: T.nilable(String),
+              name: T.nilable(String),
+              username: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models/lead_retrieve_params.rbi

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