stripe 15.2.0.pre.beta.1 → 15.3.0.pre.beta.1

data/lib/stripe/services/payment_method_service.rb

@@ -50,20 +50,11 @@ module Stripe
         end
       end
 
-      class Affirm < Stripe::RequestParams
-      end
-
-      class AfterpayClearpay < Stripe::RequestParams
-      end
-
-      class Alipay < Stripe::RequestParams
-      end
-
-      class Alma < Stripe::RequestParams
-      end
-
-      class AmazonPay < Stripe::RequestParams
-      end
+      class Affirm < Stripe::RequestParams; end
+      class AfterpayClearpay < Stripe::RequestParams; end
+      class Alipay < Stripe::RequestParams; end
+      class Alma < Stripe::RequestParams; end
+      class AmazonPay < Stripe::RequestParams; end
 
       class AuBecsDebit < Stripe::RequestParams
         # The account number for the bank account.
@@ -89,11 +80,8 @@ module Stripe
         end
       end
 
-      class Bancontact < Stripe::RequestParams
-      end
-
-      class Billie < Stripe::RequestParams
-      end
+      class Bancontact < Stripe::RequestParams; end
+      class Billie < Stripe::RequestParams; end
 
       class BillingDetails < Stripe::RequestParams
         class Address < Stripe::RequestParams
@@ -146,8 +134,7 @@ module Stripe
         end
       end
 
-      class Blik < Stripe::RequestParams
-      end
+      class Blik < Stripe::RequestParams; end
 
       class Boleto < Stripe::RequestParams
         # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -197,11 +184,8 @@ module Stripe
         end
       end
 
-      class Cashapp < Stripe::RequestParams
-      end
-
-      class CustomerBalance < Stripe::RequestParams
-      end
+      class Cashapp < Stripe::RequestParams; end
+      class CustomerBalance < Stripe::RequestParams; end
 
       class Eps < Stripe::RequestParams
         # The customer's bank.
@@ -224,14 +208,9 @@ module Stripe
         end
       end
 
-      class Giropay < Stripe::RequestParams
-      end
-
-      class Gopay < Stripe::RequestParams
-      end
-
-      class Grabpay < Stripe::RequestParams
-      end
+      class Giropay < Stripe::RequestParams; end
+      class Gopay < Stripe::RequestParams; end
+      class Grabpay < Stripe::RequestParams; end
 
       class IdBankTransfer < Stripe::RequestParams
         # Bank where the account is held.
@@ -251,11 +230,8 @@ module Stripe
         end
       end
 
-      class InteracPresent < Stripe::RequestParams
-      end
-
-      class KakaoPay < Stripe::RequestParams
-      end
+      class InteracPresent < Stripe::RequestParams; end
+      class KakaoPay < Stripe::RequestParams; end
 
       class Klarna < Stripe::RequestParams
         class Dob < Stripe::RequestParams
@@ -280,23 +256,12 @@ module Stripe
         end
       end
 
-      class Konbini < Stripe::RequestParams
-      end
-
-      class KrCard < Stripe::RequestParams
-      end
-
-      class Link < Stripe::RequestParams
-      end
-
-      class MbWay < Stripe::RequestParams
-      end
-
-      class Mobilepay < Stripe::RequestParams
-      end
-
-      class Multibanco < Stripe::RequestParams
-      end
+      class Konbini < Stripe::RequestParams; end
+      class KrCard < Stripe::RequestParams; end
+      class Link < Stripe::RequestParams; end
+      class MbWay < Stripe::RequestParams; end
+      class Mobilepay < Stripe::RequestParams; end
+      class Multibanco < Stripe::RequestParams; end
 
       class NaverPay < Stripe::RequestParams
         # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
@@ -338,8 +303,7 @@ module Stripe
         end
       end
 
-      class Oxxo < Stripe::RequestParams
-      end
+      class Oxxo < Stripe::RequestParams; end
 
       class P24 < Stripe::RequestParams
         # The customer's bank.
@@ -350,17 +314,10 @@ module Stripe
         end
       end
 
