stripe 14.0.0 → 14.1.0.pre.beta.1

data/lib/stripe/resources/event.rb

@@ -47,6 +47,35 @@ module Stripe
       attr_reader :previous_attributes
     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
+        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
+      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
+      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
+    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
@@ -113,6 +142,8 @@ module Stripe
     attr_reader :account
     # The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.
     attr_reader :api_version
+    # Attribute for field context
+    attr_reader :context
     # Time at which the object was created. Measured in seconds since the Unix epoch.
     attr_reader :created
     # Attribute for field data
@@ -125,6 +156,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`).

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
       end
@@ -64,6 +69,15 @@ module Stripe
         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
@@ -90,10 +104,13 @@ module Stripe
           attr_accessor :account
           # The ID of the Stripe customer whose accounts will be retrieved.
           attr_accessor :customer
+          # The Account ID of the Stripe customer whose accounts will be retrieved.
+          attr_accessor :customer_account
 
-          def initialize(account: nil, customer: nil)
+          def initialize(account: nil, customer: nil, customer_account: nil)
             @account = account
             @customer = customer
+            @customer_account = customer_account
           end
         end
         # If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
@@ -211,6 +228,8 @@ 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 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.

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

@@ -0,0 +1,27 @@
+# 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/institution.rb

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

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
       end
@@ -26,6 +28,24 @@ 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
+      end
+
+      class Limits < Stripe::StripeObject
+        # The number of accounts that can be linked in this Session.
+        attr_reader :accounts
+      end
+
+      class ManualEntry < Stripe::StripeObject; end
+
+      class StatusDetails < Stripe::StripeObject
+        class Cancelled < Stripe::StripeObject
+          # The reason for the Session being cancelled.
+          attr_reader :reason
+        end
+        # Attribute for field cancelled
+        attr_reader :cancelled
       end
 
       class CreateParams < Stripe::RequestParams
@@ -34,12 +54,15 @@ module Stripe
           attr_accessor :account
           # The ID of the Stripe customer whose accounts will be retrieved. Should only be present if `type` is `customer`.
           attr_accessor :customer
+          # The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
+          attr_accessor :customer_account
           # Type of account holder to collect accounts for.
           attr_accessor :type
 
-          def initialize(account: nil, customer: nil, type: nil)
+          def initialize(account: nil, customer: nil, customer_account: nil, type: nil)
             @account = account
             @customer = customer
+            @customer_account = customer_account
             @type = type
           end
         end
@@ -49,10 +72,31 @@ module Stripe
           attr_accessor :account_subcategories
           # List of countries from which to collect accounts.
           attr_accessor :countries
+          # Stripe ID of the institution with which the customer should be directed to log in.
+          attr_accessor :institution
 
-          def initialize(account_subcategories: nil, countries: nil)
+          def initialize(account_subcategories: nil, countries: nil, institution: nil)
             @account_subcategories = account_subcategories
             @countries = countries
+            @institution = institution
+          end
+        end
+
+        class Limits < Stripe::RequestParams
+          # The number of accounts that can be linked in this Session.
+          attr_accessor :accounts
+
+          def initialize(accounts: nil)
+            @accounts = accounts
+          end
+        end
+
+        class ManualEntry < Stripe::RequestParams
+          # Whether manual entry will be handled by Stripe during the Session.
+          attr_accessor :mode
+
+          def initialize(mode: nil)
+            @mode = mode
           end
         end
         # The account holder to link accounts for.
@@ -61,6 +105,10 @@ module Stripe
         attr_accessor :expand
         # Filters to restrict the kinds of accounts to collect.
         attr_accessor :filters
+        # Settings for configuring Session-specific limits.
+        attr_accessor :limits
+        # Customize manual entry behavior
+        attr_accessor :manual_entry
         # List of data features that you would like to request access to.
         #
         # Possible values are `balances`, `transactions`, `ownership`, and `payment_method`.
@@ -74,6 +122,8 @@ module Stripe
           account_holder: nil,
           expand: nil,
           filters: nil,
+          limits: nil,
+          manual_entry: nil,
           permissions: nil,
           prefetch: nil,
           return_url: nil
@@ -81,6 +131,8 @@ module Stripe
           @account_holder = account_holder
           @expand = expand
           @filters = filters
+          @limits = limits
+          @manual_entry = manual_entry
           @permissions = permissions
           @prefetch = prefetch
           @return_url = return_url
@@ -96,8 +148,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.
@@ -106,6 +162,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 = {})

data/lib/stripe/resources/gift_cards/card.rb

@@ -0,0 +1,208 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card represents a single gift card owned by a customer, including the
+    # remaining balance, gift card code, and whether or not it is active.
+    class Card < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.card"
+      def self.object_name
+        "gift_cards.card"
+      end
+
+      class CreatedBy < Stripe::StripeObject
+        class Checkout < Stripe::StripeObject
+          # The Stripe CheckoutSession that created this object.
+          attr_reader :checkout_session
+          # The Stripe CheckoutSession LineItem that created this object.
+          attr_reader :line_item
+        end
+
+        class Order < Stripe::StripeObject
+          # The Stripe Order LineItem that created this object.
+          attr_reader :line_item
+          # The Stripe Order that created this object.
+          attr_reader :order
+        end
+
+        class Payment < Stripe::StripeObject
+          # The PaymentIntent that created this object.
+          attr_reader :payment_intent
+        end
+        # Attribute for field checkout
+        attr_reader :checkout
+        # Attribute for field order
+        attr_reader :order
+        # Attribute for field payment
+        attr_reader :payment
+        # The type of event that created this object.
+        attr_reader :type
+      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 CreateParams < Stripe::RequestParams
+        class CreatedBy < Stripe::RequestParams
+          class Payment < Stripe::RequestParams
+            # The PaymentIntent used to collect payment for this object.
+            attr_accessor :payment_intent
+
+            def initialize(payment_intent: nil)
+              @payment_intent = payment_intent
+            end
+          end
+          # The details for the payment that created this object.
+          attr_accessor :payment
+          # The type of event that created this object.
+          attr_accessor :type
+
+          def initialize(payment: nil, type: nil)
+            @payment = payment
+            @type = type
+          end
+        end
+        # The active state for the new gift card, defaults to false. The active state can be updated after creation.
+        attr_accessor :active
+        # Related objects which created this gift card.
+        attr_accessor :created_by
+        # 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_accessor :currency
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The initial amount to load onto the new gift card, defaults to 0.
+        attr_accessor :initial_amount
+        # 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(
+          active: nil,
+          created_by: nil,
+          currency: nil,
+          expand: nil,
+          initial_amount: nil,
+          metadata: nil
+        )
+          @active = active
+          @created_by = created_by
+          @currency = currency
+          @expand = expand
+          @initial_amount = initial_amount
+          @metadata = metadata
+        end
+      end
+
+      class UpdateParams < Stripe::RequestParams
+        # The new active state for the gift card.
+        attr_accessor :active
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # 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(active: nil, expand: nil, metadata: nil)
+          @active = active
+          @expand = expand
+          @metadata = metadata
+        end
+      end
+
+      class ValidateParams < Stripe::RequestParams
+        # The gift card code to be validated.
+        attr_accessor :code
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The pin associated with the gift card. Not all gift cards have pins.
+        attr_accessor :giftcard_pin
+
+        def initialize(code: nil, expand: nil, giftcard_pin: nil)
+          @code = code
+          @expand = expand
+          @giftcard_pin = giftcard_pin
+        end
+      end
+      # Whether this gift card can be used or not.
+      attr_reader :active
+      # The amount of funds available for new transactions.
+      attr_reader :amount_available
+      # The amount of funds marked as held.
+      attr_reader :amount_held
+      # Code used to redeem this gift card.
+      attr_reader :code
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The related Stripe objects that created this gift card.
+      attr_reader :created_by
+      # 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
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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
+      # Transactions on this gift card.
+      attr_reader :transactions
+
+      # Creates a new gift card object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List gift cards for an account
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a gift card
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Validates a gift card code, returning the matching gift card object if it exists.
+      def self.validate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/cards/validate",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end