stripe 10.1.0 → 12.6.0

data/lib/stripe/resources/plan.rb

@@ -17,5 +17,48 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "plan"
+    def self.object_name
+      "plan"
+    end
+
+    # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/plans", params: params, opts: opts)
+    end
+
+    # Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
+    def self.delete(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/plans/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/plans/%<plan>s", { plan: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of your plans.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/plans", params: filters, opts: opts)
+    end
+
+    # Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/plans/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/price.rb

@@ -15,13 +15,36 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "price"
+    def self.object_name
+      "price"
+    end
+
+    # Creates a new price for an existing product. The price can be recurring or one-time.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/prices", params: params, opts: opts)
+    end
+
+    # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/prices", params: filters, opts: opts)
+    end
 
     def self.search(params = {}, opts = {})
-      _search("/v1/prices/search", params, opts)
+      request_stripe_object(method: :get, path: "/v1/prices/search", params: params, opts: opts)
     end
 
     def self.search_auto_paging_each(params = {}, opts = {}, &blk)
       search(params, opts).auto_paging_each(&blk)
     end
+
+    # Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/prices/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/product.rb

@@ -14,17 +14,63 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "product"
+    def self.object_name
+      "product"
+    end
+
+    nested_resource_class_methods :feature, operations: %i[create retrieve delete list]
+
+    # Creates a new product object.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/products", params: params, opts: opts)
+    end
+
+    # Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
+    def self.delete(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/products/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/products/%<id>s", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/products", params: filters, opts: opts)
+    end
 
     def self.search(params = {}, opts = {})
-      _search("/v1/products/search", params, opts)
+      request_stripe_object(method: :get, path: "/v1/products/search", params: params, opts: opts)
     end
 
     def self.search_auto_paging_each(params = {}, opts = {}, &blk)
       search(params, opts).auto_paging_each(&blk)
     end
+
+    # Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/products/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/product_feature.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A product_feature represents an attachment between a feature and a product.
+  # When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.
+  class ProductFeature < APIResource
+    OBJECT_NAME = "product_feature"
+    def self.object_name
+      "product_feature"
+    end
+  end
+end

data/lib/stripe/resources/promotion_code.rb

@@ -10,5 +10,28 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "promotion_code"
+    def self.object_name
+      "promotion_code"
+    end
+
+    # A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/promotion_codes", params: params, opts: opts)
+    end
+
+    # Returns a list of your promotion codes.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/promotion_codes", params: filters, opts: opts)
+    end
+
+    # Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/promotion_codes/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/quote.rb

@@ -10,7 +10,11 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "quote"
+    def self.object_name
+      "quote"
+    end
 
+    # Accepts the specified quote.
     def accept(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -20,90 +24,97 @@ module Stripe
       )
     end
 
-    def cancel(params = {}, opts = {})
+    # Accepts the specified quote.
+    def self.accept(quote, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(self["id"]) }),
+        path: format("/v1/quotes/%<quote>s/accept", { quote: CGI.escape(quote) }),
         params: params,
         opts: opts
       )
     end
 
-    def finalize_quote(params = {}, opts = {})
+    # Cancels the quote.
+    def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(self["id"]) }),
+        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
-    def list_computed_upfront_line_items(params = {}, opts = {})
+    # Cancels the quote.
+    def self.cancel(quote, params = {}, opts = {})
       request_stripe_object(
-        method: :get,
-        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(self["id"]) }),
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(quote) }),
         params: params,
         opts: opts
       )
     end
 
-    def list_line_items(params = {}, opts = {})
-      request_stripe_object(
-        method: :get,
-        path: format("/v1/quotes/%<quote>s/line_items", { quote: CGI.escape(self["id"]) }),
-        params: params,
-        opts: opts
-      )
+    # A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote).
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/quotes", params: params, opts: opts)
     end
 
-    def pdf(params = {}, opts = {}, &read_body_chunk_block)
-      config = opts[:client]&.config || Stripe.config
-      opts = { api_base: config.uploads_base }.merge(opts)
-      request_stream(
-        method: :get,
-        path: format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(self["id"]) }),
+    # Finalizes the quote.
+    def finalize_quote(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(self["id"]) }),
         params: params,
-        opts: opts,
-        &read_body_chunk_block
+        opts: opts
       )
     end
 
-    def self.accept(quote, params = {}, opts = {})
+    # Finalizes the quote.
+    def self.finalize_quote(quote, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/quotes/%<quote>s/accept", { quote: CGI.escape(quote) }),
+        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(quote) }),
         params: params,
         opts: opts
       )
     end
 
-    def self.cancel(quote, params = {}, opts = {})
+    # Returns a list of your quotes.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/quotes", params: filters, opts: opts)
+    end
+
+    # When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
+    def list_computed_upfront_line_items(params = {}, opts = {})
       request_stripe_object(
-        method: :post,
-        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(quote) }),
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
-    def self.finalize_quote(quote, params = {}, opts = {})
+    # When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
+    def self.list_computed_upfront_line_items(quote, params = {}, opts = {})
       request_stripe_object(
-        method: :post,
-        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(quote) }),
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(quote) }),
         params: params,
         opts: opts
       )
     end
 
