stripe 20.2.0.pre.beta.1 → 21.0.0

data/lib/stripe/resources/capital/financing_offer.rb

@@ -1,144 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Capital
-    # This is an object representing an offer of financing from
-    # Stripe Capital to a Connect subaccount.
-    class FinancingOffer < APIResource
-      extend Stripe::APIOperations::List
-
-      OBJECT_NAME = "capital.financing_offer"
-      def self.object_name
-        "capital.financing_offer"
-      end
-
-      class AcceptedTerms < ::Stripe::StripeObject
-        # Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :advance_amount
-        # Currency that the financing offer is transacted in. For example, `usd`.
-        attr_reader :currency
-        # Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
-        attr_reader :fee_amount
-        # Populated when the `product_type` of the `financingoffer` is `refill`.
-        # Represents the discount amount on remaining premium for the existing loan at payout time.
-        attr_reader :previous_financing_fee_discount_amount
-        # Per-transaction rate at which Stripe withholds funds to repay the financing.
-        attr_reader :withhold_rate
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-
-      class OfferedTerms < ::Stripe::StripeObject
-        # Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :advance_amount
-        # Describes the type of user the offer is being extended to.
-        attr_reader :campaign_type
-        # Currency that the financing offer is transacted in. For example, `usd`.
-        attr_reader :currency
-        # Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
-        attr_reader :fee_amount
-        # Populated when the `product_type` of the `financingoffer` is `refill`.
-        # Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
-        # is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
-        # and the remaining fee.
-        attr_reader :previous_financing_fee_discount_rate
-        # Per-transaction rate at which Stripe withholds funds to repay the financing.
-        attr_reader :withhold_rate
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # This is an object representing the terms of an offer of financing from
-      # Stripe Capital to a Connected account. This resource represents
-      # the terms accepted by the Connected account, which may differ from those
-      # offered.
-      attr_reader :accepted_terms
-      # The ID of the merchant associated with this financing object.
-      attr_reader :account
-      # The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
-      attr_reader :charged_off_at
-      # Time at which the offer was created. Given in seconds since unix epoch.
-      attr_reader :created
-      # The type of disclaimer to use for a financing offer in user-facing surfaces. The corresponding disclaimer text to use for each disclaimer_variant value can be found in the [marketing docs](https://docs.stripe.com/capital/marketing).
-      attr_reader :disclaimer_variant
-      # Time at which the offer expires. Given in seconds since unix epoch.
-      attr_reader :expires_after
-      # The type of financing being offered.
-      attr_reader :financing_type
-      # A unique identifier for the financing object.
-      attr_reader :id
-      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
-      attr_reader :livemode
-      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-      attr_reader :metadata
-      # The object type: financing_offer.
-      attr_reader :object
-      # This is an object representing the terms of an offer of financing from
-      # Stripe Capital to a Connected account. This resource represents
-      # both the terms offered to the Connected account.
-      attr_reader :offered_terms
-      # Financing product identifier.
-      attr_reader :product_type
-      # The ID of the financing offer that replaced this offer.
-      attr_reader :replacement
-      # The ID of the financing offer that this offer is a replacement for.
-      attr_reader :replacement_for
-      # The current status of the offer.
-      attr_reader :status
-      # See [financing_type](https://docs.stripe.com/api/capital/connect_financing_object#financing_offer_object-financing_type).
-      attr_reader :type
-
-      # Retrieves the financing offers available for Connected accounts that belong to your platform.
-      def self.list(params = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/capital/financing_offers",
-          params: params,
-          opts: opts
-        )
-      end
-
-      # Acknowledges that platform has received and delivered the financing_offer to
-      # the intended merchant recipient.
-      def mark_delivered(params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
-          params: params,
-          opts: opts
-        )
-      end
-
-      # Acknowledges that platform has received and delivered the financing_offer to
-      # the intended merchant recipient.
-      def self.mark_delivered(financing_offer, params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
-          params: params,
-          opts: opts
-        )
-      end
-
-      def self.inner_class_types
-        @inner_class_types = { accepted_terms: AcceptedTerms, offered_terms: OfferedTerms }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-  end
-end

