stripe 5.55.0 → 8.3.0

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,100 @@
+# 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,17 +3,15 @@
 
 require "stripe/resources/account"
 require "stripe/resources/account_link"
-require "stripe/resources/alipay_account"
 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"
@@ -25,6 +23,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"
@@ -44,15 +43,12 @@ 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/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"
@@ -66,8 +62,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"
@@ -77,7 +71,6 @@ 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"
@@ -91,10 +84,19 @@ require "stripe/resources/terminal/connection_token"
 require "stripe/resources/terminal/location"
 require "stripe/resources/terminal/reader"
 require "stripe/resources/test_helpers/test_clock"
-require "stripe/resources/three_d_secure"
 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/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/stripe_client.rb

@@ -494,15 +494,16 @@ module Stripe
           end
         end
 
-      http_resp = execute_request_with_rescues(method, api_base, context) do
-        self.class
-            .default_connection_manager(config)
-            .execute_request(method, url,
-                             body: body,
-                             headers: headers,
-                             query: query,
-                             &response_block)
-      end
+      http_resp =
+        execute_request_with_rescues(method, api_base, headers, context) do
+          self.class
+              .default_connection_manager(config)
+              .execute_request(method, url,
+                               body: body,
+                               headers: headers,
+                               query: query,
+                               &response_block)
+        end
 
       [http_resp, api_key]
     end
@@ -564,7 +565,7 @@ module Stripe
       http_status >= 400
     end
 
-    private def execute_request_with_rescues(method, api_base, context)
+    private def execute_request_with_rescues(method, api_base, headers, context)
       num_retries = 0
 
       begin
@@ -587,7 +588,7 @@ module Stripe
 
         log_response(context, request_start, http_status, resp.body, resp)
         notify_request_end(context, request_duration, http_status,
-                           num_retries, user_data)
+                           num_retries, user_data, resp, headers)
 
         if config.enable_telemetry? && context.request_id
           request_duration_ms = (request_duration * 1000).to_i
@@ -614,7 +615,7 @@ module Stripe
           log_response_error(error_context, request_start, e)
         end
         notify_request_end(context, request_duration, http_status, num_retries,
-                           user_data)
+                           user_data, resp, headers)
 
         if self.class.should_retry?(e,
                                     method: method,
@@ -657,17 +658,24 @@ module Stripe
     end
 
     private def notify_request_end(context, duration, http_status, num_retries,
-                                   user_data)
+                                   user_data, resp, headers)
       return if !Instrumentation.any_subscribers?(:request_end) &&
                 !Instrumentation.any_subscribers?(:request)
 
-      event = Instrumentation::RequestEndEvent.new(
+      request_context = Stripe::Instrumentation::RequestContext.new(
         duration: duration,
+        context: context,
+        header: headers
+      )
+      response_context = Stripe::Instrumentation::ResponseContext.new(
         http_status: http_status,
-        method: context.method,
+        response: resp
+      )
+
+      event = Instrumentation::RequestEndEvent.new(
+        request_context: request_context,
+        response_context: response_context,
         num_retries: num_retries,
-        path: context.path,
-        request_id: context.request_id,
         user_data: user_data || {}
       )
       Stripe::Instrumentation.notify(:request_end, event)

data/lib/stripe/stripe_object.rb

@@ -429,13 +429,13 @@ module Stripe
     # * +:opts:+ Options for StripeObject like an API key.
     # * +:partial:+ Indicates that the re-initialization should not attempt to
     #   remove accessors.
-    protected def initialize_from(values, opts, partial = false)
+    protected def initialize_from(values, opts)
       @opts = Util.normalize_opts(opts)
 
       # the `#send` is here so that we can keep this method private
       @original_values = self.class.send(:deep_copy, values)
 
-      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      removed = Set.new(@values.keys - values.keys)
       added = Set.new(values.keys - @values.keys)
 
       # Wipe old state before setting new.  This is useful for e.g. updating a

data/lib/stripe/util.rb

@@ -90,7 +90,7 @@ module Stripe
           opts
         )
 
-        Util.convert_to_stripe_object(resp.data, opts)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
       end
     end
 
@@ -104,9 +104,27 @@ module Stripe
     # ==== Attributes
     #
     # * +data+ - Hash of fields and values to be converted into a StripeObject.
+    # * +params+ - Params for +StripeObject+ like filters used in search that
+    #   will be reused on subsequent API calls.
     # * +opts+ - Options for +StripeObject+ like an API key that will be reused
     #   on subsequent API calls.
     def self.convert_to_stripe_object(data, opts = {})
+      convert_to_stripe_object_with_params(data, {}, opts)
+    end
+
+    # Converts a hash of fields or an array of hashes into a +StripeObject+ or
+    # array of +StripeObject+s. These new objects will be created as a concrete
+    # type as dictated by their `object` field (e.g. an `object` value of
+    # `charge` would create an instance of +Charge+), but if `object` is not
+    # present or of an unknown type, the newly created instance will fall back
+    # to being a +StripeObject+.
+    #
+    # ==== Attributes
+    #
+    # * +data+ - Hash of fields and values to be converted into a StripeObject.
+    # * +opts+ - Options for +StripeObject+ like an API key that will be reused
+    #   on subsequent API calls.
+    def self.convert_to_stripe_object_with_params(data, params, opts = {})
       opts = normalize_opts(opts)
 
       case data
@@ -115,8 +133,16 @@ module Stripe
       when Hash
         # Try converting to a known object class.  If none available, fall back
         # to generic StripeObject
-        object_classes.fetch(data[:object], StripeObject)
-                      .construct_from(data, opts)
+        obj = object_classes.fetch(data[:object], StripeObject)
+                            .construct_from(data, opts)
+
+        # set filters so that we can fetch the same limit, expansions, and
+        # predicates when accessing the next and previous pages
+        if obj && (obj.is_a?(SearchResultObject) || obj.is_a?(ListObject))
+          obj.filters = params.dup
+        end
+
+        obj
       else
         data
       end
@@ -390,6 +416,15 @@ module Stripe
       # Hopefully val is a string, but protect in case it's not.
       val = val.to_s
 
+      # Some values returned by the server are encoded in ASCII-8BIT before
+      # being parsed as UTF-8 by Marshal. If we don't transform these here, then
+      # puts will fail as it tries to render UTF-8 characters as ASCII-8BIT
+      # which is not valid.
+      if val && val.encoding == Encoding::ASCII_8BIT
+        # Dup the string as it is a frozen literal.
+        val = val.dup.force_encoding("UTF-8")
+      end
+
       if %r{[^\w\-/]} =~ val
         # If the string contains any special characters, escape any double
         # quotes it has, remove newlines, and wrap the whole thing in quotes.

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "5.55.0"
+  VERSION = "8.3.0"
 end