whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/transfer_create_response.rb

@@ -0,0 +1,452 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # A transfer of credit between two ledger accounts.
+    #
+    # @see WhopSDK::Resources::Transfers#create
+    module TransferCreateResponse
+      extend WhopSDK::Internal::Type::Union
+
+      # A transfer of credit between two ledger accounts.
+      variant -> { WhopSDK::Models::TransferCreateResponse::Transfer }
+
+      # Returned for a wallet_send: an onchain USDT send to a recipient.
+      variant -> { WhopSDK::Models::TransferCreateResponse::Send }
+
+      # Returned for a claim_link: a shareable URL anyone can open to claim the funds.
+      variant -> { WhopSDK::Models::TransferCreateResponse::ClaimLink }
+
+      class Transfer < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   Transfer ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #   Transfer amount.
+        #
+        #   @return [Float]
+        required :amount, Float
+
+        # @!attribute created_at
+        #   When the transfer was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute currency
+        #   Transfer currency.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute destination
+        #   Account or user receiving funds.
+        #
+        #   @return [WhopSDK::Models::TransferCreateResponse::Transfer::Destination::Company, WhopSDK::Models::TransferCreateResponse::Transfer::Destination::User]
+        required :destination, union: -> { WhopSDK::Models::TransferCreateResponse::Transfer::Destination }
+
+        # @!attribute destination_ledger_account_id
+        #   Destination ledger account ID.
+        #
+        #   @return [String]
+        required :destination_ledger_account_id, String
+
+        # @!attribute origin
+        #   Account or user sending funds.
+        #
+        #   @return [WhopSDK::Models::TransferCreateResponse::Transfer::Origin::Company, WhopSDK::Models::TransferCreateResponse::Transfer::Origin::User]
+        required :origin, union: -> { WhopSDK::Models::TransferCreateResponse::Transfer::Origin }
+
+        # @!attribute origin_ledger_account_id
+        #   Source ledger account ID.
+        #
+        #   @return [String]
+        required :origin_ledger_account_id, String
+
+        # @!attribute fee_amount
+        #   Fee charged for the transfer.
+        #
+        #   @return [Float, nil]
+        optional :fee_amount, Float, nil?: true
+
+        # @!attribute metadata
+        #   Custom metadata attached to the transfer.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+        # @!attribute notes
+        #   Transfer note.
+        #
+        #   @return [String, nil]
+        optional :notes, String, nil?: true
+
+        # @!method initialize(id:, amount:, created_at:, currency:, destination:, destination_ledger_account_id:, origin:, origin_ledger_account_id:, fee_amount: nil, metadata: nil, notes: nil)
+        #   A transfer of credit between two ledger accounts.
+        #
+        #   @param id [String] Transfer ID.
+        #
+        #   @param amount [Float] Transfer amount.
+        #
+        #   @param created_at [Time] When the transfer was created.
+        #
+        #   @param currency [String] Transfer currency.
+        #
+        #   @param destination [WhopSDK::Models::TransferCreateResponse::Transfer::Destination::Company, WhopSDK::Models::TransferCreateResponse::Transfer::Destination::User] Account or user receiving funds.
+        #
+        #   @param destination_ledger_account_id [String] Destination ledger account ID.
+        #
+        #   @param origin [WhopSDK::Models::TransferCreateResponse::Transfer::Origin::Company, WhopSDK::Models::TransferCreateResponse::Transfer::Origin::User] Account or user sending funds.
+        #
+        #   @param origin_ledger_account_id [String] Source ledger account ID.
+        #
+        #   @param fee_amount [Float, nil] Fee charged for the transfer.
+        #
+        #   @param metadata [Hash{Symbol=>Object}, nil] Custom metadata attached to the transfer.
+        #
+        #   @param notes [String, nil] Transfer note.
+
+        # Account or user receiving funds.
+        #
+        # @see WhopSDK::Models::TransferCreateResponse::Transfer#destination
+        module Destination
+          extend WhopSDK::Internal::Type::Union
+
+          discriminator :typename
+
+          variant :Company, -> { WhopSDK::Models::TransferCreateResponse::Transfer::Destination::Company }
+
+          variant :User, -> { WhopSDK::Models::TransferCreateResponse::Transfer::Destination::User }
+
+          class Company < WhopSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #   Account ID.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute typename
+            #
+            #   @return [Symbol, :Company]
+            required :typename, const: :Company
+
+            # @!attribute route
+            #   Account route.
+            #
+            #   @return [String, nil]
+            optional :route, String, nil?: true
+
+            # @!attribute title
+            #   Account display name.
+            #
+            #   @return [String, nil]
+            optional :title, String, nil?: true
+
+            # @!method initialize(id:, route: nil, title: nil, typename: :Company)
+            #   @param id [String] Account ID.
+            #
+            #   @param route [String, nil] Account route.
+            #
+            #   @param title [String, nil] Account display name.
+            #
+            #   @param typename [Symbol, :Company]
+          end
+
+          class User < WhopSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #   User ID.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute typename
+            #
+            #   @return [Symbol, :User]
+            required :typename, const: :User
+
+            # @!attribute name
+            #   User display name.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute username
+            #   User's username.
+            #
+            #   @return [String, nil]
+            optional :username, String
+
+            # @!method initialize(id:, name: nil, username: nil, typename: :User)
+            #   @param id [String] User ID.
+            #
+            #   @param name [String, nil] User display name.
+            #
+            #   @param username [String] User's username.
+            #
+            #   @param typename [Symbol, :User]
+          end
+
+          # @!method self.variants
+          #   @return [Array(WhopSDK::Models::TransferCreateResponse::Transfer::Destination::Company, WhopSDK::Models::TransferCreateResponse::Transfer::Destination::User)]
+        end
+
+        # Account or user sending funds.
+        #
+        # @see WhopSDK::Models::TransferCreateResponse::Transfer#origin
+        module Origin
+          extend WhopSDK::Internal::Type::Union
+
+          discriminator :typename
+
+          variant :Company, -> { WhopSDK::Models::TransferCreateResponse::Transfer::Origin::Company }
+
+          variant :User, -> { WhopSDK::Models::TransferCreateResponse::Transfer::Origin::User }
+
+          class Company < WhopSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #   Account ID.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute typename
+            #
+            #   @return [Symbol, :Company]
+            required :typename, const: :Company
+
+            # @!attribute route
+            #   Account route.
+            #
+            #   @return [String, nil]
+            optional :route, String, nil?: true
+
+            # @!attribute title
+            #   Account display name.
+            #
+            #   @return [String, nil]
+            optional :title, String, nil?: true
+
+            # @!method initialize(id:, route: nil, title: nil, typename: :Company)
+            #   @param id [String] Account ID.
+            #
+            #   @param route [String, nil] Account route.
+            #
+            #   @param title [String, nil] Account display name.
+            #
+            #   @param typename [Symbol, :Company]
+          end
+
+          class User < WhopSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #   User ID.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute typename
+            #
+            #   @return [Symbol, :User]
+            required :typename, const: :User
+
+            # @!attribute name
+            #   User display name.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute username
+            #   User's username.
+            #
+            #   @return [String, nil]
+            optional :username, String
+
+            # @!method initialize(id:, name: nil, username: nil, typename: :User)
+            #   @param id [String] User ID.
+            #
+            #   @param name [String, nil] User display name.
+            #
+            #   @param username [String] User's username.
+            #
+            #   @param typename [Symbol, :User]
+          end
+
+          # @!method self.variants
+          #   @return [Array(WhopSDK::Models::TransferCreateResponse::Transfer::Origin::Company, WhopSDK::Models::TransferCreateResponse::Transfer::Origin::User)]
+        end
+      end
+
+      class Send < WhopSDK::Internal::Type::BaseModel
+        # @!attribute amount
+        #
+        #   @return [String]
+        required :amount, String
+
+        # @!attribute currency
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute destination
+        #
+        #   @return [WhopSDK::Models::TransferCreateResponse::Send::Destination]
+        required :destination, -> { WhopSDK::Models::TransferCreateResponse::Send::Destination }
+
+        # @!attribute object
+        #
+        #   @return [Symbol, WhopSDK::Models::TransferCreateResponse::Send::Object]
+        required :object, enum: -> { WhopSDK::Models::TransferCreateResponse::Send::Object }
+
+        # @!attribute source
+        #
+        #   @return [WhopSDK::Models::TransferCreateResponse::Send::Source]
+        required :source, -> { WhopSDK::Models::TransferCreateResponse::Send::Source }
+
+        # @!attribute tx_hash
+        #
+        #   @return [String]
+        required :tx_hash, String
+
+        # @!method initialize(amount:, currency:, destination:, object:, source:, tx_hash:)
+        #   Returned for a wallet_send: an onchain USDT send to a recipient.
+        #
+        #   @param amount [String]
+        #   @param currency [String]
+        #   @param destination [WhopSDK::Models::TransferCreateResponse::Send::Destination]
+        #   @param object [Symbol, WhopSDK::Models::TransferCreateResponse::Send::Object]
+        #   @param source [WhopSDK::Models::TransferCreateResponse::Send::Source]
+        #   @param tx_hash [String]
+
+        # @see WhopSDK::Models::TransferCreateResponse::Send#destination
+        class Destination < WhopSDK::Internal::Type::BaseModel
+          # @!attribute account_id
+          #
+          #   @return [String]
+          required :account_id, String
+
+          # @!attribute address
+          #
+          #   @return [String]
+          required :address, String
+
+          # @!method initialize(account_id:, address:)
+          #   @param account_id [String]
+          #   @param address [String]
+        end
+
+        # @see WhopSDK::Models::TransferCreateResponse::Send#object
+        module Object
+          extend WhopSDK::Internal::Type::Enum
+
+          SEND = :send
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see WhopSDK::Models::TransferCreateResponse::Send#source
+        class Source < WhopSDK::Internal::Type::BaseModel
+          # @!attribute account_id
+          #
+          #   @return [String]
+          required :account_id, String
+
+          # @!attribute address
+          #
+          #   @return [String]
+          required :address, String
+
+          # @!method initialize(account_id:, address:)
+          #   @param account_id [String]
+          #   @param address [String]
+        end
+      end
+
+      class ClaimLink < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [String]
+        required :amount, String
+
+        # @!attribute claim_url
+        #
+        #   @return [String]
+        required :claim_url, String
+
+        # @!attribute currency
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute expires_at
+        #
+        #   @return [Time, nil]
+        required :expires_at, Time, nil?: true
+
+        # @!attribute object
+        #
+        #   @return [Symbol, WhopSDK::Models::TransferCreateResponse::ClaimLink::Object]
+        required :object, enum: -> { WhopSDK::Models::TransferCreateResponse::ClaimLink::Object }
+
+        # @!attribute redeemable_count
+        #
+        #   @return [Integer]
+        required :redeemable_count, Integer
+
+        # @!attribute source
+        #
+        #   @return [WhopSDK::Models::TransferCreateResponse::ClaimLink::Source]
+        required :source, -> { WhopSDK::Models::TransferCreateResponse::ClaimLink::Source }
+
+        # @!attribute status
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!method initialize(id:, amount:, claim_url:, currency:, expires_at:, object:, redeemable_count:, source:, status:)
+        #   Returned for a claim_link: a shareable URL anyone can open to claim the funds.
+        #
+        #   @param id [String]
+        #   @param amount [String]
+        #   @param claim_url [String]
+        #   @param currency [String]
+        #   @param expires_at [Time, nil]
+        #   @param object [Symbol, WhopSDK::Models::TransferCreateResponse::ClaimLink::Object]
+        #   @param redeemable_count [Integer]
+        #   @param source [WhopSDK::Models::TransferCreateResponse::ClaimLink::Source]
+        #   @param status [String]
+
+        # @see WhopSDK::Models::TransferCreateResponse::ClaimLink#object
+        module Object
+          extend WhopSDK::Internal::Type::Enum
+
+          CLAIM_LINK = :claim_link
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see WhopSDK::Models::TransferCreateResponse::ClaimLink#source
+        class Source < WhopSDK::Internal::Type::BaseModel
+          # @!attribute account_id
+          #
+          #   @return [String]
+          required :account_id, String
+
+          # @!method initialize(account_id:)
+          #   @param account_id [String]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(WhopSDK::Models::TransferCreateResponse::Transfer, WhopSDK::Models::TransferCreateResponse::Send, WhopSDK::Models::TransferCreateResponse::ClaimLink)]
+    end
+  end
+end

