stripe 13.3.0 → 13.4.0.pre.beta.1

data/lib/stripe/resources/file_link.rb

@@ -15,6 +15,140 @@ module Stripe
       "file_link"
     end
 
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Only return links that were created during the given date interval.
+      attr_accessor :created
+
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      # Filter links by their expiration status. By default, Stripe returns all links.
+      attr_accessor :expired
+
+      # Only return links for the given file.
+      attr_accessor :file
+
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        expired: nil,
+        file: nil,
+        limit: nil,
+        starting_after: nil
+      )
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @expired = expired
+        @file = file
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      # The link isn't usable after this future timestamp.
+      attr_accessor :expires_at
+
+      # The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
+      attr_accessor :file
+
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+
+      def initialize(expand: nil, expires_at: nil, file: nil, metadata: nil)
+        @expand = expand
+        @expires_at = expires_at
+        @file = file
+        @metadata = metadata
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      # A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.
+      attr_accessor :expires_at
+
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+
+      def initialize(expand: nil, expires_at: nil, metadata: nil)
+        @expand = expand
+        @expires_at = expires_at
+        @metadata = metadata
+      end
+    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)

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

@@ -6,12 +6,319 @@ 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
+
+        # Type of account holder that this account belongs to.
+        attr_reader :type
+      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
+        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
+        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
+      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
+      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
+      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
+      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
+      end
+
+      class ListParams < Stripe::RequestParams
+        class AccountHolder < Stripe::RequestParams
+          # The ID of the Stripe account whose accounts will be retrieved.
+          attr_accessor :account
+
+          # The ID of the Stripe customer whose accounts will be retrieved.
+          attr_accessor :customer
+
+          def initialize(account: nil, customer: nil)
+            @account = account
+            @customer = customer
+          end
+        end
+        # If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
+        attr_accessor :account_holder
+
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+
+        # If present, only return accounts that were collected as part of the given session.
+        attr_accessor :session
+
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          account_holder: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          session: nil,
+          starting_after: nil
+        )
+          @account_holder = account_holder
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @session = session
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ListOwnersParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+
+        # The ID of the ownership object to fetch owners from.
+        attr_accessor :ownership
+
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          ownership: nil,
+          starting_after: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @ownership = ownership
+          @starting_after = starting_after
+        end
+      end
+
+      class DisconnectParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class RefreshAccountParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        # The list of account features that you would like to refresh.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+
+      class SubscribeParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        # The list of account features to which you would like to subscribe.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        end
+      end
+
+      class UnsubscribeParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        # The list of account features from which you would like to unsubscribe.
+        attr_accessor :features
+
+        def initialize(expand: nil, features: nil)
+          @expand = expand
+          @features = features
+        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 state of the most recent attempt to refresh the account's inferred balance history.
+      attr_reader :inferred_balances_refresh
+
+      # 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(

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

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

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

@@ -9,6 +9,30 @@ 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
     end
   end
 end

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

@@ -9,6 +9,18 @@ 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
     end
   end
 end

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

@@ -0,0 +1,112 @@
+# 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
+        end
+
+        class Ownership < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+        end
+
+        class PaymentMethod < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+        end
+
+        class Transactions < Stripe::StripeObject
+          # Whether the given feature is supported by this institution.
+          attr_reader :supported
+        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
+      end
+
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+      # 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
+    end
+  end
+end