stripe 5.39.0 → 10.1.0

data/lib/stripe/resources/treasury/inbound_transfer.rb

@@ -0,0 +1,94 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.
+    class InboundTransfer < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.inbound_transfer"
+
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/inbound_transfers/%<inbound_transfer>s/cancel", { inbound_transfer: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.cancel(inbound_transfer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/inbound_transfers/%<inbound_transfer>s/cancel", { inbound_transfer: CGI.escape(inbound_transfer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = InboundTransfer
+
+        def self.fail(id, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/fail", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.return_inbound_transfer(id, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/return", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.succeed(id, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/succeed", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def fail(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/fail", { id: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def return_inbound_transfer(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/return", { id: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def succeed(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/inbound_transfers/%<id>s/succeed", { id: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/outbound_payment.rb

@@ -0,0 +1,96 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
+    #
+    # Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
+    class OutboundPayment < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.outbound_payment"
+
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/outbound_payments/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.cancel(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/outbound_payments/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = OutboundPayment
+
+        def self.fail(id, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_payments/%<id>s/fail", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.post(id, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_payments/%<id>s/post", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.return_outbound_payment(id, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_payments/%<id>s/return", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def fail(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_payments/%<id>s/fail", { id: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def post(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_payments/%<id>s/post", { id: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def return_outbound_payment(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_payments/%<id>s/return", { id: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/outbound_transfer.rb

@@ -0,0 +1,96 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+    #
+    # Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
+    class OutboundTransfer < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.outbound_transfer"
+
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/outbound_transfers/%<outbound_transfer>s/cancel", { outbound_transfer: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.cancel(outbound_transfer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/treasury/outbound_transfers/%<outbound_transfer>s/cancel", { outbound_transfer: CGI.escape(outbound_transfer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = OutboundTransfer
+
+        def self.fail(outbound_transfer, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/fail", { outbound_transfer: CGI.escape(outbound_transfer) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.post(outbound_transfer, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/post", { outbound_transfer: CGI.escape(outbound_transfer) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.return_outbound_transfer(outbound_transfer, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/return", { outbound_transfer: CGI.escape(outbound_transfer) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def fail(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/fail", { outbound_transfer: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def post(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/post", { outbound_transfer: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def return_outbound_transfer(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/treasury/outbound_transfers/%<outbound_transfer>s/return", { outbound_transfer: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/received_credit.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
+    class ReceivedCredit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.received_credit"
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = ReceivedCredit
+
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_credits",
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/received_debit.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
+    class ReceivedDebit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.received_debit"
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = ReceivedDebit
+
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_debits",
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.transaction"
+    end
+  end
+end

data/lib/stripe/resources/treasury/transaction_entry.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).
+    class TransactionEntry < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.transaction_entry"
+
+      def self.resource_url
+        "/v1/treasury/transaction_entries"
+      end
+    end
+  end
+end

data/lib/stripe/resources/usage_record.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Usage records allow you to report customer usage and metrics to Stripe for
+  # metered billing of subscription prices.
+  #
+  # Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)
   class UsageRecord < APIResource
     OBJECT_NAME = "usage_record"
   end

data/lib/stripe/resources/webhook_endpoint.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be
+  # notified about events that happen in your Stripe account or connected
+  # accounts.
+  #
+  # Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.
+  #
+  # Related guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure)
   class WebhookEndpoint < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources.rb

@@ -3,19 +3,19 @@
 
 require "stripe/resources/account"
 require "stripe/resources/account_link"
-require "stripe/resources/alipay_account"
+require "stripe/resources/account_session"
 require "stripe/resources/apple_pay_domain"
 require "stripe/resources/application_fee"
 require "stripe/resources/application_fee_refund"
+require "stripe/resources/apps/secret"
 require "stripe/resources/balance"
 require "stripe/resources/balance_transaction"
 require "stripe/resources/bank_account"
 require "stripe/resources/billing_portal/configuration"
 require "stripe/resources/billing_portal/session"
-require "stripe/resources/bitcoin_receiver"
-require "stripe/resources/bitcoin_transaction"
 require "stripe/resources/capability"
 require "stripe/resources/card"
+require "stripe/resources/cash_balance"
 require "stripe/resources/charge"
 require "stripe/resources/checkout/session"
 require "stripe/resources/country_spec"
@@ -24,6 +24,7 @@ require "stripe/resources/credit_note"
 require "stripe/resources/credit_note_line_item"
 require "stripe/resources/customer"
 require "stripe/resources/customer_balance_transaction"
+require "stripe/resources/customer_cash_balance_transaction"
 require "stripe/resources/discount"
 require "stripe/resources/dispute"
 require "stripe/resources/ephemeral_key"
@@ -31,6 +32,11 @@ require "stripe/resources/event"
 require "stripe/resources/exchange_rate"
 require "stripe/resources/file"
 require "stripe/resources/file_link"
+require "stripe/resources/financial_connections/account"
+require "stripe/resources/financial_connections/account_owner"
+require "stripe/resources/financial_connections/account_ownership"
+require "stripe/resources/financial_connections/session"
+require "stripe/resources/funding_instructions"
 require "stripe/resources/identity/verification_report"
 require "stripe/resources/identity/verification_session"
 require "stripe/resources/invoice"
@@ -38,17 +44,18 @@ require "stripe/resources/invoice_item"
 require "stripe/resources/invoice_line_item"
 require "stripe/resources/issuing/authorization"
 require "stripe/resources/issuing/card"
-require "stripe/resources/issuing/card_details"
 require "stripe/resources/issuing/cardholder"
 require "stripe/resources/issuing/dispute"
+require "stripe/resources/issuing/token"
 require "stripe/resources/issuing/transaction"
 require "stripe/resources/line_item"
 require "stripe/resources/login_link"
 require "stripe/resources/mandate"
-require "stripe/resources/order"
-require "stripe/resources/order_return"
 require "stripe/resources/payment_intent"
+require "stripe/resources/payment_link"
 require "stripe/resources/payment_method"
+require "stripe/resources/payment_method_configuration"
+require "stripe/resources/payment_method_domain"
 require "stripe/resources/payout"
 require "stripe/resources/person"
 require "stripe/resources/plan"
@@ -59,8 +66,6 @@ require "stripe/resources/quote"
 require "stripe/resources/radar/early_fraud_warning"
 require "stripe/resources/radar/value_list"
 require "stripe/resources/radar/value_list_item"
-require "stripe/resources/recipient"
-require "stripe/resources/recipient_transfer"
 require "stripe/resources/refund"
 require "stripe/resources/reporting/report_run"
 require "stripe/resources/reporting/report_type"
@@ -68,23 +73,41 @@ require "stripe/resources/reversal"
 require "stripe/resources/review"
 require "stripe/resources/setup_attempt"
 require "stripe/resources/setup_intent"
+require "stripe/resources/shipping_rate"
 require "stripe/resources/sigma/scheduled_query_run"
-require "stripe/resources/sku"
 require "stripe/resources/source"
 require "stripe/resources/source_transaction"
 require "stripe/resources/subscription"
 require "stripe/resources/subscription_item"
 require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax/calculation"
+require "stripe/resources/tax/calculation_line_item"
+require "stripe/resources/tax/registration"
+require "stripe/resources/tax/settings"
+require "stripe/resources/tax/transaction"
+require "stripe/resources/tax/transaction_line_item"
 require "stripe/resources/tax_code"
 require "stripe/resources/tax_id"
 require "stripe/resources/tax_rate"
+require "stripe/resources/terminal/configuration"
 require "stripe/resources/terminal/connection_token"
 require "stripe/resources/terminal/location"
 require "stripe/resources/terminal/reader"
-require "stripe/resources/three_d_secure"
+require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/token"
 require "stripe/resources/topup"
 require "stripe/resources/transfer"
+require "stripe/resources/treasury/credit_reversal"
+require "stripe/resources/treasury/debit_reversal"
+require "stripe/resources/treasury/financial_account"
+require "stripe/resources/treasury/financial_account_features"
+require "stripe/resources/treasury/inbound_transfer"
+require "stripe/resources/treasury/outbound_payment"
+require "stripe/resources/treasury/outbound_transfer"
+require "stripe/resources/treasury/received_credit"
+require "stripe/resources/treasury/received_debit"
+require "stripe/resources/treasury/transaction"
+require "stripe/resources/treasury/transaction_entry"
 require "stripe/resources/usage_record"
 require "stripe/resources/usage_record_summary"
 require "stripe/resources/webhook_endpoint"

data/lib/stripe/search_result_object.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Stripe
+  class SearchResultObject < StripeObject
+    include Enumerable
+    include Stripe::APIOperations::Search
+    include Stripe::APIOperations::Request
+
+    OBJECT_NAME = "search_result"
+
+    # This accessor allows a `SearchResultObject` to inherit various filters
+    # that were given to a predecessor. This allows for things like consistent
+    # limits, expansions, and predicates as a user pages through resources.
+    attr_accessor :filters
+
+    # An empty search result object. This is returned from +next+ when we know
+    # that there isn't a next page in order to replicate the behavior of the API
+    # when it attempts to return a page beyond the last.
+    def self.empty_search_result(opts = {})
+      SearchResultObject.construct_from({ data: [] }, opts)
+    end
+
+    def initialize(*args)
+      super
+      self.filters = {}
+    end
+
+    def [](key)
+      case key
+      when String, Symbol
+        super
+      else
+        raise ArgumentError,
+              "You tried to access the #{key.inspect} index, but " \
+              "SearchResultObject types only support String keys. " \
+              "(HINT: Search calls return an object with a 'data' (which is " \
+              "the data array). You likely want to call #data[#{key.inspect}])"
+      end
+    end
+
+    # Iterates through each resource in the page represented by the current
+    # `SearchListObject`.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&blk)
+      data.each(&blk)
+    end
+
+    # Returns true if the page object contains no elements.
+    def empty?
+      data.empty?
+    end
+
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_search_result_page+.
+    def auto_paging_each(&blk)
+      return enum_for(:auto_paging_each) unless block_given?
+
+      page = self
+
+      loop do
+        page.each(&blk)
+        page = page.next_search_result_page
+
+        break if page.empty?
+      end
+    end
+
+    # Fetches the next page in the resource list (if there is one).
+    #
+    # This method will try to respect the limit of the current page. If none
+    # was given, the default limit will be fetched again.
+    def next_search_result_page(params = {}, opts = {})
+      return self.class.empty_search_result(opts) unless has_more
+
+      params = filters.merge(page: next_page).merge(params)
+
+      _search(url, params, opts)
+    end
+  end
+end