data/lib/whop_sdk/models/transfer_list_params.rb

@@ -8,99 +8,105 @@ module WhopSDK
       include WhopSDK::Internal::Type::RequestParameters
 
       # @!attribute after
-      #   Returns the elements in the list that come after the specified cursor.
+      #   Cursor to fetch the page after (from page_info.end_cursor).
       #
       #   @return [String, nil]
-      optional :after, String, nil?: true
+      optional :after, String
 
       # @!attribute before
-      #   Returns the elements in the list that come before the specified cursor.
+      #   Cursor to fetch the page before (from page_info.start_cursor).
       #
       #   @return [String, nil]
-      optional :before, String, nil?: true
+      optional :before, String
 
       # @!attribute created_after
-      #   Only return transfers created after this timestamp.
+      #   Only transfers created strictly after this ISO 8601 timestamp.
       #
-      #   @return [Time, nil]
-      optional :created_after, Time, nil?: true
+      #   @return [String, nil]
+      optional :created_after, String
 
       # @!attribute created_before
-      #   Only return transfers created before this timestamp.
+      #   Only transfers created strictly before this ISO 8601 timestamp.
       #
-      #   @return [Time, nil]
-      optional :created_before, Time, nil?: true
+      #   @return [String, nil]
+      optional :created_before, String
 
       # @!attribute destination_id
