whop_sdk 0.0.15 → 0.0.17

data/rbi/whop_sdk/models/withdrawal_create_response.rbi

@@ -0,0 +1,564 @@
+# typed: strong
+
+module WhopSDK
+  module Models
+    class WithdrawalCreateResponse < WhopSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            WhopSDK::Models::WithdrawalCreateResponse,
+            WhopSDK::Internal::AnyHash
+          )
+        end
+
+      # Internal ID of the withdrawal request.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # How much money was attempted to be withdrawn, in a float type.
+      sig { returns(Float) }
+      attr_accessor :amount
+
+      # When the withdrawal request was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The currency of the withdrawal request.
+      sig { returns(WhopSDK::Currency::TaggedSymbol) }
+      attr_accessor :currency
+
+      # The different error codes a payout can be in.
+      sig do
+        returns(
+          T.nilable(
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :error_code
+
+      # The error message for the withdrawal, if any.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :error_message
+
+      # The estimated availability date for the withdrawal, if any.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :estimated_availability
+
+      # The fee amount that was charged for the withdrawal. This is in the same currency
+      # as the withdrawal amount.
+      sig { returns(Float) }
+      attr_accessor :fee_amount
+
+      # The different fee types for a withdrawal.
+      sig { returns(T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol)) }
+      attr_accessor :fee_type
+
+      # The ledger account associated with the withdrawal.
+      sig { returns(WhopSDK::Models::WithdrawalCreateResponse::LedgerAccount) }
+      attr_reader :ledger_account
+
+      sig do
+        params(
+          ledger_account:
+            WhopSDK::Models::WithdrawalCreateResponse::LedgerAccount::OrHash
+        ).void
+      end
+      attr_writer :ledger_account
+
+      # The markup fee that was charged for the withdrawal. This is in the same currency
+      # as the withdrawal amount. This only applies to platform accounts using Whop
+      # Rails.
+      sig { returns(Float) }
+      attr_accessor :markup_fee
+
+      # The payout token used for the withdrawal, if applicable.
+      sig do
+        returns(
+          T.nilable(WhopSDK::Models::WithdrawalCreateResponse::PayoutToken)
+        )
+      end
+      attr_reader :payout_token
+
+      sig do
+        params(
+          payout_token:
+            T.nilable(
+              WhopSDK::Models::WithdrawalCreateResponse::PayoutToken::OrHash
+            )
+        ).void
+      end
+      attr_writer :payout_token
+
+      # The speed of the withdrawal.
+      sig { returns(WhopSDK::WithdrawalSpeeds::TaggedSymbol) }
+      attr_accessor :speed
+
+      # Status of the withdrawal.
+      sig { returns(WhopSDK::WithdrawalStatus::TaggedSymbol) }
+      attr_accessor :status
+
+      # The trace code for the payout, if applicable. Provided on ACH transactions when
+      # available.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :trace_code
+
+      # The type of withdrawal.
+      sig { returns(WhopSDK::WithdrawalTypes::TaggedSymbol) }
+      attr_accessor :withdrawal_type
+
+      # A withdrawal request.
+      sig do
+        params(
+          id: String,
+          amount: Float,
+          created_at: Time,
+          currency: WhopSDK::Currency::OrSymbol,
+          error_code:
+            T.nilable(
+              WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::OrSymbol
+            ),
+          error_message: T.nilable(String),
+          estimated_availability: T.nilable(Time),
+          fee_amount: Float,
+          fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::OrSymbol),
+          ledger_account:
+            WhopSDK::Models::WithdrawalCreateResponse::LedgerAccount::OrHash,
+          markup_fee: Float,
+          payout_token:
+            T.nilable(
+              WhopSDK::Models::WithdrawalCreateResponse::PayoutToken::OrHash
+            ),
+          speed: WhopSDK::WithdrawalSpeeds::OrSymbol,
+          status: WhopSDK::WithdrawalStatus::OrSymbol,
+          trace_code: T.nilable(String),
+          withdrawal_type: WhopSDK::WithdrawalTypes::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Internal ID of the withdrawal request.
+        id:,
+        # How much money was attempted to be withdrawn, in a float type.
+        amount:,
+        # When the withdrawal request was created.
+        created_at:,
+        # The currency of the withdrawal request.
+        currency:,
+        # The different error codes a payout can be in.
+        error_code:,
+        # The error message for the withdrawal, if any.
+        error_message:,
+        # The estimated availability date for the withdrawal, if any.
+        estimated_availability:,
+        # The fee amount that was charged for the withdrawal. This is in the same currency
+        # as the withdrawal amount.
+        fee_amount:,
+        # The different fee types for a withdrawal.
+        fee_type:,
+        # The ledger account associated with the withdrawal.
+        ledger_account:,
+        # The markup fee that was charged for the withdrawal. This is in the same currency
+        # as the withdrawal amount. This only applies to platform accounts using Whop
+        # Rails.
+        markup_fee:,
+        # The payout token used for the withdrawal, if applicable.
+        payout_token:,
+        # The speed of the withdrawal.
+        speed:,
+        # Status of the withdrawal.
+        status:,
+        # The trace code for the payout, if applicable. Provided on ACH transactions when
+        # available.
+        trace_code:,
+        # The type of withdrawal.
+        withdrawal_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            amount: Float,
+            created_at: Time,
+            currency: WhopSDK::Currency::TaggedSymbol,
+            error_code:
+              T.nilable(
+                WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+              ),
+            error_message: T.nilable(String),
+            estimated_availability: T.nilable(Time),
+            fee_amount: Float,
+            fee_type: T.nilable(WhopSDK::WithdrawalFeeTypes::TaggedSymbol),
+            ledger_account:
+              WhopSDK::Models::WithdrawalCreateResponse::LedgerAccount,
+            markup_fee: Float,
+            payout_token:
+              T.nilable(WhopSDK::Models::WithdrawalCreateResponse::PayoutToken),
+            speed: WhopSDK::WithdrawalSpeeds::TaggedSymbol,
+            status: WhopSDK::WithdrawalStatus::TaggedSymbol,
+            trace_code: T.nilable(String),
+            withdrawal_type: WhopSDK::WithdrawalTypes::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The different error codes a payout can be in.
+      module ErrorCode
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::Models::WithdrawalCreateResponse::ErrorCode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACCOUNT_CLOSED =
+          T.let(
+            :account_closed,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        ACCOUNT_DOES_NOT_EXIST =
+          T.let(
+            :account_does_not_exist,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        ACCOUNT_INFORMATION_INVALID =
+          T.let(
+            :account_information_invalid,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        ACCOUNT_NUMBER_INVALID_REGION =
+          T.let(
+            :account_number_invalid_region,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        ACCOUNT_FROZEN =
+          T.let(
+            :account_frozen,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        ACCOUNT_LOOKUP_FAILED =
+          T.let(
+            :account_lookup_failed,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        ACCOUNT_NOT_FOUND =
+          T.let(
+            :account_not_found,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        AMOUNT_OUT_OF_BOUNDS =
+          T.let(
+            :amount_out_of_bounds,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        ATTRIBUTES_NOT_VALIDATED =
+          T.let(
+            :attributes_not_validated,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        B2B_PAYMENTS_PROHIBITED =
+          T.let(
+            :b2b_payments_prohibited,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        BANK_STATEMENT_REQUIRED =
+          T.let(
+            :bank_statement_required,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        COMPLIANCE_REVIEW =
+          T.let(
+            :compliance_review,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        CURRENCY_NOT_SUPPORTED =
+          T.let(
+            :currency_not_supported,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        DEPOSIT_CANCELED =
+          T.let(
+            :deposit_canceled,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        DEPOSIT_FAILED =
+          T.let(
+            :deposit_failed,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        DEPOSIT_REJECTED =
+          T.let(
+            :deposit_rejected,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        DESTINATION_UNAVAILABLE =
+          T.let(
+            :destination_unavailable,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        EXCEEDED_ACCOUNT_LIMIT =
+          T.let(
+            :exceeded_account_limit,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        EXPIRED_QUOTE =
+          T.let(
+            :expired_quote,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        GENERIC_PAYOUT_ERROR =
+          T.let(
+            :generic_payout_error,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        TECHNICAL_PROBLEM =
+          T.let(
+            :technical_problem,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        IDENTIFICATION_NUMBER_INVALID =
+          T.let(
+            :identification_number_invalid,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_ACCOUNT_NUMBER =
+          T.let(
+            :invalid_account_number,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_BANK_CODE =
+          T.let(
+            :invalid_bank_code,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_BENEFICIARY =
+          T.let(
+            :invalid_beneficiary,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_BRANCH_NUMBER =
+          T.let(
+            :invalid_branch_number,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_BRANCH_CODE =
+          T.let(
+            :invalid_branch_code,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_PHONE_NUMBER =
+          T.let(
+            :invalid_phone_number,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_ROUTING_NUMBER =
+          T.let(
+            :invalid_routing_number,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_SWIFT_CODE =
+          T.let(
+            :invalid_swift_code,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        INVALID_COMPANY_DETAILS =
+          T.let(
+            :invalid_company_details,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        MANUAL_CANCELATION =
+          T.let(
+            :manual_cancelation,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        MISC_ERROR =
+          T.let(
+            :misc_error,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        MISSING_CITY_AND_COUNTRY =
+          T.let(
+            :missing_city_and_country,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        MISSING_PHONE_NUMBER =
+          T.let(
+            :missing_phone_number,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        MISSING_REMITTANCE_INFO =
+          T.let(
+            :missing_remittance_info,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        PAYEE_NAME_INVALID =
+          T.let(
+            :payee_name_invalid,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        RECEIVING_ACCOUNT_LOCKED =
+          T.let(
+            :receiving_account_locked,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        REJECTED_BY_COMPLIANCE =
+          T.let(
+            :rejected_by_compliance,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        RTP_NOT_SUPPORTED =
+          T.let(
+            :rtp_not_supported,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        NON_TRANSACTION_ACCOUNT =
+          T.let(
+            :non_transaction_account,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        SOURCE_TOKEN_INSUFFICIENT_FUNDS =
+          T.let(
+            :source_token_insufficient_funds,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        SSN_INVALID =
+          T.let(
+            :ssn_invalid,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        WALLET_SCREENSHOT_REQUIRED =
+          T.let(
+            :wallet_screenshot_required,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+        UNSUPPORTED_REGION =
+          T.let(
+            :unsupported_region,
+            WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::Models::WithdrawalCreateResponse::ErrorCode::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class LedgerAccount < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::WithdrawalCreateResponse::LedgerAccount,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the LedgerAccount.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The ID of the company associated with this ledger account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :company_id
+
+        # The ledger account associated with the withdrawal.
+        sig do
+          params(id: String, company_id: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID of the LedgerAccount.
+          id:,
+          # The ID of the company associated with this ledger account.
+          company_id:
+        )
+        end
+
+        sig { override.returns({ id: String, company_id: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+
+      class PayoutToken < WhopSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              WhopSDK::Models::WithdrawalCreateResponse::PayoutToken,
+              WhopSDK::Internal::AnyHash
+            )
+          end
+
+        # The ID of the payout token
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The date and time the payout token was created
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The currency code of the payout destination. This is the currency that payouts
+        # will be made in for this token.
+        sig { returns(String) }
+        attr_accessor :destination_currency_code
+
+        # An optional nickname for the payout token to help the user identify it. This is
+        # not used by the provider and is only for the user's reference.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :nickname
+
+        # The name of the payer associated with the payout token.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payer_name
+
+        # The payout token used for the withdrawal, if applicable.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            destination_currency_code: String,
+            nickname: T.nilable(String),
+            payer_name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the payout token
+          id:,
+          # The date and time the payout token was created
+          created_at:,
+          # The currency code of the payout destination. This is the currency that payouts
+          # will be made in for this token.
+          destination_currency_code:,
+          # An optional nickname for the payout token to help the user identify it. This is
+          # not used by the provider and is only for the user's reference.
+          nickname:,
+          # The name of the payer associated with the payout token.
+          payer_name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              destination_currency_code: String,
+              nickname: T.nilable(String),
+              payer_name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/whop_sdk/models.rbi

@@ -330,6 +330,8 @@ module WhopSDK
 
   PaymentFailedWebhookEvent = WhopSDK::Models::PaymentFailedWebhookEvent
 
+  PaymentListFeesParams = WhopSDK::Models::PaymentListFeesParams
+
   PaymentListParams = WhopSDK::Models::PaymentListParams
 
   PaymentMethodListParams = WhopSDK::Models::PaymentMethodListParams
@@ -352,6 +354,8 @@ module WhopSDK
 
   PaymentVoidParams = WhopSDK::Models::PaymentVoidParams
 
+  PayoutMethodListParams = WhopSDK::Models::PayoutMethodListParams
+
   Plan = WhopSDK::Models::Plan
 
   PlanCreateParams = WhopSDK::Models::PlanCreateParams
@@ -499,6 +503,8 @@ module WhopSDK
 
   WithdrawalCreatedWebhookEvent = WhopSDK::Models::WithdrawalCreatedWebhookEvent
 
+  WithdrawalCreateParams = WhopSDK::Models::WithdrawalCreateParams
+
   WithdrawalFeeTypes = WhopSDK::Models::WithdrawalFeeTypes
 
   WithdrawalListParams = WhopSDK::Models::WithdrawalListParams

data/rbi/whop_sdk/resources/payment_methods.rbi

@@ -17,7 +17,7 @@ module WhopSDK
           id: String,
           member_id: String,
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Models::PaymentMethodRetrieveResponse)
+        ).returns(WhopSDK::Models::PaymentMethodRetrieveResponse::Variants)
       end
       def retrieve(
         # The ID of the PaymentMethod
@@ -50,7 +50,7 @@ module WhopSDK
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[
-            WhopSDK::Models::PaymentMethodListResponse
+            WhopSDK::Models::PaymentMethodListResponse::Variants
           ]
         )
       end

data/rbi/whop_sdk/resources/payments.rbi

@@ -144,6 +144,40 @@ module WhopSDK
       )
       end
 
+      # Lists fees for a payment
+      #
+      # Required permissions:
+      #
+      # - `payment:basic:read`
+      sig do
+        params(
+          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::PaymentListFeesResponse
+          ]
+        )
+      end
+      def list_fees(
+        # The ID of the payment to list fees for
+        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
+
       # Refunds a payment
       #
       # Required permissions:

data/rbi/whop_sdk/resources/payout_methods.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class PayoutMethods
+      # Lists payout destinations for a company
+      #
+      # 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 company ID 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