stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/event.rb

@@ -2,35 +2,23 @@
 # frozen_string_literal: true
 
 module Stripe
-  # Events are our way of letting you know when something interesting happens in
-  # your account. When an interesting event occurs, we create a new `Event`
-  # object. For example, when a charge succeeds, we create a `charge.succeeded`
-  # event, and when an invoice payment attempt fails, we create an
-  # `invoice.payment_failed` event. Certain API requests might create multiple
-  # events. For example, if you create a new subscription for a
-  # customer, you receive both a `customer.subscription.created` event and a
-  # `charge.succeeded` event.
+  # Snapshot events allow you to track and react to activity in your Stripe integration. When
+  # the state of another API resource changes, Stripe creates an `Event` object that contains
+  # all the relevant information associated with that action, including the affected API
+  # resource. For example, a successful payment triggers a `charge.succeeded` event, which
+  # contains the `Charge` in the event's data property. Some actions trigger multiple events.
+  # For example, if you create a new subscription for a customer, it triggers both a
+  # `customer.subscription.created` event and a `charge.succeeded` event.
   #
-  # Events occur when the state of another API resource changes. The event's data
-  # field embeds the resource's state at the time of the change. For
-  # example, a `charge.succeeded` event contains a charge, and an
-  # `invoice.payment_failed` event contains an invoice.
+  # Configure an event destination in your account to listen for events that represent actions
+  # your integration needs to respond to. Additionally, you can retrieve an individual event or
+  # a list of events from the API.
   #
-  # As with other API resources, you can use endpoints to retrieve an
-  # [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)
-  # from the API. We also have a separate
-  # [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the
-  # `Event` objects directly to an endpoint on your server. You can manage
-  # webhooks in your
-  # [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
-  # to [listen for events](https://docs.stripe.com/webhooks)
-  # so that your integration can automatically trigger reactions.
+  # [Connect](https://docs.stripe.com/connect) platforms can also receive event notifications
+  # that occur in their connected accounts. These events include an account attribute that
+  # identifies the relevant connected account.
   #
-  # When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications
-  # that occur in connected accounts. For these events, there's an
-  # additional `account` attribute in the received `Event` object.
-  #
-  # We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)
+  # You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)
   # for 30 days.
   class Event < APIResource
     extend Stripe::APIOperations::List
@@ -40,9 +28,69 @@ module Stripe
       "event"
     end
 
+    class Data < Stripe::StripeObject
+      # Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.
+      attr_reader :object
+      # Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.
+      attr_reader :previous_attributes
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      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
+    # The connected account that originates the event.
+    attr_reader :account
+    # The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.
+    attr_reader :api_version
+    # Authentication context needed to fetch the event or related object.
+    attr_reader :context
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Attribute for field data
+    attr_reader :data
+    # 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
+    # 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 on the API request that triggers the event.
+    attr_reader :request
+    # Description of the event (for example, `invoice.created` or `charge.refunded`).
+    attr_reader :type
+
     # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
     def self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/events", params: params, opts: opts)
     end
+
+    def self.inner_class_types
+      @inner_class_types = { data: Data, request: Request }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/exchange_rate.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # [Deprecated] The `ExchangeRate` APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.
+  #
   # `ExchangeRate` objects allow you to determine the rates that Stripe is currently
   # using to convert from one currency to another. Since this number is variable
   # throughout the day, there are various reasons why you might want to know the current
@@ -29,6 +31,7 @@ module Stripe
   #
   # *Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*
   class ExchangeRate < APIResource
+    extend Gem::Deprecate
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "exchange_rate"
@@ -36,9 +39,31 @@ module Stripe
       "exchange_rate"
     end
 
+    # Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
+    attr_reader :rates
+
+    # [Deprecated] The ExchangeRate APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead.
+    #
     # Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
     def self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/exchange_rates", params: params, opts: opts)
     end
+
+    class << self
+      extend Gem::Deprecate
+      deprecate :list, :none, 2024, 3
+    end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/file.rb

@@ -6,7 +6,7 @@ module Stripe
   # files with the [create file](https://stripe.com/docs/api#create_file) request
   # (for example, when uploading dispute evidence). Stripe also
   # creates files independently (for example, the results of a [Sigma scheduled
-  # query](https://stripe.com/docs/api#scheduled_queries)).
+  # query](https://docs.stripe.com/api#scheduled_queries)).
   #
   # Related guide: [File upload guide](https://stripe.com/docs/file-upload)
   class File < APIResource
@@ -18,6 +18,29 @@ module Stripe
       "file"
     end
 
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # The file expires and isn't available at this time in epoch seconds.
+    attr_reader :expires_at
+    # The suitable name for saving the file to a filesystem.
+    attr_reader :filename
+    # Unique identifier for the object.
+    attr_reader :id
+    # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
+    attr_reader :links
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+    attr_reader :purpose
+    # The size of the file object in bytes.
+    attr_reader :size
+    # A suitable title for the document.
+    attr_reader :title
+    # The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
+    attr_reader :type
+    # Use your live secret API key to download the file from this URL.
+    attr_reader :url
+
     # To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
     #
     # All of Stripe's officially supported Client libraries support sending multipart/form-data.
@@ -54,5 +77,13 @@ module Stripe
     def self.resource_url
       "/v1/files"
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/file_link.rb

@@ -15,6 +15,25 @@ module Stripe
       "file_link"
     end
 
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Returns if the link is already expired.
+    attr_reader :expired
+    # Time that the link expires.
+    attr_reader :expires_at
+    # The file object this link points to.
+    attr_reader :file
+    # 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
+    # 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.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The publicly accessible URL to download the file.
+    attr_reader :url
+
     # Creates a new file link object.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/file_links", params: params, opts: opts)
