stripe 18.3.0 → 18.4.0.pre.alpha.1

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,12 +6,15 @@ 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 that this account belongs to. Only available when `account_holder.type` is `account`.
         attr_reader :account
@@ -125,6 +128,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
@@ -142,6 +162,33 @@ module Stripe
         end
       end
 
+      class StatusDetails < ::Stripe::StripeObject
+        class Inactive < ::Stripe::StripeObject
+          # The action (if any) to relink the inactive Account.
+          attr_reader :action
+          # The underlying cause of the Account being inactive.
+          attr_reader :cause
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field inactive
+        attr_reader :inactive
+
+        def self.inner_class_types
+          @inner_class_types = { inactive: Inactive }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class TransactionRefresh < ::Stripe::StripeObject
         # Unique identifier for the object.
         attr_reader :id
@@ -164,6 +211,8 @@ module Stripe
       attr_reader :account_holder
       # Details about the account numbers.
       attr_reader :account_numbers
+      # The ID of the Financial Connections Authorization this account belongs to.
+      attr_reader :authorization
       # The most recent information about the account's balance.
       attr_reader :balance
       # The state of the most recent attempt to refresh the account balance.
@@ -176,6 +225,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.
@@ -192,6 +245,8 @@ module Stripe
       attr_reader :permissions
       # The status of the link to the account.
       attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
       # If `category` is `cash`, one of:
       #
       #  - `checking`
@@ -330,7 +385,9 @@ module Stripe
           account_numbers: AccountNumber,
           balance: Balance,
           balance_refresh: BalanceRefresh,
+          inferred_balances_refresh: InferredBalancesRefresh,
           ownership_refresh: OwnershipRefresh,
+          status_details: StatusDetails,
           transaction_refresh: TransactionRefresh,
         }
       end

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/authorization.rb

@@ -0,0 +1,82 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # An Authorization represents the set of credentials used to connect a group of Financial Connections Accounts.
+    class Authorization < APIResource
+      OBJECT_NAME = "financial_connections.authorization"
+      def self.object_name
+        "financial_connections.authorization"
+      end
+
+      class AccountHolder < ::Stripe::StripeObject
+        # The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.
+        attr_reader :account
+        # The ID for an Account representing a customer that this account belongs to. Only available when `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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusDetails < ::Stripe::StripeObject
+        class Inactive < ::Stripe::StripeObject
+          # The action (if any) to relink the inactive Authorization.
+          attr_reader :action
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field inactive
+        attr_reader :inactive
+
+        def self.inner_class_types
+          @inner_class_types = { inactive: Inactive }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The account holder that this authorization belongs to.
+      attr_reader :account_holder
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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 this authorization belongs to.
+      attr_reader :institution_name
+      # 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 status of the connection to the Authorization.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
+
+      def self.inner_class_types
+        @inner_class_types = { account_holder: AccountHolder, status_details: StatusDetails }
+      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

@@ -36,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 = {}
@@ -45,6 +47,86 @@ 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 RelinkOptions < ::Stripe::StripeObject
+        # Requires the end user to repair this specific account during the authentication flow instead of connecting a different one.
+        attr_reader :account
+        # The authorization to relink in the Session.
+        attr_reader :authorization
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RelinkResult < ::Stripe::StripeObject
+        # The account relinked in the Session. Only present if `relink_options[account]` is set and relink is successful.
+        attr_reader :account
+        # The authorization relinked in the Session. Only present if relink is successful.
+        attr_reader :authorization
+        # Reason for why relink failed. One of `no_authorization`, `no_account`, or `other`.
+        attr_reader :failure_reason
+
+        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.
@@ -55,16 +137,28 @@ 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.
       attr_reader :permissions
       # Data features requested to be retrieved upon account creation.
       attr_reader :prefetch
+      # Attribute for field relink_options
+      attr_reader :relink_options
+      # Attribute for field relink_result
+      attr_reader :relink_result
       # 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 = {})
@@ -77,7 +171,15 @@ 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,
+          relink_options: RelinkOptions,
+          relink_result: RelinkResult,
+          status_details: StatusDetails,
+        }
       end
 
       def self.field_remappings