stripe 5.55.0 → 8.3.0

data/lib/stripe/api_operations/create.rb

@@ -4,8 +4,12 @@ module Stripe
   module APIOperations
     module Create
       def create(params = {}, opts = {})
-        resp, opts = execute_resource_request(:post, resource_url, params, opts)
-        Util.convert_to_stripe_object(resp.data, opts)
+        request_stripe_object(
+          method: :post,
+          path: resource_url,
+          params: params,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_operations/delete.rb

@@ -18,17 +18,22 @@ module Stripe
         #   api_key to be overwritten. See
         #   {APIOperations::Request.execute_resource_request}.
         def delete(id, params = {}, opts = {})
-          resp, opts = execute_resource_request(:delete,
-                                                "#{resource_url}/#{id}",
-                                                params, opts)
-          Util.convert_to_stripe_object(resp.data, opts)
+          request_stripe_object(
+            method: :delete,
+            path: "#{resource_url}/#{id}",
+            params: params,
+            opts: opts
+          )
         end
       end
 
       def delete(params = {}, opts = {})
-        resp, opts = execute_resource_request(:delete, resource_url,
-                                              params, opts)
-        initialize_from(resp.data, opts)
+        request_stripe_object(
+          method: :delete,
+          path: resource_url,
+          params: params,
+          opts: opts
+        )
       end
 
       def self.included(base)

data/lib/stripe/api_operations/list.rb

@@ -4,15 +4,12 @@ module Stripe
   module APIOperations
     module List
       def list(filters = {}, opts = {})
-        opts = Util.normalize_opts(opts)
-
-        resp, opts = execute_resource_request(:get, resource_url, filters, opts)
-        obj = ListObject.construct_from(resp.data, opts)
-
-        # set filters so that we can fetch the same limit, expansions, and
-        # predicates when accessing the next and previous pages
-        obj.filters = filters.dup
-        obj
+        request_stripe_object(
+          method: :get,
+          path: resource_url,
+          params: filters,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_operations/nested_resource.rb

@@ -26,46 +26,74 @@ module Stripe
         end
 
         operations.each do |operation|
-          case operation
-          when :create
-            define_singleton_method(:"create_#{resource}") \
+          define_operation(
+            resource,
+            operation,
+            resource_url_method,
+            resource_plural
+          )
+        end
+      end
+
+      private def define_operation(
+        resource,
+        operation,
+        resource_url_method,
+        resource_plural
+      )
+        case operation
+        when :create
+          define_singleton_method(:"create_#{resource}") \
               do |id, params = {}, opts = {}|
-                url = send(resource_url_method, id)
-                resp, opts = execute_resource_request(:post, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :retrieve
-            define_singleton_method(:"retrieve_#{resource}") \
+            request_stripe_object(
+              method: :post,
+              path: send(resource_url_method, id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :retrieve
+          define_singleton_method(:"retrieve_#{resource}") \
               do |id, nested_id, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:get, url, {}, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :update
-            define_singleton_method(:"update_#{resource}") \
+            request_stripe_object(
+              method: :get,
+              path: send(resource_url_method, id, nested_id),
+              params: {},
+              opts: opts
+            )
+          end
+        when :update
+          define_singleton_method(:"update_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:post, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :delete
-            define_singleton_method(:"delete_#{resource}") \
+            request_stripe_object(
+              method: :post,
+              path: send(resource_url_method, id, nested_id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :delete
+          define_singleton_method(:"delete_#{resource}") \
               do |id, nested_id, params = {}, opts = {}|
-                url = send(resource_url_method, id, nested_id)
-                resp, opts = execute_resource_request(:delete, url, params,
-                                                      opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          when :list
-            define_singleton_method(:"list_#{resource_plural}") \
+            request_stripe_object(
+              method: :delete,
+              path: send(resource_url_method, id, nested_id),
+              params: params,
+              opts: opts
+            )
+          end
+        when :list
+          define_singleton_method(:"list_#{resource_plural}") \
               do |id, params = {}, opts = {}|
-                url = send(resource_url_method, id)
-                resp, opts = execute_resource_request(:get, url, params, opts)
-                Util.convert_to_stripe_object(resp.data, opts)
-              end
-          else
-            raise ArgumentError, "Unknown operation: #{operation.inspect}"
+            request_stripe_object(
+              method: :get,
+              path: send(resource_url_method, id),
+              params: params,
+              opts: opts
+            )
           end
+        else
+          raise ArgumentError, "Unknown operation: #{operation.inspect}"
         end
       end
     end

data/lib/stripe/api_operations/request.rb

@@ -24,6 +24,11 @@ module Stripe
           )
         end
 
+        private def request_stripe_object(method:, path:, params:, opts: {})
+          resp, opts = execute_resource_request(method, path, params, opts)
+          Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+        end
+
         private def execute_resource_request_internal(client_request_method_sym,
                                                       method, url,
                                                       params, opts,
@@ -122,6 +127,11 @@ module Stripe
         )
       end
 
+      private def request_stripe_object(method:, path:, params:, opts: {})
+        resp, opts = execute_resource_request(method, path, params, opts)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+      end
+
       # See notes on `alias` above.
       alias request execute_resource_request
     end

data/lib/stripe/api_operations/save.rb

@@ -24,12 +24,18 @@ module Stripe
             end
           end
 
-          resp, opts = execute_resource_request(:post, "#{resource_url}/#{id}",
-                                                params, opts)
-          Util.convert_to_stripe_object(resp.data, opts)
+          request_stripe_object(
+            method: :post,
+            path: "#{resource_url}/#{id}",
+            params: params,
+            opts: opts
+          )
         end
       end
 
+      # The `save` method is DEPRECATED and will be removed in a future major
+      # version of the library. Use the `update` method on the resource instead.
+      #
       # Creates or updates an API resource.
       #
       # If the resource doesn't yet have an assigned ID and the resource is one
@@ -65,6 +71,8 @@ module Stripe
         resp, opts = execute_resource_request(:post, save_url, values, opts)
         initialize_from(resp.data, opts)
       end
+      extend Gem::Deprecate
+      deprecate :save, :update, 2022, 11
 
       def self.included(base)
         # Set `metadata` as additive so that when it's set directly we remember

data/lib/stripe/api_operations/search.rb

@@ -4,15 +4,12 @@ module Stripe
   module APIOperations
     module Search
       def _search(search_url, filters = {}, opts = {})
-        opts = Util.normalize_opts(opts)
-
-        resp, opts = execute_resource_request(:get, search_url, filters, opts)
-        obj = SearchResultObject.construct_from(resp.data, opts)
-
-        # set filters so that we can fetch the same limit and query
-        # when accessing the next page
-        obj.filters = filters.dup
-        obj
+        request_stripe_object(
+          method: :get,
+          path: search_url,
+          params: filters,
+          opts: opts
+        )
       end
     end
   end

data/lib/stripe/api_resource.rb

@@ -97,7 +97,7 @@ module Stripe
       if Util.object_name_matches_class?(resp.data[:object], self.class)
         initialize_from(resp.data, opts)
       else
-        Util.convert_to_stripe_object(resp.data, opts)
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
       end
     end
 

data/lib/stripe/api_resource_test_helpers.rb

@@ -8,6 +8,8 @@ module Stripe
   #  class MyAPIResource < APIResource
   #    class TestHelpers < APIResourceTestHelpers
   class APIResourceTestHelpers
+    include Stripe::APIOperations::Request
+
     def initialize(resource)
       @resource = resource
     end

data/lib/stripe/api_version.rb

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module ApiVersion
+    CURRENT = "2022-11-15"
+  end
+end

data/lib/stripe/instrumentation.rb

@@ -33,6 +33,10 @@ module Stripe
       attr_reader :num_retries
       attr_reader :path
       attr_reader :request_id
+      attr_reader :response_header
+      attr_reader :response_body
+      attr_reader :request_header
+      attr_reader :request_body
 
       # Arbitrary user-provided data in the form of a Ruby hash that's passed
       # from subscribers on `request_begin` to subscribers on `request_end`.
@@ -40,19 +44,53 @@ module Stripe
       # in `request_end`.
       attr_reader :user_data
 
-      def initialize(duration:, http_status:, method:, num_retries:, path:,
-                     request_id:, user_data: nil)
-        @duration = duration
-        @http_status = http_status
-        @method = method
+      def initialize(request_context:, response_context:,
+                     num_retries:, user_data: nil)
+        @duration = request_context.duration
+        @http_status = response_context.http_status
+        @method = request_context.method
         @num_retries = num_retries
-        @path = path
-        @request_id = request_id
+        @path = request_context.path
+        @request_id = request_context.request_id
         @user_data = user_data
+        @response_header = response_context.header
+        @response_body = response_context.body
+        @request_header = request_context.header
+        @request_body = request_context.body
         freeze
       end
     end
 
+    class RequestContext
+      attr_reader :duration
+      attr_reader :method
+      attr_reader :path
+      attr_reader :request_id
+      attr_reader :body
+      attr_reader :header
+
+      def initialize(duration:, context:, header:)
+        @duration = duration
+        @method = context.method
+        @path = context.path
+        @request_id = context.request_id
+        @body = context.body
+        @header = header
+      end
+    end
+
+    class ResponseContext
+      attr_reader :http_status
+      attr_reader :body
+      attr_reader :header
+
+      def initialize(http_status:, response:)
+        @http_status = http_status
+        @header = response ? response.to_hash : nil
+        @body = response ? response.body : nil
+      end
+    end
+
     # This class was renamed for consistency. This alias is here for backwards
     # compatibility.
     RequestEvent = RequestEndEvent

data/lib/stripe/object_types.rb

@@ -14,17 +14,15 @@ module Stripe
         # business objects
         Account::OBJECT_NAME => Account,
         AccountLink::OBJECT_NAME => AccountLink,
-        AlipayAccount::OBJECT_NAME => AlipayAccount,
         ApplePayDomain::OBJECT_NAME => ApplePayDomain,
         ApplicationFee::OBJECT_NAME => ApplicationFee,
         ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund,
+        Apps::Secret::OBJECT_NAME => Apps::Secret,
         Balance::OBJECT_NAME => Balance,
         BalanceTransaction::OBJECT_NAME => BalanceTransaction,
         BankAccount::OBJECT_NAME => BankAccount,
         BillingPortal::Configuration::OBJECT_NAME => BillingPortal::Configuration,
         BillingPortal::Session::OBJECT_NAME => BillingPortal::Session,
-        BitcoinReceiver::OBJECT_NAME => BitcoinReceiver,
-        BitcoinTransaction::OBJECT_NAME => BitcoinTransaction,
         Capability::OBJECT_NAME => Capability,
         Card::OBJECT_NAME => Card,
         CashBalance::OBJECT_NAME => CashBalance,
@@ -36,6 +34,7 @@ module Stripe
         CreditNoteLineItem::OBJECT_NAME => CreditNoteLineItem,
         Customer::OBJECT_NAME => Customer,
         CustomerBalanceTransaction::OBJECT_NAME => CustomerBalanceTransaction,
+        CustomerCashBalanceTransaction::OBJECT_NAME => CustomerCashBalanceTransaction,
         Discount::OBJECT_NAME => Discount,
         Dispute::OBJECT_NAME => Dispute,
         EphemeralKey::OBJECT_NAME => EphemeralKey,
@@ -57,15 +56,12 @@ module Stripe
         InvoiceLineItem::OBJECT_NAME => InvoiceLineItem,
         Issuing::Authorization::OBJECT_NAME => Issuing::Authorization,
         Issuing::Card::OBJECT_NAME => Issuing::Card,
-        Issuing::CardDetails::OBJECT_NAME => Issuing::CardDetails,
         Issuing::Cardholder::OBJECT_NAME => Issuing::Cardholder,
         Issuing::Dispute::OBJECT_NAME => Issuing::Dispute,
         Issuing::Transaction::OBJECT_NAME => Issuing::Transaction,
         LineItem::OBJECT_NAME => LineItem,
         LoginLink::OBJECT_NAME => LoginLink,
         Mandate::OBJECT_NAME => Mandate,
-        Order::OBJECT_NAME => Order,
-        OrderReturn::OBJECT_NAME => OrderReturn,
         PaymentIntent::OBJECT_NAME => PaymentIntent,
         PaymentLink::OBJECT_NAME => PaymentLink,
         PaymentMethod::OBJECT_NAME => PaymentMethod,
@@ -79,8 +75,6 @@ module Stripe
         Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
         Radar::ValueList::OBJECT_NAME => Radar::ValueList,
         Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
-        Recipient::OBJECT_NAME => Recipient,
-        RecipientTransfer::OBJECT_NAME => RecipientTransfer,
         Refund::OBJECT_NAME => Refund,
         Reporting::ReportRun::OBJECT_NAME => Reporting::ReportRun,
         Reporting::ReportType::OBJECT_NAME => Reporting::ReportType,
@@ -90,7 +84,6 @@ module Stripe
         SetupIntent::OBJECT_NAME => SetupIntent,
         ShippingRate::OBJECT_NAME => ShippingRate,
         Sigma::ScheduledQueryRun::OBJECT_NAME => Sigma::ScheduledQueryRun,
-        SKU::OBJECT_NAME => SKU,
         Source::OBJECT_NAME => Source,
         SourceTransaction::OBJECT_NAME => SourceTransaction,
         Subscription::OBJECT_NAME => Subscription,
@@ -104,10 +97,19 @@ module Stripe
         Terminal::Location::OBJECT_NAME => Terminal::Location,
         Terminal::Reader::OBJECT_NAME => Terminal::Reader,
         TestHelpers::TestClock::OBJECT_NAME => TestHelpers::TestClock,
-        ThreeDSecure::OBJECT_NAME => ThreeDSecure,
         Token::OBJECT_NAME => Token,
         Topup::OBJECT_NAME => Topup,
         Transfer::OBJECT_NAME => Transfer,
+        Treasury::CreditReversal::OBJECT_NAME => Treasury::CreditReversal,
+        Treasury::DebitReversal::OBJECT_NAME => Treasury::DebitReversal,
+        Treasury::FinancialAccount::OBJECT_NAME => Treasury::FinancialAccount,
+        Treasury::InboundTransfer::OBJECT_NAME => Treasury::InboundTransfer,
+        Treasury::OutboundPayment::OBJECT_NAME => Treasury::OutboundPayment,
+        Treasury::OutboundTransfer::OBJECT_NAME => Treasury::OutboundTransfer,
+        Treasury::ReceivedCredit::OBJECT_NAME => Treasury::ReceivedCredit,
+        Treasury::ReceivedDebit::OBJECT_NAME => Treasury::ReceivedDebit,
+        Treasury::Transaction::OBJECT_NAME => Treasury::Transaction,
+        Treasury::TransactionEntry::OBJECT_NAME => Treasury::TransactionEntry,
         UsageRecord::OBJECT_NAME => UsageRecord,
         UsageRecordSummary::OBJECT_NAME => UsageRecordSummary,
         WebhookEndpoint::OBJECT_NAME => WebhookEndpoint,

data/lib/stripe/resources/account.rb

@@ -2,6 +2,14 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a Stripe account. You can retrieve it to see
+  # properties on the account like its current requirements or if the account is
+  # enabled to make live charges or receive payouts.
+  #
+  # For Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that
+  # account has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links)
+  # for a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express**
+  # below. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts).
   class Account < APIResource
     extend Gem::Deprecate
     extend Stripe::APIOperations::Create
@@ -12,18 +20,43 @@ module Stripe
 
     OBJECT_NAME = "account"
 
-    custom_method :reject, http_verb: :post
-
     nested_resource_class_methods :capability,
                                   operations: %i[retrieve update list],
                                   resource_plural: "capabilities"
     nested_resource_class_methods :person,
                                   operations: %i[create retrieve update delete list]
 
+    def persons(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def reject(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/reject",
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.persons(account, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.reject(account, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(account) }),
         params: params,
         opts: opts
       )
@@ -33,7 +66,6 @@ module Stripe
 
     nested_resource_class_methods :external_account,
                                   operations: %i[create retrieve update delete list]
-
     nested_resource_class_methods :login_link, operations: %i[create]
 
     def resource_url
@@ -60,11 +92,6 @@ module Stripe
       super(id, opts)
     end
 
-    def persons(params = {}, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/persons", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
-    end
-
     # We are not adding a helper for capabilities here as the Account object
     # already has a capabilities property which is a hash and not the sub-list
     # of capabilities.

data/lib/stripe/resources/account_link.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Account Links are the means by which a Connect platform grants a connected account permission to access
+  # Stripe-hosted applications, such as Connect Onboarding.
+  #
+  # Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding).
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/application_fee_refund.rb

@@ -2,6 +2,11 @@
 # 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

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

@@ -0,0 +1,40 @@
+# 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.delete_where(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.find(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/balance.rb

@@ -2,6 +2,17 @@
 # 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"
   end

data/lib/stripe/resources/balance_transaction.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Balance transactions represent funds moving through your Stripe account.
+  # They're created for every type of transaction that comes into or flows out of your Stripe account balance.
+  #
+  # Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/bank_account.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 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).
+  # 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).
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

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

@@ -3,6 +3,7 @@
 
 module Stripe
   module BillingPortal
+    # A portal configuration describes the functionality and behavior of a portal session.
     class Configuration < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

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

@@ -3,6 +3,20 @@
 
 module Stripe
   module BillingPortal
+    # The Billing customer portal is a Stripe-hosted UI for subscription and
+    # billing management.
+    #
+    # A portal configuration describes the functionality and features that you
+    # want to provide to your customers through the portal.
+    #
+    # A portal session describes the instantiation of the customer portal for
+    # a particular customer. By visiting the session's URL, the customer
+    # can manage their subscriptions and billing details. For security reasons,
+    # sessions are short-lived and will expire if the customer does not visit the URL.
+    # Create sessions on-demand when customers intend to manage their subscriptions
+    # and billing details.
+    #
+    # Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
     class Session < APIResource
       extend Stripe::APIOperations::Create