stripe 13.3.0 → 13.4.0.pre.beta.2

data/rbi/stripe/resources/capital/financing_summary.rbi

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Capital
+    # A financing object describes an account's current financing state. Used by Connect
+    # platforms to read the state of Capital offered to their connected accounts.
+    class FinancingSummary < SingletonAPIResource
+      class Details < Stripe::StripeObject
+        class CurrentRepaymentInterval < Stripe::StripeObject
+          # The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
+          # Given in seconds since unix epoch.
+          sig { returns(Float) }
+          attr_reader :due_at
+          # The amount that has already been paid in the current repayment interval.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :paid_amount
+          # The amount that is yet to be paid in the current repayment interval.
+          sig { returns(Integer) }
+          attr_reader :remaining_amount
+        end
+        # Amount of financing offered, in minor units.
+        sig { returns(Integer) }
+        attr_reader :advance_amount
+        # The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :advance_paid_out_at
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        sig { returns(String) }
+        attr_reader :currency
+        # The chronologically current repayment interval for the financing offer.
+        sig { returns(T.nilable(CurrentRepaymentInterval)) }
+        attr_reader :current_repayment_interval
+        # Fixed fee amount, in minor units.
+        sig { returns(Integer) }
+        attr_reader :fee_amount
+        # The amount the Connected account has paid toward the financing debt so far.
+        sig { returns(Integer) }
+        attr_reader :paid_amount
+        # The balance remaining to be paid on the financing, in minor units.
+        sig { returns(Integer) }
+        attr_reader :remaining_amount
+        # The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :repayments_begin_at
+        # Per-transaction rate at which Stripe will withhold funds to repay the financing.
+        sig { returns(Float) }
+        attr_reader :withhold_rate
+      end
+      # Additional information about the financing summary. Describes currency, advance amount,
+      # fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
+      # repayment start date, and advance payout date.
+      sig { returns(T.nilable(Details)) }
+      attr_reader :details
+      # The Financing Offer ID this Financing Summary corresponds to
+      sig { returns(T.nilable(String)) }
+      attr_reader :financing_offer
+      # The object type: financing_summary
+      sig { returns(String) }
+      attr_reader :object
+      # Status of the Connected Account's financing. [/v1/capital/financing_summary](https://stripe.com/docs/api/capital/financing_summary) will only return `details` for `paid_out` financing.
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+    end
+  end
+end

data/rbi/stripe/resources/capital/financing_transaction.rbi

