stripe 5.28.0 → 8.7.0

data/lib/stripe/resources/source_transaction.rb

@@ -1,6 +1,11 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # Some payment methods have no required amount that a customer must send.
+  # Customers can be instructed to send any amount, and it can be made up of
+  # multiple transactions. As such, sources can have multiple associated
+  # transactions.
   class SourceTransaction < StripeObject
     OBJECT_NAME = "source_transaction"
   end

data/lib/stripe/resources/subscription.rb

@@ -2,25 +2,79 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Subscriptions allow you to charge a customer on a recurring basis.
+  #
+  # Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)
   class Subscription < APIResource
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "subscription"
 
-    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     def delete_discount(params = {}, opts = {})
       request_stripe_object(
         method: :delete,
-        path: resource_url + "/discount",
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s/discount", { subscription_exposed_id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def resume(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/resume", { subscription: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(subscription_exposed_id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.delete_discount(subscription_exposed_id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s/discount", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.resume(subscription, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/resume", { subscription: CGI.escape(subscription) }),
         params: params,
         opts: opts
       )
     end
 
     save_nested_resource :source
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/subscriptions/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/subscription_item.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Subscription items allow you to create customer subscriptions with more than
+  # one plan, making it easy to represent complex billing relationships.
   class SubscriptionItem < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
@@ -15,12 +17,5 @@ module Stripe
     nested_resource_class_methods :usage_record_summary,
                                   operations: %i[list],
                                   resource_plural: "usage_record_summaries"
-
-    def usage_record_summaries(params = {}, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/usage_record_summaries", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
-    end
-    extend Gem::Deprecate
-    deprecate :usage_record_summaries, :"SubscriptionItem.list_usage_record_summaries", 2020, 1
   end
 end

data/lib/stripe/resources/subscription_schedule.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
+  #
+  # Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)
   class SubscriptionSchedule < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,13 +12,10 @@ module Stripe
 
     OBJECT_NAME = "subscription_schedule"
 
-    custom_method :cancel, http_verb: :post
-    custom_method :release, http_verb: :post
-
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -24,7 +24,25 @@ module Stripe
     def release(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/release",
+        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(schedule, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.release(schedule, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(schedule) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/tax/calculation.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # A Tax Calculation allows you to calculate the tax to collect from your customer.
+    #
+    # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)
+    class Calculation < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "tax.calculation"
+
+      def list_line_items(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.list_line_items(calculation, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(calculation) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/tax/calculation_line_item.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class CalculationLineItem < APIResource
+      OBJECT_NAME = "tax.calculation_line_item"
+    end
+  end
+end

data/lib/stripe/resources/tax/settings.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.
+    #
+    # Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)
+    class Settings < SingletonAPIResource
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "tax.settings"
+    end
+  end
+end

data/lib/stripe/resources/tax/transaction.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # A Tax Transaction records the tax collected from or refunded to your customer.
+    #
+    # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)
+    class Transaction < APIResource
+      OBJECT_NAME = "tax.transaction"
+
+      def list_line_items(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/tax/transactions/%<transaction>s/line_items", { transaction: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.create_from_calculation(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/tax/transactions/create_from_calculation",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.create_reversal(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/tax/transactions/create_reversal",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.list_line_items(transaction, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/tax/transactions/%<transaction>s/line_items", { transaction: CGI.escape(transaction) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/tax/transaction_line_item.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class TransactionLineItem < APIResource
+      OBJECT_NAME = "tax.transaction_line_item"
+    end
+  end
+end

data/lib/stripe/resources/tax_code.rb

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
+  class TaxCode < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "tax_code"
+  end
+end

data/lib/stripe/resources/tax_id.rb

@@ -1,6 +1,11 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers).
+  # A customer's tax IDs are displayed on invoices and credit notes issued for the customer.
+  #
+  # Related guide: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids)
   class TaxId < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/tax_rate.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
+  #
+  # Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
   class TaxRate < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

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

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    # A Configurations object represents how features should be configured for terminal readers.
+    class Configuration < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "terminal.configuration"
+    end
+  end
+end

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

@@ -3,6 +3,9 @@
 
 module Stripe
   module Terminal
+    # A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
+    #
+    # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
     class ConnectionToken < APIResource
       extend Stripe::APIOperations::Create
 

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

@@ -3,6 +3,9 @@
 
 module Stripe
   module Terminal
+    # A Location represents a grouping of readers.
+    #
+    # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
     class Location < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

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

@@ -3,6 +3,9 @@
 
 module Stripe
   module Terminal
+    # A Reader represents a physical device for accepting payment details.
+    #
+    # Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)
     class Reader < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete
@@ -10,6 +13,122 @@ module Stripe
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "terminal.reader"
+
+      def cancel_action(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def process_payment_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def process_setup_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def refund_payment(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def set_reader_display(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.cancel_action(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.process_payment_intent(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.process_setup_intent(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.refund_payment(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.set_reader_display(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = Reader
+
+        def self.present_payment_method(reader, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/present_payment_method", { reader: CGI.escape(reader) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def present_payment_method(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/terminal/readers/%<reader>s/present_payment_method", { reader: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
     end
   end
 end

data/lib/stripe/resources/test_helpers/test_clock.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+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 advance(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/test_clocks/%<test_clock>s/advance", { test_clock: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      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
+    end
+  end
+end

data/lib/stripe/resources/token.rb

@@ -2,6 +2,26 @@
 # 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. You should use our
+  # [recommended payments integrations](https://stripe.com/docs/payments) to perform this process
+  # client-side. This ensures that no sensitive card data touches your server,
+  # and allows your integration to operate in a PCI-compliant way.
+  #
+  # If you cannot use client-side tokenization, you can also create tokens using
+  # the API with either your publishable or secret API key. Keep in mind that if
+  # your integration uses this method, you are responsible for any PCI compliance
+  # that may be required, and you must keep your secret API key safe. Unlike with
+  # client-side tokenization, your customer's information is not sent directly to
+  # Stripe, so we cannot determine how it is handled or stored.
+  #
+  # Tokens cannot be stored or used more than once. To store card or bank account
+  # information for later use, you can create [Customer](https://stripe.com/docs/api#customers)
+  # objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that
+  # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
+  # performs best with integrations that use client-side tokenization.
   class Token < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/topup.rb

@@ -2,6 +2,11 @@
 # 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://stripe.com/docs/connect/top-ups)
   class Topup < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,12 +14,19 @@ module Stripe
 
     OBJECT_NAME = "topup"
 
-    custom_method :cancel, http_verb: :post
-
     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
+
+    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
       )

data/lib/stripe/resources/transfer.rb

@@ -2,6 +2,16 @@
 # 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://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more
+  # information, read about the
+  # [transfer/payout split](https://stripe.com/docs/transfer-payout-split).
+  #
+  # Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)
   class Transfer < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -10,18 +20,7 @@ module Stripe
 
     OBJECT_NAME = "transfer"
 
-    custom_method :cancel, http_verb: :post
-
     nested_resource_class_methods :reversal,
                                   operations: %i[create retrieve update list]
-
-    def cancel(params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: resource_url + "/cancel",
-        params: params,
-        opts: opts
-      )
-    end
   end
 end

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

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # You can reverse some [ReceivedCredits](https://stripe.com/docs/api#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"
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # You can reverse some [ReceivedDebits](https://stripe.com/docs/api#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"
+    end
+  end
+end