stripe 17.1.0 → 17.2.0.pre.alpha.2

data/lib/stripe/resources/event.rb

@@ -43,6 +43,67 @@ module Stripe
       end
     end
 
+    class Reason < ::Stripe::StripeObject
+      class AutomationAction < ::Stripe::StripeObject
+        class StripeSendWebhookCustomEvent < ::Stripe::StripeObject
+          # Set of key-value pairs attached to the action when creating an Automation.
+          attr_reader :custom_data
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field stripe_send_webhook_custom_event
+        attr_reader :stripe_send_webhook_custom_event
+        # The trigger name of the automation that triggered this action.
+        #  Please visit [Revenue and retention automations](https://docs.stripe.com/billing/automations#choose-a-trigger) for all possible trigger names.
+        attr_reader :trigger
+        # The type of the `automation_action`.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { stripe_send_webhook_custom_event: StripeSendWebhookCustomEvent }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Request < ::Stripe::StripeObject
+        # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
+        attr_reader :id
+        # The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
+        attr_reader :idempotency_key
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field automation_action
+      attr_reader :automation_action
+      # Attribute for field request
+      attr_reader :request
+      # The type of the reason for the event.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { automation_action: AutomationAction, request: Request }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Request < ::Stripe::StripeObject
       # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
       attr_reader :id
@@ -75,6 +136,8 @@ module Stripe
     attr_reader :object
     # Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
     attr_reader :pending_webhooks
+    # Information about the action that causes the event. Only present when the event is triggered by an API request or an [Automation](https://docs.stripe.com/billing/automations) action.
+    attr_reader :reason
     # Information on the API request that triggers the event.
     attr_reader :request
     # Description of the event (for example, `invoice.created` or `charge.refunded`).
@@ -86,7 +149,7 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = { data: Data, request: Request }
+      @inner_class_types = { data: Data, reason: Reason, request: Request }
     end
 
     def self.field_remappings

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

@@ -6,17 +6,22 @@ module Stripe
     # A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
     class Account < APIResource
       extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
 
       OBJECT_NAME = "financial_connections.account"
       def self.object_name
         "financial_connections.account"
       end
 
+      nested_resource_class_methods :inferred_balance, operations: %i[list]
+
       class AccountHolder < ::Stripe::StripeObject
         # The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
         attr_reader :account
         # ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
         attr_reader :customer
+        # Attribute for field customer_account
+        attr_reader :customer_account
         # Type of account holder that this account belongs to.
         attr_reader :type
 
@@ -104,6 +109,23 @@ module Stripe
         end
       end
 
+      class InferredBalancesRefresh < ::Stripe::StripeObject
+        # The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
+        attr_reader :last_attempted_at
+        # Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
+        attr_reader :next_refresh_available_at
+        # The status of the last refresh attempt.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class OwnershipRefresh < ::Stripe::StripeObject
         # The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
         attr_reader :last_attempted_at
@@ -153,6 +175,10 @@ module Stripe
       attr_reader :display_name
       # Unique identifier for the object.
       attr_reader :id
+      # The state of the most recent attempt to refresh the account's inferred balance history.
+      attr_reader :inferred_balances_refresh
+      # The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).
+      attr_reader :institution
       # The name of the institution that holds this account.
       attr_reader :institution_name
       # The last 4 digits of the account number. If present, this will be 4 numeric characters.
@@ -306,6 +332,7 @@ module Stripe
           account_holder: AccountHolder,
           balance: Balance,
           balance_refresh: BalanceRefresh,
+          inferred_balances_refresh: InferredBalancesRefresh,
           ownership_refresh: OwnershipRefresh,
           transaction_refresh: TransactionRefresh,
         }

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

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

@@ -0,0 +1,127 @@
+# 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
+      # 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
+      # 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/financial_connections/session.rb

@@ -17,6 +17,8 @@ module Stripe
         attr_reader :account
         # ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
         attr_reader :customer
+        # Attribute for field customer_account
+        attr_reader :customer_account
         # Type of account holder that this account belongs to.
         attr_reader :type
 
@@ -34,6 +36,8 @@ module Stripe
         attr_reader :account_subcategories
         # List of countries from which to filter accounts.
         attr_reader :countries
