whop_sdk 0.0.40 → 0.0.41

data/lib/whop_sdk/models/payout_create_response.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payouts#create
+    class PayoutCreateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Payout ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The payout amount in whole currency units.
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute created_at
+      #   When the payout was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   Payout currency.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute estimated_arrival
+      #   Estimated time the funds become available in the destination account. Null until
+      #   the payout settles.
+      #
+      #   @return [Time, nil]
+      required :estimated_arrival, Time, nil?: true
+
+      # @!attribute fee_amount
+      #   The fee charged for the payout, in the payout currency.
+      #
+      #   @return [Float]
+      required :fee_amount, Float
+
+      # @!attribute object
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutCreateResponse::Object]
+      required :object, enum: -> { WhopSDK::Models::PayoutCreateResponse::Object }
+
+      # @!attribute payer_name
+      #   Name of the entity processing the payout. Null until the payout settles.
+      #
+      #   @return [String, nil]
+      required :payer_name, String, nil?: true
+
+      # @!attribute payout_token
+      #   The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @return [WhopSDK::Models::PayoutCreateResponse::PayoutToken, nil]
+      required :payout_token, -> { WhopSDK::Models::PayoutCreateResponse::PayoutToken }, nil?: true
+
+      # @!attribute speed
+      #   Payout delivery speed.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutCreateResponse::Speed]
+      required :speed, enum: -> { WhopSDK::Models::PayoutCreateResponse::Speed }
+
+      # @!attribute status
+      #   Current payout status, in the same vocabulary as GET /payouts.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutCreateResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::PayoutCreateResponse::Status }
+
+      # @!method initialize(id:, amount:, created_at:, currency:, estimated_arrival:, fee_amount:, object:, payer_name:, payout_token:, speed:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PayoutCreateResponse} for more details.
+      #
+      #   @param id [String] Payout ID.
+      #
+      #   @param amount [Float] The payout amount in whole currency units.
+      #
+      #   @param created_at [Time] When the payout was created.
+      #
+      #   @param currency [String] Payout currency.
+      #
+      #   @param estimated_arrival [Time, nil] Estimated time the funds become available in the destination account. Null until
+      #
+      #   @param fee_amount [Float] The fee charged for the payout, in the payout currency.
+      #
+      #   @param object [Symbol, WhopSDK::Models::PayoutCreateResponse::Object]
+      #
+      #   @param payer_name [String, nil] Name of the entity processing the payout. Null until the payout settles.
+      #
+      #   @param payout_token [WhopSDK::Models::PayoutCreateResponse::PayoutToken, nil] The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @param speed [Symbol, WhopSDK::Models::PayoutCreateResponse::Speed] Payout delivery speed.
+      #
+      #   @param status [Symbol, WhopSDK::Models::PayoutCreateResponse::Status] Current payout status, in the same vocabulary as GET /payouts.
+
+      # @see WhopSDK::Models::PayoutCreateResponse#object
+      module Object
+        extend WhopSDK::Internal::Type::Enum
+
+        PAYOUT = :payout
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see WhopSDK::Models::PayoutCreateResponse#payout_token
+      class PayoutToken < WhopSDK::Internal::Type::BaseModel
+        # @!attribute nickname
+        #   Saved payout method nickname.
+        #
+        #   @return [String, nil]
+        required :nickname, String, nil?: true
+
+        # @!attribute payout_destination
+        #   Payout destination display details.
+        #
+        #   @return [WhopSDK::Models::PayoutCreateResponse::PayoutToken::PayoutDestination, nil]
+        required :payout_destination,
+                 -> { WhopSDK::Models::PayoutCreateResponse::PayoutToken::PayoutDestination },
+                 nil?: true
+
+        # @!method initialize(nickname:, payout_destination:)
+        #   The saved payout method used. Requires payout:destination:read; null without it.
+        #
+        #   @param nickname [String, nil] Saved payout method nickname.
+        #
+        #   @param payout_destination [WhopSDK::Models::PayoutCreateResponse::PayoutToken::PayoutDestination, nil] Payout destination display details.
+
+        # @see WhopSDK::Models::PayoutCreateResponse::PayoutToken#payout_destination
+        class PayoutDestination < WhopSDK::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   Payout destination icon URL.
+          #
+          #   @return [String, nil]
+          required :icon_url, String, nil?: true
+
+          # @!attribute payer_name
+          #   Payout destination display name.
+          #
+          #   @return [String, nil]
+          required :payer_name, String, nil?: true
+
+          # @!method initialize(icon_url:, payer_name:)
+          #   Payout destination display details.
+          #
+          #   @param icon_url [String, nil] Payout destination icon URL.
+          #
+          #   @param payer_name [String, nil] Payout destination display name.
+        end
+      end
+
+      # Payout delivery speed.
+      #
+      # @see WhopSDK::Models::PayoutCreateResponse#speed
+      module Speed
+        extend WhopSDK::Internal::Type::Enum
+
+        STANDARD = :standard
+        INSTANT = :instant
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current payout status, in the same vocabulary as GET /payouts.
+      #
+      # @see WhopSDK::Models::PayoutCreateResponse#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        REQUESTED = :requested
+        IN_TRANSIT = :in_transit
+        COMPLETED = :completed
+        FAILED = :failed
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/payout_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payouts#list
+    class PayoutListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute after
+      #   Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute currency
+      #   Optional currency code filter, for example `usd`.
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!attribute first
+      #   Number of payouts to return from the start of the window.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute last
+      #   Number of payouts to return from the end of the window.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer
+
+      # @!attribute user_id
+      #   The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(account_id: nil, after: nil, before: nil, currency: nil, first: nil, last: nil, user_id: nil, request_options: {})
+      #   @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      #   @param currency [String] Optional currency code filter, for example `usd`.
+      #
+      #   @param first [Integer] Number of payouts to return from the start of the window.
+      #
+      #   @param last [Integer] Number of payouts to return from the end of the window.
+      #
+      #   @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/payout_list_response.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payouts#list
+    class PayoutListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Payout ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The payout amount in whole currency units.
+      #
+      #   @return [Float]
+      required :amount, Float
+
+      # @!attribute created_at
+      #   When the payout was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   Payout currency.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute estimated_arrival
+      #   Estimated time the funds become available in the destination account.
+      #
+      #   @return [Time, nil]
+      required :estimated_arrival, Time, nil?: true
+
+      # @!attribute fee_amount
+      #   The fee charged for the payout, in the payout currency.
+      #
+      #   @return [Float]
+      required :fee_amount, Float
+
+      # @!attribute object
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutListResponse::Object]
+      required :object, enum: -> { WhopSDK::Models::PayoutListResponse::Object }
+
+      # @!attribute payer_name
+      #   Name of the entity processing the payout.
+      #
+      #   @return [String, nil]
+      required :payer_name, String, nil?: true
+
+      # @!attribute payout_request_id
+      #   The ID returned by POST /payouts when this payout was requested. Match it to the
+      #   settled payout in GET /payouts. Null for payouts not created by POST /payouts.
+      #
+      #   @return [String, nil]
+      required :payout_request_id, String, nil?: true
+
+      # @!attribute payout_token
+      #   The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @return [WhopSDK::Models::PayoutListResponse::PayoutToken, nil]
+      required :payout_token, -> { WhopSDK::Models::PayoutListResponse::PayoutToken }, nil?: true
+
+      # @!attribute speed
+      #   Payout delivery speed.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutListResponse::Speed]
+      required :speed, enum: -> { WhopSDK::Models::PayoutListResponse::Speed }
+
+      # @!attribute status
+      #   Current payout status.
+      #
+      #   @return [Symbol, WhopSDK::Models::PayoutListResponse::Status]
+      required :status, enum: -> { WhopSDK::Models::PayoutListResponse::Status }
+
+      # @!method initialize(id:, amount:, created_at:, currency:, estimated_arrival:, fee_amount:, object:, payer_name:, payout_request_id:, payout_token:, speed:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PayoutListResponse} for more details.
+      #
+      #   @param id [String] Payout ID.
+      #
+      #   @param amount [Float] The payout amount in whole currency units.
+      #
+      #   @param created_at [Time] When the payout was created.
+      #
+      #   @param currency [String] Payout currency.
+      #
+      #   @param estimated_arrival [Time, nil] Estimated time the funds become available in the destination account.
+      #
+      #   @param fee_amount [Float] The fee charged for the payout, in the payout currency.
+      #
+      #   @param object [Symbol, WhopSDK::Models::PayoutListResponse::Object]
+      #
+      #   @param payer_name [String, nil] Name of the entity processing the payout.
+      #
+      #   @param payout_request_id [String, nil] The ID returned by POST /payouts when this payout was requested. Match it to the
+      #
+      #   @param payout_token [WhopSDK::Models::PayoutListResponse::PayoutToken, nil] The saved payout method used. Requires payout:destination:read; null without it.
+      #
+      #   @param speed [Symbol, WhopSDK::Models::PayoutListResponse::Speed] Payout delivery speed.
+      #
+      #   @param status [Symbol, WhopSDK::Models::PayoutListResponse::Status] Current payout status.
+
+      # @see WhopSDK::Models::PayoutListResponse#object
+      module Object
+        extend WhopSDK::Internal::Type::Enum
+
+        PAYOUT = :payout
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see WhopSDK::Models::PayoutListResponse#payout_token
+      class PayoutToken < WhopSDK::Internal::Type::BaseModel
+        # @!attribute nickname
+        #   Saved payout method nickname.
+        #
+        #   @return [String, nil]
+        required :nickname, String, nil?: true
+
+        # @!attribute payout_destination
+        #   Payout destination display details.
+        #
+        #   @return [WhopSDK::Models::PayoutListResponse::PayoutToken::PayoutDestination, nil]
+        required :payout_destination,
+                 -> { WhopSDK::Models::PayoutListResponse::PayoutToken::PayoutDestination },
+                 nil?: true
+
+        # @!method initialize(nickname:, payout_destination:)
+        #   The saved payout method used. Requires payout:destination:read; null without it.
+        #
+        #   @param nickname [String, nil] Saved payout method nickname.
+        #
+        #   @param payout_destination [WhopSDK::Models::PayoutListResponse::PayoutToken::PayoutDestination, nil] Payout destination display details.
+
+        # @see WhopSDK::Models::PayoutListResponse::PayoutToken#payout_destination
+        class PayoutDestination < WhopSDK::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   Payout destination icon URL.
+          #
+          #   @return [String, nil]
+          required :icon_url, String, nil?: true
+
+          # @!attribute payer_name
+          #   Payout destination display name.
+          #
+          #   @return [String, nil]
+          required :payer_name, String, nil?: true
+
+          # @!method initialize(icon_url:, payer_name:)
+          #   Payout destination display details.
+          #
+          #   @param icon_url [String, nil] Payout destination icon URL.
+          #
+          #   @param payer_name [String, nil] Payout destination display name.
+        end
+      end
+
+      # Payout delivery speed.
+      #
+      # @see WhopSDK::Models::PayoutListResponse#speed
+      module Speed
+        extend WhopSDK::Internal::Type::Enum
+
+        STANDARD = :standard
+        INSTANT = :instant
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Current payout status.
+      #
+      # @see WhopSDK::Models::PayoutListResponse#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        REQUESTED = :requested
+        AWAITING_PAYMENT = :awaiting_payment
+        IN_TRANSIT = :in_transit
+        COMPLETED = :completed
+        FAILED = :failed
+        CANCELED = :canceled
+        DENIED = :denied
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/payout_method_created_webhook_event.rb

