whop_sdk 1.0.13 → 1.1.0

data/lib/whop_sdk/exports/types/list_exports_request_resource.rb

@@ -18,8 +18,6 @@ module Whop_sdk
         DISPUTES = "disputes"
         EVENTS = "events"
         FINANCIAL_ACTIVITY = "financial-activity"
-        MEMBERS = "members"
-        MEMBERSHIPS = "memberships"
         PAYOUT_METHODS = "payout_methods"
         PAYOUTS = "payouts"
         PEOPLE = "people"
@@ -31,8 +29,10 @@ module Whop_sdk
         TEAM_MEMBERS = "team_members"
         TRANSFERS = "transfers"
         WEBHOOKS = "webhooks"
+        MEMBERS = "members"
         RECEIPTS = "receipts"
         UNCLAIMED_MEMBERSHIPS = "unclaimed_memberships"
+        MEMBERSHIPS = "memberships"
         TRACKING_LINKS = "tracking_links"
         PROMO_CODES = "promo_codes"
         RESOLUTIONS = "resolutions"

data/lib/whop_sdk/files/client.rb

@@ -10,7 +10,75 @@ module Whop_sdk
         @client = client
       end
 
-      # Create a new file record and receive a presigned URL for uploading content to S3.
+      # Returns the files with the given IDs, newest first — fetch a batch in one request instead of retrieving each
+      # file individually. Only files you created are returned; IDs that do not exist, or that another credential
+      # created, are omitted. A request for up to 100 IDs answers in a single page by default; a larger batch pages at
+      # up to 100 files per response — follow `page_info` with the same `file_ids` to walk the rest.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :file_ids
+      # @option params [Whop_sdk::Files::Types::ListFilesRequestOrder, nil] :order
+      # @option params [Whop_sdk::Files::Types::ListFilesRequestDirection, nil] :direction
+      # @option params [Integer, nil] :first
+      # @option params [String, nil] :after
+      # @option params [Integer, nil] :last
+      # @option params [String, nil] :before
+      #
+      # @example
+      #   client.files.list(file_ids: ["file_xxxxxxxxxxxxx"])
+      #
+      # @return [Whop_sdk::Files::Types::ListFilesResponse]
+      def list(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["file_ids"] = params[:file_ids] if params.key?(:file_ids)
+        query_params["order"] = params[:order] if params.key?(:order)
+        query_params["direction"] = params[:direction] if params.key?(:direction)
+        query_params["first"] = params[:first] if params.key?(:first)
+        query_params["after"] = params[:after] if params.key?(:after)
+        query_params["last"] = params[:last] if params.key?(:last)
+        query_params["before"] = params[:before] if params.key?(:before)
+
+        Whop_sdk::Internal::CursorItemIterator.new(
+          cursor_field: :end_cursor,
+          item_field: :data,
+          initial_cursor: query_params["after"]
+        ) do |next_cursor|
+          query_params["after"] = next_cursor
+          request = Whop_sdk::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "files",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Whop_sdk::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            parsed_response = Whop_sdk::Files::Types::ListFilesResponse.load(response.body)
+            [parsed_response, response]
+          else
+            error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+
+      # Creates a file and returns a presigned destination to upload its bytes to. PUT the bytes to `upload_url`
+      # (single-part), or to each of `multipart_upload_urls` and then call Complete File Multipart Upload. Once the
+      # bytes land the file becomes `ready`, and its ID can be attached wherever a file is accepted — account legal
+      # documents, dispute evidence documents. For a step-by-step walkthrough of single-part and multipart uploads, see
+      # the [direct file uploads guide](/developer/guides/direct-file-uploads).
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Files::Types::CreateFilesRequest]
@@ -21,9 +89,9 @@ module Whop_sdk
       # @option request_options [Integer] :timeout_in_seconds
       #
       # @example
-      #   client.files.create(filename: "filename")
+      #   client.files.create(filename: "terms.pdf")
       #
