stripe 13.5.0 → 14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 928062945af6605fafe312cf05d06a64fe7fb636f41f02ff6f816af0449dbe1a
-  data.tar.gz: 7fccabdb8857bbdb1728f594c277fc4afdc5be8d44edc5eeac944ccac4cb53d3
+  metadata.gz: b5525691fb4bdeceebc4d8a3ff05952e3b0f2f90f77ffedf9f3b982a6e15cc49
+  data.tar.gz: 8d2250d5b1941abbf886cbd160ee80bf16fbe1d66412665a9e6121e9b88d4928
 SHA512:
-  metadata.gz: 80c16055d8f85a1ffe0ed6f41e6082205d672886aa23b7a9f184ca9609ea4cd09855528bcc4341ad7360306bc82c18d2d364e91e7e4081d4cf848b553a0aed07
-  data.tar.gz: abb2d60a2c14b95b1815dfd986310f7d75d663c9c339ad32a9b30e5273cba832a364911b2b248f82f9a851a01cef2622ddaea658926ddf3f1241d93d2dc68b1c
+  metadata.gz: 3e347248e1f10850cc635b84053a05098ba18366b9614a2d8390905552da62fcdb0eaa17d917b2dc3718f54448c1e34f418258b8d1bc71adc8e0d22c39e91601
+  data.tar.gz: 3f83f0d0ab7b51b0fb908611293879549c324aeac451661df9182c9771dcd3e2322a083e733fcb0741a2e80576220fa50a7cde87855fd9f7405d9063c24ddef7

data/CHANGELOG.md

@@ -1,7 +1,37 @@
 # Changelog