@@ -0,0 +1,130 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Capital
+    # This is an object representing the details of a transaction on a Capital financing object.
+    class FinancingTransaction < APIResource
+      class Details < Stripe::StripeObject
+        class Transaction < Stripe::StripeObject
+          # The linked payment ID.
+          sig { returns(String) }
+          attr_reader :charge
+          # The linked Treasury Financing Transaction ID.
+          sig { returns(String) }
+          attr_reader :treasury_transaction
+        end
+        # The advance amount being repaid, paid out, or reversed in minor units.
+        sig { returns(Integer) }
+        attr_reader :advance_amount
+        # The currency of the financing transaction.
+        sig { returns(String) }
+        attr_reader :currency
+        # The fee amount being repaid, paid out, or reversed in minor units.
+        sig { returns(Integer) }
+        attr_reader :fee_amount
+        # The linked payment for the transaction. This field only applies to financing transactions of type `paydown` and reason `automatic_withholding`.
+        sig { returns(String) }
+        attr_reader :linked_payment
+        # The reason for the financing transaction (if applicable).
+        sig { returns(String) }
+        attr_reader :reason
+        # The reversed transaction. This field only applies to financing
+        # transactions of type `reversal`.
+        sig { returns(String) }
+        attr_reader :reversed_transaction
+        # The advance and fee amount being repaid, paid out, or reversed in minor units.
+        sig { returns(Integer) }
+        attr_reader :total_amount
+        # This is an object representing a linked transaction on a Capital Financing Transaction.
+        sig { returns(Transaction) }
+        attr_reader :transaction
+      end
+      # The ID of the merchant associated with this financing transaction.
+      sig { returns(String) }
+      attr_reader :account
+      # Time at which the financing transaction was created. Given in seconds since unix epoch.
+      sig { returns(Integer) }
+      attr_reader :created_at
+      # This is an object representing a transaction on a Capital financing offer.
+      sig { returns(Details) }
+      attr_reader :details
+      # The Capital financing offer for this financing transaction.
+      sig { returns(T.nilable(String)) }
+      attr_reader :financing_offer
+      # A unique identifier for the financing transaction object.
+      sig { returns(String) }
+      attr_reader :id
+      # The Capital transaction object that predates the Financing Transactions API and
+      # corresponds with the balance transaction that was created as a result of this
+      # financing transaction.
+      sig { returns(String) }
+      attr_reader :legacy_balance_transaction_source
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+      # The object type: financing_transaction
+      sig { returns(String) }
+      attr_reader :object
+      # The type of the financing transaction.
+      sig { returns(String) }
+      attr_reader :type
+      # A human-friendly description of the financing transaction.
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_facing_description
+      class ListParams < Stripe::RequestParams
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
+        sig { returns(String) }
+        attr_accessor :charge
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        sig { returns(String) }
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        # Returns transactions that were created that apply to this financing offer ID.
+        sig { returns(String) }
+        attr_accessor :financing_offer
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        sig { returns(Integer) }
+        attr_accessor :limit
+        # Only returns transactions that are responsible for reversing this financing transaction ID.
+        sig { returns(String) }
+        attr_accessor :reversed_transaction
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        sig { returns(String) }
+        attr_accessor :starting_after
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
+        sig { returns(String) }
+        attr_accessor :treasury_transaction
+        sig {
+          params(charge: String, ending_before: String, expand: T::Array[String], financing_offer: String, limit: Integer, reversed_transaction: String, starting_after: String, treasury_transaction: String).void
+         }
+        def initialize(
+          charge: nil,
+          ending_before: nil,
+          expand: nil,
+          financing_offer: nil,
+          limit: nil,
+          reversed_transaction: nil,
+          starting_after: nil,
+          treasury_transaction: nil
+        ); end
+      end
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      sig {
+        params(params: T.any(::Stripe::Capital::FinancingTransaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/resources/card.rbi

@@ -0,0 +1,128 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # You can store multiple cards on a customer in order to charge the customer
+  # later. You can also store multiple debit cards on a recipient in order to
+  # transfer to those cards later.
+  #
+  # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
+  class Card < APIResource
+    class Networks < Stripe::StripeObject
+      # The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.
+      sig { returns(T.nilable(String)) }
+      attr_reader :preferred
+    end
+    # The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+    sig { returns(T.nilable(T.any(String, Stripe::Account))) }
+    attr_reader :account
+    # City/District/Suburb/Town/Village.
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_city
+    # Billing address country, if provided when creating card.
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_country
+    # Address line 1 (Street address/PO Box/Company name).
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_line1
+    # If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_line1_check
+    # Address line 2 (Apartment/Suite/Unit/Building).
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_line2
+    # State/County/Province/Region.
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_state
+    # ZIP or postal code.
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_zip
+    # If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+    sig { returns(T.nilable(String)) }
+    attr_reader :address_zip_check
+    # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.
+    sig { returns(T.nilable(String)) }
+    attr_reader :allow_redisplay
+    # A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :available_payout_methods
+    # Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
+    sig { returns(String) }
+    attr_reader :brand
+    # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
+    sig { returns(T.nilable(String)) }
+    attr_reader :brand_product
+    # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
+    sig { returns(T.nilable(String)) }
+    attr_reader :country
+    # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+    sig { returns(T.nilable(String)) }
+    attr_reader :currency
+    # The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+    sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
+    attr_reader :customer
+    # If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).
+    sig { returns(T.nilable(String)) }
+    attr_reader :cvc_check
+    # Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :default_for_currency
+    # A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
+    sig { returns(String) }
+    attr_reader :description
+    # (For tokenized numbers only.) The last four digits of the device account number.
+    sig { returns(T.nilable(String)) }
+    attr_reader :dynamic_last4
+    # Two-digit number representing the card's expiration month.
+    sig { returns(Integer) }
+    attr_reader :exp_month
+    # Four-digit number representing the card's expiration year.
+    sig { returns(Integer) }
+    attr_reader :exp_year
+    # Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
+    #
+    # *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
+    sig { returns(T.nilable(String)) }
+    attr_reader :fingerprint
+    # Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
+    sig { returns(String) }
+    attr_reader :funding
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
+    sig { returns(String) }
+    attr_reader :iin
+    # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
+    sig { returns(String) }
+    attr_reader :issuer
+    # The last four digits of the card.
+    sig { returns(String) }
+    attr_reader :last4
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    sig { returns(T.nilable(T::Hash[String, String])) }
+    attr_reader :metadata
+    # Cardholder name.
+    sig { returns(T.nilable(String)) }
+    attr_reader :name
+    # Attribute for field networks
+    sig { returns(Networks) }
+    attr_reader :networks
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # Status of a card based on the card issuer.
+    sig { returns(T.nilable(String)) }
+    attr_reader :regulated_status
+    # For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
+    sig { returns(T.nilable(String)) }
+    attr_reader :status
+    # If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.
+    sig { returns(T.nilable(String)) }
+    attr_reader :tokenization_method
+    # Always true for a deleted object
+    sig { returns(T::Boolean) }
+    attr_reader :deleted
+  end
+end

data/rbi/stripe/resources/cash_balance.rbi

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: 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
+    class Settings < Stripe::StripeObject
+      # The configuration for how funds that land in the customer cash balance are reconciled.
+      sig { returns(String) }
+      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
+      sig { returns(T::Boolean) }
+      attr_reader :using_merchant_default
+    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).
+    sig { returns(T.nilable(T::Hash[String, Integer])) }
+    attr_reader :available
+    # The ID of the customer whose cash balance this object represents.
+    sig { returns(String) }
+    attr_reader :customer
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # Attribute for field settings
+    sig { returns(Settings) }
+    attr_reader :settings
+  end
+end