stripe 19.3.0 → 19.4.0.pre.alpha.2

data/lib/stripe/resources/tax_fund.rb

@@ -0,0 +1,179 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A TaxFund object represents a single tax float sweep event — funds moved between
+  # a merchant's payments balance and their tax fund financial account for Stripe Tax obligations.
+  class TaxFund < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "tax_fund"
+    def self.object_name
+      "tax_fund"
+    end
+
+    class Context < ::Stripe::StripeObject
+      # The Checkout Session associated with this sweep, if any.
+      attr_reader :checkout_session
+      # The Credit Note associated with this sweep, if any.
+      attr_reader :credit_note
+      # The Invoice associated with this sweep, if any.
+      attr_reader :invoice
+      # The PaymentIntent associated with this sweep, if any.
+      attr_reader :payment_intent
+      # The Refund associated with this sweep, if any.
+      attr_reader :refund
+      # The Tax Transaction associated with this sweep, if any.
+      attr_reader :tax_transaction
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Destination < ::Stripe::StripeObject
+      class PaymentsBalance < ::Stripe::StripeObject
+        # The balance transaction on the payments balance side of the sweep.
+        attr_reader :balance_transaction
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class TaxFundAccount < ::Stripe::StripeObject
+        # The tax fund financial account involved in the sweep.
+        attr_reader :financial_account
+        # The financial account transaction on the tax fund account side of the sweep.
+        attr_reader :transaction
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Details about the payments balance side of the sweep.
+      attr_reader :payments_balance
+      # Details about the tax fund financial account side of the sweep.
+      attr_reader :tax_fund_account
+      # The type of account funds moved to or from. Either `payments_balance` or `tax_fund_account`.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { payments_balance: PaymentsBalance, tax_fund_account: TaxFundAccount }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Source < ::Stripe::StripeObject
+      class PaymentsBalance < ::Stripe::StripeObject
+        # The balance transaction on the payments balance side of the sweep.
+        attr_reader :balance_transaction
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class TaxFundAccount < ::Stripe::StripeObject
+        # The tax fund financial account involved in the sweep.
+        attr_reader :financial_account
+        # The financial account transaction on the tax fund account side of the sweep.
+        attr_reader :transaction
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Details about the payments balance side of the sweep.
+      attr_reader :payments_balance
+      # Details about the tax fund financial account side of the sweep.
+      attr_reader :tax_fund_account
+      # The type of account funds moved to or from. Either `payments_balance` or `tax_fund_account`.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { payments_balance: PaymentsBalance, tax_fund_account: TaxFundAccount }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Trigger < ::Stripe::StripeObject
+      # The balance transaction on the payments balance that triggered the sweep.
+      attr_reader :balance_transaction
+      # The type of event that triggered the sweep. Always `balance_transaction`.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Amount swept, in the smallest currency unit. Always positive.
+    attr_reader :amount
+    # Associated billing or tax documents for this sweep.
+    attr_reader :context
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # 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
+    # Where funds moved to.
+    attr_reader :destination
+    # Unique identifier for the object.
+    attr_reader :id
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+    attr_reader :livemode
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Where funds moved from.
+    attr_reader :source
+    # What caused the sweep.
+    attr_reader :trigger
+
+    # Returns a list of tax funds in reverse chronological order.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/tax_funds", params: params, opts: opts)
+    end
+
+    def self.inner_class_types
+      @inner_class_types = {
+        context: Context,
+        destination: Destination,
+        source: Source,
+        trigger: Trigger,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/terminal/configuration.rb

@@ -68,6 +68,19 @@ module Stripe
         end
       end
 
+      class ReaderSecurity < ::Stripe::StripeObject
+        # Passcode used to access a reader's admin menu.
+        attr_reader :admin_menu_passcode
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class RebootWindow < ::Stripe::StripeObject
         # Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.
         attr_reader :end_hour
@@ -701,6 +714,8 @@ module Stripe
       attr_reader :object
       # Attribute for field offline
       attr_reader :offline
+      # Attribute for field reader_security
+      attr_reader :reader_security
       # Attribute for field reboot_window
       attr_reader :reboot_window
       # Attribute for field stripe_s700
@@ -778,6 +793,7 @@ module Stripe
           bbpos_wisepos_e: BbposWiseposE,
           cellular: Cellular,
           offline: Offline,
+          reader_security: ReaderSecurity,
           reboot_window: RebootWindow,
           stripe_s700: StripeS700,
           stripe_s710: StripeS710,

data/lib/stripe/resources/terminal/reader.rb

@@ -315,6 +315,8 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # Represents a per-transaction override of a reader configuration
           attr_reader :collect_config
           # Most recent PaymentIntent processed by the reader.
@@ -348,6 +350,8 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # Represents a per-transaction override of a reader configuration
           attr_reader :confirm_config
           # Most recent PaymentIntent processed by the reader.
@@ -426,6 +430,8 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # Most recent PaymentIntent processed by the reader.
           attr_reader :payment_intent
           # Represents a per-transaction override of a reader configuration
@@ -482,6 +488,8 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # Account the payment intent belongs to.
+          attr_reader :account
           # The amount being refunded.
           attr_reader :amount
           # Charge that is being refunded.

data/lib/stripe/resources/terminal/reader_collected_data.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    # Returns data collected by Terminal readers. This data is only stored for 24 hours.
+    class ReaderCollectedData < APIResource
+      OBJECT_NAME = "terminal.reader_collected_data"
+      def self.object_name
+        "terminal.reader_collected_data"
+      end
+
+      class Magstripe < ::Stripe::StripeObject
+        # The raw magstripe data collected by the reader.
+        attr_reader :data
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # The magstripe data collected by the reader.
+      attr_reader :magstripe
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The type of data collected by the reader.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { magstripe: Magstripe }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/token.rb

@@ -30,6 +30,18 @@ module Stripe
       "token"
     end
 
+    class Redaction < ::Stripe::StripeObject
+      # Indicates whether this object and its related objects have been redacted or not.
+      attr_reader :status
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
     # These bank accounts are payment methods on `Customer` objects.
     #
     # On the other hand [External Accounts](/api#external_accounts) are transfer
@@ -54,6 +66,8 @@ module Stripe
     attr_reader :livemode
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
+    # Redaction status of this token. If not null, this token is associated to a redaction job.
+    attr_reader :redaction
     # Type of the token: `account`, `bank_account`, `card`, or `pii`.
     attr_reader :type
     # Determines if you have already used this token (you can only use tokens once).
@@ -66,7 +80,7 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = {}
+      @inner_class_types = { redaction: Redaction }
     end
 
     def self.field_remappings

data/lib/stripe/resources/transfer.rb

@@ -29,6 +29,10 @@ module Stripe
     attr_reader :amount
     # Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
     attr_reader :amount_reversed
+    # Attribute for field application_fee
+    attr_reader :application_fee
+    # Attribute for field application_fee_amount
+    attr_reader :application_fee_amount
     # Balance transaction that describes the impact of this transfer on your account balance.
     attr_reader :balance_transaction
     # Time that this record of the transfer was first created.
@@ -41,6 +45,8 @@ module Stripe
     attr_reader :destination
     # If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
     attr_reader :destination_payment
+    # The FX Quote used for the transfer.
+    attr_reader :fx_quote
     # Unique identifier for the object.
     attr_reader :id
     # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.

data/lib/stripe/resources/transit_balance.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Funds that are in transit and destined for another balance or another connected account.
+  class TransitBalance < APIResource
+    OBJECT_NAME = "transit_balance"
+    def self.object_name
+      "transit_balance"
+    end
+
+    class Balance < ::Stripe::StripeObject
+      # Attribute for field available
+      attr_reader :available
+      # Attribute for field pending
+      attr_reader :pending
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Attribute for field balance
+    attr_reader :balance
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # 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
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+    attr_reader :livemode
+    # 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 = { balance: Balance }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/treasury/financial_account.rb

@@ -116,6 +116,8 @@ module Stripe
       attr_reader :country
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
+      # The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+      attr_reader :display_name
       # Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
       # Stripe or the platform can control Features via the requested field.
       attr_reader :features

data/lib/stripe/resources/treasury/financial_account_features.rb

@@ -95,6 +95,8 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # Requested bank partner for this Financial Account
+          attr_reader :bank
           # Whether the FinancialAccount should have the Feature.
           attr_reader :requested
           # Whether the Feature is operational.

data/lib/stripe/resources/treasury/outbound_payment.rb

@@ -246,6 +246,8 @@ module Stripe
       attr_reader :metadata
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
+      # The purpose of the OutboundPayment, if applicable.
+      attr_reader :purpose
       # Details about a returned OutboundPayment. Only set when the status is `returned`.
       attr_reader :returned_details
       # The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).

data/lib/stripe/resources/treasury/outbound_transfer.rb

@@ -120,6 +120,33 @@ module Stripe
         end
       end
 
+      class NetworkDetails < ::Stripe::StripeObject
+        class Ach < ::Stripe::StripeObject
+          # ACH Addenda record
+          attr_reader :addenda
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Details about an ACH transaction.
+        attr_reader :ach
+        # The type of flow that originated the OutboundTransfer.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { ach: Ach }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class ReturnedDetails < ::Stripe::StripeObject
         # Reason for the return.
         attr_reader :code
@@ -225,6 +252,8 @@ module Stripe
       attr_reader :livemode
       # Set of [key-value pairs](https://docs.stripe.com/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
+      # Details about the network used for the OutboundTransfer.
+      attr_reader :network_details
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Details about a returned OutboundTransfer. Only set when the status is `returned`.
@@ -374,6 +403,7 @@ module Stripe
       def self.inner_class_types
         @inner_class_types = {
           destination_payment_method_details: DestinationPaymentMethodDetails,
+          network_details: NetworkDetails,
           returned_details: ReturnedDetails,
           status_transitions: StatusTransitions,
           tracking_details: TrackingDetails,

data/lib/stripe/resources/treasury/received_credit.rb

@@ -167,6 +167,33 @@ module Stripe
         end
       end
 
+      class NetworkDetails < ::Stripe::StripeObject
+        class Ach < ::Stripe::StripeObject
+          # ACH Addenda record
+          attr_reader :addenda
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Details about an ACH transaction.
+        attr_reader :ach
+        # The type of flow that originated the ReceivedCredit.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { ach: Ach }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class ReversalDetails < ::Stripe::StripeObject
         # Time before which a ReceivedCredit can be reversed.
         attr_reader :deadline
@@ -205,6 +232,8 @@ module Stripe
       attr_reader :livemode
       # The rails used to send the funds.
       attr_reader :network
+      # Details specific to the money movement rails.
+      attr_reader :network_details
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Details describing when a ReceivedCredit may be reversed.
@@ -249,6 +278,7 @@ module Stripe
         @inner_class_types = {
           initiating_payment_method_details: InitiatingPaymentMethodDetails,
           linked_flows: LinkedFlows,
+          network_details: NetworkDetails,
           reversal_details: ReversalDetails,
         }
       end

data/lib/stripe/resources/treasury/received_debit.rb

@@ -120,6 +120,8 @@ module Stripe
         attr_reader :issuing_transaction
         # Set if the ReceivedDebit was created due to a [Payout](https://api.stripe.com#payouts) object.
         attr_reader :payout
+        # The ReceivedCredit that Capital withheld from
+        attr_reader :received_credit_capital_withholding
         # Set if the ReceivedDebit was created due to a [Topup](https://api.stripe.com#topups) object.
         attr_reader :topup
 
@@ -132,6 +134,33 @@ module Stripe
         end
       end
 
+      class NetworkDetails < ::Stripe::StripeObject
+        class Ach < ::Stripe::StripeObject
+          # ACH Addenda record
+          attr_reader :addenda
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Details about an ACH transaction.
+        attr_reader :ach
+        # The type of flow that originated the ReceivedDebit.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { ach: Ach }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class ReversalDetails < ::Stripe::StripeObject
         # Time before which a ReceivedDebit can be reversed.
         attr_reader :deadline
@@ -170,6 +199,8 @@ module Stripe
       attr_reader :livemode
       # The network used for the ReceivedDebit.
       attr_reader :network
+      # Details specific to the money movement rails.
+      attr_reader :network_details
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
       # Details describing when a ReceivedDebit might be reversed.
@@ -214,6 +245,7 @@ module Stripe
         @inner_class_types = {
           initiating_payment_method_details: InitiatingPaymentMethodDetails,
           linked_flows: LinkedFlows,
+          network_details: NetworkDetails,
           reversal_details: ReversalDetails,
         }
       end