+        # Stripe ID of the institution with which the customer should be directed to log in.
+        attr_reader :institution
 
         def self.inner_class_types
           @inner_class_types = {}
@@ -43,6 +47,54 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class Limits < ::Stripe::StripeObject
+        # The number of accounts that can be linked in this Session.
+        attr_reader :accounts
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ManualEntry < ::Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusDetails < ::Stripe::StripeObject
+        class Cancelled < ::Stripe::StripeObject
+          # The reason for the Session being cancelled.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field cancelled
+        attr_reader :cancelled
+
+        def self.inner_class_types
+          @inner_class_types = { cancelled: Cancelled }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
       # The account holder for whom accounts are collected in this session.
       attr_reader :account_holder
       # The accounts that were collected as part of this Session.
@@ -53,8 +105,12 @@ module Stripe
       attr_reader :filters
       # Unique identifier for the object.
       attr_reader :id
+      # Attribute for field limits
+      attr_reader :limits
       # 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
+      # Attribute for field manual_entry
+      attr_reader :manual_entry
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Permissions requested for accounts collected during this session.
@@ -63,6 +119,10 @@ module Stripe
       attr_reader :prefetch
       # For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
       attr_reader :return_url
+      # The current state of the session.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
 
       # To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
       def self.create(params = {}, opts = {})
@@ -75,7 +135,13 @@ module Stripe
       end
 
       def self.inner_class_types
-        @inner_class_types = { account_holder: AccountHolder, filters: Filters }
+        @inner_class_types = {
+          account_holder: AccountHolder,
+          filters: Filters,
+          limits: Limits,
+          manual_entry: ManualEntry,
+          status_details: StatusDetails,
+        }
       end
 
       def self.field_remappings

data/lib/stripe/resources/fx_quote.rb

@@ -0,0 +1,147 @@
+# 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 a 1-hour period or 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
+    # The duration the exchange rate quote remains valid from creation time. Allowed values are none, hour, and day. Note that for the test mode API available in alpha, you can request an extended quote, but it won't be usable for any transactions.
+    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 FX quotes that have been issued. 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

data/lib/stripe/resources/identity/blocklist_entry.rb

@@ -0,0 +1,116 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    # A BlocklistEntry represents an entry in our identity verification blocklist.
+    # It helps prevent fraudulent users from repeatedly attempting verification with similar information.
+    # When you create a BlocklistEntry, we store data from a specified VerificationReport,
+    # such as document details or facial biometrics.
+    # This allows us to compare future verification attempts against these entries.
+    # If a match is found, we categorize the new verification as unverified.
+    #
+    # To learn more, see [Identity Verification Blocklist](https://stripe.com/docs/identity/review-tools#block-list)
+    class BlocklistEntry < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "identity.blocklist_entry"
+      def self.object_name
+        "identity.blocklist_entry"
+      end
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Time at which you disabled the BlocklistEntry. Measured in seconds since the Unix epoch.
+      attr_reader :disabled_at
+      # Time at which the BlocklistEntry expires. Measured in seconds since the Unix epoch.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The current status of the BlocklistEntry.
+      attr_reader :status
+      # The type of BlocklistEntry.
+      attr_reader :type
+      # The verification report the BlocklistEntry was created from.
+      attr_reader :verification_report
+      # The verification session the BlocklistEntry was created from.
+      attr_reader :verification_session
+
+      # Creates a BlocklistEntry object from a verification report.
+      #
+      # A blocklist entry prevents future identity verifications that match the same identity information.
+      # You can create blocklist entries from verification reports that contain document extracted data
+      # or a selfie.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#add-a-blocklist-entry)
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Disables a BlocklistEntry object.
+      #
+      # After a BlocklistEntry is disabled, it will no longer block future verifications that match
+      # the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+      # must be created using the same verification report.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+      def disable(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/blocklist_entries/%<id>s/disable", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Disables a BlocklistEntry object.
+      #
+      # After a BlocklistEntry is disabled, it will no longer block future verifications that match
+      # the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+      # must be created using the same verification report.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+      def self.disable(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/identity/blocklist_entries/%<id>s/disable", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of BlocklistEntry objects associated with your account.
+      #
+      # The blocklist entries are returned sorted by creation date, with the most recently created
+      # entries appearing first.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end