stripe 8.6.0.pre.beta.3 → 8.6.0.pre.beta.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8329baf2324481281bac8a14057e933252bcc1fccbde79f4303fb1e84d113c9
-  data.tar.gz: bce0345d4c34fb1b25278e55a5ca31db6303d7b5b69037d05e55b3aa8f68537e
+  metadata.gz: 9bbe5f8429142f8ca731c92b88cdb7ce4c13ac0dc47f736b479c4e12ea73ce53
+  data.tar.gz: 3fecbead2127d4a54204e04107edf6b9131cce54c94bbc7c550318127354cc03
 SHA512:
-  metadata.gz: 7055e66eae45c2a9e3cf0d3dd6f65c1da2e7ef6a0189feb9a7cbf04de25b857a37e7888c7cfe8f391004192c9cbce4f3f30ee25236fa2f94bd4b7d4263ae696a
-  data.tar.gz: 47077ba02bc7c0c73071d92500333e84bce73cae25ea88ec0ff5c47b378bc5b2e0473cb5bc8cdc9d65d9151b6f74f5361df674685af2ce194d452ae0fe6d5df7
+  metadata.gz: f386d2f8fbce74b1ea1e898ae28a983689af6ddd87a9ac98b4f60b98866780192d35a89abf80cfbb01630b0dd6ba378486c59b97ab6cb3b9065c347702917260
+  data.tar.gz: 0cf9d291677ec2fd7186c47c408de3436cca0c3dcd9396d4b388cbdb5cc0b4f9ec6fb992fd99b35cf159f70a5f79de94f1a01cc1f065bca79de9212edf7abf3a

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 8.6.0-beta.5 - 2023-06-01
+* [#1227](https://github.com/stripe/stripe-ruby/pull/1227) Update generated code for beta
+* [#1228](https://github.com/stripe/stripe-ruby/pull/1228) Document raw_request
+* [#1222](https://github.com/stripe/stripe-ruby/pull/1222) Update generated code for beta
+* [#1224](https://github.com/stripe/stripe-ruby/pull/1224) Handle developer message in preview error responses
+
+## 8.6.0-beta.4 - 2023-05-19
+* [#1220](https://github.com/stripe/stripe-ruby/pull/1220) Update generated code for beta
+  * Add support for `subscribe` and `unsubscribe` methods on resource `FinancialConnections.Account`
+* [#1217](https://github.com/stripe/stripe-ruby/pull/1217) Add raw_request
+* [#1216](https://github.com/stripe/stripe-ruby/pull/1216) Update generated code for beta
+* [#1214](https://github.com/stripe/stripe-ruby/pull/1214) Update generated code for beta
+
+
 ## 8.6.0-beta.3 - 2023-04-17
 * [#1211](https://github.com/stripe/stripe-ruby/pull/1211) Update generated code for beta
 * [#1210](https://github.com/stripe/stripe-ruby/pull/1210), [#1212](https://github.com/stripe/stripe-ruby/pull/1212), [#1213](https://github.com/stripe/stripe-ruby/pull/1213) Add support for request signing

data/Gemfile

@@ -25,6 +25,9 @@ group :development do
   # up-to-date, but it's not the end of the world if it's not.
   gem "rubocop", "0.80"
 
+  # jaro_winkler 1.5.5 installation fails for jruby
+  gem "jaro_winkler", "1.5.4"
+
   platforms :mri do
     gem "byebug"
     gem "pry"

data/OPENAPI_VERSION

@@ -1 +1 @@
-v299
+v361

data/README.md

@@ -323,6 +323,17 @@ If your beta feature requires a `Stripe-Version` header to be sent, use the `Str
 Stripe.api_version += "; feature_beta=v3"
 ```
 
+### Custom requests
+
+If you would like to send a request to an undocumented API (for example you are in a private beta), or if you prefer to bypass the method definitions in the library and specify your request details directly, you can use the `raw_request` method on `Stripe`.
+
+```ruby
+resp = Stripe.raw_request(:post, "/v1/beta_endpoint", {param: 123}, {stripe_version: "2022-11-15; feature_beta=v3"})
+
+# (Optional) resp is a StripeResponse. You can use `Stripe.deserialize` to get a StripeObject.
+deserialized_resp = Stripe.deserialize(resp.http_body)
+```
+
 ## Support
 
 New features and bug fixes are released on the latest major version of the Stripe Ruby library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.

data/VERSION

@@ -1 +1 @@
-8.6.0-beta.3
+8.6.0-beta.5

data/lib/stripe/api_operations/request.rb

@@ -47,6 +47,7 @@ module Stripe
           api_key = headers.delete(:api_key)
           api_base = headers.delete(:api_base)
           client = headers.delete(:client)
+          api_mode = headers.delete(:api_mode)
           # Assume all remaining opts must be headers
 
           resp, opts[:api_key] = client.send(
@@ -54,6 +55,7 @@ module Stripe
             method, url,
             api_base: api_base, api_key: api_key,
             headers: headers, params: params,
+            api_mode: api_mode,
             &read_body_chunk_block
           )
 

data/lib/stripe/api_version.rb

@@ -4,5 +4,6 @@
 module Stripe
   module ApiVersion
     CURRENT = "2022-11-15"
+    PREVIEW = "2023-05-26.preview-v2"
   end
 end

data/lib/stripe/resources/account_link.rb

@@ -5,7 +5,7 @@ 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).
+  # Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding)
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/account_session.rb

@@ -8,7 +8,7 @@ module Stripe
   # to your user. Do not save AccountSessions to your database as they expire relatively
   # quickly, and cannot be used more than once.
   #
-  # Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components).
+  # Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
   class AccountSession < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/application_fee_refund.rb

@@ -6,7 +6,7 @@ module Stripe
   # 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).
+  # 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

@@ -11,7 +11,7 @@ module Stripe
     #
     # 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).
+    # 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

data/lib/stripe/resources/balance.rb

@@ -12,7 +12,7 @@ module Stripe
   # 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).
+  # 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

@@ -5,7 +5,7 @@ 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).
+  # 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

@@ -8,7 +8,7 @@ module Stripe
   # 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).
+  # 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/capability.rb

@@ -4,7 +4,7 @@
 module Stripe
   # This is an object representing a capability for a Stripe account.
   #
-  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities).
+  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
   class Capability < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/card.rb

@@ -6,7 +6,7 @@ module Stripe
   # later. You can also store multiple debit cards on a recipient in order to
   # transfer to those cards later.
   #
-  # Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards).
+  # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
   class Card < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/charge.rb

@@ -2,11 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
-  # To charge a credit or a debit card, you create a `Charge` object. You can
-  # retrieve and refund individual charges as well as list all charges. Charges
-  # are identified by a unique, random ID.
-  #
-  # Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).
+  # The `Charge` object represents a single attempt to move money into your Stripe account.
+  # PaymentIntent confirmation is the most common way to create Charges, but transferring
+  # money to a different Stripe account through Connect also creates Charges.
+  # Some legacy payment flows create Charges directly, which is not recommended for new integrations.
   class Charge < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

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

@@ -16,7 +16,7 @@ module Stripe
     # You can create a Checkout Session on your server and redirect to its URL
     # to begin Checkout.
     #
-    # Related guide: [Checkout Quickstart](https://stripe.com/docs/checkout/quickstart).
+    # Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
     class Session < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/credit_note.rb

@@ -4,7 +4,7 @@
 module Stripe
   # Issue a credit note to adjust an invoice's amount after the invoice is finalized.
   #
-  # Related guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes).
+  # Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)
   class CreditNote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/customer.rb

@@ -4,7 +4,7 @@
 module Stripe
   # This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.
   #
-  # Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).
+  # Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)
   class Customer < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
-  # Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value,
+  # Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,
   # which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
   # You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),
   # or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.
   #
-  # Related guide: [Customer Balance](https://stripe.com/docs/billing/customer/balance) to learn more.
+  # Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)
   class CustomerBalanceTransaction < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/discount.rb

@@ -5,7 +5,7 @@ module Stripe
   # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
   # It contains information about when the discount began, when it will end, and what it is applied to.
   #
-  # Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
+  # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
   class Discount < StripeObject
     OBJECT_NAME = "discount"
   end

data/lib/stripe/resources/dispute.rb

@@ -8,7 +8,7 @@ module Stripe
   # information about the dispute process in our [Disputes and
   # Fraud](https://stripe.com/docs/disputes) documentation.
   #
-  # Related guide: [Disputes and Fraud](https://stripe.com/docs/disputes).
+  # Related guide: [Disputes and fraud](https://stripe.com/docs/disputes)
   class Dispute < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/file.rb

@@ -8,7 +8,7 @@ module Stripe
   # been created by Stripe (for example, the results of a [Sigma scheduled
   # query](https://stripe.com/docs/api#scheduled_queries)).
   #
-  # Related guide: [File Upload Guide](https://stripe.com/docs/file-upload).
+  # Related guide: [File upload guide](https://stripe.com/docs/file-upload)
   class File < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/financial_connections/account.rb

@@ -39,6 +39,24 @@ module Stripe
         )
       end
 
+      def subscribe(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def unsubscribe(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       def self.disconnect(account, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -65,6 +83,24 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.subscribe(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.unsubscribe(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/funding_instructions.rb

@@ -6,7 +6,7 @@ module Stripe
   # automatically applied to future invoices and payments using the `customer_balance` payment method.
   # Customers can fund this balance by initiating a bank transfer to any account in the
   # `financial_addresses` field.
-  # Related guide: [Customer Balance - Funding Instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) to learn more
+  # Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)
   class FundingInstructions < APIResource
     OBJECT_NAME = "funding_instructions"
 

data/lib/stripe/resources/invoice.rb

@@ -33,7 +33,7 @@ module Stripe
   # More details on the customer's credit balance are
   # [here](https://stripe.com/docs/billing/customer/balance).
   #
-  # Related guide: [Send Invoices to Customers](https://stripe.com/docs/billing/invoices/sending).
+  # Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)
   class Invoice < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/issuing/authorization.rb

@@ -7,7 +7,7 @@ module Stripe
     # object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
     # purchase to be completed successfully.
     #
-    # Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations).
+    # Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)
     class Authorization < APIResource
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save

data/lib/stripe/resources/issuing/cardholder.rb

@@ -5,7 +5,7 @@ module Stripe
   module Issuing
     # An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.
     #
-    # Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)
+    # Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)
     class Cardholder < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/issuing/dispute.rb

@@ -5,7 +5,7 @@ module Stripe
   module Issuing
     # As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
     #
-    # Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes)
+    # Related guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)
     class Dispute < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

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

@@ -7,7 +7,7 @@ module Stripe
     # your Stripe account, such as a completed purchase or refund, is represented by an Issuing
     # `Transaction` object.
     #
-    # Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions).
+    # Related guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)
     class Transaction < APIResource
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save

data/lib/stripe/resources/payment_intent.rb

@@ -12,7 +12,7 @@ module Stripe
   # throughout its lifetime as it interfaces with Stripe.js to perform
   # authentication flows and ultimately creates at most one successful charge.
   #
-  # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).
+  # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)
   class PaymentIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/payout.rb

@@ -9,7 +9,7 @@ module Stripe
   # schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
   # industry.
   #
-  # Related guide: [Receiving Payouts](https://stripe.com/docs/payouts).
+  # Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
   class Payout < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/person.rb

@@ -7,7 +7,7 @@ module Stripe
   # A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.
   # See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.
   #
-  # Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).
+  # Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information)
   class Person < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/radar/early_fraud_warning.rb

@@ -6,7 +6,7 @@ module Stripe
     # An early fraud warning indicates that the card issuer has notified us that a
     # charge may be fraudulent.
     #
-    # Related guide: [Early Fraud Warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings).
+    # Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)
     class EarlyFraudWarning < APIResource
       extend Stripe::APIOperations::List
 

data/lib/stripe/resources/radar/value_list.rb

@@ -5,7 +5,7 @@ module Stripe
   module Radar
     # Value lists allow you to group values together which can then be referenced in rules.
     #
-    # Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items).
+    # Related guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)
     class ValueList < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

data/lib/stripe/resources/radar/value_list_item.rb

@@ -5,7 +5,7 @@ module Stripe
   module Radar
     # Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
     #
-    # Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items).
+    # Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)
     class ValueListItem < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

data/lib/stripe/resources/refund.rb

@@ -6,7 +6,7 @@ module Stripe
   # but not yet refunded. Funds will be refunded to the credit or debit card that
   # was originally charged.
   #
-  # Related guide: [Refunds](https://stripe.com/docs/refunds).
+  # Related guide: [Refunds](https://stripe.com/docs/refunds)
   class Refund < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/reversal.rb

@@ -14,7 +14,7 @@ module Stripe
   # transfer only if the destination account has enough balance to cover the
   # reversal.
   #
-  # Related guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers).
+  # Related guide: [Reversing transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers)
   class Reversal < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/setup_intent.rb

@@ -23,7 +23,7 @@ module Stripe
   # By using SetupIntents, you ensure that your customers experience the minimum set of required friction,
   # even as regulations change over time.
   #
-  # Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).
+  # Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)
   class SetupIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/subscription.rb

@@ -4,7 +4,7 @@
 module Stripe
   # Subscriptions allow you to charge a customer on a recurring basis.
   #
-  # Related guide: [Creating Subscriptions](https://stripe.com/docs/billing/subscriptions/creating).
+  # Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)
   class Subscription < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/subscription_schedule.rb

@@ -4,7 +4,7 @@
 module Stripe
   # A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
   #
-  # Related guide: [Subscription Schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
+  # Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)
   class SubscriptionSchedule < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/tax/calculation.rb

@@ -5,7 +5,7 @@ module Stripe
   module Tax
     # A Tax Calculation allows you to calculate the tax to collect from your customer.
     #
-    # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom).
+    # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)
     class Calculation < APIResource
       extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/tax/registration.rb

@@ -5,7 +5,9 @@ module Stripe
   module Tax
     # A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).
     #
-    # Stripe will not register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).
+    # Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).
+    #
+    # Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)
     class Registration < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/tax/settings.rb

@@ -5,7 +5,7 @@ module Stripe
   module Tax
     # You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.
     #
-    # Related guide: [Account settings](https://stripe.com/docs/tax/connect/settings).
+    # Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)
     class Settings < SingletonAPIResource
       include Stripe::APIOperations::Save
 

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

@@ -5,7 +5,7 @@ module Stripe
   module Tax
     # A Tax Transaction records the tax collected from or refunded to your customer.
     #
-    # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction).
+    # Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)
     class Transaction < APIResource
       OBJECT_NAME = "tax.transaction"
 

data/lib/stripe/resources/tax_id.rb

@@ -5,7 +5,7 @@ module Stripe
   # You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers).
   # A customer's tax IDs are displayed on invoices and credit notes issued for the customer.
   #
-  # Related guide: [Customer Tax Identification Numbers](https://stripe.com/docs/billing/taxes/tax-ids).
+  # Related guide: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids)
   class TaxId < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/tax_rate.rb

@@ -4,7 +4,7 @@
 module Stripe
   # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
   #
-  # Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
+  # Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
   class TaxRate < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/terminal/connection_token.rb

@@ -5,7 +5,7 @@ module Stripe
   module Terminal
     # A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
     #
-    # Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations).
+    # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
     class ConnectionToken < APIResource
       extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/terminal/location.rb

@@ -5,7 +5,7 @@ module Stripe
   module Terminal
     # A Location represents a grouping of readers.
     #
-    # Related guide: [Fleet Management](https://stripe.com/docs/terminal/fleet/locations).
+    # Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)
     class Location < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

data/lib/stripe/resources/terminal/reader.rb

@@ -5,7 +5,7 @@ module Stripe
   module Terminal
     # A Reader represents a physical device for accepting payment details.
     #
-    # Related guide: [Connecting to a Reader](https://stripe.com/docs/terminal/payments/connect-reader).
+    # Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)
     class Reader < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

data/lib/stripe/resources/token.rb

@@ -22,8 +22,6 @@ module Stripe
   # objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that
   # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
   # performs best with integrations that use client-side tokenization.
-  #
-  # Related guide: [Accept a payment](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token)
   class Token < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/topup.rb

@@ -6,7 +6,7 @@ module Stripe
   # individual top-ups, as well as list all top-ups. Top-ups are identified by a
   # unique, random ID.
   #
-  # Related guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups).
+  # Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)
   class Topup < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/transfer.rb

@@ -11,7 +11,7 @@ module Stripe
   # information, read about the
   # [transfer/payout split](https://stripe.com/docs/transfer-payout-split).
   #
-  # Related guide: [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/charges-transfers).
+  # Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/charges-transfers)
   class Transfer < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/usage_record.rb

@@ -5,7 +5,7 @@ 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).
+  # 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

@@ -8,7 +8,7 @@ module Stripe
   #
   # 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).
+  # 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/stripe_client.rb

@@ -212,9 +212,10 @@ module Stripe
     end
 
     def execute_request(method, path,
-                        api_base: nil, api_key: nil, headers: {}, params: {})
+                        api_base: nil, api_key: nil,
+                        headers: {}, params: {}, api_mode: nil)
       http_resp, api_key = execute_request_internal(
-        method, path, api_base, api_key, headers, params
+        method, path, api_base, api_key, headers, params, api_mode
       )
 
       begin
@@ -245,6 +246,7 @@ module Stripe
     def execute_request_stream(method, path,
                                api_base: nil, api_key: nil,
                                headers: {}, params: {},
+                               api_mode: nil,
                                &read_body_chunk_block)
       unless block_given?
         raise ArgumentError,
@@ -252,7 +254,8 @@ module Stripe
       end
 
       http_resp, api_key = execute_request_internal(
-        method, path, api_base, api_key, headers, params, &read_body_chunk_block
+        method, path, api_base, api_key,
+        headers, params, api_mode, &read_body_chunk_block
       )
 
       # When the read_body_chunk_block is given, we no longer have access to the
@@ -432,7 +435,7 @@ module Stripe
 
     private def execute_request_internal(method, path,
                                          api_base, api_key, headers, params,
-                                         &read_body_chunk_block)
+                                         api_mode, &read_body_chunk_block)
       raise ArgumentError, "method should be a symbol" \
       unless method.is_a?(Symbol)
       raise ArgumentError, "path should be a string" \
@@ -456,8 +459,9 @@ module Stripe
 
       query_params, path = merge_query_params(query_params, path)
 
-      headers = request_headers(api_key, method)
+      headers = request_headers(api_key, method, api_mode)
                 .update(Util.normalize_headers(headers))
+
       url = api_url(path, api_base)
 
       # Merge given query parameters with any already encoded in the path.
@@ -468,7 +472,7 @@ module Stripe
       # a log-friendly variant of the encoded form. File objects are displayed
       # as such instead of as their file contents.
       body, body_log =
-        body_params ? encode_body(body_params, headers) : [nil, nil]
+        body_params ? encode_body(body_params, headers, api_mode) : [nil, nil]
 
       authenticator.authenticate(method, headers, body) unless api_key
 
@@ -544,7 +548,7 @@ module Stripe
     # Encodes a set of body parameters using multipart if `Content-Type` is set
     # for that, or standard form-encoding otherwise. Returns the encoded body
     # and a version of the encoded body that's safe to be logged.
-    private def encode_body(body_params, headers)
+    private def encode_body(body_params, headers, api_mode)
       body = nil
       flattened_params = Util.flatten_params(body_params)
 
@@ -560,15 +564,22 @@ module Stripe
         flattened_params =
           flattened_params.map { |k, v| [k, v.is_a?(String) ? v : v.to_s] }.to_h
 
+      elsif api_mode == :preview
+        body = JSON.generate(body_params)
+        headers["Content-Type"] = "application/json"
       else
         body = Util.encode_parameters(body_params)
       end
 
-      # We don't use `Util.encode_parameters` partly as an optimization (to not
-      # redo work we've already done), and partly because the encoded forms of
-      # certain characters introduce a lot of visual noise and it's nice to
-      # have a clearer format for logs.
-      body_log = flattened_params.map { |k, v| "#{k}=#{v}" }.join("&")
+      if api_mode == :preview
+        body_log = body
+      else
+        # We don't use `Util.encode_parameters` partly as an optimization (to
+        # not redo work we've already done), and partly because the encoded
+        # forms of certain characters introduce a lot of visual noise and it's
+        # nice to have a clearer format for logs.
+        body_log = flattened_params.map { |k, v| "#{k}=#{v}" }.join("&")
+      end
 
       [body, body_log]
     end
@@ -757,10 +768,11 @@ module Stripe
     end
 
     private def specific_api_error(resp, error_data, context)
+      message = error_data[:message] || error_data[:developer_message]
       Util.log_error("Stripe API error",
                      status: resp.http_status,
                      error_code: error_data[:code],
-                     error_message: error_data[:message],
+                     error_message: message,
                      error_param: error_data[:param],
                      error_type: error_data[:type],
                      idempotency_key: context.idempotency_key,
@@ -781,26 +793,26 @@ module Stripe
       when 400, 404
         case error_data[:type]
         when "idempotency_error"
-          IdempotencyError.new(error_data[:message], **opts)
+          IdempotencyError.new(message, **opts)
         else
           InvalidRequestError.new(
-            error_data[:message], error_data[:param],
+            message, error_data[:param],
             **opts
           )
         end
       when 401
-        AuthenticationError.new(error_data[:message], **opts)
+        AuthenticationError.new(message, **opts)
       when 402
         CardError.new(
-          error_data[:message], error_data[:param],
+          message, error_data[:param],
           **opts
         )
       when 403
-        PermissionError.new(error_data[:message], **opts)
+        PermissionError.new(message, **opts)
       when 429
-        RateLimitError.new(error_data[:message], **opts)
+        RateLimitError.new(message, **opts)
       else
-        APIError.new(error_data[:message], **opts)
+        APIError.new(message, **opts)
       end
     end
 
@@ -868,7 +880,7 @@ module Stripe
             message + "\n\n(Network error: #{error.message})"
     end
 
-    private def request_headers(api_key, method)
+    private def request_headers(api_key, method, api_mode)
       user_agent = "Stripe/v1 RubyBindings/#{Stripe::VERSION}"
       unless Stripe.app_info.nil?
         user_agent += " " + format_app_info(Stripe.app_info)
@@ -877,9 +889,13 @@ module Stripe
       headers = {
         "User-Agent" => user_agent,
         "Authorization" => "Bearer #{api_key}",
-        "Content-Type" => "application/x-www-form-urlencoded",
       }
 
+      if api_mode != :preview
+        # TODO: (major) don't set Content-Type if method is not post
+        headers["Content-Type"] = "application/x-www-form-urlencoded"
+      end
+
       if config.enable_telemetry? && !@last_request_metrics.nil?
         headers["X-Stripe-Client-Telemetry"] = JSON.generate(
           last_request_metrics: @last_request_metrics.payload
@@ -892,7 +908,12 @@ module Stripe
         headers["Idempotency-Key"] ||= SecureRandom.uuid
       end
 
-      headers["Stripe-Version"] = config.api_version if config.api_version
+      if api_mode == :preview
+        headers["Stripe-Version"] = ApiVersion::PREVIEW
+      elsif config.api_version
+        headers["Stripe-Version"] = config.api_version
+      end
+
       headers["Stripe-Account"] = config.stripe_account if config.stripe_account
 
       user_agent = @system_profiler.user_agent

data/lib/stripe/version.rb

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

data/lib/stripe.rb

@@ -119,6 +119,49 @@ module Stripe
       version: version,
     }
   end
+
+  class Preview
+    def self._get_default_opts(opts)
+      { api_mode: :preview }.merge(opts)
+    end
+
+    def self.get(url, opts = {})
+      Stripe.raw_request(:get, url, {}, _get_default_opts(opts))
+    end
+
+    def self.post(url, params = {}, opts = {})
+      Stripe.raw_request(:post, url, params, _get_default_opts(opts))
+    end
+
+    def self.delete(url, opts = {})
+      Stripe.raw_request(:delete, url, {}, _get_default_opts(opts))
+    end
+  end
+
+  class RawRequest
+    include Stripe::APIOperations::Request
+
+    def initialize
+      @opts = {}
+    end
+
+    def execute(method, url, params = {}, opts = {})
+      resp, = execute_resource_request(method, url, params, opts)
+
+      resp
+    end
+  end
+
+  # Sends a request to Stripe REST API
+  def self.raw_request(method, url, params = {}, opts = {})
+    req = RawRequest.new
+    req.execute(method, url, params, opts)
+  end
+
+  def self.deserialize(data)
+    data = JSON.parse(data) if data.is_a?(String)
+    Util.convert_to_stripe_object(data, {})
+  end
 end
 
 Stripe.log_level = ENV["STRIPE_LOG"] unless ENV["STRIPE_LOG"].nil?

metadata

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