-      #   Filter to transfers received by this account. Accepts a user, company, or ledger
-      #   account ID.
+      #   Filter to transfers received by this account.
       #
       #   @return [String, nil]
-      optional :destination_id, String, nil?: true
+      optional :destination_id, String
 
       # @!attribute direction
-      #   The direction of the sort.
+      #   Sort direction. Defaults to desc.
       #
-      #   @return [Symbol, WhopSDK::Models::Direction, nil]
-      optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
+      #   @return [Symbol, WhopSDK::Models::TransferListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::TransferListParams::Direction }
 
       # @!attribute first
-      #   Returns the first _n_ elements from the list.
+      #   Number of transfers to return from the start of the window.
       #
       #   @return [Integer, nil]
-      optional :first, Integer, nil?: true
+      optional :first, Integer
 
       # @!attribute last
-      #   Returns the last _n_ elements from the list.
+      #   Number of transfers to return from the end of the window.
       #
       #   @return [Integer, nil]
-      optional :last, Integer, nil?: true
+      optional :last, Integer
 
       # @!attribute order
-      #   Which columns can be used to sort.
+      #   Sort column. Defaults to created_at.
       #
       #   @return [Symbol, WhopSDK::Models::TransferListParams::Order, nil]
-      optional :order, enum: -> { WhopSDK::TransferListParams::Order }, nil?: true
+      optional :order, enum: -> { WhopSDK::TransferListParams::Order }
 
       # @!attribute origin_id
