stripe 5.55.0 → 13.5.1

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

@@ -3,12 +3,46 @@
 
 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
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "billing_portal.configuration"
+      def self.object_name
+        "billing_portal.configuration"
+      end
+
+      # Creates a configuration that describes the functionality and behavior of a PortalSession
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing_portal/configurations",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of configurations that describe the functionality of the customer portal.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing_portal/configurations",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a configuration that describes the functionality of the customer portal.
+      def self.update(configuration, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing_portal/configurations/%<configuration>s", { configuration: CGI.escape(configuration) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

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

@@ -3,10 +3,37 @@
 
 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.
+    #
+    # Related guide: [Customer management](https://stripe.com/customer-management)
     class Session < APIResource
       extend Stripe::APIOperations::Create
 
       OBJECT_NAME = "billing_portal.session"
+      def self.object_name
+        "billing_portal.session"
+      end
+
+      # Creates a session of the customer portal.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing_portal/sessions",
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/capability.rb

@@ -2,11 +2,16 @@
 # 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
 
     OBJECT_NAME = "capability"
+    def self.object_name
+      "capability"
+    end
 
     def resource_url
       if !respond_to?(:account) || account.nil?
@@ -14,7 +19,7 @@ module Stripe
               "Capabilities cannot be accessed without an account ID."
       end
       "#{Account.resource_url}/#{CGI.escape(account)}/capabilities" \
-      "/#{CGI.escape(id)}"
+        "/#{CGI.escape(id)}"
     end
 
     def self.retrieve(_id, _opts = {})

data/lib/stripe/resources/card.rb

@@ -2,17 +2,23 @@
 # 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
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "card"
+    def self.object_name
+      "card"
+    end
 
     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)}"
@@ -34,5 +40,30 @@ module Stripe
             "'customer_id', 'card_id')` or " \
             "`Account.retrieve_external_account('account_id', 'card_id')`"
     end
+
+    def self.delete(id, params = {}, opts = {})
+      raise NotImplementedError,
+            "Card cannot be deleted without a customer ID or an account " \
+            "ID. Delete a card using `Customer.delete_source(" \
+            "'customer_id', 'card_id')` or " \
+            "`Account.delete_external_account('account_id', 'card_id')`"
+    end
+
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: resource_url.to_s,
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list(params = {}, opts = {})
+      raise NotImplementedError,
+            "Cards cannot be listed without a customer ID or an account " \
+            "ID. List cards using `Customer.list_sources(" \
+            "'customer_id')` or " \
+            "`Account.list_external_accounts('account_id')`"
+    end
   end
 end

data/lib/stripe/resources/cash_balance.rb

@@ -2,8 +2,12 @@
 # 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 self.object_name
+      "cash_balance"
+    end
 
     def resource_url
       if !respond_to?(:customer) || customer.nil?

data/lib/stripe/resources/charge.rb

@@ -2,31 +2,80 @@
 # 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::NestedResource
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "charge"
+    def self.object_name
+      "charge"
+    end
 
-    custom_method :capture, http_verb: :post
+    nested_resource_class_methods :refund, operations: %i[retrieve list]
 
+    # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
+    #
+    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
+    #
+    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
     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
+
+    # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
+    #
+    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
+    #
+    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
+    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
 
+    # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents)
+    # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
+    # object used to request payment.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/charges", params: params, opts: opts)
+    end
+
+    # Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/charges", params: params, opts: opts)
+    end
+
     def self.search(params = {}, opts = {})