data/lib/stripe/resources/capital/financing_summary.rb

@@ -1,82 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Capital
-    # A financing summary object describes a connected account's financing details in real time.
-    class FinancingSummary < SingletonAPIResource
-      OBJECT_NAME = "capital.financing_summary"
-      def self.object_name
-        "capital.financing_summary"
-      end
-
-      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.
-          attr_reader :due_at
-          # The amount that has already been paid in the current repayment interval, in minor units. For example, 100 USD is represented as 10000.
-          attr_reader :paid_amount
-          # The amount that is yet to be paid in the current repayment interval, in minor units. For example, 100 USD is represented as 10000.
-          attr_reader :remaining_amount
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :advance_amount
-        # The time at which the funds were paid out to the connected account's Stripe balance. Given in seconds since unix epoch.
-        attr_reader :advance_paid_out_at
-        # Currency that the financing offer is transacted in. For example, `usd`.
-        attr_reader :currency
-        # The chronologically current repayment interval for the financing offer.
-        attr_reader :current_repayment_interval
-        # The type of disclaimer to use for a financing offer in user-facing surfaces. The corresponding disclaimer text to use for each disclaimer_variant value can be found in the [regulatory compliance docs](https://docs.stripe.com/capital/regulatory-compliance).
-        attr_reader :disclaimer_variant
-        # Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
-        attr_reader :fee_amount
-        # The amount the Connected account has paid toward the financing debt so far, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :paid_amount
-        # The balance remaining to be paid on the financing, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :remaining_amount
-        # The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
-        attr_reader :repayments_begin_at
-        # Per-transaction rate at which Stripe withholds funds to repay the financing.
-        attr_reader :withhold_rate
-
-        def self.inner_class_types
-          @inner_class_types = { current_repayment_interval: CurrentRepaymentInterval }
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      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.
-      #
-      # Only present for financing offers with a `status` other than `none`.
-      attr_reader :details
-      # The unique identifier of the Financing Offer object that corresponds to the Financing Summary object.
-      attr_reader :financing_offer
-      # The object type: financing_summary
-      attr_reader :object
-      # The financing status of the connected account.
-      attr_reader :status
-
-      def self.inner_class_types
-        @inner_class_types = { details: Details }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-  end
-end

data/lib/stripe/resources/capital/financing_transaction.rb

@@ -1,99 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Capital
-    # This is an object representing the details of a transaction on a Capital financing object.
-    class FinancingTransaction < APIResource
-      extend Stripe::APIOperations::List
-
-      OBJECT_NAME = "capital.financing_transaction"
-      def self.object_name
-        "capital.financing_transaction"
-      end
-
-      class Details < ::Stripe::StripeObject
-        class Transaction < ::Stripe::StripeObject
-          # The linked payment ID.
-          attr_reader :charge
-          # The linked Treasury Financing Transaction ID.
-          attr_reader :treasury_transaction
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # The advance amount being repaid, paid out, or reversed in minor units.
-        attr_reader :advance_amount
-        # The currency of the financing transaction.
-        attr_reader :currency
-        # The fee amount being repaid, paid out, or reversed in minor units.
-        attr_reader :fee_amount
-        # The linked payment for the transaction. This field only applies to financing transactions of type `payment` and reason `automatic_withholding`.
-        attr_reader :linked_payment
-        # The reason for the financing transaction (if applicable).
-        attr_reader :reason
-        # The reversed transaction. This field only applies to financing
-        # transactions of type `reversal`.
-        attr_reader :reversed_transaction
-        # The advance and fee amount being repaid, paid out, or reversed in minor units.
-        attr_reader :total_amount
-        # This is an object representing a linked transaction on a Capital Financing Transaction.
-        attr_reader :transaction
-
-        def self.inner_class_types
-          @inner_class_types = { transaction: Transaction }
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # The ID of the merchant associated with this financing transaction.
-      attr_reader :account
-      # Time at which the financing transaction was created. Given in seconds since unix epoch.
-      attr_reader :created_at
-      # This is an object representing a transaction on a Capital financing offer.
-      attr_reader :details
-      # The Capital financing offer for this financing transaction.
-      attr_reader :financing_offer
-      # A unique identifier for the financing transaction object.
-      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.
-      attr_reader :legacy_balance_transaction_source
-      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
-      attr_reader :livemode
-      # The object type: financing_transaction
-      attr_reader :object
-      # The type of the financing transaction.
-      attr_reader :type
-      # A human-friendly description of the financing transaction.
-      attr_reader :user_facing_description
-
-      # Returns a list of financing transactions. The transactions are returned in sorted order,
-      # with the most recent transactions appearing first.
-      def self.list(params = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/capital/financing_transactions",
-          params: params,
-          opts: opts
-        )
-      end
-
-      def self.inner_class_types
-        @inner_class_types = { details: Details }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-  end
-end

