stripe 10.15.0.pre.beta.1 → 11.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +72 -326
  3. data/Makefile +1 -1
  4. data/OPENAPI_VERSION +1 -1
  5. data/README.md +5 -18
  6. data/VERSION +1 -1
  7. data/lib/stripe/api_operations/request.rb +3 -4
  8. data/lib/stripe/api_operations/save.rb +1 -1
  9. data/lib/stripe/api_operations/singleton_save.rb +1 -1
  10. data/lib/stripe/api_resource.rb +3 -3
  11. data/lib/stripe/api_version.rb +1 -2
  12. data/lib/stripe/object_types.rb +0 -16
  13. data/lib/stripe/resources/financial_connections/account.rb +0 -3
  14. data/lib/stripe/resources/invoice.rb +0 -113
  15. data/lib/stripe/resources/payment_intent.rb +0 -50
  16. data/lib/stripe/resources/product.rb +1 -1
  17. data/lib/stripe/resources/quote.rb +0 -104
  18. data/lib/stripe/resources/subscription_schedule.rb +0 -20
  19. data/lib/stripe/resources/terminal/reader.rb +0 -60
  20. data/lib/stripe/resources.rb +0 -15
  21. data/lib/stripe/stripe_client.rb +36 -74
  22. data/lib/stripe/stripe_configuration.rb +1 -2
  23. data/lib/stripe/stripe_object.rb +8 -3
  24. data/lib/stripe/util.rb +4 -11
  25. data/lib/stripe/version.rb +1 -1
  26. data/lib/stripe.rb +0 -54
  27. data/stripe.gemspec +4 -5
  28. metadata +6 -22
  29. data/lib/stripe/request_signing_authenticator.rb +0 -79
  30. data/lib/stripe/resources/account_notice.rb +0 -32
  31. data/lib/stripe/resources/capital/financing_offer.rb +0 -49
  32. data/lib/stripe/resources/capital/financing_summary.rb +0 -15
  33. data/lib/stripe/resources/capital/financing_transaction.rb +0 -27
  34. data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -14
  35. data/lib/stripe/resources/gift_cards/card.rb +0 -59
  36. data/lib/stripe/resources/gift_cards/transaction.rb +0 -93
  37. data/lib/stripe/resources/invoice_payment.rb +0 -12
  38. data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -88
  39. data/lib/stripe/resources/margin.rb +0 -37
  40. data/lib/stripe/resources/order.rb +0 -120
  41. data/lib/stripe/resources/quote_phase.rb +0 -39
  42. data/lib/stripe/resources/quote_preview_invoice.rb +0 -43
  43. data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -11
  44. data/lib/stripe/resources/tax/form.rb +0 -49
  45. /data/{bin → exe}/stripe-console +0 -0
data/CHANGELOG.md CHANGED
@@ -1,10 +1,21 @@
1
1
  # Changelog
