stripe-ruby/lib/stripe/resources/cash_balance.rb

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  # A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
  class CashBalance < APIResource
    OBJECT_NAME = "cash_balance"
    def self.object_name
      "cash_balance"
    end

    class Settings < Stripe::StripeObject
      # The configuration for how funds that land in the customer cash balance are reconciled.
      attr_reader :reconciliation_mode
      # A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance
      attr_reader :using_merchant_default

      def self.inner_class_types
        @inner_class_types = {}
      end

      def self.field_remappings
        @field_remappings = {}
      end
    end
    # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
    attr_reader :available
    # The ID of the customer whose cash balance this object represents.
    attr_reader :customer
    # The ID of the account whose cash balance this object represents.
    attr_reader :customer_account
    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
    attr_reader :livemode
    # String representing the object's type. Objects of the same type share the same value.
    attr_reader :object
    # Attribute for field settings
    attr_reader :settings

    def resource_url
      if !respond_to?(:customer) || customer.nil?
        raise NotImplementedError,
              "Customer Cash Balance cannot be accessed without a customer ID."
      end
      "#{Customer.resource_url}/#{CGI.escape(customer)}/cash_balance"
    end

    def self.retrieve(_id, _opts = {})
      raise NotImplementedError,
            "Customer Cash Balance cannot be retrieved without a customer ID. " \
            "Retrieve a Customer Cash Balance using `Customer.retrieve_cash_balance('cus_123')`"
    end

    def self.inner_class_types
      @inner_class_types = { settings: Settings }
    end

    def self.field_remappings
      @field_remappings = {}
    end
  end
end