-      _search("/v1/charges/search", params, opts)
+      request_stripe_object(method: :get, path: "/v1/charges/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 charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    def self.update(charge, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/charges/%<charge>s", { charge: CGI.escape(charge) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

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

@@ -3,21 +3,99 @@
 
 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
+      include Stripe::APIOperations::Save
 
       OBJECT_NAME = "checkout.session"
+      def self.object_name
+        "checkout.session"
+      end
 
-      custom_method :expire, http_verb: :post
-
-      nested_resource_class_methods :line_item, operations: %i[list]
+      # Creates a Session object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/checkout/sessions",
+          params: params,
+          opts: opts
+        )
+      end
 
+      # A Session can be expired when it is in one of these statuses: open
+      #
+      # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
       def expire(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: resource_url + "/expire",
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # A Session can be expired when it is in one of these statuses: open
+      #
+      # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
+      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
+
+      # Returns a list of Checkout Sessions.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/checkout/sessions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # When retrieving a Checkout Session, 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/checkout/sessions/%<session>s/line_items", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # When retrieving a Checkout Session, 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(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
+
+      # Updates a Session object.
+      def self.update(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s", { session: CGI.escape(session) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/climate/order.rb

@@ -0,0 +1,67 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    # Orders represent your intent to purchase a particular Climate product. When you create an order, the
+    # payment is deducted from your merchant balance.
+    class Order < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "climate.order"
+      def self.object_name
+        "climate.order"
+      end
+
+      # Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
+      # reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
+      # might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
+      # provides 90 days advance notice and refunds the amount_total.
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/climate/orders/%<order>s/cancel", { order: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
+      # reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
+      # might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
+      # provides 90 days advance notice and refunds the amount_total.
+      def self.cancel(order, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/climate/orders/%<order>s/cancel", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a Climate order object for a given Climate product. The order will be processed immediately
+      # after creation and payment will be deducted your Stripe balance.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/climate/orders", params: params, opts: opts)
+      end
+
+      # Lists all Climate order objects. The orders are returned sorted by creation date, with the
+      # most recently created orders appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/climate/orders", params: params, opts: opts)
+      end
+
+      # Updates the specified order by setting the values of the parameters passed.
+      def self.update(order, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/climate/orders/%<order>s", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/climate/product.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    # A Climate product represents a type of carbon removal unit available for reservation.
+    # You can retrieve it to see the current price and availability.
+    class Product < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "climate.product"
+      def self.object_name
+        "climate.product"
+      end
+
+      # Lists all available Climate product objects.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/climate/products",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/climate/supplier.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    # A supplier of carbon removal.
+    class Supplier < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "climate.supplier"
+      def self.object_name
+        "climate.supplier"
+      end
+
+      # Lists all available Climate supplier objects.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/climate/suppliers",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/confirmation_token.rb

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # ConfirmationTokens help transport client side data collected by Stripe JS over
+  # to your server for confirming a PaymentIntent or SetupIntent. If the confirmation
+  # is successful, values present on the ConfirmationToken are written onto the Intent.
+  #
+  # To learn more about how to use ConfirmationToken, visit the related guides:
+  # - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)
+  # - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).
+  class ConfirmationToken < APIResource
+    OBJECT_NAME = "confirmation_token"
+    def self.object_name
+      "confirmation_token"
+    end
+
+    def test_helpers
+      TestHelpers.new(self)
+    end
+
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = ConfirmationToken
+      def self.resource_class
+        "ConfirmationToken"
+      end
+
+      # Creates a test mode Confirmation Token server side for your integration tests.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/test_helpers/confirmation_tokens",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/country_spec.rb

@@ -2,9 +2,23 @@
 # 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
 
     OBJECT_NAME = "country_spec"
+    def self.object_name
+      "country_spec"
+    end
+
+    # Lists all Country Spec objects available in the API.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/country_specs", params: params, opts: opts)
+    end
   end
 end

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
@@ -9,5 +12,50 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "coupon"
+    def self.object_name
+      "coupon"
+    end
+
+    # You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
+    #
+    # A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/coupons", params: params, opts: opts)
+    end
+
+    # You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+    def self.delete(coupon, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of your coupons.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/coupons", params: params, opts: opts)
+    end
+
+    # Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
+    def self.update(coupon, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end