stripe 5.41.0 → 9.0.0

data/lib/stripe/resources/issuing/dispute.rb

@@ -3,6 +3,9 @@
 
 module Stripe
   module Issuing
+    # As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
+    #
+    # Related guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)
     class Dispute < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
@@ -10,12 +13,19 @@ module Stripe
 
       OBJECT_NAME = "issuing.dispute"
 
-      custom_method :submit, http_verb: :post
-
       def submit(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/submit",
+          path: format("/v1/issuing/disputes/%<dispute>s/submit", { dispute: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.submit(dispute, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/disputes/%<dispute>s/submit", { dispute: CGI.escape(dispute) }),
           params: params,
           opts: opts
         )

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

@@ -3,6 +3,11 @@
 
 module Stripe
   module Issuing
+    # Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving
+    # your Stripe account, such as a completed purchase or refund, is represented by an Issuing
+    # `Transaction` object.
+    #
+    # Related guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)
     class Transaction < APIResource
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save

data/lib/stripe/resources/line_item.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A line item.
   class LineItem < APIResource
     OBJECT_NAME = "item"
   end

data/lib/stripe/resources/login_link.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Login Links are single-use login link for an Express account to access their Stripe dashboard.
   class LoginLink < APIResource
     OBJECT_NAME = "login_link"
 

data/lib/stripe/resources/mandate.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Mandate is a record of the permission a customer has given you to debit their payment method.
   class Mandate < APIResource
     OBJECT_NAME = "mandate"
   end

data/lib/stripe/resources/payment_intent.rb

@@ -2,21 +2,38 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A PaymentIntent guides you through the process of collecting a payment from your customer.
+  # We recommend that you create exactly one PaymentIntent for each order or
+  # customer session in your system. You can reference the PaymentIntent later to
+  # see the history of payment attempts for a particular session.
+  #
+  # A PaymentIntent transitions through
+  # [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
+  # throughout its lifetime as it interfaces with Stripe.js to perform
+  # authentication flows and ultimately creates at most one successful charge.
+  #
+  # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
   class PaymentIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "payment_intent"
 
-    custom_method :cancel, http_verb: :post
-    custom_method :capture, http_verb: :post
-    custom_method :confirm, http_verb: :post
+    def apply_customer_balance(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/apply_customer_balance", { intent: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/payment_intents/%<intent>s/cancel", { intent: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -25,7 +42,7 @@ module Stripe
     def capture(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/capture",
+        path: format("/v1/payment_intents/%<intent>s/capture", { intent: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -34,10 +51,90 @@ module Stripe
     def confirm(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/confirm",
+        path: format("/v1/payment_intents/%<intent>s/confirm", { intent: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def increment_authorization(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/increment_authorization", { intent: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def verify_microdeposits(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.apply_customer_balance(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/apply_customer_balance", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/cancel", { intent: CGI.escape(intent) }),
         params: params,
         opts: opts
       )
     end
+
+    def self.capture(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/capture", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.confirm(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/confirm", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.increment_authorization(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/increment_authorization", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.verify_microdeposits(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/payment_intents/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/payment_link.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
+  #
+  # When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.
+  #
+  # Related guide: [Payment Links API](https://stripe.com/docs/payment-links)
+  class PaymentLink < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "payment_link"
+
+    def list_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/payment_links/%<payment_link>s/line_items", { payment_link: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_line_items(payment_link, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/payment_links/%<payment_link>s/line_items", { payment_link: CGI.escape(payment_link) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/payment_method.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # PaymentMethod objects represent your customer's payment instruments.
+  # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
+  # Customer objects to store instrument details for future payments.
+  #
+  # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
   class PaymentMethod < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,13 +14,10 @@ module Stripe
 
     OBJECT_NAME = "payment_method"
 
-    custom_method :attach, http_verb: :post
-    custom_method :detach, http_verb: :post
-
     def attach(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/attach",
+        path: format("/v1/payment_methods/%<payment_method>s/attach", { payment_method: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -24,7 +26,25 @@ module Stripe
     def detach(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/detach",
+        path: format("/v1/payment_methods/%<payment_method>s/detach", { payment_method: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.attach(payment_method, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_methods/%<payment_method>s/attach", { payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.detach(payment_method, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_methods/%<payment_method>s/detach", { payment_method: CGI.escape(payment_method) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/payout.rb

@@ -2,6 +2,14 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A `Payout` object is created when you receive funds from Stripe, or when you
+  # initiate a payout to either a bank account or debit card of a [connected
+  # Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
+  # as well as list all payouts. Payouts are made on [varying
+  # schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
+  # industry.
+  #
+  # Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
   class Payout < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,13 +17,10 @@ module Stripe
 
     OBJECT_NAME = "payout"
 
-    custom_method :cancel, http_verb: :post
-    custom_method :reverse, http_verb: :post
-
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/payouts/%<payout>s/cancel", { payout: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -24,7 +29,25 @@ module Stripe
     def reverse(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/reverse",
+        path: format("/v1/payouts/%<payout>s/reverse", { payout: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(payout, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payouts/%<payout>s/cancel", { payout: CGI.escape(payout) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.reverse(payout, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payouts/%<payout>s/reverse", { payout: CGI.escape(payout) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/person.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a person associated with a Stripe account.
+  #
+  # A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.
+  # See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps.
+  #
+  # Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information)
   class Person < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/plan.rb

@@ -2,6 +2,14 @@
 # frozen_string_literal: true
 
 module Stripe
+  # 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.
+  #
+  # Plans define the base price, currency, and billing cycle for recurring purchases of products.
+  # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
+  #
+  # For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
   class Plan < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/price.rb

@@ -2,11 +2,26 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
+  # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
+  #
+  # For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
   class Price < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "price"
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/prices/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/product.rb

@@ -2,12 +2,29 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Products describe the specific goods or services you offer to your customers.
+  # For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
+  # They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),
+  # [share a Payment Link](https://stripe.com/docs/payment-links),
+  # [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),
+  # and more about [Products and Prices](https://stripe.com/docs/products-prices/overview)
   class Product < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "product"
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/products/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/promotion_code.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to
+  # create multiple codes for a single coupon.
   class PromotionCode < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/quote.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Quote is a way to model prices that you'd like to provide to a customer.
+  # Once accepted, it will automatically create an invoice, subscription or subscription schedule.
   class Quote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,16 +11,10 @@ module Stripe
 
     OBJECT_NAME = "quote"
 
-    custom_method :accept, http_verb: :post
-    custom_method :cancel, http_verb: :post
-    custom_method :finalize_quote, http_verb: :post, http_path: "finalize"
-    custom_method :list_computed_upfront_line_items, http_verb: :get, http_path: "computed_upfront_line_items"
-    custom_method :list_line_items, http_verb: :get, http_path: "line_items"
-
     def accept(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/accept",
+        path: format("/v1/quotes/%<quote>s/accept", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -27,7 +23,7 @@ module Stripe
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -36,7 +32,7 @@ module Stripe
     def finalize_quote(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/finalize",
+        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -45,7 +41,7 @@ module Stripe
     def list_computed_upfront_line_items(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/computed_upfront_line_items",
+        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -54,52 +50,79 @@ module Stripe
     def list_line_items(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/line_items",
+        path: format("/v1/quotes/%<quote>s/line_items", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
     def pdf(params = {}, opts = {}, &read_body_chunk_block)
-      unless block_given?
-        raise ArgumentError, "A read_body_chunk_block block parameter is required when calling the pdf method."
-      end
-
       config = opts[:client]&.config || Stripe.config
-
+      opts = { api_base: config.uploads_base }.merge(opts)
       request_stream(
         method: :get,
-        path: resource_url + "/pdf",
+        path: format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(self["id"]) }),
         params: params,
-        opts: {
-          api_base: config.uploads_base,
-        }.merge(opts),
+        opts: opts,
         &read_body_chunk_block
       )
     end
 
-    def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
-      unless id.is_a?(String)
-        raise ArgumentError,
-              "id should be a string representing the ID of an API resource"
-      end
+    def self.accept(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/accept", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
 
-      unless block_given?
-        raise ArgumentError, "A read_body_chunk_block block parameter is required when calling the pdf method."
-      end
+    def self.cancel(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
 
-      config = opts[:client]&.config || Stripe.config
+    def self.finalize_quote(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_computed_upfront_line_items(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
 
-      resp = execute_resource_request_stream(
+    def self.list_line_items(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/line_items", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
+      config = opts[:client]&.config || Stripe.config
+      opts = { api_base: config.uploads_base }.merge(opts)
+      execute_resource_request_stream(
         :get,
-        "#{resource_url}/#{CGI.escape(id)}/pdf",
+        format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(quote) }),
         params,
-        {
-          api_base: config.uploads_base,
-        }.merge(opts),
+        opts,
         &read_body_chunk_block
       )
-      resp
     end
   end
 end

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

@@ -3,6 +3,10 @@
 
 module Stripe
   module Radar
+    # An early fraud warning indicates that the card issuer has notified us that a
+    # charge may be fraudulent.
+    #
+    # Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)
     class EarlyFraudWarning < APIResource
       extend Stripe::APIOperations::List
 

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

@@ -3,6 +3,9 @@
 
 module Stripe
   module Radar
+    # Value lists allow you to group values together which can then be referenced in rules.
+    #
+    # Related guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)
     class ValueList < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

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

@@ -3,6 +3,9 @@
 
 module Stripe
   module Radar
+    # Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
+    #
+    # Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)
     class ValueListItem < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete