stripe 13.6.0.pre.beta.1 → 14.0.0

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

@@ -1,74 +0,0 @@
-# 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

@@ -1,130 +0,0 @@
-# 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/financial_connections/account_inferred_balance.rbi

@@ -1,27 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module FinancialConnections
-    # A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
-    class AccountInferredBalance < APIResource
-      # The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
-      sig { returns(Integer) }
-      attr_reader :as_of
-      # The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
-      #
-      # Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
-      #
-      # Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
-      sig { returns(T::Hash[String, Integer]) }
-      attr_reader :current
-      # Unique identifier for the object.
-      sig { returns(String) }
-      attr_reader :id
-      # String representing the object's type. Objects of the same type share the same value.
-      sig { returns(String) }
-      attr_reader :object
-    end
-  end
-end

data/rbi/stripe/resources/financial_connections/institution.rbi

@@ -1,99 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module FinancialConnections
-    # An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
-    class Institution < APIResource
-      class Features < Stripe::StripeObject
-        class Balances < Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          sig { returns(T::Boolean) }
-          attr_reader :supported
-        end
-        class Ownership < Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          sig { returns(T::Boolean) }
-          attr_reader :supported
-        end
-        class PaymentMethod < Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          sig { returns(T::Boolean) }
-          attr_reader :supported
-        end
-        class Transactions < Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          sig { returns(T::Boolean) }
-          attr_reader :supported
-        end
-        # Attribute for field balances
-        sig { returns(Balances) }
-        attr_reader :balances
-        # Attribute for field ownership
-        sig { returns(Ownership) }
-        attr_reader :ownership
-        # Attribute for field payment_method
-        sig { returns(PaymentMethod) }
-        attr_reader :payment_method
-        # Attribute for field transactions
-        sig { returns(Transactions) }
-        attr_reader :transactions
-      end
-      # Attribute for field features
-      sig { returns(Features) }
-      attr_reader :features
-      # Unique identifier for the object.
-      sig { returns(String) }
-      attr_reader :id
-      # 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 name of this institution.
-      sig { returns(String) }
-      attr_reader :name
-      # String representing the object's type. Objects of the same type share the same value.
-      sig { returns(String) }
-      attr_reader :object
-      # A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.
-      sig { returns(T::Array[String]) }
-      attr_reader :routing_numbers
-      # The status of this institution in the Financial Connections authentication flow.
-      sig { returns(String) }
-      attr_reader :status
-      # A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.
-      sig { returns(T.nilable(String)) }
-      attr_reader :url
-      class ListParams < Stripe::RequestParams
-        # 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
-        # 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
-        # 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
-        sig {
-          params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
-         }
-        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: 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 Financial Connections Institution objects.
-      sig {
-        params(params: T.any(::Stripe::FinancialConnections::Institution::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/gift_cards/card.rbi

@@ -1,206 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module GiftCards
-    # A gift card represents a single gift card owned by a customer, including the
-    # remaining balance, gift card code, and whether or not it is active.
-    class Card < APIResource
-      class CreatedBy < Stripe::StripeObject
-        class Checkout < Stripe::StripeObject
-          # The Stripe CheckoutSession that created this object.
-          sig { returns(String) }
-          attr_reader :checkout_session
-          # The Stripe CheckoutSession LineItem that created this object.
-          sig { returns(T.nilable(String)) }
-          attr_reader :line_item
-        end
-        class Order < Stripe::StripeObject
-          # The Stripe Order LineItem that created this object.
-          sig { returns(T.nilable(String)) }
-          attr_reader :line_item
-          # The Stripe Order that created this object.
-          sig { returns(String) }
-          attr_reader :order
-        end
-        class Payment < Stripe::StripeObject
-          # The PaymentIntent that created this object.
-          sig { returns(String) }
-          attr_reader :payment_intent
-        end
-        # Attribute for field checkout
-        sig { returns(Checkout) }
-        attr_reader :checkout
-        # Attribute for field order
-        sig { returns(Order) }
-        attr_reader :order
-        # Attribute for field payment
-        sig { returns(Payment) }
-        attr_reader :payment
-        # The type of event that created this object.
-        sig { returns(String) }
-        attr_reader :type
-      end
-      # Whether this gift card can be used or not.
-      sig { returns(T::Boolean) }
-      attr_reader :active
-      # The amount of funds available for new transactions.
-      sig { returns(Integer) }
-      attr_reader :amount_available
-      # The amount of funds marked as held.
-      sig { returns(Integer) }
-      attr_reader :amount_held
-      # Code used to redeem this gift card.
-      sig { returns(T.nilable(String)) }
-      attr_reader :code
-      # Time at which the object was created. Measured in seconds since the Unix epoch.
-      sig { returns(Integer) }
-      attr_reader :created
-      # The related Stripe objects that created this gift card.
-      sig { returns(T.nilable(CreatedBy)) }
-      attr_reader :created_by
-      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-      sig { returns(String) }
-      attr_reader :currency
-      # Unique identifier for the object.
-      sig { returns(String) }
-      attr_reader :id
-      # 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
-      # String representing the object's type. Objects of the same type share the same value.
-      sig { returns(String) }
-      attr_reader :object
-      # Transactions on this gift card.
-      sig { returns(Stripe::ListObject) }
-      attr_reader :transactions
-      class ListParams < Stripe::RequestParams
-        # 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
-        # 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
-        # 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
-        sig {
-          params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
-         }
-        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
-      end
-      class CreateParams < Stripe::RequestParams
-        class CreatedBy < Stripe::RequestParams
-          class Payment < Stripe::RequestParams
-            # The PaymentIntent used to collect payment for this object.
-            sig { returns(String) }
-            attr_accessor :payment_intent
-            sig { params(payment_intent: String).void }
-            def initialize(payment_intent: nil); end
-          end
-          # The details for the payment that created this object.
-          sig { returns(::Stripe::GiftCards::Card::CreateParams::CreatedBy::Payment) }
-          attr_accessor :payment
-          # The type of event that created this object.
-          sig { returns(String) }
-          attr_accessor :type
-          sig {
-            params(payment: ::Stripe::GiftCards::Card::CreateParams::CreatedBy::Payment, type: String).void
-           }
-          def initialize(payment: nil, type: nil); end
-        end
-        # The active state for the new gift card, defaults to false. The active state can be updated after creation.
-        sig { returns(T::Boolean) }
-        attr_accessor :active
-        # Related objects which created this gift card.
-        sig { returns(::Stripe::GiftCards::Card::CreateParams::CreatedBy) }
-        attr_accessor :created_by
-        # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-        sig { returns(String) }
-        attr_accessor :currency
-        # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
-        attr_accessor :expand
-        # The initial amount to load onto the new gift card, defaults to 0.
-        sig { returns(Integer) }
-        attr_accessor :initial_amount
-        # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-        sig { returns(T::Hash[String, String]) }
-        attr_accessor :metadata
-        sig {
-          params(active: T::Boolean, created_by: ::Stripe::GiftCards::Card::CreateParams::CreatedBy, currency: String, expand: T::Array[String], initial_amount: Integer, metadata: T::Hash[String, String]).void
-         }
-        def initialize(
-          active: nil,
-          created_by: nil,
-          currency: nil,
-          expand: nil,
-          initial_amount: nil,
-          metadata: 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
-      class UpdateParams < Stripe::RequestParams
-        # The new active state for the gift card.
-        sig { returns(T::Boolean) }
-        attr_accessor :active
-        # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
-        attr_accessor :expand
-        # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
-        sig { returns(T.nilable(T::Hash[String, String])) }
-        attr_accessor :metadata
-        sig {
-          params(active: T::Boolean, expand: T::Array[String], metadata: T.nilable(T::Hash[String, String])).void
-         }
-        def initialize(active: nil, expand: nil, metadata: nil); end
-      end
-      class ValidateParams < Stripe::RequestParams
-        # The gift card code to be validated.
-        sig { returns(String) }
-        attr_accessor :code
-        # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
-        attr_accessor :expand
-        # The pin associated with the gift card. Not all gift cards have pins.
-        sig { returns(String) }
-        attr_accessor :giftcard_pin
-        sig { params(code: String, expand: T::Array[String], giftcard_pin: String).void }
-        def initialize(code: nil, expand: nil, giftcard_pin: nil); end
-      end
-      # Creates a new gift card object.
-      sig {
-        params(params: T.any(::Stripe::GiftCards::Card::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::GiftCards::Card)
-       }
-      def self.create(params = {}, opts = {}); end
-
-      # List gift cards for an account
-      sig {
-        params(params: T.any(::Stripe::GiftCards::Card::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
-       }
-      def self.list(params = {}, opts = {}); end
-
-      # Update a gift card
-      sig {
-        params(id: String, params: T.any(::Stripe::GiftCards::Card::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::GiftCards::Card)
-       }
-      def self.update(id, params = {}, opts = {}); end
-
-      # Validates a gift card code, returning the matching gift card object if it exists.
-      sig {
-        params(params: T.any(::Stripe::GiftCards::Card::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::GiftCards::Card)
-       }
-      def self.validate(params = {}, opts = {}); end
-    end
-  end
-end