stripe 10.5.0.pre.beta.1 → 10.6.0.pre.beta.1

data/lib/stripe/resources/topup.rb

@@ -14,6 +14,7 @@ module Stripe
 
     OBJECT_NAME = "topup"
 
+    # Cancels a top-up. Only pending top-ups can be canceled.
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -23,6 +24,7 @@ module Stripe
       )
     end
 
+    # Cancels a top-up. Only pending top-ups can be canceled.
     def self.cancel(topup, params = {}, opts = {})
       request_stripe_object(
         method: :post,

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

@@ -12,6 +12,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.financial_account"
 
+      # Retrieves Features information associated with the FinancialAccount.
       def retrieve_features(params = {}, opts = {})
         request_stripe_object(
           method: :get,
@@ -21,6 +22,7 @@ module Stripe
         )
       end
 
+      # Updates the Features associated with a FinancialAccount.
       def update_features(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -30,6 +32,7 @@ module Stripe
         )
       end
 
+      # Retrieves Features information associated with the FinancialAccount.
       def self.retrieve_features(financial_account, params = {}, opts = {})
         request_stripe_object(
           method: :get,
@@ -39,6 +42,7 @@ module Stripe
         )
       end
 
+      # Updates the Features associated with a FinancialAccount.
       def self.update_features(financial_account, params = {}, opts = {})
         request_stripe_object(
           method: :post,

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

@@ -10,6 +10,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.inbound_transfer"
 
+      # Cancels an InboundTransfer.
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -19,6 +20,7 @@ module Stripe
         )
       end
 
+      # Cancels an InboundTransfer.
       def self.cancel(inbound_transfer, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -35,6 +37,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = InboundTransfer
 
+        # Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
         def self.fail(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -44,6 +47,7 @@ module Stripe
           )
         end
 
+        # Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
         def self.return_inbound_transfer(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -53,6 +57,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
         def self.succeed(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -62,6 +67,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
         def fail(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -71,6 +77,7 @@ module Stripe
           )
         end
 
+        # Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
         def return_inbound_transfer(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -80,6 +87,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
         def succeed(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,

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

@@ -12,6 +12,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.outbound_payment"
 
+      # Cancel an OutboundPayment.
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -21,6 +22,7 @@ module Stripe
         )
       end
 
+      # Cancel an OutboundPayment.
       def self.cancel(id, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -37,6 +39,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = OutboundPayment
 
+        # Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
         def self.fail(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -46,6 +49,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
         def self.post(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -55,6 +59,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
         def self.return_outbound_payment(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -64,6 +69,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
         def fail(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -73,6 +79,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
         def post(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -82,6 +89,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
         def return_outbound_payment(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,

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

@@ -12,6 +12,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.outbound_transfer"
 
+      # An OutboundTransfer can be canceled if the funds have not yet been paid out.
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -21,6 +22,7 @@ module Stripe
         )
       end
 
+      # An OutboundTransfer can be canceled if the funds have not yet been paid out.
       def self.cancel(outbound_transfer, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -37,6 +39,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = OutboundTransfer
 
+        # Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
         def self.fail(outbound_transfer, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -46,6 +49,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
         def self.post(outbound_transfer, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -55,6 +59,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
         def self.return_outbound_transfer(outbound_transfer, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -64,6 +69,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
         def fail(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -73,6 +79,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
         def post(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -82,6 +89,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
         def return_outbound_transfer(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,

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

@@ -16,6 +16,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = ReceivedCredit
 
+        # Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
         def self.create(params = {}, opts = {})
           request_stripe_object(
             method: :post,

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

@@ -16,6 +16,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = ReceivedDebit
 
+        # Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can't directly create ReceivedDebits initiated by third parties.
         def self.create(params = {}, opts = {})
           request_stripe_object(
             method: :post,

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "10.5.0-beta.1"
+  VERSION = "10.6.0-beta.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 10.5.0.pre.beta.1
+  version: 10.6.0.pre.beta.1
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.