-    def self.list_computed_upfront_line_items(quote, params = {}, opts = {})
+    # When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+    def list_line_items(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(quote) }),
+        path: format("/v1/quotes/%<quote>s/line_items", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
+    # When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
     def self.list_line_items(quote, params = {}, opts = {})
       request_stripe_object(
         method: :get,
@@ -113,6 +124,20 @@ module Stripe
       )
     end
 
+    # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
+    def pdf(params = {}, opts = {}, &read_body_chunk_block)
+      config = opts[:client]&.config || Stripe.config
+      opts = { api_base: config.uploads_base }.merge(opts)
+      request_stream(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts,
+        &read_body_chunk_block
+      )
+    end
+
+    # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
     def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
       config = opts[:client]&.config || Stripe.config
       opts = { api_base: config.uploads_base }.merge(opts)
@@ -124,5 +149,15 @@ module Stripe
         &read_body_chunk_block
       )
     end
+
+    # A quote models prices and services for a customer.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/radar/early_fraud_warning.rb

@@ -11,6 +11,19 @@ module Stripe
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "radar.early_fraud_warning"
+      def self.object_name
+        "radar.early_fraud_warning"
+      end
+
+      # Returns a list of early fraud warnings.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/radar/early_fraud_warnings",
+          params: filters,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/radar/value_list.rb

@@ -13,6 +13,59 @@ module Stripe
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "radar.value_list"
+      def self.object_name
+        "radar.value_list"
+      end
+
+      # Creates a new ValueList object, which can then be referenced in rules.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/radar/value_lists",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
+      def self.delete(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/radar/value_lists/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
+      def delete(params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/radar/value_lists/%<value_list>s", { value_list: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/radar/value_lists",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/radar/value_lists/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/radar/value_list_item.rb

@@ -12,6 +12,49 @@ module Stripe
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "radar.value_list_item"
+      def self.object_name
+        "radar.value_list_item"
+      end
+
+      # Creates a new ValueListItem object, which is added to the specified parent value list.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/radar/value_list_items",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a ValueListItem object, removing it from its parent value list.
+      def self.delete(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/radar/value_list_items/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deletes a ValueListItem object, removing it from its parent value list.
+      def delete(params = {}, opts = {})
+        request_stripe_object(
+          method: :delete,
+          path: format("/v1/radar/value_list_items/%<item>s", { item: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/radar/value_list_items",
+          params: filters,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/refund.rb

@@ -13,7 +13,13 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "refund"
+    def self.object_name
+      "refund"
+    end
 
+    # Cancels a refund with a status of requires_action.
+    #
+    # You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -23,6 +29,9 @@ module Stripe
       )
     end
 
+    # Cancels a refund with a status of requires_action.
+    #
+    # You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
     def self.cancel(refund, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -32,13 +41,49 @@ module Stripe
       )
     end
 
+    # When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+    #
+    # Creating a new refund will refund a charge that has previously been created but not yet refunded.
+    # Funds will be refunded to the credit or debit card that was originally charged.
+    #
+    # You can optionally refund only part of a charge.
+    # You can do so multiple times, until the entire charge has been refunded.
+    #
+    # Once entirely refunded, a charge can't be refunded again.
+    # This method will raise an error when called on an already-refunded charge,
+    # or when trying to refund more money than is left on a charge.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/refunds", params: params, opts: opts)
+    end
+
+    # Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/refunds", params: filters, opts: opts)
+    end
+
+    # Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
+    #
+    # This request only accepts metadata as an argument.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/refunds/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def test_helpers
       TestHelpers.new(self)
     end
 
     class TestHelpers < APIResourceTestHelpers
       RESOURCE_CLASS = Refund
+      def self.resource_class
+        "Refund"
+      end
 
+      # Expire a refund with a status of requires_action.
       def self.expire(refund, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -48,6 +93,7 @@ module Stripe
         )
       end
 
+      # Expire a refund with a status of requires_action.
       def expire(params = {}, opts = {})
         @resource.request_stripe_object(
           method: :post,

data/lib/stripe/resources/reporting/report_run.rb

@@ -16,6 +16,29 @@ module Stripe
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "reporting.report_run"
+      def self.object_name
+        "reporting.report_run"
+      end
+
+      # Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/reporting/report_runs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of Report Runs, with the most recent appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/reporting/report_runs",
+          params: filters,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/reporting/report_type.rb

@@ -15,6 +15,19 @@ module Stripe
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "reporting.report_type"
+      def self.object_name
+        "reporting.report_type"
+      end
+
+      # Returns a full list of Report Types.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/reporting/report_types",
+          params: filters,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/reversal.rb

@@ -14,16 +14,18 @@ module Stripe
   # transfer only if the destination account has enough balance to cover the
   # reversal.
   #
-  # Related guide: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers)
+  # Related guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)
   class Reversal < APIResource
-    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "transfer_reversal"
+    def self.object_name
+      "transfer_reversal"
+    end
 
     def resource_url
       "#{Transfer.resource_url}/#{CGI.escape(transfer)}/reversals" \
-      "/#{CGI.escape(id)}"
+        "/#{CGI.escape(id)}"
     end
 
     def self.update(_id, _params = nil, _opts = nil)