-      class PayByBank < Stripe::RequestParams
-      end
-
-      class Payco < Stripe::RequestParams
-      end
-
-      class Paynow < Stripe::RequestParams
-      end
-
-      class Paypal < Stripe::RequestParams
-      end
+      class PayByBank < Stripe::RequestParams; end
+      class Payco < Stripe::RequestParams; end
+      class Paynow < Stripe::RequestParams; end
+      class Paypal < Stripe::RequestParams; end
 
       class Payto < Stripe::RequestParams
         # The account number for the bank account.
@@ -377,14 +334,9 @@ module Stripe
         end
       end
 
-      class Pix < Stripe::RequestParams
-      end
-
-      class Promptpay < Stripe::RequestParams
-      end
-
-      class Qris < Stripe::RequestParams
-      end
+      class Pix < Stripe::RequestParams; end
+      class Promptpay < Stripe::RequestParams; end
+      class Qris < Stripe::RequestParams; end
 
       class RadarOptions < Stripe::RequestParams
         # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
@@ -418,14 +370,9 @@ module Stripe
         end
       end
 
-      class RevolutPay < Stripe::RequestParams
-      end
-
-      class SamsungPay < Stripe::RequestParams
-      end
-
-      class Satispay < Stripe::RequestParams
-      end
+      class RevolutPay < Stripe::RequestParams; end
+      class SamsungPay < Stripe::RequestParams; end
+      class Satispay < Stripe::RequestParams; end
 
       class SepaDebit < Stripe::RequestParams
         # IBAN of the bank account.
@@ -436,8 +383,7 @@ module Stripe
         end
       end
 
-      class Shopeepay < Stripe::RequestParams
-      end
+      class Shopeepay < Stripe::RequestParams; end
 
       class Sofort < Stripe::RequestParams
         # Two-letter ISO code representing the country the bank account is located in.
@@ -460,11 +406,8 @@ module Stripe
         end
       end
 
-      class Swish < Stripe::RequestParams
-      end
-
-      class Twint < Stripe::RequestParams
-      end
+      class Swish < Stripe::RequestParams; end
+      class Twint < Stripe::RequestParams; end
 
       class UsBankAccount < Stripe::RequestParams
         # Account holder type: individual or company.
@@ -493,11 +436,8 @@ module Stripe
         end
       end
 
-      class WechatPay < Stripe::RequestParams
-      end
-
-      class Zip < Stripe::RequestParams
-      end
+      class WechatPay < Stripe::RequestParams; end
+      class Zip < Stripe::RequestParams; end
       # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
       attr_accessor :acss_debit
       # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
@@ -844,11 +784,8 @@ module Stripe
         end
       end
 
-      class Link < Stripe::RequestParams
-      end
-
-      class PayByBank < Stripe::RequestParams
-      end
+      class Link < Stripe::RequestParams; end
+      class PayByBank < Stripe::RequestParams; end
 
       class Payto < Stripe::RequestParams
         # The account number for the bank account.
@@ -944,16 +881,16 @@ module Stripe
 
     # Attaches a PaymentMethod object to a Customer.
     #
-    # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents)
-    # or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage).
+    # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents)
+    # or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage).
     # These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach
     # endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for
     # future use, which makes later declines and payment friction more likely.
-    # See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up
+    # See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up
     # future payments.
     #
     # To use this PaymentMethod as the default for invoice or subscription payments,
-    # set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method),
+    # set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method),
     # on the Customer to the PaymentMethod's ID.
     def attach(payment_method, params = {}, opts = {})
       request(
@@ -965,9 +902,9 @@ module Stripe
       )
     end
 
-    # Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
+    # Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
     #
-    # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
+    # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.
     def create(params = {}, opts = {})
       request(
         method: :post,
@@ -989,7 +926,7 @@ module Stripe
       )
     end
 
-    # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead.
+    # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead.
     def list(params = {}, opts = {})
       request(
         method: :get,
@@ -1000,7 +937,7 @@ module Stripe
       )
     end
 
-    # Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer)
+    # Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer)
     def retrieve(payment_method, params = {}, opts = {})
       request(
         method: :get,

data/lib/stripe/services/payout_service.rb

@@ -177,11 +177,11 @@ module Stripe
       )
     end
 
-    # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
+    # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
     #
     # If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.
     #
-    # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type.
+    # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type.
     def create(params = {}, opts = {})
       request(method: :post, path: "/v1/payouts", params: params, opts: opts, base_address: :api)
     end