data/lib/stripe/resources/financial_connections/account_inferred_balance.rb

@@ -1,35 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: 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
-      OBJECT_NAME = "financial_connections.account_inferred_balance"
-      def self.object_name
-        "financial_connections.account_inferred_balance"
-      end
-
-      # 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.
-      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.
-      attr_reader :current
-      # Unique identifier for the object.
-      attr_reader :id
-      # String representing the object's type. Objects of the same type share the same value.
-      attr_reader :object
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-  end
-end

data/lib/stripe/resources/financial_connections/institution.rb

@@ -1,127 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: 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
-      extend Stripe::APIOperations::List
-
-      OBJECT_NAME = "financial_connections.institution"
-      def self.object_name
-        "financial_connections.institution"
-      end
-
-      class Features < ::Stripe::StripeObject
-        class Balances < ::Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          attr_reader :supported
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-
-        class Ownership < ::Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          attr_reader :supported
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-
-        class PaymentMethod < ::Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          attr_reader :supported
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-
-        class Transactions < ::Stripe::StripeObject
-          # Whether the given feature is supported by this institution.
-          attr_reader :supported
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # Attribute for field balances
-        attr_reader :balances
-        # Attribute for field ownership
-        attr_reader :ownership
-        # Attribute for field payment_method
-        attr_reader :payment_method
-        # Attribute for field transactions
-        attr_reader :transactions
-
-        def self.inner_class_types
-          @inner_class_types = {
-            balances: Balances,
-            ownership: Ownership,
-            payment_method: PaymentMethod,
-            transactions: Transactions,
-          }
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # The list of countries supported by this institution, formatted as ISO country codes.
-      attr_reader :countries
-      # Attribute for field features
-      attr_reader :features
-      # Unique identifier for the object.
-      attr_reader :id
-      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
-      attr_reader :livemode
-      # The name of this institution.
-      attr_reader :name
-      # String representing the object's type. Objects of the same type share the same value.
-      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.
-      attr_reader :routing_numbers
-      # The status of this institution in the Financial Connections authentication flow.
-      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.
-      attr_reader :url
-
-      # Returns a list of Financial Connections Institution objects.
-      def self.list(params = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/financial_connections/institutions",
-          params: params,
-          opts: opts
-        )
-      end
-
-      def self.inner_class_types
-        @inner_class_types = { features: Features }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-  end
-end

data/lib/stripe/resources/fx_quote.rb