@@ -34,5 +53,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

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

@@ -12,6 +12,185 @@ module Stripe
         "financial_connections.account"
       end
 
+      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
+        # 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 Balance < Stripe::StripeObject
+        class Cash < Stripe::StripeObject
+          # The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and 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 :available
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Credit < Stripe::StripeObject
+          # The credit that has been used by the account holder.
+          #
+          # 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 :used
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.
+        attr_reader :as_of
+        # Attribute for field cash
+        attr_reader :cash
+        # Attribute for field credit
+        attr_reader :credit
+        # 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
+        # The `type` of the balance. An additional hash is included on the balance with a name matching this value.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { cash: Cash, credit: Credit }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BalanceRefresh < 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 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
+        # Time at which the next ownership 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 TransactionRefresh < Stripe::StripeObject
+        # Unique identifier for the object.
+        attr_reader :id
+        # 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 transaction 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
+      # The account holder that this account belongs to.
+      attr_reader :account_holder
+      # The most recent information about the account's balance.
+      attr_reader :balance
+      # The state of the most recent attempt to refresh the account balance.
+      attr_reader :balance_refresh
+      # The type of the account. Account category is further divided in `subcategory`.
+      attr_reader :category
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # A human-readable name that has been assigned to this account, either by the account holder or by the institution.
+      attr_reader :display_name
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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.
+      attr_reader :last4
+      # 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 most recent information about the account's owners.
+      attr_reader :ownership
+      # The state of the most recent attempt to refresh the account owners.
+      attr_reader :ownership_refresh
+      # The list of permissions granted by this account.
+      attr_reader :permissions
+      # The status of the link to the account.
+      attr_reader :status
+      # If `category` is `cash`, one of:
+      #
+      #  - `checking`
+      #  - `savings`
+      #  - `other`
+      #
+      # If `category` is `credit`, one of:
+      #
+      #  - `mortgage`
+      #  - `line_of_credit`
+      #  - `credit_card`
+      #  - `other`
+      #
+      # If `category` is `investment` or `other`, this will be `other`.
+      attr_reader :subcategory
+      # The list of data refresh subscriptions requested on this account.
+      attr_reader :subscriptions
+      # The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
+      attr_reader :supported_payment_method_types
+      # The state of the most recent attempt to refresh the account transactions.
+      attr_reader :transaction_refresh
+
       # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
       def disconnect(params = {}, opts = {})
         request_stripe_object(
@@ -121,6 +300,20 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          account_holder: AccountHolder,
+          balance: Balance,
+          balance_refresh: BalanceRefresh,
+          ownership_refresh: OwnershipRefresh,
+          transaction_refresh: TransactionRefresh,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -9,6 +9,31 @@ module Stripe
       def self.object_name
         "financial_connections.account_owner"
       end
+
+      # The email address of the owner.
+      attr_reader :email
+      # Unique identifier for the object.
+      attr_reader :id
+      # The full name of the owner.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ownership object that this owner belongs to.
+      attr_reader :ownership
+      # The raw phone number of the owner.
+      attr_reader :phone
+      # The raw physical address of the owner.
+      attr_reader :raw_address
+      # The timestamp of the refresh that updated this owner.
+      attr_reader :refreshed_at
+
+      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/account_ownership.rb

@@ -9,6 +9,23 @@ module Stripe
       def self.object_name
         "financial_connections.account_ownership"
       end
+
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # 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
+      # A paginated list of owners for this account.
+      attr_reader :owners
+
+      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/session.rb

@@ -12,6 +12,58 @@ module Stripe
         "financial_connections.session"
       end
 
+      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
+        # 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 Filters < Stripe::StripeObject
+        # Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.
+        attr_reader :account_subcategories
+        # List of countries from which to filter accounts.
+        attr_reader :countries
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        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.
+      attr_reader :accounts
+      # A value that will be passed to the client to launch the authentication flow.
+      attr_reader :client_secret
+      # Attribute for field filters
+      attr_reader :filters
+      # 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
+      # Permissions requested for accounts collected during this session.
+      attr_reader :permissions
+      # Data features requested to be retrieved upon account creation.
+      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
+
       # 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 = {})
         request_stripe_object(
@@ -21,6 +73,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { account_holder: AccountHolder, filters: Filters }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -12,6 +12,45 @@ module Stripe
         "financial_connections.transaction"
       end
 
+      class StatusTransitions < Stripe::StripeObject
+        # Time at which this transaction posted. Measured in seconds since the Unix epoch.
+        attr_reader :posted_at
+        # Time at which this transaction was voided. Measured in seconds since the Unix epoch.
+        attr_reader :void_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The ID of the Financial Connections Account this transaction belongs to.
+      attr_reader :account
+      # The amount of this transaction, in cents (or local equivalent).
+      attr_reader :amount
+      # 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).
+      attr_reader :currency
+      # The description of this transaction.
+      attr_reader :description
+      # 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 status of the transaction.
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # Time at which the transaction was transacted. Measured in seconds since the Unix epoch.
+      attr_reader :transacted_at
+      # The token of the transaction refresh that last updated or created this transaction.
+      attr_reader :transaction_refresh
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+
       # Returns a list of Financial Connections Transaction objects.
       def self.list(params = {}, opts = {})
         request_stripe_object(
@@ -21,6 +60,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { status_transitions: StatusTransitions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end