@@ -164,8 +164,8 @@ module WhopSDK
           # @!attribute category
           #   The category of the payout destination
           #
-          #   @return [Symbol, WhopSDK::Models::PayoutDestinationCategory]
-          required :category, enum: -> { WhopSDK::PayoutDestinationCategory }
+          #   @return [Symbol, WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination::Category]
+          required :category, enum: -> { WhopSDK::PayoutMethodCreatedWebhookEvent::Data::Destination::Category }
 
           # @!attribute country_code
           #   The country code of the payout destination
@@ -183,11 +183,28 @@ module WhopSDK
           #   The payout destination configuration linked to this token. Null if not yet
           #   configured.
           #
-          #   @param category [Symbol, WhopSDK::Models::PayoutDestinationCategory] The category of the payout destination
+          #   @param category [Symbol, WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination::Category] The category of the payout destination
           #
           #   @param country_code [String] The country code of the payout destination
           #
           #   @param name [String] The name of the payer associated with the payout destination
+
+          # The category of the payout destination
+          #
+          # @see WhopSDK::Models::PayoutMethodCreatedWebhookEvent::Data::Destination#category
+          module Category
+            extend WhopSDK::Internal::Type::Enum
+
+            CRYPTO = :crypto
+            RTP = :rtp
+            NEXT_DAY_BANK = :next_day_bank
+            BANK_WIRE = :bank_wire
+            DIGITAL_WALLET = :digital_wallet
+            UNKNOWN = :unknown
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end