@@ -1,149 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # The FX Quotes API provides three functions:
-  # - View Stripe's current exchange rate for any given currency pair.
-  # - Extend quoted rates for up to a 24-hour period, minimizing uncertainty from FX fluctuations.
-  # - Preview the FX fees Stripe will charge on your FX transaction, allowing you to anticipate specific settlement amounts before payment costs.
-  #
-  # [View the docs](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api)
-  class FxQuote < APIResource
-    extend Stripe::APIOperations::Create
-    extend Stripe::APIOperations::List
-
-    OBJECT_NAME = "fx_quote"
-    def self.object_name
-      "fx_quote"
-    end
-
-    class Rates < ::Stripe::StripeObject
-      class RateDetails < ::Stripe::StripeObject
-        # The rate for the currency pair.
-        attr_reader :base_rate
-        # The fee for locking the conversion rates.
-        attr_reader :duration_premium
-        # The FX fee for the currency pair.
-        attr_reader :fx_fee_rate
-        # A reference rate for the currency pair provided by the reference rate provider.
-        attr_reader :reference_rate
-        # The reference rate provider.
-        attr_reader :reference_rate_provider
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # The rate that includes the FX fee rate.
-      attr_reader :exchange_rate
-      # Attribute for field rate_details
-      attr_reader :rate_details
-
-      def self.inner_class_types
-        @inner_class_types = { rate_details: RateDetails }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class Usage < ::Stripe::StripeObject
-      class Payment < ::Stripe::StripeObject
-        # The Stripe account ID that the funds will be transferred to.
-        #
-        # This field should match the account ID that would be used in the PaymentIntent’s transfer_data[destination] field.
-        attr_reader :destination
-        # The Stripe account ID that these funds are intended for.
-        #
-        # This field must match the account ID that would be used in the PaymentIntent’s on_behalf_of field.
-        attr_reader :on_behalf_of
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-
-      class Transfer < ::Stripe::StripeObject
-        # The Stripe account ID that the funds will be transferred to.
-        #
-        # This field should match the account ID that would be used in the Transfer’s destination field.
-        attr_reader :destination
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # The details required to use an FX Quote for a payment
-      attr_reader :payment
-      # The details required to use an FX Quote for a transfer
-      attr_reader :transfer
-      # The transaction type for which the FX Quote will be used.
-      #
-      # Can be 'payment' or 'transfer'.
-      attr_reader :type
-
-      def self.inner_class_types
-        @inner_class_types = { payment: Payment, transfer: Transfer }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-    # Time at which the quote was created, measured in seconds since the Unix epoch.
-    attr_reader :created
-    # Unique identifier for the object.
-    attr_reader :id
-    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
-    attr_reader :livemode
-    # The duration that the quote is locked for, from creation time. The quote will be usable for the duration specified.
-    attr_reader :lock_duration
-    # Time at which the quote will expire, measured in seconds since the Unix epoch.
-    #
-    # If lock_duration is set to ‘none’ this field will be set to null.
-    attr_reader :lock_expires_at
-    # Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp.
-    #
-    # Can return value none, active, or expired.
-    attr_reader :lock_status
-    # String representing the object's type. Objects of the same type share the same value.
-    attr_reader :object
-    # Information about the rates.
-    attr_reader :rates
-    # The currency to convert into, typically this is the currency that you want to settle to your Stripe balance. Three-letter ISO currency code, in lowercase. Must be a supported currency.
-    attr_reader :to_currency
-    # Attribute for field usage
-    attr_reader :usage
-
-    # Creates an FX Quote object
-    def self.create(params = {}, opts = {})
-      request_stripe_object(method: :post, path: "/v1/fx_quotes", params: params, opts: opts)
-    end
-
-    # Returns a list of active FX quotes. The FX quotes are returned in sorted order, with the most recent FX quotes appearing first.
-    def self.list(params = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/fx_quotes", params: params, opts: opts)
-    end
-
-    def self.inner_class_types
-      @inner_class_types = { rates: Rates, usage: Usage }
-    end
-
-    def self.field_remappings
-      @field_remappings = {}
-    end
-  end
-end