stripe 19.4.0 → 19.5.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

@@ -18,6 +18,21 @@ module Stripe
       end
 
       class Action < ::Stripe::StripeObject
+        class ActivateGiftCard < ::Stripe::StripeObject
+          # The gift card used in this reader action.
+          attr_reader :gift_card
+          # The GiftCardOperation created for this reader action.
+          attr_reader :gift_card_operation
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class ApiError < ::Stripe::StripeObject
           # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one.
           attr_reader :advice_code
@@ -29,6 +44,9 @@ module Stripe
           attr_reader :decline_code
           # A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
           attr_reader :doc_url
+          # A GiftCardOperation represents an operation performed on a third-party gift card,
+          # such as activation, reload, cashout, balance check, or void.
+          attr_reader :gift_card_operation
           # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
           attr_reader :message
           # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
@@ -95,6 +113,36 @@ module Stripe
           end
         end
 
+        class CashoutGiftCard < ::Stripe::StripeObject
+          # The gift card used in this reader action.
+          attr_reader :gift_card
+          # The GiftCardOperation created for this reader action.
+          attr_reader :gift_card_operation
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CheckGiftCardBalance < ::Stripe::StripeObject
+          # The gift card used in this reader action.
+          attr_reader :gift_card
+          # The GiftCardOperation created for this reader action.
+          attr_reader :gift_card_operation
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class CollectInputs < ::Stripe::StripeObject
           class Input < ::Stripe::StripeObject
             class CustomText < ::Stripe::StripeObject
@@ -315,6 +363,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 +398,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.
@@ -362,6 +414,21 @@ module Stripe
           end
         end
 
+        class DeactivateGiftCard < ::Stripe::StripeObject
+          # The gift card used in this reader action.
+          attr_reader :gift_card
+          # The GiftCardOperation created for this reader action.
+          attr_reader :gift_card_operation
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class PrintContent < ::Stripe::StripeObject
           class Image < ::Stripe::StripeObject
             # Creation time of the object (in seconds since the Unix epoch).
@@ -426,6 +493,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 +551,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.
@@ -510,6 +581,21 @@ module Stripe
           end
         end
 
+        class ReloadGiftCard < ::Stripe::StripeObject
+          # The gift card used in this reader action.
+          attr_reader :gift_card
+          # The GiftCardOperation created for this reader action.
+          attr_reader :gift_card_operation
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class SetReaderDisplay < ::Stripe::StripeObject
           class Cart < ::Stripe::StripeObject
             class LineItem < ::Stripe::StripeObject
@@ -558,14 +644,22 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # Represents a reader action to activate a gift card
+        attr_reader :activate_gift_card
         # The reader action failed due to an [API error](https://docs.stripe.com/api/errors). Only present when `status` is `failed` and the underlying failure was an API error. Avoid parsing the `message` field for programmatic logic; use `type` or `code` instead. The `message` field is for display to humans only and may be updated at anytime. Requires [reader version](https://docs.stripe.com/terminal/readers/stripe-reader-s700-s710#reader-software-version) 2.42 or later. Readers on older versions always return null.
         attr_reader :api_error
+        # Represents a reader action to cash out a gift card
+        attr_reader :cashout_gift_card
+        # Represents a reader action to check a gift card balance
+        attr_reader :check_gift_card_balance
         # Represents a reader action to collect customer inputs
         attr_reader :collect_inputs
         # Represents a reader action to collect a payment method
         attr_reader :collect_payment_method
         # Represents a reader action to confirm a payment
         attr_reader :confirm_payment_intent
+        # Represents a reader action to deactivate a gift card
+        attr_reader :deactivate_gift_card
         # Failure code, only set if status is `failed`.
         attr_reader :failure_code
         # Detailed failure message, only set if status is `failed`.
@@ -578,6 +672,8 @@ module Stripe
         attr_reader :process_setup_intent
         # Represents a reader action to refund a payment
         attr_reader :refund_payment
+        # Represents a reader action to reload a gift card
+        attr_reader :reload_gift_card
         # Represents a reader action to set the reader display
         attr_reader :set_reader_display
         # Status of the action performed by the reader.
@@ -587,14 +683,19 @@ module Stripe
 
         def self.inner_class_types
           @inner_class_types = {
+            activate_gift_card: ActivateGiftCard,
             api_error: ApiError,
+            cashout_gift_card: CashoutGiftCard,
+            check_gift_card_balance: CheckGiftCardBalance,
             collect_inputs: CollectInputs,
             collect_payment_method: CollectPaymentMethod,
             confirm_payment_intent: ConfirmPaymentIntent,
+            deactivate_gift_card: DeactivateGiftCard,
             print_content: PrintContent,
             process_payment_intent: ProcessPaymentIntent,
             process_setup_intent: ProcessSetupIntent,
             refund_payment: RefundPayment,
+            reload_gift_card: ReloadGiftCard,
             set_reader_display: SetReaderDisplay,
           }
         end
@@ -632,6 +733,26 @@ module Stripe
       # The networking status of the reader. We do not recommend using this field in flows that may block taking payments.
       attr_reader :status
 
+      # Initiates a gift card activation flow on a Reader and optionally sets its balance.
+      def activate_gift_card(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/activate_gift_card", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a gift card activation flow on a Reader and optionally sets its balance.
+      def self.activate_gift_card(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/activate_gift_card", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Cancels the current reader action. See [Programmatic Cancellation](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven#programmatic-cancellation) for more details.
       def cancel_action(params = {}, opts = {})
         request_stripe_object(
@@ -652,6 +773,46 @@ module Stripe
         )
       end
 
+      # Initiates a gift card cashout flow on a Reader. A cashout sets the gift card balance to 0.
+      def cashout_gift_card(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/cashout_gift_card", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a gift card cashout flow on a Reader. A cashout sets the gift card balance to 0.
+      def self.cashout_gift_card(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/cashout_gift_card", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a gift card balance check flow on a Reader.
+      def check_gift_card_balance(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/check_gift_card_balance", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a gift card balance check flow on a Reader.
+      def self.check_gift_card_balance(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/check_gift_card_balance", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Initiates an [input collection flow](https://docs.stripe.com/docs/terminal/features/collect-inputs) on a Reader to display input forms and collect information from your customers.
       def collect_inputs(params = {}, opts = {})
         request_stripe_object(
@@ -812,6 +973,26 @@ module Stripe
         )
       end
 
+      # Initiates a gift card reload flow on a Reader by adding the specified amount to its balance.
+      def reload_gift_card(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/reload_gift_card", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a gift card reload flow on a Reader by adding the specified amount to its balance.
+      def self.reload_gift_card(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/reload_gift_card", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Sets the reader display to show [cart details](https://docs.stripe.com/docs/terminal/features/display).
       def set_reader_display(params = {}, opts = {})
         request_stripe_object(

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).