stripe 5.55.0 → 18.2.0.pre.beta.1

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
+      # 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 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/test_helpers/test_clock.rb

@@ -3,23 +3,131 @@
 
 module Stripe
   module TestHelpers
+    # A test clock enables deterministic control over objects in testmode. With a test clock, you can create
+    # objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,
+    # you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.
     class TestClock < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "test_helpers.test_clock"
+      def self.object_name
+        "test_helpers.test_clock"
+      end
+
+      class StatusDetails < ::Stripe::StripeObject
+        class Advancing < ::Stripe::StripeObject
+          # The `frozen_time` that the Test Clock is advancing towards.
+          attr_reader :target_frozen_time
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
 
-      custom_method :advance, http_verb: :post
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field advancing
+        attr_reader :advancing
+
+        def self.inner_class_types
+          @inner_class_types = { advancing: Advancing }
+        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
+      # Time at which this clock is scheduled to auto delete.
+      attr_reader :deletes_after
+      # Time at which all objects belonging to this clock are frozen.
+      attr_reader :frozen_time
+      # 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 custom name supplied at creation.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The status of the Test Clock.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
+      # Always true for a deleted object
+      attr_reader :deleted
 
+      # Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
       def advance(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/advance",
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s/advance", { test_clock: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
+      def self.advance(test_clock, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s/advance", { test_clock: CGI.escape(test_clock) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a new test clock that can be attached to new customers and quotes.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/test_helpers/test_clocks",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a test clock.
+      def self.delete(test_clock, params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s", { test_clock: CGI.escape(test_clock) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a test clock.
+      def delete(params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s", { test_clock: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
+
+      # Returns a list of your test clocks.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/test_helpers/test_clocks",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { status_details: StatusDetails }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/token.rb

@@ -2,9 +2,75 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Tokenization is the process Stripe uses to collect sensitive card or bank
+  # account details, or personally identifiable information (PII), directly from
+  # your customers in a secure manner. A token representing this information is
+  # returned to your server to use. Use our
+  # [recommended payments integrations](https://docs.stripe.com/payments) to perform this process
+  # on the client-side. This guarantees that no sensitive card data touches your server,
+  # and allows your integration to operate in a PCI-compliant way.
+  #
+  # If you can't use client-side tokenization, you can also create tokens using
+  # the API with either your publishable or secret API key. If
+  # your integration uses this method, you're responsible for any PCI compliance
+  # that it might require, and you must keep your secret API key safe. Unlike with
+  # client-side tokenization, your customer's information isn't sent directly to
+  # Stripe, so we can't determine how it's handled or stored.
+  #
+  # You can't store or use tokens more than once. To store card or bank account
+  # information for later use, create [Customer](https://docs.stripe.com/api#customers)
+  # objects or [External accounts](https://docs.stripe.com/api#external_accounts).
+  # [Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection,
+  # performs best with integrations that use client-side tokenization.
   class Token < APIResource
     extend Stripe::APIOperations::Create
 
     OBJECT_NAME = "token"
+    def self.object_name
+      "token"
+    end
+
+    # These bank accounts are payment methods on `Customer` objects.
+    #
+    # On the other hand [External Accounts](/api#external_accounts) are transfer
+    # destinations on `Account` objects for connected accounts.
+    # They can be bank accounts or debit cards as well, and are documented in the links above.
+    #
+    # Related guide: [Bank debits and transfers](/payments/bank-debits-transfers)
+    attr_reader :bank_account
+    # You can store multiple cards on a customer in order to charge the customer
+    # later. You can also store multiple debit cards on a recipient in order to
+    # transfer to those cards later.
+    #
+    # Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards)
+    attr_reader :card
+    # IP address of the client that generates the token.
+    attr_reader :client_ip
+    # 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
+    # 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
+    # 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).
+    attr_reader :used
+
+    # Creates a single-use token that represents a bank account's details.
+    # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/tokens", params: params, opts: opts)
+    end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/topup.rb

@@ -2,22 +2,100 @@
 # frozen_string_literal: true
 
 module Stripe
+  # To top up your Stripe balance, you create a top-up object. You can retrieve
+  # individual top-ups, as well as list all top-ups. Top-ups are identified by a
+  # unique, random ID.
+  #
+  # Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups)
   class Topup < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "topup"
+    def self.object_name
+      "topup"
+    end
 
-    custom_method :cancel, http_verb: :post
+    # Amount transferred.
+    attr_reader :amount
+    # ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
+    attr_reader :balance_transaction
+    # 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
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
+    attr_reader :expected_availability_date
+    # Error code explaining reason for top-up failure if available (see [the errors section](https://docs.stripe.com/api#errors) for a list of codes).
+    attr_reader :failure_code
+    # Message to user further explaining reason for top-up failure if available.
+    attr_reader :failure_message
+    # 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://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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The source field is deprecated. It might not always be present in the API response.
+    attr_reader :source
+    # Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
+    attr_reader :statement_descriptor
+    # The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
+    attr_reader :status
+    # A string that identifies this top-up as part of a group.
+    attr_reader :transfer_group
 
+    # Cancels a top-up. Only pending top-ups can be canceled.
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Cancels a top-up. Only pending top-ups can be canceled.
+    def self.cancel(topup, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/topups/%<topup>s/cancel", { topup: CGI.escape(topup) }),
         params: params,
         opts: opts
       )
     end
+
+    # Top up the balance of an account
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/topups", params: params, opts: opts)
+    end
+
+    # Returns a list of top-ups.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/topups", params: params, opts: opts)
+    end
+
+    # Updates the metadata of a top-up. Other top-up details are not editable by design.
+    def self.update(topup, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/topups/%<topup>s", { topup: CGI.escape(topup) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/transfer.rb

@@ -2,26 +2,94 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A `Transfer` object is created when you move funds between Stripe accounts as
+  # part of Connect.
+  #
+  # Before April 6, 2017, transfers also represented movement of funds from a
+  # Stripe account to a card or bank account. This behavior has since been split
+  # out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more
+  # information, read about the
+  # [transfer/payout split](https://docs.stripe.com/transfer-payout-split).
+  #
+  # Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers)
   class Transfer < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::NestedResource
+    include Stripe::APIOperations::Save
 
     OBJECT_NAME = "transfer"
+    def self.object_name
+      "transfer"
+    end
 
-    custom_method :cancel, http_verb: :post
+    nested_resource_class_methods :reversal, operations: %i[create retrieve update list]
 
-    nested_resource_class_methods :reversal,
-                                  operations: %i[create retrieve update list]
+    # Amount in cents (or local equivalent) to be transferred.
+    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
+    # 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.
+    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
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # ID of the Stripe account the transfer was sent to.
+    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
+    # 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://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
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # A list of reversals that have been applied to the transfer.
+    attr_reader :reversals
+    # Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
+    attr_reader :reversed
+    # ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.
+    attr_reader :source_transaction
+    # The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.
+    attr_reader :source_type
+    # A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
+    attr_reader :transfer_group
 
-    def cancel(params = {}, opts = {})
+    # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/transfers", params: params, opts: opts)
+    end
+
+    # Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/transfers", params: params, opts: opts)
+    end
+
+    # Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    #
+    # This request accepts only metadata as an argument.
+    def self.update(transfer, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/transfers/%<transfer>s", { transfer: CGI.escape(transfer) }),
         params: params,
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

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

@@ -0,0 +1,86 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
+    class CreditReversal < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.credit_reversal"
+      def self.object_name
+        "treasury.credit_reversal"
+      end
+
+      class StatusTransitions < ::Stripe::StripeObject
+        # Timestamp describing when the CreditReversal changed status to `posted`
+        attr_reader :posted_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Amount (in cents) transferred.
+      attr_reader :amount
+      # 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
+      # The FinancialAccount to reverse funds from.
+      attr_reader :financial_account
+      # A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+      attr_reader :hosted_regulatory_receipt_url
+      # 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://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
+      # The rails used to reverse the funds.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ReceivedCredit being reversed.
+      attr_reader :received_credit
+      # Status of the CreditReversal
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
+      # Reverses a ReceivedCredit and creates a CreditReversal object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/treasury/credit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of CreditReversals.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/treasury/credit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { status_transitions: StatusTransitions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.
+    class DebitReversal < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.debit_reversal"
+      def self.object_name
+        "treasury.debit_reversal"
+      end
+
+      class LinkedFlows < ::Stripe::StripeObject
+        # Set if there is an Issuing dispute associated with the DebitReversal.
+        attr_reader :issuing_dispute
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusTransitions < ::Stripe::StripeObject
+        # Timestamp describing when the DebitReversal changed status to `completed`.
+        attr_reader :completed_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Amount (in cents) transferred.
+      attr_reader :amount
+      # 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
+      # The FinancialAccount to reverse funds from.
+      attr_reader :financial_account
+      # A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+      attr_reader :hosted_regulatory_receipt_url
+      # Unique identifier for the object.
+      attr_reader :id
+      # Other flows linked to a DebitReversal.
+      attr_reader :linked_flows
+      # 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://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
+      # The rails used to reverse the funds.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ReceivedDebit being reversed.
+      attr_reader :received_debit
+      # Status of the DebitReversal
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
+      # Reverses a ReceivedDebit and creates a DebitReversal object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/treasury/debit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of DebitReversals.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/treasury/debit_reversals",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { linked_flows: LinkedFlows, status_transitions: StatusTransitions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end