data/lib/stripe/services/plan_service.rb

@@ -3,8 +3,7 @@
 
 module Stripe
   class PlanService < StripeService
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
@@ -252,7 +251,7 @@ module Stripe
       end
     end
 
-    # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
+    # You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
     def create(params = {}, opts = {})
       request(method: :post, path: "/v1/plans", params: params, opts: opts, base_address: :api)
     end

data/lib/stripe/services/price_service.rb

@@ -520,7 +520,7 @@ module Stripe
       request(method: :post, path: "/v1/prices", params: params, opts: opts, base_address: :api)
     end
 
-    # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
+    # Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
     def list(params = {}, opts = {})
       request(method: :get, path: "/v1/prices", params: params, opts: opts, base_address: :api)
     end
@@ -536,7 +536,7 @@ module Stripe
       )
     end
 
-    # Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
     # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
     # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
     # to an hour behind during outages. Search functionality is not available to merchants in India.

data/lib/stripe/services/privacy/redaction_job_service.rb

@@ -87,12 +87,9 @@ module Stripe
         end
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-        # The objects at the root level that are subject to redaction.
+        # The objects to redact. These root objects and their related ones will be validated for redaction.
         attr_accessor :objects
-        # Default is "error". If "error", we will make sure all objects in the graph are
-        # redactable in the 1st traversal, otherwise error. If "fix", where possible, we will
-        # auto-fix any validation errors (e.g. by auto-transitioning objects to a terminal
-        # state, etc.) in the 2nd traversal before redacting
+        # Determines the validation behavior of the job. Default is `error`.
         attr_accessor :validation_behavior
 
         def initialize(expand: nil, objects: nil, validation_behavior: nil)
@@ -114,7 +111,7 @@ module Stripe
       class UpdateParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-        # Attribute for param field validation_behavior
+        # Determines the validation behavior of the job. Default is `error`.
         attr_accessor :validation_behavior
 
         def initialize(expand: nil, validation_behavior: nil)
@@ -150,7 +147,9 @@ module Stripe
         end
       end
 
-      # Cancel redaction job method
+      # You can cancel a redaction job when it's in one of these statuses: ready, failed.
+      #
+      # Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
       def cancel(job, params = {}, opts = {})
         request(
           method: :post,
@@ -161,7 +160,7 @@ module Stripe
         )
       end
 
-      # Create redaction job method
+      # Creates a redaction job. When a job is created, it will start to validate.
       def create(params = {}, opts = {})
         request(
           method: :post,
@@ -172,7 +171,7 @@ module Stripe
         )
       end
 
-      # List redaction jobs method...
+      # Returns a list of redaction jobs.
       def list(params = {}, opts = {})
         request(
           method: :get,
@@ -183,7 +182,7 @@ module Stripe
         )
       end
 
-      # Retrieve redaction job method
+      # Retrieves the details of a previously created redaction job.
       def retrieve(job, params = {}, opts = {})
         request(
           method: :get,
@@ -194,7 +193,11 @@ module Stripe
         )
       end
 
-      # Run redaction job method
+      # Run a redaction job in a ready status.
+      #
+      # When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
+      #
+      # The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
       def run(job, params = {}, opts = {})
         request(
           method: :post,
@@ -205,7 +208,9 @@ module Stripe
         )
       end
 
-      # Update redaction job method
+      # Updates the properties of a redaction job without running or canceling the job.
+      #
+      # If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
       def update(job, params = {}, opts = {})
         request(
           method: :post,
@@ -216,7 +221,11 @@ module Stripe
         )
       end
 
