stripe 5.55.0 → 13.5.1

data/lib/stripe/resources/alipay_account.rb

@@ -14,7 +14,7 @@ module Stripe
       end
 
       "#{Customer.resource_url}/#{CGI.escape(customer)}/sources" \
-      "/#{CGI.escape(id)}"
+        "/#{CGI.escape(id)}"
     end
 
     def self.update(_id, _params = nil, _opts = nil)

data/lib/stripe/resources/apple_pay_domain.rb

@@ -9,6 +9,44 @@ module Stripe
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "apple_pay_domain"
+    def self.object_name
+      "apple_pay_domain"
+    end
+
+    # Create an apple pay domain.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "/v1/apple_pay/domains",
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Delete an apple pay domain.
+    def self.delete(domain, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/apple_pay/domains/%<domain>s", { domain: CGI.escape(domain) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Delete an apple pay domain.
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/apple_pay/domains/%<domain>s", { domain: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # List apple pay domains.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/apple_pay/domains", params: params, opts: opts)
+    end
 
     def self.resource_url
       "/v1/apple_pay/domains"

data/lib/stripe/resources/application_fee.rb

@@ -7,8 +7,15 @@ module Stripe
     extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "application_fee"
+    def self.object_name
+      "application_fee"
+    end
 
-    nested_resource_class_methods :refund,
-                                  operations: %i[create retrieve update list]
+    nested_resource_class_methods :refund, operations: %i[create retrieve update list]
+
+    # Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/application_fees", params: params, opts: opts)
+    end
   end
 end

data/lib/stripe/resources/application_fee_refund.rb

@@ -2,15 +2,22 @@
 # 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
 
     OBJECT_NAME = "fee_refund"
+    def self.object_name
+      "fee_refund"
+    end
 
     def resource_url
       "#{ApplicationFee.resource_url}/#{CGI.escape(fee)}/refunds" \
-      "/#{CGI.escape(id)}"
+        "/#{CGI.escape(id)}"
     end
 
     def self.update(_id, _params = nil, _opts = nil)

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

@@ -0,0 +1,55 @@
+# 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.object_name
+        "apps.secret"
+      end
+
+      # Create or replace a secret in the secret store.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/apps/secrets", params: params, opts: opts)
+      end
+
+      # Deletes a secret from the secret store by name and scope.
+      def self.delete_where(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Finds a secret in the secret store by name and scope.
+      def self.find(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List all secrets stored on the given scope.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/apps/secrets", params: params, opts: opts)
+      end
+    end
+  end
+end

data/lib/stripe/resources/balance.rb

@@ -2,7 +2,21 @@
 # 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"
+    def self.object_name
+      "balance"
+    end
   end
 end

data/lib/stripe/resources/balance_transaction.rb

@@ -2,9 +2,28 @@
 # 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
 
     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(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/balance_transactions",
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/bank_account.rb

@@ -2,16 +2,39 @@
 # frozen_string_literal: true
 
 module Stripe
+  # These bank accounts are payment methods on `Customer` objects.
+  #
+  # 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/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
@@ -24,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)`"
@@ -39,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(params = {}, 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(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/billing/alerts", params: params, opts: opts)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # Indicates the billing credit balance for billing credits granted to a customer.
+    class CreditBalanceSummary < SingletonAPIResource
+      OBJECT_NAME = "billing.credit_balance_summary"
+      def self.object_name
+        "billing.credit_balance_summary"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
+    class CreditBalanceTransaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "billing.credit_balance_transaction"
+      def self.object_name
+        "billing.credit_balance_transaction"
+      end
+
+      # Retrieve a list of credit balance transactions.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing/credit_balance_transactions",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A credit grant is an API resource that documents the allocation of some billing credits to a customer.
+    #
+    # Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)
+    class CreditGrant < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing.credit_grant"
+      def self.object_name
+        "billing.credit_grant"
+      end
+
+      # Creates a credit grant.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Expires a credit grant.
+      def expire(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Expires a credit grant.
+      def self.expire(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of credit grants.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a credit grant.
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Voids a credit grant.
+      def void_grant(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Voids a credit grant.
+      def self.void_grant(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
+    #
+    # Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
+    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
+
+      # When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
+      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
+
+      # When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
+      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(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/billing/meters", params: params, opts: opts)
+      end
+
+      # When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
+      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
+
+      # When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
+      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,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.
+    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,17 @@
+# 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.
+    #
+    # Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.
+    class MeterEventSummary < APIResource
+      OBJECT_NAME = "billing.meter_event_summary"
+      def self.object_name
+        "billing.meter_event_summary"
+      end
+    end
+  end
+end