stripe 5.39.0 → 10.1.0

data/lib/stripe/resources/account_link.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Account Links are the means by which a Connect platform grants a connected account permission to access
+  # Stripe-hosted applications, such as Connect Onboarding.
+  #
+  # Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/account_session.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
+  #
+  # We recommend that you create an AccountSession each time you need to display an embedded component
+  # to your user. Do not save AccountSessions to your database as they expire relatively
+  # quickly, and cannot be used more than once.
+  #
+  # Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
+  class AccountSession < APIResource
+    extend Stripe::APIOperations::Create
+
+    OBJECT_NAME = "account_session"
+  end
+end

data/lib/stripe/resources/application_fee.rb

@@ -8,7 +8,6 @@ module Stripe
 
     OBJECT_NAME = "application_fee"
 
-    nested_resource_class_methods :refund,
-                                  operations: %i[create retrieve update list]
+    nested_resource_class_methods :refund, operations: %i[create retrieve update list]
   end
 end

data/lib/stripe/resources/application_fee_refund.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # `Application Fee Refund` objects allow you to refund an application fee that
+  # has previously been created but not yet refunded. Funds will be refunded to
+  # the Stripe account from which the fee was originally collected.
+  #
+  # Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)
   class ApplicationFeeRefund < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/apps/secret.rb

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Apps
+    # Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
+    #
+    # The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
+    #
+    # All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
+    #
+    # A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
+    #
+    # Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)
+    class Secret < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "apps.secret"
+
+      def self.delete_where(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.find(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/balance.rb

@@ -2,6 +2,17 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing your Stripe balance. You can retrieve it to see
+  # the balance currently on your Stripe account.
+  #
+  # You can also retrieve the balance history, which contains a list of
+  # [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance
+  # (charges, payouts, and so forth).
+  #
+  # The available and pending amounts for each currency are broken down further by
+  # payment source types.
+  #
+  # Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
   class Balance < SingletonAPIResource
     OBJECT_NAME = "balance"
   end

data/lib/stripe/resources/balance_transaction.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Balance transactions represent funds moving through your Stripe account.
+  # Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
+  #
+  # Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/bank_account.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # These bank accounts are payment methods on `Customer` objects.
+  #
+  # On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer
+  # destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).
+  # They can be bank accounts or debit cards as well, and are documented in the links above.
+  #
+  # Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

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

@@ -3,6 +3,7 @@
 
 module Stripe
   module BillingPortal
+    # A portal configuration describes the functionality and behavior of a portal session.
     class Configuration < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/billing_portal/session.rb

@@ -3,6 +3,20 @@
 
 module Stripe
   module BillingPortal
+    # The Billing customer portal is a Stripe-hosted UI for subscription and
+    # billing management.
+    #
+    # A portal configuration describes the functionality and features that you
+    # want to provide to your customers through the portal.
+    #
+    # A portal session describes the instantiation of the customer portal for
+    # a particular customer. By visiting the session's URL, the customer
+    # can manage their subscriptions and billing details. For security reasons,
+    # sessions are short-lived and will expire if the customer does not visit the URL.
+    # Create sessions on-demand when customers intend to manage their subscriptions
+    # and billing details.
+    #
+    # Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
     class Session < APIResource
       extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/capability.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a capability for a Stripe account.
+  #
+  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
   class Capability < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/card.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # 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://stripe.com/docs/sources/cards)
   class Card < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
@@ -10,9 +15,7 @@ module Stripe
     OBJECT_NAME = "card"
 
     def resource_url
-      if respond_to?(:recipient) && !recipient.nil? && !recipient.empty?
-        "#{Recipient.resource_url}/#{CGI.escape(recipient)}/cards/#{CGI.escape(id)}"
-      elsif respond_to?(:customer) && !customer.nil? && !customer.empty?
+      if respond_to?(:customer) && !customer.nil? && !customer.empty?
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
       elsif respond_to?(:account) && !account.nil? && !account.empty?
         "#{Account.resource_url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"

data/lib/stripe/resources/cash_balance.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
+  class CashBalance < APIResource
+    OBJECT_NAME = "cash_balance"
+
+    def resource_url
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "Customer Cash Balance cannot be accessed without a customer ID."
+      end
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/cash_balance"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Customer Cash Balance cannot be retrieved without a customer ID. " \
+            "Retrieve a Customer Cash Balance using `Customer.retrieve_cash_balance('cus_123')`"
+    end
+  end
+end

data/lib/stripe/resources/charge.rb

@@ -2,22 +2,42 @@
 # frozen_string_literal: true
 
 module Stripe
+  # The `Charge` object represents a single attempt to move money into your Stripe account.
+  # PaymentIntent confirmation is the most common way to create Charges, but transferring
+  # money to a different Stripe account through Connect also creates Charges.
+  # Some legacy payment flows create Charges directly, which is not recommended for new integrations.
   class Charge < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "charge"
 
-    custom_method :capture, http_verb: :post
-
     def capture(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/capture",
+        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.capture(charge, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(charge) }),
         params: params,
         opts: opts
       )
     end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/charges/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/checkout/session.rb

@@ -3,14 +3,61 @@
 
 module Stripe
   module Checkout
+    # A Checkout Session represents your customer's session as they pay for
+    # one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
+    # or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
+    # new Session each time your customer attempts to pay.
+    #
+    # Once payment is successful, the Checkout Session will contain a reference
+    # to the [Customer](https://stripe.com/docs/api/customers), and either the successful
+    # [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
+    # [Subscription](https://stripe.com/docs/api/subscriptions).
+    #
+    # You can create a Checkout Session on your server and redirect to its URL
+    # to begin Checkout.
+    #
+    # Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
     class Session < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
-      extend Stripe::APIOperations::NestedResource
 
       OBJECT_NAME = "checkout.session"
 
-      nested_resource_class_methods :line_item, operations: %i[list]
+      def expire(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def list_line_items(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.expire(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.list_line_items(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/country_spec.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Stripe needs to collect certain pieces of information about each account
+  # created. These requirements can differ depending on the account's country. The
+  # Country Specs API makes these rules available to your integration.
+  #
+  # You can also view the information from this API call as [an online
+  # guide](https://stripe.com/docs/connect/required-verification-information).
   class CountrySpec < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/coupon.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A coupon contains information about a percent-off or amount-off discount you
+  # might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
+  # [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
   class Coupon < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/credit_note.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Issue a credit note to adjust an invoice's amount after the invoice is finalized.
+  #
+  # Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)
   class CreditNote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,25 +12,40 @@ module Stripe
 
     OBJECT_NAME = "credit_note"
 
-    custom_method :void_credit_note, http_verb: :post, http_path: "void"
-
     def void_credit_note(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/void",
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_preview_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/credit_notes/preview/lines",
         params: params,
         opts: opts
       )
     end
 
-    def self.preview(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/preview", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+    def self.preview(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/credit_notes/preview",
+        params: params,
+        opts: opts
+      )
     end
 
-    def self.list_preview_line_items(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/preview/lines", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+    def self.void_credit_note(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
     end
   end
 end

data/lib/stripe/resources/credit_note_line_item.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # The credit note line item object
   class CreditNoteLineItem < StripeObject
     OBJECT_NAME = "credit_note_line_item"
   end

data/lib/stripe/resources/customer.rb

@@ -2,32 +2,94 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.
+  #
+  # Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)
   class Customer < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
     extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "customer"
 
-    custom_method :list_payment_methods, http_verb: :get, http_path: "payment_methods"
+    nested_resource_class_methods :balance_transaction, operations: %i[create retrieve update list]
+    nested_resource_class_methods :cash_balance_transaction, operations: %i[retrieve list]
+    nested_resource_class_methods :tax_id, operations: %i[create retrieve delete list]
 
-    nested_resource_class_methods :balance_transaction,
-                                  operations: %i[create retrieve update list]
-    nested_resource_class_methods :tax_id,
-                                  operations: %i[create retrieve delete list]
+    def create_funding_instructions(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def delete_discount(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     def list_payment_methods(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/payment_methods",
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def retrieve_payment_method(payment_method, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(self["id"]), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.create_funding_instructions(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.delete_discount(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_payment_methods(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
         params: params,
         opts: opts
       )
     end
 
-    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+    def self.retrieve_payment_method(customer, payment_method, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     save_nested_resource :source
     nested_resource_class_methods :source,
@@ -39,14 +101,56 @@ module Stripe
       alias detach_source delete_source
     end
 
-    # Deletes a discount associated with the customer.
-    #
-    # Returns the deleted discount. The customer object is not updated,
-    # so you must call `refresh` on it to get a new version with the
-    # discount removed.
-    def delete_discount
-      resp, opts = execute_resource_request(:delete, resource_url + "/discount")
-      Util.convert_to_stripe_object(resp.data, opts)
+    def self.search(params = {}, opts = {})
+      _search("/v1/customers/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
+
+    def self.retrieve_cash_balance(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.update_cash_balance(customer, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def test_helpers
+      TestHelpers.new(self)
+    end
+
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = Customer
+
+      def self.fund_cash_balance(customer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(customer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def fund_cash_balance(params = {}, opts = {})
+        @resource.request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/customers/%<customer>s/fund_cash_balance", { customer: CGI.escape(@resource["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,
+  # which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
+  # You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),
+  # or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.
+  #
+  # Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)
   class CustomerBalanceTransaction < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/customer_cash_balance_transaction.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Customers with certain payments enabled have a cash balance, representing funds that were paid
+  # by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions
+  # represent when funds are moved into or out of this balance. This includes funding by the customer, allocation
+  # to payments, and refunds to the customer.
+  class CustomerCashBalanceTransaction < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "customer_cash_balance_transaction"
+  end
+end

data/lib/stripe/resources/discount.rb

@@ -1,6 +1,11 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+  # It contains information about when the discount began, when it will end, and what it is applied to.
+  #
+  # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
   class Discount < StripeObject
     OBJECT_NAME = "discount"
   end