2
+ ## 11.0.0 - 2024-04-10
3
+ * [#1374](https://github.com/stripe/stripe-ruby/pull/1374)
4
+
5
+ * This release changes the pinned API version to `2024-04-10`. Please read the [API Upgrade Guide](https://stripe.com/docs/upgrades#2024-04-10) and carefully review the API changes before upgrading.
6
+
7
+ ### ⚠️ Breaking changes
8
+
9
+ * When no `x-stripe-should-retry` header is set in the response, the library now retries all requests with `status >= 500`, not just non-POST methods.
2
10
 
3
- ## 10.15.0-beta.1 - 2024-04-04
4
- * [#1373](https://github.com/stripe/stripe-ruby/pull/1373) Update generated code for beta
5
- * Add support for `update` method on resource `Entitlements.Feature`
6
- * [#1370](https://github.com/stripe/stripe-ruby/pull/1370) Update generated code for beta
7
-
11
+ ## 10.15.0 - 2024-04-09
12
+ * [#1377](https://github.com/stripe/stripe-ruby/pull/1377) Add last_response to StripeObject
13
+ * Users can now retrieve raw response from the returned resource, using the `last_response` property. See [README](https://github.com/stripe/stripe-ruby/blob/master/README.md) for an example.
14
+ * [#1372](https://github.com/stripe/stripe-ruby/pull/1372) Update generated code
15
+ * Add support for new resources `Entitlements.ActiveEntitlement` and `Entitlements.Feature`
16
+ * Add support for `list` and `retrieve` methods on resource `ActiveEntitlement`
17
+ * Add support for `create`, `list`, `retrieve`, and `update` methods on resource `Feature`
18
+ * [#1366](https://github.com/stripe/stripe-ruby/pull/1366) Move executables to `exe` folder
8
19
 
9
20
  ## 10.14.0 - 2024-03-28
10
21
  * [#1369](https://github.com/stripe/stripe-ruby/pull/1369) Update generated code
@@ -12,11 +23,6 @@
12
23
  * Add support for `create`, `deactivate`, `list`, `reactivate`, `retrieve`, and `update` methods on resource `Meter`
13
24
  * Add support for `create` method on resources `MeterEventAdjustment` and `MeterEvent`
14
25
 
15
- ## 10.14.0-beta.1 - 2024-03-21
16
- * [#1363](https://github.com/stripe/stripe-ruby/pull/1363) Update generated code for beta
17
- * Add support for new resources `Entitlements.ActiveEntitlementSummary` and `Entitlements.ActiveEntitlement`
18
- * Add support for `list` method on resource `ActiveEntitlement`
19
-
20
26
  ## 10.13.0 - 2024-03-21
21
27
  * [#1367](https://github.com/stripe/stripe-ruby/pull/1367) Update generated code
22
28
  * Add support for new resources `ConfirmationToken` and `Forwarding.Request`
@@ -24,14 +30,6 @@
24
30
  * Add support for `create`, `list`, and `retrieve` methods on resource `Request`
25
31
  * [#1362](https://github.com/stripe/stripe-ruby/pull/1362) Exclude sorbet directory and tapioca script when packing gem
26
32
 
27
- ## 10.13.0-beta.1 - 2024-03-14
28
- * [#1360](https://github.com/stripe/stripe-ruby/pull/1360) Update generated code for beta
29
- * Add support for new resources `Billing.MeterEventAdjustment`, `Billing.MeterEvent`, and `Billing.Meter`
30
- * Add support for `create`, `deactivate`, `list`, `reactivate`, `retrieve`, and `update` methods on resource `Meter`
31
- * Add support for `create` method on resources `MeterEventAdjustment` and `MeterEvent`
32
- * Add support for `create` test helper method on resource `ConfirmationToken`
33
- * Add support for `add_lines`, `remove_lines`, and `update_lines` methods on resource `Invoice`
34
-
35
33
  ## 10.12.0 - 2024-03-14
36
34
  * [#1359](https://github.com/stripe/stripe-ruby/pull/1359) Update generated code
37
35
  * Add support for new resources `Issuing.PersonalizationDesign` and `Issuing.PhysicalBundle`
@@ -42,24 +40,12 @@
42
40
  * [#1355](https://github.com/stripe/stripe-ruby/pull/1355) Disable Metrics/ClassLength
43
41
  * [#1351](https://github.com/stripe/stripe-ruby/pull/1351) Update CHANGELOG.md
44
42
 
45
- ## 10.12.0-beta.1 - 2024-02-29
46
- * [#1352](https://github.com/stripe/stripe-ruby/pull/1352) Update generated code for beta
47
- Release specs are identical.
48
- * [#1350](https://github.com/stripe/stripe-ruby/pull/1350) Update generated code for beta
49
-
50
- * [#1341](https://github.com/stripe/stripe-ruby/pull/1341) Update generated code for beta
51
- * Remove support for resource `Entitlements.Event`
52
- * [#1343](https://github.com/stripe/stripe-ruby/pull/1343) Add a helper to add a beta version
53
-
54
43
  ## 10.11.0 - 2024-02-29
55
44
  * [#1348](https://github.com/stripe/stripe-ruby/pull/1348) Use sorbet gem instead of sorbet-static
56
45
  * [#1342](https://github.com/stripe/stripe-ruby/pull/1342) Update generated code
57
46
  * Add `list_refunds` and `retrieve_refund` methods on resource `Charge`.
58
47
  * [#1345](https://github.com/stripe/stripe-ruby/pull/1345) Update README to use add_beta_version
59
48
 
60
- ## 10.11.0-beta.1 - 2024-02-22
61
- * [#1335](https://github.com/stripe/stripe-ruby/pull/1335) Update generated code for beta
62
-
63
49
  ## 10.10.0 - 2024-02-22
64
50
  * [#1336](https://github.com/stripe/stripe-ruby/pull/1336) Update generated code
65
51
  - Add `InvoiceLineItem.update` method.
@@ -68,33 +54,18 @@
68
54
  * The `delete` method now sends a DELETE request to `/v1/tax_ids/{id}` instead of `/v1/customers/{customer}/tax_ids/{id}`. The endpoints are functionally the same when operating on a Customer Tax ID.
69
55
  * The `resource_url` method on `TaxId` now returns the top-level `/v1/tax_ids/{id}` path instead of the `/v1/customers/{customer}/tax_ids/{id}` path.
70
56
 
71
- ## 10.10.0-beta.1 - 2024-02-16
72
- * [#1332](https://github.com/stripe/stripe-ruby/pull/1332) Update generated code for beta
73
- * Add support for `decrement_authorization` method on resource `PaymentIntent`
74
- * [#1328](https://github.com/stripe/stripe-ruby/pull/1328) Update generated code for beta
75
-
76
57
  ## 10.9.0 - 2024-02-15
77
58
  * [#1329](https://github.com/stripe/stripe-ruby/pull/1329) Update generated code
78
59
  * Fixed bug where `TaxId` resource `delete` method sent request to wrong URL (https://github.com/stripe/stripe-ruby/issues/1333)
79
60
  * [#1324](https://github.com/stripe/stripe-ruby/pull/1324) Start running Sorbet in CI
80
61
  * [#1327](https://github.com/stripe/stripe-ruby/pull/1327) Add methods for dynamically referenced constants
81
62
 
82
- ## 10.9.0-beta.1 - 2024-02-08
83
- * [#1321](https://github.com/stripe/stripe-ruby/pull/1321) Update generated code for beta
84
- * Release specs are identical.
85
-
86
63
  ## 10.8.0 - 2024-02-08
87
64
  * [#1322](https://github.com/stripe/stripe-ruby/pull/1322) Update generated code
88
65
  * [#1323](https://github.com/stripe/stripe-ruby/pull/1323) Extract other CRUDL api operations from mixins
89
66
  * Extract more CRUDL operations, namely `create`, `delete`, `update`, and `list` into the resources. These methods will no longer rely on the APIOperation mixins.
90
67
  * [#1314](https://github.com/stripe/stripe-ruby/pull/1314) Update mocha gem to 1.16
91
68
 
92
- ## 10.8.0-beta.1 - 2024-02-01
93
- * [#1318](https://github.com/stripe/stripe-ruby/pull/1318) Update generated code for beta
94
- * Add support for new resources `Entitlements.Event` and `Entitlements.Feature`
95
- * Add support for `create` method on resource `Event`
96
- * Add support for `create` and `list` methods on resource `Feature`
97
-
98
69
  ## 10.7.1 - 2024-02-05
99
70
  * [#1320](https://github.com/stripe/stripe-ruby/pull/1320) Remove spurious _search deprecation messages (https://github.com/stripe/stripe-ruby/issues/1319)
100
71
 
@@ -103,34 +74,15 @@
103
74
  * Removes list method mixin from child resources, as these methods always return `InvalidRequestError` and never succeed
104
75
  * [#1311](https://github.com/stripe/stripe-ruby/pull/1311) Use the deprecation gem in search and clean up usage of the gem
105
76
 
106
- ## 10.7.0-beta.3 - 2024-01-25
107
- * [#1313](https://github.com/stripe/stripe-ruby/pull/1313) Update generated code for beta
108
- * Add support for `create_preview` method on resource `Invoice`
109
- * [#1307](https://github.com/stripe/stripe-ruby/pull/1307) Beta: report raw request usage
110
-
111
- ## 10.7.0-beta.2 - 2024-01-19
112
- * [#1307](https://github.com/stripe/stripe-ruby/pull/1307) Beta: report raw request usage
113
-
114
- ## 10.7.0-beta.1 - 2024-01-12
115
- * [#1309](https://github.com/stripe/stripe-ruby/pull/1309) Update generated code for beta
116
- * [#1305](https://github.com/stripe/stripe-ruby/pull/1305) Update generated code for beta
117
-
118
77
  ## 10.6.0 - 2024-01-12
119
78
  * [#1310](https://github.com/stripe/stripe-ruby/pull/1310) Update generated code
120
79
  * Add support for new resource `CustomerSession`
121
80
  * Add support for `create` method on resource `CustomerSession`
122
81
 
123
- ## 10.6.0-beta.1 - 2024-01-04
124
- * [#1302](https://github.com/stripe/stripe-ruby/pull/1302) Update generated code for beta
125
- * Updated stable APIs to the latest version
126
-
127
82
  ## 10.5.0 - 2024-01-04
128
83
  * [#1306](https://github.com/stripe/stripe-ruby/pull/1306) Update generated code
129
84
  * Add support for `retrieve` method on resource `Tax.Registration`
130
85
 
131
- ## 10.5.0-beta.1 - 2023-12-22
132
- * [#1302](https://github.com/stripe/stripe-ruby/pull/1302) Update generated code for beta
133
-
134
86
  ## 10.4.0 - 2023-12-22
135
87
  * [#1303](https://github.com/stripe/stripe-ruby/pull/1303) Update generated code
136
88
  * Add support for new resource `FinancialConnections.Transaction`
@@ -138,16 +90,9 @@
138
90
  * Add support for `subscribe` and `unsubscribe` methods on resource `FinancialConnections.Account`
139
91
  * [#1304](https://github.com/stripe/stripe-ruby/pull/1304) Add support for updatable singleton resources
140
92
 
141
- ## 10.4.0-beta.1 - 2023-12-14
142
- Updated stable APIs to the latest version
143
-
144
93
  ## 10.3.0 - 2023-12-14
145
94
  * [#1294](https://github.com/stripe/stripe-ruby/pull/1294) Support sending parameters inside singleton retrieve
146
95
 
147
- ## 10.3.0-beta.1 - 2023-11-30
148
- * [#1298](https://github.com/stripe/stripe-ruby/pull/1298) Update generated code for beta
149
- * [#1296](https://github.com/stripe/stripe-ruby/pull/1296) Merge master into beta
150
-
151
96
  ## 10.2.0 - 2023-11-30
152
97
  * [#1292](https://github.com/stripe/stripe-ruby/pull/1292) Update generated code
153
98
  * Add support for new resources `Climate.Order`, `Climate.Product`, and `Climate.Supplier`
@@ -160,26 +105,12 @@
160
105
 
161
106
  * [#1288](https://github.com/stripe/stripe-ruby/pull/1288) Update generated code
162
107
 
163
- ## 10.2.0-beta.1 - 2023-11-02
164
- * [#1287](https://github.com/stripe/stripe-ruby/pull/1287) Update generated code for beta
165
- * Add support for `attach_payment_intent` method on resource `Invoice`
166
- * [#1285](https://github.com/stripe/stripe-ruby/pull/1285) Update generated code for beta
167
108
 
168
109
  ## 10.1.0 - 2023-11-02
169
110
  * [#1286](https://github.com/stripe/stripe-ruby/pull/1286) Update generated code
170
111
  * Add support for new resource `Tax.Registration`
171
112
  * Add support for `create`, `list`, and `update` methods on resource `Registration`
172
113
 
173
- ## 10.1.0-beta.2 - 2023-10-26
174
- * [#1285](https://github.com/stripe/stripe-ruby/pull/1285) Update generated code for beta
175
- * Add support for new resource `Margin`
176
- * Add support for `create`, `list`, `retrieve`, and `update` methods on resource `Margin`
177
-
178
- ## 10.1.0-beta.1 - 2023-10-17
179
- * [#1284](https://github.com/stripe/stripe-ruby/pull/1284) Update generated code for beta
180
- - Update pinned API version to `2023-10-16`
181
- * [#1282](https://github.com/stripe/stripe-ruby/pull/1282) Update generated code for beta
182
-
183
114
  ## 10.0.0 - 2023-10-16
184
115
  * This release changes the pinned API version to `2023-10-16`. Please read the [API Upgrade Guide](https://stripe.com/docs/upgrades#2023-10-16) and carefully review the API changes before upgrading `stripe-ruby`.
185
116
  * [#1283](https://github.com/stripe/stripe-ruby/pull/1283) Update generated code
@@ -187,33 +118,11 @@
187
118
  * [#1281](https://github.com/stripe/stripe-ruby/pull/1281) Update generated code
188
119
  * Documentation only changes
189
120
 
190
- ## 9.5.0-beta.2 - 2023-10-12
191
- * [#1280](https://github.com/stripe/stripe-ruby/pull/1280) Update generated code for beta
192
- * Add support for new resources `AccountNotice` and `Issuing.CreditUnderwritingRecord`
193
- * Add support for `list`, `retrieve`, and `update` methods on resource `AccountNotice`
194
- * Add support for `correct`, `create_from_application`, `create_from_proactive_review`, `list`, `report_decision`, and `retrieve` methods on resource `CreditUnderwritingRecord`
195
-
196
- ## 9.5.0-beta.1 - 2023-10-05
197
- * [#1278](https://github.com/stripe/stripe-ruby/pull/1278) Update generated code for beta
198
- * Add support for `mark_draft` and `mark_stale` methods on resource `Quote`
199
- * Remove support for `draft_quote` and `mark_stale_quote` methods on resource `Quote`
200
- * Rename `preview_invoice_lines` to `list_preview_invoice_lines` on resource `Quote`
201
-
202
121
  ## 9.4.0 - 2023-10-05
203
122
  * [#1277](https://github.com/stripe/stripe-ruby/pull/1277) Update generated code
204
123
  * Add support for new resources `Issuing.Token`
205
124
  * Add support for `list`, `retrieve`, and `update` methods on resource `Token`
206
125
 
207
- ## 9.4.0-beta.3 - 2023-09-28
208
- * [#1276](https://github.com/stripe/stripe-ruby/pull/1276) Update generated code for beta
209
- * Rename resources `Issuing.CardDesign` and `Issuing.CardBundle` to `Issuing.PersonalizationDesign` and `Issuing.PhysicalBundle`
210
-
211
- ## 9.4.0-beta.2 - 2023-09-21
212
- * [#1273](https://github.com/stripe/stripe-ruby/pull/1273) Update generated code for beta
213
-
214
- ## 9.4.0-beta.1 - 2023-09-14
215
- * Updated stable APIs to the latest version
216
-
217
126
  ## 9.3.0 - 2023-09-14
218
127
  * [#1272](https://github.com/stripe/stripe-ruby/pull/1272) Update generated code
219
128
  * Add support for new resource `PaymentMethodConfiguration`
@@ -222,103 +131,54 @@
222
131
  * Add support for `capture`, `create`, `expire`, `increment`, and `reverse` test helper methods on resource `Issuing.Authorization`
223
132
  * Add support for `create_force_capture`, `create_unlinked_refund`, and `refund` test helper methods on resource `Issuing.Transaction`
224
133
 
225
- ## 9.3.0-beta.1 - 2023-09-07
226
- * [#1269](https://github.com/stripe/stripe-ruby/pull/1269) Update generated code for beta
227
- * Release specs are identical.
228
- * [#1268](https://github.com/stripe/stripe-ruby/pull/1268) Update generated code for beta
229
- * Remove support for `submit_card` test helper method on resource `Issuing.Card`
230
- * [#1265](https://github.com/stripe/stripe-ruby/pull/1265) Update generated code for beta
231
- * Rename `Quote.preview_invoices` to `QuotePreviewInvoice.list` and `Quote.preview_schedules` to `QuotePreviewSchedules.list`
232
- * [#1264](https://github.com/stripe/stripe-ruby/pull/1264) Update generated code for beta
233
- * Add support for new resources `QuotePreviewInvoice` and `QuotePreviewSchedule`
234
- * [#1259](https://github.com/stripe/stripe-ruby/pull/1259) Update generated code for beta
235
-
236
- * [#1257](https://github.com/stripe/stripe-ruby/pull/1257) Update generated code for beta
237
-
238
- * [#1254](https://github.com/stripe/stripe-ruby/pull/1254) Update generated code for beta
239
- * Add support for `submit_card` test helper method on resource `Issuing.Card`
240
- * [#1252](https://github.com/stripe/stripe-ruby/pull/1252) Remove developer_message support
241
-
242
134
  ## 9.2.0 - 2023-09-07
243
135
  * [#1267](https://github.com/stripe/stripe-ruby/pull/1267) Update generated code
244
136
  * Add support for new resource `PaymentMethodDomain`
245
137
  * Add support for `create`, `list`, `retrieve`, `update`, and `validate` methods on resource `PaymentMethodDomain`
246
138
 
247
- ## 9.2.0-beta.1 - 2023-08-31
248
- * [#1265](https://github.com/stripe/stripe-ruby/pull/1265) Update generated code for beta
249
- * Rename `Quote.preview_invoices` to `QuotePreviewInvoice.list` and `Quote.preview_schedules` to `QuotePreviewSchedules.list`
250
-
251
139
  ## 9.1.0 - 2023-08-31
252
140
  * [#1266](https://github.com/stripe/stripe-ruby/pull/1266) Update generated code
253
141
  * Add support for new resource `AccountSession`
254
142
  * Add support for `create` method on resource `AccountSession`
255
143
  * [#1262](https://github.com/stripe/stripe-ruby/pull/1262) Explicitly format timestamp in SignatureVerificationError message
256
144
 
145
+
257
146
  ## 9.0.0 - 2023-08-16
258
147
  **⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️**
259
148
 
260
149
  * [#1253](https://github.com/stripe/stripe-ruby/pull/1253) [#1260](https://github.com/stripe/stripe-ruby/pull/1260) Pin latest API version as the default
261
-
150
+
262
151
  In this release, Stripe API Version `2023-08-16` (the latest at time of release) will be sent by default on all requests. This is a significant change with wide ramifications. The API version affects the properties you see on responses, the parameters you are allowed to send on requests, and so on. The previous default was to use your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version).
263
-
152
+
264
153
  To successfully upgrade to stripe-ruby v9, you must either
265
-
154
+
266
155
  1. **(Recommended) Upgrade your integration to be compatible with API Version `2023-08-16`.**
267
-
156
+
268
157
  Please read the API Changelog carefully for each API Version from `2023-08-16` back to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe [Test Mode](https://stripe.com/docs/keys#test-live-modes) before deploying them to production.
269
-
158
+
270
159
  You can read the [v9 migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v9) for more detailed instructions.
271
160
  2. **(Alternative option) Specify a version other than `2023-08-16` when initializing `stripe-ruby`.**
272
-
161
+
273
162
  If you were previously initializing stripe-ruby without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). For example:
274
-
163
+
275
164
  ```diff
276
165
  require 'stripe'
277
166
  Stripe.api_key = "sk_test_..."
278
167
  + Stripe.api_version = '2020-08-27'
279
168
  ```
280
-
169
+
281
170
  If you were already initializing stripe-ruby with an explicit API Version, upgrading to v9 will not affect your integration.
282
-
171
+
283
172
  Read the [v9 migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v9) for more details.
284
-
285
- Going forward, each major release of this library will be *pinned* by default to the latest Stripe API Version at the time of release.
286
-
287
- That is, instead of upgrading stripe-ruby and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-ruby, you should also upgrade your integration to be compatible with the latest Stripe API version.
288
173
 
289
- ## 9.0.0-beta.1 - 2023-08-24
290
- * [#1264](https://github.com/stripe/stripe-ruby/pull/1264) Update generated code for beta
291
- * Add support for new resources `QuotePreviewInvoice` and `QuotePreviewSchedule`
292
- * [#1259](https://github.com/stripe/stripe-ruby/pull/1259) Update generated code for beta
174
+ Going forward, each major release of this library will be *pinned* by default to the latest Stripe API Version at the time of release.
293
175
 
294
- ## 8.8.0-beta.1 - 2023-08-10
295
- * [#1257](https://github.com/stripe/stripe-ruby/pull/1257) Update generated code for beta
296
- * Updated stable APIs to the latest version
176
+ That is, instead of upgrading stripe-ruby and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-ruby, you should also upgrade your integration to be compatible with the latest Stripe API version.
297
177
 
298
178
  ## 8.7.0 - 2023-08-10
299
179
  * [#1256](https://github.com/stripe/stripe-ruby/pull/1256) Update generated code
300
180
  Add resources `Tax::CalculationLineItem`, `Tax::TransactionLineItem`, and `Treasury::FinancialAccountFeatures`. These resources have no methods on them, but do represent the return type of methods elsewhere.
301
181
 
302
- ## 8.7.0-beta.3 - 2023-08-03
303
- * [#1254](https://github.com/stripe/stripe-ruby/pull/1254) Update generated code for beta
304
- * Add support for `submit_card` test helper method on resource `Issuing.Card`
305
- * [#1252](https://github.com/stripe/stripe-ruby/pull/1252) Remove developer_message support
306
-
307
- ## 8.7.0-beta.2 - 2023-07-28
308
- * [#1251](https://github.com/stripe/stripe-ruby/pull/1251) Update generated code for beta
309
- * Add support for new resource `Tax.Form`
310
- * Add support for `list`, `pdf`, and `retrieve` methods on resource `Form`
311
- * [#1249](https://github.com/stripe/stripe-ruby/pull/1249) Update generated code for beta
312
- * [#1246](https://github.com/stripe/stripe-ruby/pull/1246) Update generated code for beta
313
-
314
- ## 8.7.0-beta.1 - 2023-07-13
315
- * [#1245](https://github.com/stripe/stripe-ruby/pull/1245) Update generated code for beta
316
- Release specs are identical.
317
- * [#1243](https://github.com/stripe/stripe-ruby/pull/1243) Update generated code for beta
318
- * Add support for new resource `PaymentMethodConfiguration`
319
- * Add support for `create`, `list`, `retrieve`, and `update` methods on resource `PaymentMethodConfiguration`
320
- * [#1239](https://github.com/stripe/stripe-ruby/pull/1239) Update generated code for beta
321
-
322
182
  ## 8.6.0 - 2023-07-13
323
183
  * [#1244](https://github.com/stripe/stripe-ruby/pull/1244) Update generated code
324
184
  * Add support for new resource `Tax.Settings`
@@ -339,7 +199,7 @@
339
199
 
340
200
  * [#1225](https://github.com/stripe/stripe-ruby/pull/1225) Downgrade jaro_winkler
341
201
  * [#1219](https://github.com/stripe/stripe-ruby/pull/1219) Update generated code
342
-
202
+
343
203
  Documentation updates.
344
204
  * [#1215](https://github.com/stripe/stripe-ruby/pull/1215) Update generated code
345
205
 
@@ -347,37 +207,6 @@
347
207
 
348
208
  * [#1204](https://github.com/stripe/stripe-ruby/pull/1204) Update generated code
349
209
 
350
- ## 8.6.0-beta.6 - 2023-06-22
351
- * [#1237](https://github.com/stripe/stripe-ruby/pull/1237) Update generated code for beta
352
- * Add support for new resource `CustomerSession`
353
- * Add support for `create` method on resource `CustomerSession`
354
- * [#1233](https://github.com/stripe/stripe-ruby/pull/1233) Update generated code for beta
355
- * [#1229](https://github.com/stripe/stripe-ruby/pull/1229) Update generated code for beta
356
-
357
- ## 8.6.0-beta.5 - 2023-06-01
358
- * [#1227](https://github.com/stripe/stripe-ruby/pull/1227) Update generated code for beta
359
- * [#1228](https://github.com/stripe/stripe-ruby/pull/1228) Document raw_request
360
- * [#1222](https://github.com/stripe/stripe-ruby/pull/1222) Update generated code for beta
361
- * [#1224](https://github.com/stripe/stripe-ruby/pull/1224) Handle developer message in preview error responses
362
-
363
- ## 8.6.0-beta.4 - 2023-05-19
364
- * [#1220](https://github.com/stripe/stripe-ruby/pull/1220) Update generated code for beta
365
- * Add support for `subscribe` and `unsubscribe` methods on resource `FinancialConnections.Account`
366
- * [#1217](https://github.com/stripe/stripe-ruby/pull/1217) Add raw_request
367
- * [#1216](https://github.com/stripe/stripe-ruby/pull/1216) Update generated code for beta
368
- * [#1214](https://github.com/stripe/stripe-ruby/pull/1214) Update generated code for beta
369
-
370
- ## 8.6.0-beta.3 - 2023-04-17
371
- * [#1211](https://github.com/stripe/stripe-ruby/pull/1211) Update generated code for beta
372
- * [#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
373
-
374
- ## 8.6.0-beta.2 - 2023-04-13
375
- * [#1206](https://github.com/stripe/stripe-ruby/pull/1206) Update generated code for beta
376
- * Add support for `collect_payment_method` and `confirm_payment_intent` methods on resource `Terminal.Reader`
377
- * [#1205](https://github.com/stripe/stripe-ruby/pull/1205) Update generated code for beta
378
-
379
- ## 8.6.0-beta.1 - 2023-03-30
380
- * [#1202](https://github.com/stripe/stripe-ruby/pull/1202) Update generated code for beta
381
210
 
382
211
  ## 8.5.0 - 2023-03-30
383
212
  * [#1203](https://github.com/stripe/stripe-ruby/pull/1203) Update generated code
@@ -385,11 +214,6 @@
385
214
  * This is not a breaking change, as this method was deprecated before the Tax Transactions API was released in favor of the `create_from_calculation` method.
386
215
  * [#1201](https://github.com/stripe/stripe-ruby/pull/1201) Update save deprecation message
387
216
 
388
- ## 8.5.0-beta.1 - 2023-03-23
389
- * [#1194](https://github.com/stripe/stripe-ruby/pull/1194) Update generated code for beta (new)
390
- * Add support for new resources `Tax.CalculationLineItem` and `Tax.TransactionLineItem`
391
- * Add support for `collect_inputs` method on resource `Terminal.Reader`
392
-
393
217
  ## 8.4.0 - 2023-03-23
394
218
  * [#1197](https://github.com/stripe/stripe-ruby/pull/1197) Update generated code (new)
395
219
  * Add support for new resources `Tax.CalculationLineItem`, `Tax.Calculation`, `Tax.TransactionLineItem`, and `Tax.Transaction`
@@ -397,91 +221,18 @@
397
221
  * Add support for `create_from_calculation`, `create_reversal`, `create`, `list_line_items`, and `retrieve` methods on resource `Transaction`
398
222
  * [#1152](https://github.com/stripe/stripe-ruby/pull/1152) Symbolize hash keys inside `convert_to_stripe_object_with_params`
399
223
 
400
- ## 8.4.0-beta.4 - 2023-03-16
401
- * [#1189](https://github.com/stripe/stripe-ruby/pull/1189) Update generated code for beta (new)
402
- * Add support for `create_from_calculation` method on resource `Tax.Transaction`
403
- * [#1188](https://github.com/stripe/stripe-ruby/pull/1188) Update generated code for beta (new)
404
- * Remove support for resources `Capital.FinancingOffer` and `Capital.FinancingSummary`
405
- * Remove support for `list`, `mark_delivered`, and `retrieve` methods on resource `FinancingOffer`
406
- * Remove support for `retrieve` method on resource `FinancingSummary`
407
- * [#1187](https://github.com/stripe/stripe-ruby/pull/1187) Merge upstream master
408
-
409
- ## 8.4.0-beta.3 - 2023-03-09
410
- * [#1184](https://github.com/stripe/stripe-ruby/pull/1184) API Updates for beta branch
411
- * Updated stable APIs to the latest version
412
- * Remove support for `list_transactions` method on resource `Tax.Transaction`
413
-
414
- ## 8.4.0-beta.2 - 2023-03-03
415
- * [#1183](https://github.com/stripe/stripe-ruby/pull/1183) API Updates for beta branch
416
- * Updated stable APIs to the latest version
417
- * Add support for new resources `Issuing.CardBundle` and `Issuing.CardDesign`
418
- * Add support for `list` and `retrieve` methods on resource `CardBundle`
419
- * Add support for `list`, `retrieve`, and `update` methods on resource `CardDesign`
420
-
421
- ## 8.4.0-beta.1 - 2023-02-23
422
- * [#1182](https://github.com/stripe/stripe-ruby/pull/1182) API Updates for beta branch
423
- * Updated stable APIs to the latest version
424
-
425
224
  ## 8.3.0 - 2023-02-16
426
225
  * [#1175](https://github.com/stripe/stripe-ruby/pull/1175) API Updates
427
226
  * Add support for `refund_payment` method on resource `Terminal.Reader`
428
227
 
429
- ## 8.3.0-beta.1 - 2023-02-02
430
- * [#1174](https://github.com/stripe/stripe-ruby/pull/1174) API Updates for beta branch
431
- * Updated stable APIs to the latest version
432
- * Add support for new resource `FinancialConnections.Transaction`
433
- * Add support for `list` method on resource `Transaction`
434
-
435
228
  ## 8.2.0 - 2023-02-02
436
229
  * [#1173](https://github.com/stripe/stripe-ruby/pull/1173) API Updates
437
230
  * Add support for `resume` method on resource `Subscription`
438
231
  * [#1171](https://github.com/stripe/stripe-ruby/pull/1171) Remove unused `partial` param from `initialize_from`
439
232
 
440
- ## 8.2.0-beta.3 - 2023-01-26
441
- * [#1172](https://github.com/stripe/stripe-ruby/pull/1172) API Updates for beta branch
442
- * Updated stable APIs to the latest version
443
- * Add support for `list_transactions` method on resource `Tax.Transaction`
444
-
445
- ## 8.2.0-beta.2 - 2023-01-19
446
- * [#1170](https://github.com/stripe/stripe-ruby/pull/1170) API Updates for beta branch
447
- * Updated stable APIs to the latest version
448
- * Add support for `Tax.Settings` resource.
449
-
450
- ## 8.2.0-beta.1 - 2023-01-12
451
- * [#1167](https://github.com/stripe/stripe-ruby/pull/1167) API Updates for beta branch
452
- * Updated stable APIs to the latest version
453
- * Change `quote.draft_quote` implementation to from calling `POST /v1/quotes/{quote}/draft` to `POST /v1/quotes/{quote}/mark_draft`
454
- * Add support for `Tax::Register` resource
455
-
456
233
  ## 8.1.0 - 2023-01-12
457
234
  * [#1162](https://github.com/stripe/stripe-ruby/pull/1162) Improve request events instrumentation
458
235
 
459
- ## 8.1.0-beta.4 - 2023-01-05
460
- * [#1164](https://github.com/stripe/stripe-ruby/pull/1164) API Updates for beta branch
461
- * Updated stable APIs to the latest version
462
- * Add support for `mark_stale_quote` method on resource `Quote`
463
-
464
- ## 8.1.0-beta.3 - 2022-12-22
465
- * [#1158](https://github.com/stripe/stripe-ruby/pull/1158) API Updates for beta branch
466
- * Updated stable APIs to the latest version
467
- * Move `TaxCalculation` and `TaxTransaction` to `Tax::Calculation` and `Tax::Transaction`.
468
-
469
- ## 8.1.0-beta.2 - 2022-12-15
470
- * [#1156](https://github.com/stripe/stripe-ruby/pull/1156) API Updates for beta branch
471
- * Updated stable APIs to the latest version
472
- * Add support for new resources `TaxCalculation`, and `TaxTransaction`
473
- * Add support for `create` and `list_line_items` methods on resource `TaxCalculation`
474
- * Add support for `create_reversal`, `create`, and `retrieve` methods on resource `TaxTransaction`
475
- * [#1155](https://github.com/stripe/stripe-ruby/pull/1155) API Updates for beta branch
476
- * Updated stable APIs to the latest version
477
- * Add support for new resource `QuoteLine`.
478
-
479
- ## 8.1.0-beta.1 - 2022-12-08
480
- * [#1153](https://github.com/stripe/stripe-ruby/pull/1153) API Updates for beta branch
481
- * Updated stable APIs to the latest version
482
- * [#1146](https://github.com/stripe/stripe-ruby/pull/1146) API Updates for beta branch
483
- * Updated stable APIs to the latest version
484
-
485
236
  ## 8.0.0 - 2022-11-16
486
237
  * [#1144](https://github.com/stripe/stripe-ruby/pull/1144) Next major release changes
487
238
 
@@ -489,29 +240,30 @@ Breaking changes that arose during code generation of the library that we postpo
489
240
 
490
241
  "⚠️" symbol highlights breaking changes.
491
242
 
492
- ## 7.2.0-beta.5 - 2022-11-02
493
- * [#1139](https://github.com/stripe/stripe-ruby/pull/1139) API Updates for beta branch
494
- * Updated beta APIs to the latest stable version
495
- * [#1135](https://github.com/stripe/stripe-ruby/pull/1135) API Updates for beta branch
496
- * Updated stable APIs to the latest version
243
+ ### Deprecated
244
+ - The `save` method is deprecated. Prefer the static `update` method that doesn't require retrieval of the resource to update it.
245
+ ``` ruby
246
+ # before
247
+ refund = Stripe::Refund.retrieve("re_123")
248
+ refund.description = "Refund description"
249
+ refund.save
497
250
 
498
- ## 7.2.0-beta.4 - 2022-10-07
499
- * [#999](https://github.com/stripe/stripe-ruby/pull/999) DESCRIBE CHANGES HERE (try to use the same style, tense, etc. as the other entries)
251
+ # after
252
+ Stripe::Refund.update("re_123", description: "Refund description")
253
+ ```
500
254
 
501
- ## 7.2.0-beta.3 - 2022-09-26
502
- * [#1129](https://github.com/stripe/stripe-ruby/pull/1129) API Updates for beta branch
503
- * Updated stable APIs to the latest version
504
- * Add `FinancingOffer`, `FinancingSummary` and `FinancingTransaction` resources.
255
+ ### ⚠️ Removed
256
+ - Removed deprecated `Sku` resource.
257
+ - Removed deprecated `Orders` resource.
258
+ - Removed deprecated `delete` method on `Subscription` resource. Please use `cancel` method instead.
259
+ ```ruby
260
+ # before
261
+ Stripe::Subscription::delete("sub_12345")
505
262
 
506
- ## 7.2.0-beta.2 - 2022-08-26
507
- * [#1127](https://github.com/stripe/stripe-ruby/pull/1127) API Updates for beta branch
508
- * Updated stable APIs to the latest version
509
- * Add support for the beta [Gift Card API](https://stripe.com/docs/gift-cards).
263
+ # after
264
+ Stripe::Subscription::cancel("sub_12345")
265
+ ```
510
266
 
511
- ## 7.2.0-beta.1 - 2022-08-23
512
- * [#1122](https://github.com/stripe/stripe-ruby/pull/1122) API Updates for beta branch
513
- - Updated stable APIs to the latest version
514
- - `Stripe-Version` beta headers are not pinned by-default and need to be manually specified, please refer to [beta SDKs README section](https://github.com/stripe/stripe-ruby/blob/master/README.md#beta-sdks)
515
267
 
516
268
  ## 7.1.0 - 2022-08-19
517
269
  * [#1116](https://github.com/stripe/stripe-ruby/pull/1116) API Updates
@@ -520,16 +272,6 @@ Breaking changes that arose during code generation of the library that we postpo
520
272
  * [#1117](https://github.com/stripe/stripe-ruby/pull/1117) Refresh rubocop config.
521
273
  * [#1115](https://github.com/stripe/stripe-ruby/pull/1115) Add a support section to the readme
522
274
 
523
- ## 7.1.0-beta.2 - 2022-08-11
524
- * [#1113](https://github.com/stripe/stripe-ruby/pull/1113) API Updates for beta branch
525
- - Updated stable APIs to the latest version
526
- - Add `refund_payment` method to Terminal resource
527
-
528
- ## 7.1.0-beta.1 - 2022-08-03
529
- * [#1107](https://github.com/stripe/stripe-ruby/pull/1107) API Updates for beta branch
530
- - Updated stable APIs to the latest version
531
- - Added the `Order` resource support
532
-
533
275
  ## 7.0.0 - 2022-08-02
534
276
 
535
277
  Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the SDK, read more detailed description at https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v7. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-08-01.
@@ -541,19 +283,21 @@ Breaking changes that arose during code generation of the library that we postpo
541
283
  * [#1090](https://github.com/stripe/stripe-ruby/pull/1090) Use auto-generation for `Invoice` methods
542
284
  * [#1103](https://github.com/stripe/stripe-ruby/pull/1103) Next major release changes
543
285
 
544
- ## 6.6.0-beta.1 - 2022-07-22
545
- * [#1100](https://github.com/stripe/stripe-ruby/pull/1100) API Updates for beta branch
546
- - Updated stable APIs to the latest version
547
- - Add `QuotePhase` resource
548
- * [#1097](https://github.com/stripe/stripe-ruby/pull/1097) API Updates for beta branch
549
- - Updated stable APIs to the latest version
550
- - Add `SubscriptionSchedule.amend` method.
551
- * [#1093](https://github.com/stripe/stripe-ruby/pull/1093) API Updates for beta branch
552
- - Include `server_side_confirmation_beta=v1` beta
553
- - Add `secretKeyConfirmation` to `PaymentIntent`
554
- * [#1085](https://github.com/stripe/stripe-ruby/pull/1085) API Updates for beta branch
555
- - Updated stable APIs to the latest version
556
- * [#1075](https://github.com/stripe/stripe-ruby/pull/1075) Use the generated API version
286
+ ### ⚠️ Changed
287
+ * `retrieve_cash_balance` and `update_cash_balance` methods on `Customer` resource no longer requires the second argument to always be `nil`. The methods now now take in `customer_id`, `params`, and `opts` parameters.
288
+ * Update default bundle of CA certificates to April 26, 2022.
289
+
290
+ ### Deprecated
291
+ * Deprecate `delete` method on `Subscription` resource. Please use `cancel` method instead.
292
+
293
+ ### ⚠️ Removed
294
+ * Remove `details` method from `Issuing.Card` resource. The method was not supported.
295
+ * Remove `Issuing.CardDetails` resource. Read more at https://stripe.com/docs/issuing/cards/virtual.
296
+ * Remove `create` method from `ReportType` resource. The method was not supported.
297
+ * Remove `usage_record_summaries` method from `SubscriptionItem` resource. Please use `list_usage_record_summaries` method instead.
298
+ * Remove `AlipayAccount`, `BitcoinReceiver`, `BitcoinTransaction`, `Issuing::CardDetails`, `Recipient`, ` RecipientTransfer`, and `ThreeDSecure` resources. The resources were deprecated or no longer in use.
299
+ * Remove ability to list `Card` resource for a `Recipient`.
300
+ * Remove `cancel` method from `Transfer` resource. The method was deprecated.
557
301
 
558
302
  ## 6.5.0 - 2022-06-29
559
303
  * [#1084](https://github.com/stripe/stripe-ruby/pull/1084) API Updates
@@ -567,7 +311,7 @@ Breaking changes that arose during code generation of the library that we postpo
567
311
  * [#1072](https://github.com/stripe/stripe-ruby/pull/1072) Trigger workflows on beta branches
568
312
  * [#1071](https://github.com/stripe/stripe-ruby/pull/1071) Use request_stripe_object for all requests
569
313
  * [#1070](https://github.com/stripe/stripe-ruby/pull/1070) API Updates
570
-
314
+
571
315
  Switch from using meta-programing to generating explicit methods for custom methods.
572
316
  * [#1069](https://github.com/stripe/stripe-ruby/pull/1069) chore: Stop special implementation of Account.persons method.
573
317
 
@@ -584,12 +328,14 @@ Breaking changes that arose during code generation of the library that we postpo
584
328
  * Add support for `retrieve_payment_method` method on resource `Customer`
585
329
  * Add support for `list_owners` and `list` methods on resource `FinancialConnections.Account`
586
330
 
331
+
332
+
587
333
  ## 6.0.0 - 2022-05-09
588
334
  * [#1056](https://github.com/stripe/stripe-ruby/pull/1056) API Updates
589
335
  Major version release. The [migration guide](https://github.com/stripe/stripe-ruby/wiki/Migration-Guide-for-v6) contains more information.
590
-
336
+
591
337
  (⚠️ = breaking changes):
592
- * ⚠️ Replace the legacy `Order` API with the new `Order` API.
338
+ * ⚠️ Replace the legacy `Order` API with the new `Order` API.
593
339
  * New methods: `cancel`, `list_line_items`, `reopen`, and `submit`
594
340
  * Removed methods: `pay` and `return_order`
595
341
  * Removed resources: `OrderItem` and `OrderReturn`
@@ -599,6 +345,7 @@ Breaking changes that arose during code generation of the library that we postpo
599
345
  * [#1055](https://github.com/stripe/stripe-ruby/pull/1055) API Updates
600
346
  * Add support for new resources `FinancialConnections.AccountOwner`, `FinancialConnections.AccountOwnership`, `FinancialConnections.Account`, and `FinancialConnections.Session`
601
347
 
348
+
602
349
  ## 5.54.0 - 2022-05-03
603
350
  * [#1053](https://github.com/stripe/stripe-ruby/pull/1053) API Updates
604
351
  * Add support for new resource `CashBalance`
@@ -608,7 +355,7 @@ Breaking changes that arose during code generation of the library that we postpo
608
355
  * Add support for `expire` test helper method on resource `Refund`
609
356
 
610
357
  ## 5.52.0 - 2022-04-18
611
- * [#1046](https://github.com/stripe/stripe-ruby/pull/1046) [#1047](https://github.com/stripe/stripe-ruby/pull/1047) API Updates
358
+ * [#1046](https://github.com/stripe/stripe-ruby/pull/1046) [#1047](https://github.com/stripe/stripe-ruby/pull/1047) API Updates
612
359
  * Add support for new resources `FundingInstructions` and `Terminal.Configuration`
613
360
 
614
361
  ## 5.51.0 - 2022-04-15
@@ -630,7 +377,7 @@ Breaking changes that arose during code generation of the library that we postpo
630
377
  * [#1040](https://github.com/stripe/stripe-ruby/pull/1040) API Updates
631
378
  * Add support for Search API
632
379
  * Add support for `search` method on resources `Charge`, `Customer`, `Invoice`, `PaymentIntent`, `Price`, `Product`, and `Subscription`
633
-
380
+
634
381
  * [#1034](https://github.com/stripe/stripe-ruby/pull/1034) Add supporting classes for test helper generation
635
382
 
636
383
  ## 5.46.0 - 2022-03-23
@@ -1628,4 +1375,3 @@ Identical to 1.56.0 above. I incorrectly cut a patch-level release.
1628
1375
  <!--
1629
1376
  # vim: set tw=0:
1630
1377
  -->
1631
-