-      # Validate redaction job method
+      # Validate a redaction job when it is in a failed status.
+      #
+      # When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
+      #
+      # The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
       def validate(job, params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb

@@ -22,7 +22,7 @@ module Stripe
         end
       end
 
-      # List validation errors method
+      # Returns a list of validation errors for the specified redaction job.
       def list(job, params = {}, opts = {})
         request(
           method: :get,

data/lib/stripe/services/product_feature_service.rb

@@ -3,8 +3,7 @@
 
 module Stripe
   class ProductFeatureService < StripeService
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.

data/lib/stripe/services/product_service.rb

@@ -10,8 +10,7 @@ module Stripe
       @features = Stripe::ProductFeatureService.new(@requestor)
     end
 
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
@@ -344,40 +343,6 @@ module Stripe
           @width = width
         end
       end
-
-      class Provisioning < Stripe::RequestParams
-        class GiftCard < Stripe::RequestParams
-          class FixedAmount < Stripe::RequestParams
-            # The initial amount with which the provisioned gift card will be created.
-            attr_accessor :amount
-            # Attribute for param field currency
-            attr_accessor :currency
-
-            def initialize(amount: nil, currency: nil)
-              @amount = amount
-              @currency = currency
-            end
-          end
-          # Attribute for param field fixed_amount
-          attr_accessor :fixed_amount
-          # The specific type of gift_card provisioning, only `fixed_amount` currently supported.
-          attr_accessor :type
-
-          def initialize(fixed_amount: nil, type: nil)
-            @fixed_amount = fixed_amount
-            @type = type
-          end
-        end
-        # Attribute for param field gift_card
-        attr_accessor :gift_card
-        # The type of provisioning, only `gift_card` currently supported.
-        attr_accessor :type
-
-        def initialize(gift_card: nil, type: nil)
-          @gift_card = gift_card
-          @type = type
-        end
-      end
       # Whether the product is currently available for purchase. Defaults to `true`.
       attr_accessor :active
       # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
@@ -398,8 +363,6 @@ module Stripe
       attr_accessor :name
       # The dimensions of this product for shipping purposes.
       attr_accessor :package_dimensions
-      # Provisioning configuration for this product.
-      attr_accessor :provisioning
       # Whether this product is shipped (i.e., physical goods).
       attr_accessor :shippable
       # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
@@ -427,7 +390,6 @@ module Stripe
         metadata: nil,
         name: nil,
         package_dimensions: nil,
-        provisioning: nil,
         shippable: nil,
         statement_descriptor: nil,
         tax_code: nil,
@@ -445,7 +407,6 @@ module Stripe
         @metadata = metadata
         @name = name
         @package_dimensions = package_dimensions
-        @provisioning = provisioning
         @shippable = shippable
         @statement_descriptor = statement_descriptor
         @tax_code = tax_code
@@ -505,7 +466,7 @@ module Stripe
       )
     end
 
-    # Search for products you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
     # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
     # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
     # to an hour behind during outages. Search functionality is not available to merchants in India.

data/lib/stripe/services/promotion_code_service.rb

@@ -211,7 +211,7 @@ module Stripe
       )
     end
 
-    # Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code.
+    # Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code.
     def retrieve(promotion_code, params = {}, opts = {})
       request(
         method: :get,

data/lib/stripe/services/quote_service.rb

@@ -834,7 +834,7 @@ module Stripe
         attr_accessor :billing_behavior
         # When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
         attr_accessor :billing_cycle_anchor
-        # Configure billing_mode to opt in improved credit proration behavior.Once a quote that creates a subscription or subscription schedule is accepted,all future operations on the subscription or subscription schedule will be processed based on this billing_mode.
+        # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
         attr_accessor :billing_mode
         # The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
         attr_accessor :description

data/lib/stripe/services/radar/early_fraud_warning_service.rb

@@ -78,7 +78,7 @@ module Stripe
 
       # Retrieves the details of an early fraud warning that has previously been created.
       #
-      # Please refer to the [early fraud warning](https://stripe.com/docs/api#early_fraud_warning_object) object reference for more details.
+      # Please refer to the [early fraud warning](https://docs.stripe.com/api#early_fraud_warning_object) object reference for more details.
       def retrieve(early_fraud_warning, params = {}, opts = {})
         request(
           method: :get,

data/lib/stripe/services/radar/value_list_item_service.rb

@@ -4,8 +4,7 @@
 module Stripe
   module Radar
     class ValueListItemService < StripeService
-      class DeleteParams < Stripe::RequestParams
-      end
+      class DeleteParams < Stripe::RequestParams; end
 
       class RetrieveParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.

data/lib/stripe/services/radar/value_list_service.rb

@@ -4,8 +4,7 @@
 module Stripe
   module Radar
     class ValueListService < StripeService
-      class DeleteParams < Stripe::RequestParams
-      end
+      class DeleteParams < Stripe::RequestParams; end
 
       class RetrieveParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.