whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/models/transfer.rbi

@@ -1,407 +0,0 @@
-# typed: strong
-
-module WhopSDK
-  module Models
-    class Transfer < WhopSDK::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias { T.any(WhopSDK::Transfer, WhopSDK::Internal::AnyHash) }
-
-      # The unique identifier for the credit transaction transfer.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The transfer amount in the currency specified by the currency field. For
-      # example, 10.43 represents $10.43 USD.
-      sig { returns(Float) }
-      attr_accessor :amount
-
-      # The datetime the credit transaction transfer was created.
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # The currency in which this transfer amount is denominated.
-      sig { returns(WhopSDK::Currency::TaggedSymbol) }
-      attr_accessor :currency
-
-      # The entity receiving the transferred funds.
-      sig { returns(T.nilable(WhopSDK::Transfer::Destination::Variants)) }
-      attr_accessor :destination
-
-      # The unique identifier of the ledger account receiving the funds.
-      sig { returns(String) }
-      attr_accessor :destination_ledger_account_id
-
-      # The flat fee amount deducted from this transfer, in the transfer's currency.
-      # Null if no flat fee was applied.
-      sig { returns(T.nilable(Float)) }
-      attr_accessor :fee_amount
-
-      # Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
-      # characters per key, 5000 characters per value.
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_accessor :metadata
-
-      # A free-text note attached to this transfer by the sender. Null if no note was
-      # provided.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :notes
-
-      # The entity that sent the transferred funds.
-      sig { returns(T.nilable(WhopSDK::Transfer::Origin::Variants)) }
-      attr_accessor :origin
-
-      # The unique identifier of the ledger account that sent the funds.
-      sig { returns(String) }
-      attr_accessor :origin_ledger_account_id
-
-      # A transfer of credit between two ledger accounts.
-      sig do
-        params(
-          id: String,
-          amount: Float,
-          created_at: Time,
-          currency: WhopSDK::Currency::OrSymbol,
-          destination:
-            T.nilable(
-              T.any(
-                WhopSDK::Transfer::Destination::User::OrHash,
-                WhopSDK::Transfer::Destination::Company::OrHash
-              )
-            ),
-          destination_ledger_account_id: String,
-          fee_amount: T.nilable(Float),
-          metadata: T.nilable(T::Hash[Symbol, T.anything]),
-          notes: T.nilable(String),
-          origin:
-            T.nilable(
-              T.any(
-                WhopSDK::Transfer::Origin::User::OrHash,
-                WhopSDK::Transfer::Origin::Company::OrHash
-              )
-            ),
-          origin_ledger_account_id: String
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The unique identifier for the credit transaction transfer.
-        id:,
-        # The transfer amount in the currency specified by the currency field. For
-        # example, 10.43 represents $10.43 USD.
-        amount:,
-        # The datetime the credit transaction transfer was created.
-        created_at:,
-        # The currency in which this transfer amount is denominated.
-        currency:,
-        # The entity receiving the transferred funds.
-        destination:,
-        # The unique identifier of the ledger account receiving the funds.
-        destination_ledger_account_id:,
-        # The flat fee amount deducted from this transfer, in the transfer's currency.
-        # Null if no flat fee was applied.
-        fee_amount:,
-        # Custom key-value pairs attached to this transfer. Maximum 50 keys, 500
-        # characters per key, 5000 characters per value.
-        metadata:,
-        # A free-text note attached to this transfer by the sender. Null if no note was
-        # provided.
-        notes:,
-        # The entity that sent the transferred funds.
-        origin:,
-        # The unique identifier of the ledger account that sent the funds.
-        origin_ledger_account_id:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            amount: Float,
-            created_at: Time,
-            currency: WhopSDK::Currency::TaggedSymbol,
-            destination: T.nilable(WhopSDK::Transfer::Destination::Variants),
-            destination_ledger_account_id: String,
-            fee_amount: T.nilable(Float),
-            metadata: T.nilable(T::Hash[Symbol, T.anything]),
-            notes: T.nilable(String),
-            origin: T.nilable(WhopSDK::Transfer::Origin::Variants),
-            origin_ledger_account_id: String
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # The entity receiving the transferred funds.
-      module Destination
-        extend WhopSDK::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.nilable(
-              T.any(
-                WhopSDK::Transfer::Destination::User,
-                WhopSDK::Transfer::Destination::Company
-              )
-            )
-          end
-
-        class User < WhopSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                WhopSDK::Transfer::Destination::User,
-                WhopSDK::Internal::AnyHash
-              )
-            end
-
-          # The unique identifier for the user.
-          sig { returns(String) }
-          attr_accessor :id
-
-          # The user's display name shown on their public profile.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :name
-
-          # The typename of this object
-          sig { returns(Symbol) }
-          attr_accessor :typename
-
-          # The user's unique username shown on their public profile.
-          sig { returns(String) }
-          attr_accessor :username
-
-          # A user account on Whop. Contains profile information, identity details, and
-          # social connections.
-          sig do
-            params(
-              id: String,
-              name: T.nilable(String),
-              username: String,
-              typename: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The unique identifier for the user.
-            id:,
-            # The user's display name shown on their public profile.
-            name:,
-            # The user's unique username shown on their public profile.
-            username:,
-            # The typename of this object
-            typename: :User
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                name: T.nilable(String),
-                typename: Symbol,
-                username: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        class Company < WhopSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                WhopSDK::Transfer::Destination::Company,
-                WhopSDK::Internal::AnyHash
-              )
-            end
-
-          # The unique identifier for the company.
-          sig { returns(String) }
-          attr_accessor :id
-
-          # The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
-          sig { returns(String) }
-          attr_accessor :route
-
-          # The display name of the company shown to customers.
-          sig { returns(String) }
-          attr_accessor :title
-
-          # The typename of this object
-          sig { returns(Symbol) }
-          attr_accessor :typename
-
-          # A company is a seller on Whop. Companies own products, manage members, and
-          # receive payouts.
-          sig do
-            params(
-              id: String,
-              route: String,
-              title: String,
-              typename: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The unique identifier for the company.
-            id:,
-            # The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
-            route:,
-            # The display name of the company shown to customers.
-            title:,
-            # The typename of this object
-            typename: :Company
-          )
-          end
-
-          sig do
-            override.returns(
-              { id: String, route: String, title: String, typename: Symbol }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        sig do
-          override.returns(T::Array[WhopSDK::Transfer::Destination::Variants])
-        end
-        def self.variants
-        end
-      end
-
-      # The entity that sent the transferred funds.
-      module Origin
-        extend WhopSDK::Internal::Type::Union
-
-        Variants =
-          T.type_alias do
-            T.nilable(
-              T.any(
-                WhopSDK::Transfer::Origin::User,
-                WhopSDK::Transfer::Origin::Company
-              )
-            )
-          end
-
-        class User < WhopSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(WhopSDK::Transfer::Origin::User, WhopSDK::Internal::AnyHash)
-            end
-
-          # The unique identifier for the user.
-          sig { returns(String) }
-          attr_accessor :id
-
-          # The user's display name shown on their public profile.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :name
-
-          # The typename of this object
-          sig { returns(Symbol) }
-          attr_accessor :typename
-
-          # The user's unique username shown on their public profile.
-          sig { returns(String) }
-          attr_accessor :username
-
-          # A user account on Whop. Contains profile information, identity details, and
-          # social connections.
-          sig do
-            params(
-              id: String,
-              name: T.nilable(String),
-              username: String,
-              typename: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The unique identifier for the user.
-            id:,
-            # The user's display name shown on their public profile.
-            name:,
-            # The user's unique username shown on their public profile.
-            username:,
-            # The typename of this object
-            typename: :User
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                name: T.nilable(String),
-                typename: Symbol,
-                username: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        class Company < WhopSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                WhopSDK::Transfer::Origin::Company,
-                WhopSDK::Internal::AnyHash
-              )
-            end
-
-          # The unique identifier for the company.
-          sig { returns(String) }
-          attr_accessor :id
-
-          # The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
-          sig { returns(String) }
-          attr_accessor :route
-
-          # The display name of the company shown to customers.
-          sig { returns(String) }
-          attr_accessor :title
-
-          # The typename of this object
-          sig { returns(Symbol) }
-          attr_accessor :typename
-
-          # A company is a seller on Whop. Companies own products, manage members, and
-          # receive payouts.
-          sig do
-            params(
-              id: String,
-              route: String,
-              title: String,
-              typename: Symbol
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The unique identifier for the company.
-            id:,
-            # The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
-            route:,
-            # The display name of the company shown to customers.
-            title:,
-            # The typename of this object
-            typename: :Company
-          )
-          end
-
-          sig do
-            override.returns(
-              { id: String, route: String, title: String, typename: Symbol }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        sig { override.returns(T::Array[WhopSDK::Transfer::Origin::Variants]) }
-        def self.variants
-        end
-      end
-    end
-  end
-end

data/rbi/whop_sdk/models/user_list_response.rbi

@@ -1,124 +0,0 @@
-# typed: strong
-
-module WhopSDK
-  module Models
-    class UserListResponse < WhopSDK::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(WhopSDK::Models::UserListResponse, WhopSDK::Internal::AnyHash)
-        end
-
-      # The unique identifier for the user.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # A short biography written by the user, displayed on their public profile.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :bio
-
-      # The datetime the user was created.
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # The user's display name shown on their public profile.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :name
-
-      # The user's profile picture attachment with URL, content type, and file metadata.
-      # Null if using a legacy profile picture.
-      sig do
-        returns(T.nilable(WhopSDK::Models::UserListResponse::ProfilePicture))
-      end
-      attr_reader :profile_picture
-
-      sig do
-        params(
-          profile_picture:
-            T.nilable(WhopSDK::Models::UserListResponse::ProfilePicture::OrHash)
-        ).void
-      end
-      attr_writer :profile_picture
-
-      # The user's unique username shown on their public profile.
-      sig { returns(String) }
-      attr_accessor :username
-
-      # A user account on Whop. Contains profile information, identity details, and
-      # social connections.
-      sig do
-        params(
-          id: String,
-          bio: T.nilable(String),
-          created_at: Time,
-          name: T.nilable(String),
-          profile_picture:
-            T.nilable(
-              WhopSDK::Models::UserListResponse::ProfilePicture::OrHash
-            ),
-          username: String
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The unique identifier for the user.
-        id:,
-        # A short biography written by the user, displayed on their public profile.
-        bio:,
-        # The datetime the user was created.
-        created_at:,
-        # The user's display name shown on their public profile.
-        name:,
-        # The user's profile picture attachment with URL, content type, and file metadata.
-        # Null if using a legacy profile picture.
-        profile_picture:,
-        # The user's unique username shown on their public profile.
-        username:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            bio: T.nilable(String),
-            created_at: Time,
-            name: T.nilable(String),
-            profile_picture:
-              T.nilable(WhopSDK::Models::UserListResponse::ProfilePicture),
-            username: String
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class ProfilePicture < WhopSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              WhopSDK::Models::UserListResponse::ProfilePicture,
-              WhopSDK::Internal::AnyHash
-            )
-          end
-
-        # A pre-optimized URL for rendering this attachment on the client. This should be
-        # used for displaying attachments in apps.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :url
-
-        # The user's profile picture attachment with URL, content type, and file metadata.
-        # Null if using a legacy profile picture.
-        sig { params(url: T.nilable(String)).returns(T.attached_class) }
-        def self.new(
-          # A pre-optimized URL for rendering this attachment on the client. This should be
-          # used for displaying attachments in apps.
-          url:
-        )
-        end
-
-        sig { override.returns({ url: T.nilable(String) }) }
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/whop_sdk/resources/conversions.rbi

@@ -1,71 +0,0 @@
-# typed: strong
-
-module WhopSDK
-  module Resources
-    # Conversions
-    class Conversions
-      # Track a conversion or engagement event for a company.
-      #
-      # Required permissions:
-      #
-      # - `event:create`
-      sig do
-        params(
-          company_id: String,
-          event_name: WhopSDK::ConversionCreateParams::EventName::OrSymbol,
-          action_source:
-            T.nilable(WhopSDK::ConversionCreateParams::ActionSource::OrSymbol),
-          context: T.nilable(WhopSDK::ConversionCreateParams::Context::OrHash),
-          currency: T.nilable(WhopSDK::Currency::OrSymbol),
-          custom_name: T.nilable(String),
-          event_id: T.nilable(String),
-          event_time: T.nilable(Time),
-          plan_id: T.nilable(String),
-          product_id: T.nilable(String),
-          referrer_url: T.nilable(String),
-          url: T.nilable(String),
-          user: T.nilable(WhopSDK::ConversionCreateParams::User::OrHash),
-          value: T.nilable(Float),
-          request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Models::ConversionCreateResponse)
-      end
-      def create(
-        # The company to associate with this event.
-        company_id:,
-        # The type of event.
-        event_name:,
-        # The channel where an event originated
-        action_source: nil,
-        # Tracking and attribution context.
-        context: nil,
-        # The available currencies on the platform
-        currency: nil,
-        # Custom event name when event_name is 'custom'.
-        custom_name: nil,
-        # Client-provided identifier for deduplication. Generated if omitted.
-        event_id: nil,
-        # When the event occurred. Defaults to now.
-        event_time: nil,
-        # The plan associated with the event.
-        plan_id: nil,
-        # The product associated with the event.
-        product_id: nil,
-        # The referring URL.
-        referrer_url: nil,
-        # The URL where the event occurred.
-        url: nil,
-        # User identity and profile data.
-        user: nil,
-        # Monetary value associated with the event.
-        value: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/whop_sdk/resources/payout_methods.rbi

@@ -1,66 +0,0 @@
-# typed: strong
-
-module WhopSDK
-  module Resources
-    # Payout methods
-    class PayoutMethods
-      # Retrieves the details of an existing payout method.
-      #
-      # Required permissions:
-      #
-      # - `payout:destination:read`
-      sig do
-        params(
-          id: String,
-          request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Models::PayoutMethodRetrieveResponse)
-      end
-      def retrieve(
-        # The unique identifier of the payout method to retrieve.
-        id,
-        request_options: {}
-      )
-      end
-
-      # Returns a list of active payout methods configured for a company, ordered by
-      # most recently created.
-      #
-      # Required permissions:
-      #
-      # - `payout:destination:read`
-      sig do
-        params(
-          company_id: String,
-          after: T.nilable(String),
-          before: T.nilable(String),
-          first: T.nilable(Integer),
-          last: T.nilable(Integer),
-          request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(
-          WhopSDK::Internal::CursorPage[
-            WhopSDK::Models::PayoutMethodListResponse
-          ]
-        )
-      end
-      def list(
-        # The unique identifier of the company to list payout methods 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,
-        # Returns the first _n_ elements from the list.
-        first: nil,
-        # Returns the last _n_ elements from the list.
-        last: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end