data/lib/whop_sdk/models/payouts/method_list_params.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    module Payouts
+      # @see WhopSDK::Resources::Payouts::Methods#list
+      class MethodListParams < WhopSDK::Internal::Type::BaseModel
+        extend WhopSDK::Internal::Type::RequestParameters::Converter
+        include WhopSDK::Internal::Type::RequestParameters
+
+        # @!attribute account_id
+        #   The owning account ID (a biz\_ identifier). Provide this or user_id.
+        #
+        #   @return [String, nil]
+        optional :account_id, String
+
+        # @!attribute after
+        #   Cursor to fetch the page after (from page_info.end_cursor).
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute amount
+        #   Optional withdrawal amount in whole currency units, for example `250.00`. When
+        #   provided, each method includes a quote with the estimated fee, amount received,
+        #   and delivery date for that amount.
+        #
+        #   @return [Float, nil]
+        optional :amount, Float
+
+        # @!attribute before
+        #   Cursor to fetch the page before (from page_info.start_cursor).
+        #
+        #   @return [String, nil]
+        optional :before, String
+
+        # @!attribute currency
+        #   Currency code of the amount, for example `usd`. Only meaningful with amount.
+        #
+        #   @return [String, nil]
+        optional :currency, String
+
+        # @!attribute first
+        #   Number of payout methods to return from the start of the window. Capped at 25
+        #   when an amount is provided.
+        #
+        #   @return [Integer, nil]
+        optional :first, Integer
+
+        # @!attribute include_available
+        #   When true, the response also carries available_destinations — payout rails the
+        #   account could add as a new payout method, with per-currency quotes when an
+        #   amount is provided.
+        #
+        #   @return [Boolean, nil]
+        optional :include_available, WhopSDK::Internal::Type::Boolean
+
+        # @!attribute last
+        #   Number of payout methods to return from the end of the window.
+        #
+        #   @return [Integer, nil]
+        optional :last, Integer
+
+        # @!attribute status
+        #   Optional status filter. `created` means saved but unused, `active` means a
+        #   payout through it succeeded, `broken` means the last payout failed and the
+        #   method needs fixing.
+        #
+        #   @return [Symbol, WhopSDK::Models::Payouts::MethodListParams::Status, nil]
+        optional :status, enum: -> { WhopSDK::Payouts::MethodListParams::Status }
+
+        # @!attribute user_id
+        #   The owning user ID (a user\_ identifier). Provide this or account_id.
+        #
+        #   @return [String, nil]
+        optional :user_id, String
+
+        # @!method initialize(account_id: nil, after: nil, amount: nil, before: nil, currency: nil, first: nil, include_available: nil, last: nil, status: nil, user_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::Payouts::MethodListParams} for more details.
+        #
+        #   @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+        #
+        #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+        #
+        #   @param amount [Float] Optional withdrawal amount in whole currency units, for example `250.00`. When p
+        #
+        #   @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+        #
+        #   @param currency [String] Currency code of the amount, for example `usd`. Only meaningful with amount.
+        #
+        #   @param first [Integer] Number of payout methods to return from the start of the window. Capped at 25 wh
+        #
+        #   @param include_available [Boolean] When true, the response also carries available_destinations — payout rails the a
+        #
+        #   @param last [Integer] Number of payout methods to return from the end of the window.
+        #
+        #   @param status [Symbol, WhopSDK::Models::Payouts::MethodListParams::Status] Optional status filter. `created` means saved but unused, `active` means a payou
+        #
+        #   @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+        #
+        #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        # Optional status filter. `created` means saved but unused, `active` means a
+        # payout through it succeeded, `broken` means the last payout failed and the
+        # method needs fixing.
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          CREATED = :created
+          ACTIVE = :active
+          BROKEN = :broken
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end