-      #   Filter to transfers sent from this account. Accepts a user, company, or ledger
-      #   account ID.
+      #   Filter to transfers sent from this account.
       #
       #   @return [String, nil]
-      optional :origin_id, String, nil?: true
+      optional :origin_id, String
 
       # @!method initialize(after: nil, before: nil, created_after: nil, created_before: nil, destination_id: nil, direction: nil, first: nil, last: nil, order: nil, origin_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {WhopSDK::Models::TransferListParams} for more details.
-      #
-      #   @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
       #
-      #   @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #   @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
       #
-      #   @param created_after [Time, nil] Only return transfers created after this timestamp.
+      #   @param created_after [String] Only transfers created strictly after this ISO 8601 timestamp.
       #
-      #   @param created_before [Time, nil] Only return transfers created before this timestamp.
+      #   @param created_before [String] Only transfers created strictly before this ISO 8601 timestamp.
       #
-      #   @param destination_id [String, nil] Filter to transfers received by this account. Accepts a user, company, or ledger
+      #   @param destination_id [String] Filter to transfers received by this account.
       #
-      #   @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #   @param direction [Symbol, WhopSDK::Models::TransferListParams::Direction] Sort direction. Defaults to desc.
       #
-      #   @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #   @param first [Integer] Number of transfers to return from the start of the window.
       #
-      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #   @param last [Integer] Number of transfers to return from the end of the window.
       #
-      #   @param order [Symbol, WhopSDK::Models::TransferListParams::Order, nil] Which columns can be used to sort.
+      #   @param order [Symbol, WhopSDK::Models::TransferListParams::Order] Sort column. Defaults to created_at.
       #
-      #   @param origin_id [String, nil] Filter to transfers sent from this account. Accepts a user, company, or ledger a
+      #   @param origin_id [String] Filter to transfers sent from this account.
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
 
-      # Which columns can be used to sort.
+      # Sort direction. Defaults to desc.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Sort column. Defaults to created_at.
       module Order
         extend WhopSDK::Internal::Type::Enum
 
-        AMOUNT = :amount
         CREATED_AT = :created_at
+        AMOUNT = :amount
 
         # @!method self.values
         #   @return [Array<Symbol>]