+## 14.0.0 - 2025-04-01
+* [#1559](https://github.com/stripe/stripe-ruby/pull/1559) Add RBI annotations for fields and params
+  * Adds explicit field types for resources and parameters for methods, and add RBI static annotations for all resources and services
+  ![image](https://github.com/user-attachments/assets/1b6cd994-d3ea-4f47-8487-f5c7b9ebf885)
+  * See [the wiki](https://github.com/stripe/stripe-ruby/wiki/Static-Type-Annotations) for more details
+  
+* [#1543](https://github.com/stripe/stripe-ruby/pull/1543) Support for APIs in the new API version 2025-03-31.basil
+
+  This release changes the pinned API version to `2025-03-31.basil`.
+  
+  ### ⚠️ Breaking changes  due to changes in the Stripe API
+
+  Please review details for the breaking changes and alternatives in the [Stripe API changelog](https://docs.stripe.com/changelog/basil) before upgrading.
+  
+  * Remove support for resources `SubscriptionItemUsageRecordSummary` and `SubscriptionItemUsageRecord`
+  * Remove support for `create` method on resource `SubscriptionItemUsageRecord`
+  * Remove support for `list` method on resource `SubscriptionItemUsageRecordSummary`
+  * Remove support for `upcomingLines` and `upcoming` methods on resource `Invoice`
+
+  ### ⚠️ Other breaking changes in the SDK
+  * [#1553](https://github.com/stripe/stripe-ruby/pull/1553) Remove public idempotent_replayed? method
+    * ⚠️ Remove the `idempotent_replayed?` method on `StripeError`
+      * The information is accessible indirectly via the raw response headers, `StripeResponse.http_headers`. For example, use `resource.last_response.http_headers['Idempotent-Replayed']`
+  
+  ### Additions to the Stripe API
+  
+  * Add support for new resource `InvoicePayment`
+  * Add support for `list` and `retrieve` methods on resource `InvoicePayment`
+  
+
 ## 13.5.0 - 2025-02-24
 * [#1534](https://github.com/stripe/stripe-ruby/pull/1534) Update generated code
-  * Fixed `Stripe::InvoiceLineItem.update` method. 
+  * Fixed `Stripe::InvoiceLineItem.update` method. 
 * [#1536](https://github.com/stripe/stripe-ruby/pull/1536) Fix InvoiceLineItem parent class
   * Fix bug where `Stripe::InvoiceLineItem` had the incorrect parent class, making it error when `update` was called
 * [#1533](https://github.com/stripe/stripe-ruby/pull/1533) add codeowners file
@@ -22,7 +52,7 @@
 * [#1512](https://github.com/stripe/stripe-ruby/pull/1512) Import global configuration for options not available on StripeClient options
   * Fixes bug where `StripeClient` was not falling back to global options for options that are not available to be set per-client
 * [#1516](https://github.com/stripe/stripe-ruby/pull/1516) ThinEvent reason and livemode
-  - Add `livemode` and optional `reason` fields to ThinEvent
+  - Add `livemode` and optional `reason` fields to ThinEvent
 * [#1518](https://github.com/stripe/stripe-ruby/pull/1518) Pin ubuntu version in Test action
 * [#1508](https://github.com/stripe/stripe-ruby/pull/1508) Added pull request template
 
@@ -30,7 +60,7 @@
 * [#1500](https://github.com/stripe/stripe-ruby/pull/1500) This release changes the pinned API version to `2024-12-18.acacia`.
 
 * [#1507](https://github.com/stripe/stripe-ruby/pull/1507) Pass requestor to all deserialized objects including lists
-  
+  
   * Fixes bug where `StripeObject` retrieved from lists could not be used to make requests, such as `refresh`
 
 ## 13.2.0 - 2024-11-20

data/Gemfile

@@ -34,4 +34,8 @@ group :development do
     gem "pry"
     gem "pry-byebug"
   end
+
+  platforms :jruby do
+    gem "rbi", "0.2.4" # jruby does not support rbs, a new dependency in 0.3.0
+  end
 end

data/OPENAPI_VERSION

@@ -1 +1 @@
-v1505
+v1642

data/README.md

@@ -317,6 +317,35 @@ You can disable this behavior if you prefer:
 Stripe.enable_telemetry = false
 ```
 
+### Types
+
+In [v14.0.0](https://github.com/stripe/stripe-python/releases/tag/v7.1.0) and newer, the library provides RBI
+static type annotations. See [the wiki](https://github.com/stripe/stripe-ruby/wiki/Static-Type-Annotations)
+for an detailed guide.
+
+Please note that these types are available only for static analysis and we only support RBIs at the moment.
+Please [report an issue](https://github.com/stripe/stripe-ruby/issues/new/choose)
+if you find discrepancies or have issues using types.
+
+The RBIs can be found in the `rbi/stripe/` directory, and to decrease `Tapioca` loading time we pack the gem with the
+combined RBI at `rbi/stripe.rbi`.
+
+#### Types and the Versioning Policy
+
+We release type changes in minor releases. While stripe-ruby follows semantic versioning, our semantic
+versions describe the runtime behavior of the library alone. Our type annotations are not reflected in the
+semantic version. That is, upgrading to a new minor version of `stripe-ruby` might result in your type checker
+producing a type error that it didn't before. You can use `~> x.x` or `x.x.x` constrain the version
+of `stripe-ruby` in your Gemfile to a certain version or range of `stripe-ruby`.
+
+#### Types and API Versions
+
+The types describe the [Stripe API version](https://stripe.com/docs/api/versioning)
+that was the latest at the time of release. This is the version that your library sends
+by default. If you are overriding `Stripe.api_version` / `stripe_version` on the StripeClient,
+or using a webhook endpoint tied to an older version, be aware that the data
+you see at runtime may not match the types.
+
 ### Beta SDKs
 
 Stripe has features in the beta phase that can be accessed via the beta version of this package.

data/VERSION

@@ -1 +1 @@
-13.5.0
+14.0.0

data/lib/stripe/api_operations/request.rb

@@ -34,6 +34,7 @@ module Stripe
                                                       method, url, base_address,
                                                       params, opts, usage,
                                                       &read_body_chunk_block)
+          params = params.to_h if params.is_a?(Stripe::RequestParams)
           params ||= {}
 
           error_on_invalid_params(params)

data/lib/stripe/api_requestor.rb

@@ -196,6 +196,7 @@ module Stripe
 
     def execute_request(method, path, base_address,
                         params: {}, opts: {}, usage: [])
+      params = params.to_h if params.is_a?(RequestParams)
       http_resp, req_opts = execute_request_internal(
         method, path, base_address, params, opts, usage
       )
@@ -221,6 +222,7 @@ module Stripe
                                         params: {}, opts: {}, usage: [])
       opts = RequestOptions.combine_opts(object.instance_variable_get(:@opts), opts)
       opts = Util.normalize_opts(opts)
+      params = params.to_h if params.is_a?(RequestParams)
       http_resp, req_opts = execute_request_internal(
         method, path, base_address, params, opts, usage
       )
@@ -270,6 +272,7 @@ module Stripe
               "execute_request_stream requires a read_body_chunk_block"
       end
 
+      params = params.to_h if params.is_a?(RequestParams)
       http_resp, api_key = execute_request_internal(
         method, path, base_address, params, opts, usage, &read_body_chunk_block
       )

data/lib/stripe/api_version.rb

@@ -3,6 +3,6 @@
 
 module Stripe
   module ApiVersion
-    CURRENT = "2025-02-24.acacia"
+    CURRENT = "2025-03-31.basil"
   end
 end

data/lib/stripe/errors.rb

@@ -31,13 +31,6 @@ module Stripe
       ErrorObject.construct_from(@json_body[:error], {}, nil, :v1)
     end
 
-    # Whether the error was the result of an idempotent replay, meaning that it
-    # originally occurred on a previous request and is being replayed back
-    # because the user sent the same idempotency key for this one.
-    def idempotent_replayed?
-      @idempotent_replayed
-    end
-
     def to_s
       status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
       id_string = @request_id.nil? ? "" : "(Request #{@request_id}) "

data/lib/stripe/object_types.rb

@@ -16,6 +16,7 @@ module Stripe
         AccountLink.object_name => AccountLink,
         AccountSession.object_name => AccountSession,
         ApplePayDomain.object_name => ApplePayDomain,
+        Application.object_name => Application,
         ApplicationFee.object_name => ApplicationFee,
         ApplicationFeeRefund.object_name => ApplicationFeeRefund,
         Apps::Secret.object_name => Apps::Secret,
@@ -23,6 +24,7 @@ module Stripe
         BalanceTransaction.object_name => BalanceTransaction,
         BankAccount.object_name => BankAccount,
         Billing::Alert.object_name => Billing::Alert,
+        Billing::AlertTriggered.object_name => Billing::AlertTriggered,
         Billing::CreditBalanceSummary.object_name => Billing::CreditBalanceSummary,
         Billing::CreditBalanceTransaction.object_name => Billing::CreditBalanceTransaction,
         Billing::CreditGrant.object_name => Billing::CreditGrant,
@@ -41,6 +43,7 @@ module Stripe
         Climate::Product.object_name => Climate::Product,
         Climate::Supplier.object_name => Climate::Supplier,
         ConfirmationToken.object_name => ConfirmationToken,
+        ConnectCollectionTransfer.object_name => ConnectCollectionTransfer,
         CountrySpec.object_name => CountrySpec,
         Coupon.object_name => Coupon,
         CreditNote.object_name => CreditNote,
@@ -52,6 +55,7 @@ module Stripe
         Discount.object_name => Discount,
         Dispute.object_name => Dispute,
         Entitlements::ActiveEntitlement.object_name => Entitlements::ActiveEntitlement,
+        Entitlements::ActiveEntitlementSummary.object_name => Entitlements::ActiveEntitlementSummary,
         Entitlements::Feature.object_name => Entitlements::Feature,
         EphemeralKey.object_name => EphemeralKey,
         Event.object_name => Event,
@@ -70,6 +74,7 @@ module Stripe
         Invoice.object_name => Invoice,
         InvoiceItem.object_name => InvoiceItem,
         InvoiceLineItem.object_name => InvoiceLineItem,
+        InvoicePayment.object_name => InvoicePayment,
         InvoiceRenderingTemplate.object_name => InvoiceRenderingTemplate,
         Issuing::Authorization.object_name => Issuing::Authorization,
         Issuing::Card.object_name => Issuing::Card,
@@ -101,6 +106,7 @@ module Stripe
         Refund.object_name => Refund,
         Reporting::ReportRun.object_name => Reporting::ReportRun,
         Reporting::ReportType.object_name => Reporting::ReportType,
+        ReserveTransaction.object_name => ReserveTransaction,
         Reversal.object_name => Reversal,
         Review.object_name => Review,
         SetupAttempt.object_name => SetupAttempt,
@@ -108,6 +114,7 @@ module Stripe
         ShippingRate.object_name => ShippingRate,
         Sigma::ScheduledQueryRun.object_name => Sigma::ScheduledQueryRun,
         Source.object_name => Source,
+        SourceMandateNotification.object_name => SourceMandateNotification,
         SourceTransaction.object_name => SourceTransaction,
         Subscription.object_name => Subscription,
         SubscriptionItem.object_name => SubscriptionItem,
@@ -119,6 +126,7 @@ module Stripe
         Tax::Transaction.object_name => Tax::Transaction,
         Tax::TransactionLineItem.object_name => Tax::TransactionLineItem,
         TaxCode.object_name => TaxCode,
+        TaxDeductedAtSource.object_name => TaxDeductedAtSource,
         TaxId.object_name => TaxId,
         TaxRate.object_name => TaxRate,
         Terminal::Configuration.object_name => Terminal::Configuration,
@@ -140,8 +148,6 @@ module Stripe
         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,
         # object classes: The end of the section generated from our OpenAPI spec
       }

data/lib/stripe/request_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# typed: true
+
+module Stripe
+  # For internal use only. Does not provide a stable API and may be broken
+  # with future non-major changes.
+  class RequestParams
+    def to_h
+      instance_variables.each_with_object({}) do |var, hash|
+        key = var.to_s.delete("@").to_sym
+        value = instance_variable_get(var)
+
+        hash[key] = if value.is_a?(RequestParams)
+                      value.to_h
+                    # Check if value is an array and contains RequestParams objects
+                    elsif value.is_a?(Array)
+                      value.map { |item| item.is_a?(RequestParams) ? item.to_h : item }
+                    else
+                      value
+                    end
+      end
+    end
+  end
+end