stripe 10.1.0 → 12.6.0

data/lib/stripe/resources/balance_transaction.rb

@@ -10,5 +10,20 @@ module Stripe
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "balance_transaction"
+    def self.object_name
+      "balance_transaction"
+    end
+
+    # Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
+    #
+    # Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/balance_transactions",
+        params: filters,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/bank_account.rb

@@ -4,21 +4,37 @@
 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).
+  # On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer
+  # destinations on `Account` objects for connected 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)
+  # Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers)
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "bank_account"
+    def self.object_name
+      "bank_account"
+    end
 
     def verify(params = {}, opts = {})
-      resp, opts = execute_resource_request(:post, resource_url + "/verify", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: "#{Customer.resource_url}/#{customer}/sources/#{id}/verify",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.verify(customer, id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "#{Customer.resource_url}/#{customer}/sources/#{id}/verify",
+        params: params,
+        opts: opts
+      )
     end
 
     def resource_url
@@ -31,8 +47,8 @@ module Stripe
 
     def self.update(_id, _params = nil, _opts = nil)
       raise NotImplementedError,
-            "Bank accounts cannot be updated without a customer ID or an " \
-            " account ID. Update a bank account using " \
+            "Bank accounts cannot be updated without a customer ID or an  " \
+            "account ID. Update a bank account using " \
             "`Customer.update_source('customer_id', 'bank_account_id', " \
             "update_params)` or `Account.update_external_account(" \
             "'account_id', 'bank_account_id', update_params)`"
@@ -46,5 +62,31 @@ module Stripe
             "or `Account.retrieve_external_account('account_id', " \
             "'bank_account_id')`"
     end
+
+    def self.delete(id, params = {}, opts = {})
+      raise NotImplementedError,
+            "Bank accounts cannot be deleted without a customer ID or an " \
+            "account ID. Delete a bank account using " \
+            "`Customer.delete_source('customer_id', 'bank_account_id')` " \
+            "or `Account.delete_external_account('account_id', " \
+            "'bank_account_id')`"
+    end
+
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: resource_url.to_s,
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list(filters = {}, opts = {})
+      raise NotImplementedError,
+            "Bank accounts cannot be listed without a customer ID or an " \
+            "account ID. List bank accounts using " \
+            "`Customer.list_sources('customer_id')` " \
+            "or `Account.list_external_accounts('account_id')`"
+    end
   end
 end

data/lib/stripe/resources/billing/alert.rb

@@ -0,0 +1,87 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
+    class Alert < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "billing.alert"
+      def self.object_name
+        "billing.alert"
+      end
+
+      # Reactivates this alert, allowing it to trigger again.
+      def activate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Reactivates this alert, allowing it to trigger again.
+      def self.activate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
+      def archive(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
+      def self.archive(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a billing alert
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/billing/alerts", params: params, opts: opts)
+      end
+
+      # Deactivates this alert, preventing it from triggering.
+      def deactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deactivates this alert, preventing it from triggering.
+      def self.deactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Lists billing active and inactive alerts
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/billing/alerts", params: filters, opts: opts)
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter.rb

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.
+    class Meter < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing.meter"
+      def self.object_name
+        "billing.meter"
+      end
+
+      nested_resource_class_methods :event_summary,
+                                    operations: %i[list],
+                                    resource_plural: "event_summaries"
+
+      # Creates a billing meter
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/billing/meters", params: params, opts: opts)
+      end
+
+      # Deactivates a billing meter
+      def deactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Deactivates a billing meter
+      def self.deactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of billing meters.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/billing/meters", params: filters, opts: opts)
+      end
+
+      # Reactivates a billing meter
+      def reactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Reactivates a billing meter
+      def self.reactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a billing meter
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter_event.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.
+    # Meter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing.
+    class MeterEvent < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing.meter_event"
+      def self.object_name
+        "billing.meter_event"
+      end
+
+      # Creates a billing meter event
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/meter_events",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter_event_adjustment.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.
+    class MeterEventAdjustment < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing.meter_event_adjustment"
+      def self.object_name
+        "billing.meter_event_adjustment"
+      end
+
+      # Creates a billing meter event adjustment
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/meter_event_adjustments",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter_event_summary.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much
+    # usage was accrued by a customer for that period.
+    class MeterEventSummary < APIResource
+      OBJECT_NAME = "billing.meter_event_summary"
+      def self.object_name
+        "billing.meter_event_summary"
+      end
+    end
+  end
+end

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

@@ -10,6 +10,39 @@ module Stripe
       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(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing_portal/configurations",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Updates a configuration that describes the functionality of the customer portal.
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing_portal/configurations/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

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

@@ -16,11 +16,24 @@ module Stripe
     # 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).
+    # 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

@@ -6,10 +6,12 @@ module Stripe
   #
   # 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?
@@ -17,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

@@ -13,6 +13,9 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "card"
+    def self.object_name
+      "card"
+    end
 
     def resource_url
       if respond_to?(:customer) && !customer.nil? && !customer.empty?
@@ -37,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(filters = {}, 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

@@ -5,6 +5,9 @@ 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

@@ -9,11 +9,22 @@ module Stripe
   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
+
+    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,
@@ -23,6 +34,11 @@ module Stripe
       )
     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,
@@ -32,12 +48,34 @@ module Stripe
       )
     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(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/charges", params: filters, 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(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/charges/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

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

@@ -20,27 +20,38 @@ module Stripe
     class Session < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
 
       OBJECT_NAME = "checkout.session"
+      def self.object_name
+        "checkout.session"
+      end
 
-      def expire(params = {}, opts = {})
+      # Creates a Session object.
+      def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(self["id"]) }),
+          path: "/v1/checkout/sessions",
           params: params,
           opts: opts
         )
       end
 
-      def list_line_items(params = {}, opts = {})
+      # 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: :get,
-          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(self["id"]) }),
+          method: :post,
+          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,
@@ -50,6 +61,27 @@ module Stripe
         )
       end
 
+      # Returns a list of Checkout Sessions.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/checkout/sessions",
+          params: filters,
+          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,
@@ -58,6 +90,16 @@ module Stripe
           opts: opts
         )
       end
+
+      # Updates a Session object.
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end