-      # @return [Whop_sdk::Files::Types::CreateFilesResponse]
+      # @return [Whop_sdk::Types::File]
       def create(request_options: {}, **params)
         params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
         request = Whop_sdk::Internal::JSON::Request.new(
@@ -40,14 +108,15 @@ module Whop_sdk
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Whop_sdk::Files::Types::CreateFilesResponse.load(response.body)
+          Whop_sdk::Types::File.load(response.body)
         else
           error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
         end
       end
 
-      # Retrieves the details of an existing file.
+      # Retrieves a file you uploaded — poll it after uploading the bytes to see `upload_status` become `ready`. Only
+      # the creator can retrieve a file this way; a file attached to another resource is read through that resource.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -59,7 +128,7 @@ module Whop_sdk
       # @option params [String] :id
       #
       # @example
-      #   client.files.retrieve(id: "file_xxxxxxxxxxxxx")
+      #   client.files.retrieve(id: "id")
       #
       # @return [Whop_sdk::Types::File]
       def retrieve(request_options: {}, **params)
@@ -83,6 +152,57 @@ module Whop_sdk
           raise error_class.new(response.body, code: code)
         end
       end
+
+      # Assembles the parts of a multipart upload after every part has been PUT to its presigned URL. Pass the
+      # `multipart_upload_id` from Create File and each part's `ETag` response header. For a step-by-step walkthrough of
+      # multipart uploads, see the [direct file uploads guide](/developer/guides/direct-file-uploads).
+      #
+      # @param request_options [Hash]
+      # @param params [Whop_sdk::Files::Types::CompleteFilesRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :id
+      #
+      # @example
+      #   client.files.complete(
+      #     id: "id",
+      #     multipart_parts: [{
+      #       etag: "etag-1",
+      #       part_number: 1
+      #     }],
+      #     multipart_upload_id: "upload-id"
+      #   )
+      #
+      # @return [Whop_sdk::Types::File]
+      def complete(request_options: {}, **params)
+        params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+        request_data = Whop_sdk::Files::Types::CompleteFilesRequest.new(params).to_h
+        non_body_param_names = %w[id]
+        body = request_data.except(*non_body_param_names)
+
+        request = Whop_sdk::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "files/#{URI.encode_uri_component(params[:id].to_s)}/complete",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Whop_sdk::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Whop_sdk::Types::File.load(response.body)
+        else
+          error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
     end
   end
 end

data/lib/whop_sdk/files/types/complete_files_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      class CompleteFilesRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+
+        field :multipart_parts, -> { Internal::Types::Array[Whop_sdk::Files::Types::CompleteFilesRequestMultipartPartsItem] }, optional: false, nullable: false
+
+        field :multipart_upload_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/files/types/complete_files_request_multipart_parts_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      class CompleteFilesRequestMultipartPartsItem < Internal::Types::Model
+        field :etag, -> { String }, optional: false, nullable: false
+
+        field :part_number, -> { Integer }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/files/types/create_files_request.rb

@@ -4,9 +4,13 @@ module Whop_sdk
   module Files
     module Types
       class CreateFilesRequest < Internal::Types::Model
+        field :byte_size, -> { Integer }, optional: true, nullable: false
+
         field :filename, -> { String }, optional: false, nullable: false
 
-        field :visibility, -> { Whop_sdk::Types::FileVisibility }, optional: true, nullable: false
+        field :multipart, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :visibility, -> { Whop_sdk::Files::Types::CreateFilesRequestVisibility }, optional: true, nullable: false
       end
     end
   end

data/lib/whop_sdk/files/types/create_files_request_visibility.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      module CreateFilesRequestVisibility
+        extend Whop_sdk::Internal::Types::Enum
+
+        PUBLIC = "public"
+        PRIVATE = "private"
+      end
+    end
+  end
+end

data/lib/whop_sdk/files/types/list_files_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      class ListFilesRequest < Internal::Types::Model
+        field :file_ids, -> { String }, optional: true, nullable: false
+
+        field :order, -> { Whop_sdk::Files::Types::ListFilesRequestOrder }, optional: true, nullable: false
+
+        field :direction, -> { Whop_sdk::Files::Types::ListFilesRequestDirection }, optional: true, nullable: false
+
+        field :first, -> { Integer }, optional: true, nullable: false
+
+        field :after, -> { String }, optional: true, nullable: false
+
+        field :last, -> { Integer }, optional: true, nullable: false
+
+        field :before, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/files/types/list_files_request_direction.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      module ListFilesRequestDirection
+        extend Whop_sdk::Internal::Types::Enum
+
+        ASC = "asc"
+        DESC = "desc"
+      end
+    end
+  end
+end

data/lib/whop_sdk/files/types/list_files_request_order.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      module ListFilesRequestOrder
+        extend Whop_sdk::Internal::Types::Enum
+
+        CREATED_AT = "created_at"
+      end
+    end
+  end
+end

data/lib/whop_sdk/files/types/list_files_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      class ListFilesResponse < Internal::Types::Model
+        field :data, -> { Internal::Types::Array[Whop_sdk::Types::File] }, optional: false, nullable: false
+
+        field :page_info, -> { Whop_sdk::Files::Types::ListFilesResponsePageInfo }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/whop_sdk/files/types/list_files_response_page_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Files
+    module Types
+      class ListFilesResponsePageInfo < Internal::Types::Model
+        field :end_cursor, -> { String }, optional: false, nullable: true
+
+        field :has_next_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :has_previous_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :start_cursor, -> { String }, optional: false, nullable: true
+      end
+    end
+  end
+end

data/lib/whop_sdk/financial_activity/client.rb

@@ -24,6 +24,9 @@ module Whop_sdk
       # @option params [Boolean, nil] :include_owned_accounts
       # @option params [Boolean, nil] :include_resource
       # @option params [Whop_sdk::FinancialActivity::Types::ListFinancialActivityRequestLineTypesItem, nil] :line_types
+      # @option params [Whop_sdk::FinancialActivity::Types::ListFinancialActivityRequestDirection, nil] :direction
+      # @option params [String, nil] :resource_id
+      # @option params [String, nil] :activity_id
       # @option params [String, nil] :currency
       # @option params [String, nil] :posted_after
       # @option params [String, nil] :posted_before
@@ -44,6 +47,9 @@ module Whop_sdk
         query_params["include_owned_accounts"] = params[:include_owned_accounts] if params.key?(:include_owned_accounts)
         query_params["include_resource"] = params[:include_resource] if params.key?(:include_resource)
         query_params["line_types"] = params[:line_types] if params.key?(:line_types)
+        query_params["direction"] = params[:direction] if params.key?(:direction)
+        query_params["resource_id"] = params[:resource_id] if params.key?(:resource_id)
+        query_params["activity_id"] = params[:activity_id] if params.key?(:activity_id)
         query_params["currency"] = params[:currency] if params.key?(:currency)
         query_params["posted_after"] = params[:posted_after] if params.key?(:posted_after)
         query_params["posted_before"] = params[:posted_before] if params.key?(:posted_before)

data/lib/whop_sdk/financial_activity/types/list_financial_activity_request.rb

@@ -14,6 +14,12 @@ module Whop_sdk
 
         field :line_types, -> { Whop_sdk::FinancialActivity::Types::ListFinancialActivityRequestLineTypesItem }, optional: true, nullable: false
 
+        field :direction, -> { Whop_sdk::FinancialActivity::Types::ListFinancialActivityRequestDirection }, optional: true, nullable: false
+
+        field :resource_id, -> { String }, optional: true, nullable: false
+
+        field :activity_id, -> { String }, optional: true, nullable: false
+
         field :currency, -> { String }, optional: true, nullable: false
 
         field :posted_after, -> { String }, optional: true, nullable: false

data/lib/whop_sdk/financial_activity/types/list_financial_activity_request_direction.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module FinancialActivity
+    module Types
+      module ListFinancialActivityRequestDirection
+        extend Whop_sdk::Internal::Types::Enum
+
+        MONEY_IN = "money_in"
+        MONEY_OUT = "money_out"
+      end
+    end
+  end
+end

data/lib/whop_sdk/financial_activity/types/list_financial_activity_request_line_types_item.rb

@@ -19,19 +19,28 @@ module Whop_sdk
         AIRDROP_REVERSAL = "airdrop_reversal"
         APPLICATION_FEE = "application_fee"
         APPLICATION_FEE_PAYOUT = "application_fee_payout"
+        BALANCE_RESERVATION = "balance_reservation"
+        BALANCE_RESERVATION_REVERSAL = "balance_reservation_reversal"
         BANK_TRANSFER = "bank_transfer"
         BILLING_PERCENTAGE_FEE = "billing_percentage_fee"
         BUYER_FEE = "buyer_fee"
+        CARD_INTERCHANGE = "card_interchange"
+        CARD_LOAD_DEPOSIT = "card_load_deposit"
+        CARD_LOAD_TRANSFER = "card_load_transfer"
         CARD_SPEND_AUTHORIZATION = "card_spend_authorization"
         CARD_SPEND_AUTHORIZATION_VOID = "card_spend_authorization_void"
         CARD_SPEND_REFUND = "card_spend_refund"
+        CARD_UNLOAD_DEPOSIT = "card_unload_deposit"
+        CARD_UNLOAD_TRANSFER = "card_unload_transfer"
         COMPANY_REFERRAL = "company_referral"
+        CONNECTED_ACCOUNT_NEGATIVE_BALANCE = "connected_account_negative_balance"
         CROSS_BORDER_PERCENTAGE_FEE = "cross_border_percentage_fee"
         CURRENCY_CONVERSION_INCOMING = "currency_conversion_incoming"
         CURRENCY_CONVERSION_OUTGOING = "currency_conversion_outgoing"
         DISPUTE_ALERT_FEE = "dispute_alert_fee"
         DISPUTE_HOLD_ADJUSTMENT = "dispute_hold_adjustment"
         DISPUTE_REPRESENTMENT_FEE = "dispute_representment_fee"
+        EXTERNAL_CARD_LOAD_DEPOSIT = "external_card_load_deposit"
         FEES = "fees"
         FRAUD_PREVENTION_FEE = "fraud_prevention_fee"
         FX_PERCENTAGE_FEE = "fx_percentage_fee"
@@ -40,6 +49,15 @@ module Whop_sdk
         INTERNAL_BALANCE_TRANSFER_INCOMING = "internal_balance_transfer_incoming"
         INTERNAL_BALANCE_TRANSFER_OUTGOING = "internal_balance_transfer_outgoing"
         INTERNAL_WITHDRAWAL = "internal_withdrawal"
+        INTERNAL_WITHDRAWAL_COMPLETE = "internal_withdrawal_complete"
+        INTERNAL_WITHDRAWAL_FEE = "internal_withdrawal_fee"
+        INTERNAL_WITHDRAWAL_FEE_REVERSAL = "internal_withdrawal_fee_reversal"
+        INTERNAL_WITHDRAWAL_IN_TRANSIT = "internal_withdrawal_in_transit"
+        INTERNAL_WITHDRAWAL_IN_TRANSIT_REVERSAL = "internal_withdrawal_in_transit_reversal"
+        INTERNAL_WITHDRAWAL_MARKUP_FEE = "internal_withdrawal_markup_fee"
+        INTERNAL_WITHDRAWAL_MARKUP_FEE_PAYOUT = "internal_withdrawal_markup_fee_payout"
+        INTERNAL_WITHDRAWAL_MARKUP_FEE_PAYOUT_REVERSAL = "internal_withdrawal_markup_fee_payout_reversal"
+        INTERNAL_WITHDRAWAL_MARKUP_FEE_REVERSAL = "internal_withdrawal_markup_fee_reversal"
         INTERNAL_WITHDRAWAL_REVERSAL = "internal_withdrawal_reversal"
         LEGACY_CRYPTO_PAYMENT = "legacy_crypto_payment"
         LEGACY_PAYMENT = "legacy_payment"
@@ -47,13 +65,17 @@ module Whop_sdk
         LICENSE_SALE = "license_sale"
         LICENSE_SALE_COMMISSION = "license_sale_commission"
         LICENSE_SALE_REVENUE = "license_sale_revenue"
+        MARKETPLACE_AFFILIATE_FEE = "marketplace_affiliate_fee"
         MISC_PURCHASE = "misc_purchase"
         MISC_REFUND = "misc_refund"
         MISC_REVERSAL = "misc_reversal"
+        ONBOARDING_REWARD = "onboarding_reward"
         ONCHAIN_DEPOSIT = "onchain_deposit"
+        ONCHAIN_SWAP_SOURCE = "onchain_swap_source"
         ONCHAIN_SWAP_TARGET = "onchain_swap_target"
         ONCHAIN_WALLET_TRANSFER_INCOMING = "onchain_wallet_transfer_incoming"
         ONCHAIN_WALLET_TRANSFER_OUTGOING = "onchain_wallet_transfer_outgoing"
+        ONCHAIN_WITHDRAWAL = "onchain_withdrawal"
         ORCHESTRATION_PERCENTAGE_FEE = "orchestration_percentage_fee"
         PASSTHROUGH_GMV = "passthrough_gmv"
         PAYMENT_DISPUTE = "payment_dispute"
@@ -65,6 +87,7 @@ module Whop_sdk
         PAYMENT_PROCESSING_FIXED_FEE = "payment_processing_fixed_fee"
         PAYMENT_PROCESSING_PERCENTAGE_FEE = "payment_processing_percentage_fee"
         PAYMENT_REFERRAL = "payment_referral"
+        PAYMENT_REFERRAL_REFUND = "payment_referral_refund"
         PAYMENT_REFERRAL_REVERSAL = "payment_referral_reversal"
         PAYMENT_REFUND = "payment_refund"
         PAYMENT_REFUND_REVERSAL = "payment_refund_reversal"
@@ -77,9 +100,11 @@ module Whop_sdk
         PLATFORM_AFFILIATE_PAYMENT_REVERSAL = "platform_affiliate_payment_reversal"
         PLATFORM_BALANCE_PAYMENT = "platform_balance_payment"
         PLATFORM_BALANCE_PAYMENT_REFUND = "platform_balance_payment_refund"
+        PLATFORM_BALANCE_TRANSFER_FEE = "platform_balance_transfer_fee"
         PLATFORM_BALANCE_TRANSFER_INCOMING = "platform_balance_transfer_incoming"
         PLATFORM_BALANCE_TRANSFER_OUTGOING = "platform_balance_transfer_outgoing"
         PLATFORM_COVERED_DISPUTE = "platform_covered_dispute"
+        PLATFORM_EARNING = "platform_earning"
         PROMO_REVERSAL = "promo_reversal"
         REFERRAL_BONUS = "referral_bonus"
         RESOLUTION_CENTER_REFUND = "resolution_center_refund"
@@ -91,6 +116,7 @@ module Whop_sdk
         SOFTWARE_RENTAL_TRANSACTION = "software_rental_transaction"
         STRIPE_DOMESTIC_PROCESSING_FEE = "stripe_domestic_processing_fee"
         STRIPE_INTERNATIONAL_PROCESSING_FEE = "stripe_international_processing_fee"
+        SWAP_FEE = "swap_fee"
         THREE_DS_FIXED_FEE = "three_ds_fixed_fee"
         TOPUP = "topup"
         TOPUP_FEE = "topup_fee"
@@ -100,8 +126,15 @@ module Whop_sdk
         WITHDRAWAL = "withdrawal"
         WITHDRAWAL_CLAWBACK = "withdrawal_clawback"
         WITHDRAWAL_CLAWBACK_REVERSAL = "withdrawal_clawback_reversal"
+        WITHDRAWAL_FEE = "withdrawal_fee"
+        WITHDRAWAL_FEE_REVERSAL = "withdrawal_fee_reversal"
+        WITHDRAWAL_MARKUP_FEE = "withdrawal_markup_fee"
+        WITHDRAWAL_MARKUP_FEE_PAYOUT = "withdrawal_markup_fee_payout"
+        WITHDRAWAL_MARKUP_FEE_PAYOUT_REVERSAL = "withdrawal_markup_fee_payout_reversal"
+        WITHDRAWAL_MARKUP_FEE_REVERSAL = "withdrawal_markup_fee_reversal"
         WITHDRAWAL_RECLASSIFICATION = "withdrawal_reclassification"
         WITHDRAWAL_REVERSAL = "withdrawal_reversal"
+        WITHDRAWAL_TOPUP_ADJUSTMENT = "withdrawal_topup_adjustment"
       end
     end
   end

data/lib/whop_sdk/financial_reports/breakdown/client.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module FinancialReports
+    module Breakdown
+      class Client
+        # @param client [Whop_sdk::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Returns the top entities behind one high-level financial report bucket and an aggregate remainder.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :account_id
+        # @option params [Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownRequestBucket] :bucket
+        # @option params [Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownRequestDirection] :direction
+        # @option params [String] :currency
+        # @option params [String] :from
+        # @option params [String] :to
+        # @option params [Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownRequestGroupBy, nil] :group_by
+        # @option params [String, nil] :timezone
+        #
+        # @example
+        #   client.financial_reports.breakdown.retrieve(
+        #     account_id: "account_id",
+        #     bucket: "transfers",
+        #     direction: "money_in",
+        #     currency: "currency",
+        #     from: "2024-01-15T09:30:00Z",
+        #     to: "2024-01-15T09:30:00Z"
+        #   )
+        #
+        # @return [Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownResponse]
+        def retrieve(request_options: {}, **params)
+          params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["account_id"] = params[:account_id] if params.key?(:account_id)
+          query_params["bucket"] = params[:bucket] if params.key?(:bucket)
+          query_params["direction"] = params[:direction] if params.key?(:direction)
+          query_params["currency"] = params[:currency] if params.key?(:currency)
+          query_params["from"] = params[:from] if params.key?(:from)
+          query_params["to"] = params[:to] if params.key?(:to)
+          query_params["group_by"] = params[:group_by] if params.key?(:group_by)
+          query_params["timezone"] = params[:timezone] if params.key?(:timezone)
+
+          request = Whop_sdk::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "financial_reports/breakdown",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Whop_sdk::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownResponse.load(response.body)
+          else
+            error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/financial_reports/breakdown/types/retrieve_breakdown_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module FinancialReports
+    module Breakdown
+      module Types
+        class RetrieveBreakdownRequest < Internal::Types::Model
+          field :account_id, -> { String }, optional: false, nullable: false
+
+          field :bucket, -> { Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownRequestBucket }, optional: false, nullable: false
+
+          field :direction, -> { Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownRequestDirection }, optional: false, nullable: false
+
+          field :currency, -> { String }, optional: false, nullable: false
+
+          field :from, -> { String }, optional: false, nullable: false
+
+          field :to, -> { String }, optional: false, nullable: false
+
+          field :group_by, -> { Whop_sdk::FinancialReports::Breakdown::Types::RetrieveBreakdownRequestGroupBy }, optional: true, nullable: false
+
+          field :timezone, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/financial_reports/breakdown/types/retrieve_breakdown_request_bucket.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module FinancialReports
+    module Breakdown
+      module Types
+        module RetrieveBreakdownRequestBucket
+          extend Whop_sdk::Internal::Types::Enum
+
+          TRANSFERS = "transfers"
+          PAYMENTS = "payments"
+          REFUNDS = "refunds"
+          ADS = "ads"
+          CARD_SPEND = "card_spend"
+          CARD_AUTHORIZATION_RELEASES = "card_authorization_releases"
+          WITHDRAWALS = "withdrawals"
+          SWAPS = "swaps"
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/financial_reports/breakdown/types/retrieve_breakdown_request_direction.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module FinancialReports
+    module Breakdown
+      module Types
+        module RetrieveBreakdownRequestDirection
+          extend Whop_sdk::Internal::Types::Enum
+
+          MONEY_IN = "money_in"
+          MONEY_OUT = "money_out"
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/financial_reports/breakdown/types/retrieve_breakdown_request_group_by.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module FinancialReports
+    module Breakdown
+      module Types
+        module RetrieveBreakdownRequestGroupBy
+          extend Whop_sdk::Internal::Types::Enum
+
+          DAY = "day"
+          WEEK = "week"
+          MONTH = "month"
+        end
+      end
+    end
+  end
+end