stripe 9.2.0 → 9.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # CHANGELOG
2
2
 
3
+ ## 9.3.0 - 2022-05-23
4
+ * [#1430](https://github.com/stripe/stripe-node/pull/1430) API Updates
5
+ * Add support for new resource `Apps.Secret`
6
+ * Add support for `affirm` on `Charge.payment_method_details`, `PaymentIntent.payment_method_options`, `PaymentIntentConfirmParams.payment_method_data`, `PaymentIntentConfirmParams.payment_method_options`, `PaymentIntentCreateParams.payment_method_data`, `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_data`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentMethodCreateParams`, `PaymentMethodUpdateParams`, `PaymentMethod`, `SetupIntentConfirmParams.payment_method_data`, `SetupIntentCreateParams.payment_method_data`, and `SetupIntentUpdateParams.payment_method_data`
7
+ * Add support for `link` on `Charge.payment_method_details`, `Mandate.payment_method_details`, `OrderCreateParams.payment.settings.payment_method_options`, `OrderUpdateParams.payment.settings.payment_method_options`, `PaymentIntent.payment_method_options`, `PaymentIntentConfirmParams.payment_method_data`, `PaymentIntentConfirmParams.payment_method_options`, `PaymentIntentCreateParams.payment_method_data`, `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_data`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentMethodCreateParams`, `PaymentMethodUpdateParams`, `PaymentMethod`, `SetupAttempt.payment_method_details`, `SetupIntent.payment_method_options`, `SetupIntentConfirmParams.payment_method_data`, `SetupIntentConfirmParams.payment_method_options`, `SetupIntentCreateParams.payment_method_data`, `SetupIntentCreateParams.payment_method_options`, `SetupIntentUpdateParams.payment_method_data`, and `SetupIntentUpdateParams.payment_method_options`
8
+ * Add support for new values `affirm` and `link` on enums `CustomerListPaymentMethodsParams.type` and `PaymentMethodListParams.type`
9
+ * Add support for new value `link` on enums `Invoice.payment_settings.payment_method_types[]`, `InvoiceCreateParams.payment_settings.payment_method_types[]`, `InvoiceUpdateParams.payment_settings.payment_method_types[]`, `Subscription.payment_settings.payment_method_types[]`, `SubscriptionCreateParams.payment_settings.payment_method_types[]`, and `SubscriptionUpdateParams.payment_settings.payment_method_types[]`
10
+ * Add support for new values `affirm` and `link` on enums `PaymentIntentConfirmParams.payment_method_data.type`, `PaymentIntentCreateParams.payment_method_data.type`, `PaymentIntentUpdateParams.payment_method_data.type`, `SetupIntentConfirmParams.payment_method_data.type`, `SetupIntentCreateParams.payment_method_data.type`, and `SetupIntentUpdateParams.payment_method_data.type`
11
+ * Add support for new values `affirm` and `link` on enum `PaymentMethodCreateParams.type`
12
+ * Add support for new values `affirm` and `link` on enum `PaymentMethod.type`
13
+
3
14
  ## 9.2.0 - 2022-05-19
4
15
  * [#1422](https://github.com/stripe/stripe-node/pull/1422) API Updates
5
16
  * Add support for new `Treasury` APIs: `CreditReversal`, `DebitReversal`, `FinancialAccountFeatures`, `FinancialAccount`, `FlowDetails`, `InboundTransfer`, `OutboundPayment`, `OutboundTransfer`, `ReceivedCredit`, `ReceivedDebit`, `TransactionEntry`, and `Transaction`
package/VERSION CHANGED
@@ -1 +1 @@
1
- 9.2.0
1
+ 9.3.0
@@ -0,0 +1,31 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ 'use strict';
4
+
5
+ const StripeResource = require('../../StripeResource');
6
+ const stripeMethod = StripeResource.method;
7
+
8
+ module.exports = StripeResource.extend({
9
+ path: 'apps/secrets',
10
+
11
+ create: stripeMethod({
12
+ method: 'POST',
13
+ path: '',
14
+ }),
15
+
16
+ list: stripeMethod({
17
+ method: 'GET',
18
+ path: '',
19
+ methodType: 'list',
20
+ }),
21
+
22
+ deleteWhere: stripeMethod({
23
+ method: 'POST',
24
+ path: '/delete',
25
+ }),
26
+
27
+ find: stripeMethod({
28
+ method: 'GET',
29
+ path: '/find',
30
+ }),
31
+ });
package/lib/resources.js CHANGED
@@ -55,6 +55,9 @@ module.exports = {
55
55
  Topups: require('./resources/Topups'),
56
56
  Transfers: require('./resources/Transfers'),
57
57
  WebhookEndpoints: require('./resources/WebhookEndpoints'),
58
+ Apps: resourceNamespace('apps', {
59
+ Secrets: require('./resources/Apps/Secrets'),
60
+ }),
58
61
  BillingPortal: resourceNamespace('billingPortal', {
59
62
  Configurations: require('./resources/BillingPortal/Configurations'),
60
63
  Sessions: require('./resources/BillingPortal/Sessions'),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stripe",
3
- "version": "9.2.0",
3
+ "version": "9.3.0",
4
4
  "description": "Stripe API wrapper",
5
5
  "keywords": [
6
6
  "stripe",
@@ -0,0 +1,241 @@
1
+ // File generated from our OpenAPI spec
2
+
3
+ declare module 'stripe' {
4
+ namespace Stripe {
5
+ namespace Apps {
6
+ /**
7
+ * The Secret object.
8
+ */
9
+ interface Secret {
10
+ /**
11
+ * Unique identifier for the object.
12
+ */
13
+ id: string;
14
+
15
+ /**
16
+ * String representing the object's type. Objects of the same type share the same value.
17
+ */
18
+ object: 'apps.secret';
19
+
20
+ /**
21
+ * Time at which the object was created. Measured in seconds since the Unix epoch.
22
+ */
23
+ created: number;
24
+
25
+ /**
26
+ * If true, indicates that this secret has been deleted
27
+ */
28
+ deleted?: boolean;
29
+
30
+ /**
31
+ * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
32
+ */
33
+ livemode: boolean;
34
+
35
+ /**
36
+ * A name for the secret that's unique within the scope.
37
+ */
38
+ name: string;
39
+
40
+ /**
41
+ * The plaintext secret value to be stored.
42
+ */
43
+ payload: string | null;
44
+
45
+ scope: Secret.Scope;
46
+ }
47
+
48
+ namespace Secret {
49
+ interface Scope {
50
+ /**
51
+ * The secret scope type.
52
+ */
53
+ type: Scope.Type;
54
+
55
+ /**
56
+ * The user ID, if type is set to "user"
57
+ */
58
+ user?: string;
59
+ }
60
+
61
+ namespace Scope {
62
+ type Type = 'account' | 'user';
63
+ }
64
+ }
65
+
66
+ interface SecretCreateParams {
67
+ /**
68
+ * A name for the secret that's unique within the scope.
69
+ */
70
+ name: string;
71
+
72
+ /**
73
+ * The plaintext secret value to be stored.
74
+ */
75
+ payload: string;
76
+
77
+ /**
78
+ * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
79
+ */
80
+ scope: SecretCreateParams.Scope;
81
+
82
+ /**
83
+ * Specifies which fields in the response should be expanded.
84
+ */
85
+ expand?: Array<string>;
86
+ }
87
+
88
+ namespace SecretCreateParams {
89
+ interface Scope {
90
+ /**
91
+ * The secret scope type.
92
+ */
93
+ type: Scope.Type;
94
+
95
+ /**
96
+ * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
97
+ */
98
+ user?: string;
99
+ }
100
+
101
+ namespace Scope {
102
+ type Type = 'account' | 'user';
103
+ }
104
+ }
105
+
106
+ interface SecretListParams extends PaginationParams {
107
+ /**
108
+ * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
109
+ */
110
+ scope: SecretListParams.Scope;
111
+
112
+ /**
113
+ * Specifies which fields in the response should be expanded.
114
+ */
115
+ expand?: Array<string>;
116
+ }
117
+
118
+ namespace SecretListParams {
119
+ interface Scope {
120
+ /**
121
+ * The secret scope type.
122
+ */
123
+ type: Scope.Type;
124
+
125
+ /**
126
+ * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
127
+ */
128
+ user?: string;
129
+ }
130
+
131
+ namespace Scope {
132
+ type Type = 'account' | 'user';
133
+ }
134
+ }
135
+
136
+ interface SecretDeleteWhereParams {
137
+ /**
138
+ * A name for the secret that's unique within the scope.
139
+ */
140
+ name: string;
141
+
142
+ /**
143
+ * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
144
+ */
145
+ scope: SecretDeleteWhereParams.Scope;
146
+
147
+ /**
148
+ * Specifies which fields in the response should be expanded.
149
+ */
150
+ expand?: Array<string>;
151
+ }
152
+
153
+ namespace SecretDeleteWhereParams {
154
+ interface Scope {
155
+ /**
156
+ * The secret scope type.
157
+ */
158
+ type: Scope.Type;
159
+
160
+ /**
161
+ * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
162
+ */
163
+ user?: string;
164
+ }
165
+
166
+ namespace Scope {
167
+ type Type = 'account' | 'user';
168
+ }
169
+ }
170
+
171
+ interface SecretFindParams {
172
+ /**
173
+ * A name for the secret that's unique within the scope.
174
+ */
175
+ name: string;
176
+
177
+ /**
178
+ * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
179
+ */
180
+ scope: SecretFindParams.Scope;
181
+
182
+ /**
183
+ * Specifies which fields in the response should be expanded.
184
+ */
185
+ expand?: Array<string>;
186
+ }
187
+
188
+ namespace SecretFindParams {
189
+ interface Scope {
190
+ /**
191
+ * The secret scope type.
192
+ */
193
+ type: Scope.Type;
194
+
195
+ /**
196
+ * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
197
+ */
198
+ user?: string;
199
+ }
200
+
201
+ namespace Scope {
202
+ type Type = 'account' | 'user';
203
+ }
204
+ }
205
+
206
+ class SecretsResource {
207
+ /**
208
+ * Create or replace a secret in the secret store.
209
+ */
210
+ create(
211
+ params: SecretCreateParams,
212
+ options?: RequestOptions
213
+ ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
214
+
215
+ /**
216
+ * List all secrets stored on the given scope.
217
+ */
218
+ list(
219
+ params: SecretListParams,
220
+ options?: RequestOptions
221
+ ): ApiListPromise<Stripe.Apps.Secret>;
222
+
223
+ /**
224
+ * Deletes a secret from the secret store by name and scope.
225
+ */
226
+ deleteWhere(
227
+ params: SecretDeleteWhereParams,
228
+ options?: RequestOptions
229
+ ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
230
+
231
+ /**
232
+ * Finds a secret in the secret store by name and scope.
233
+ */
234
+ find(
235
+ params: SecretFindParams,
236
+ options?: RequestOptions
237
+ ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
238
+ }
239
+ }
240
+ }
241
+ }
@@ -388,6 +388,8 @@ declare module 'stripe' {
388
388
 
389
389
  acss_debit?: PaymentMethodDetails.AcssDebit;
390
390
 
391
+ affirm?: PaymentMethodDetails.Affirm;
392
+
391
393
  afterpay_clearpay?: PaymentMethodDetails.AfterpayClearpay;
392
394
 
393
395
  alipay?: PaymentMethodDetails.Alipay;
@@ -422,6 +424,8 @@ declare module 'stripe' {
422
424
 
423
425
  konbini?: PaymentMethodDetails.Konbini;
424
426
 
427
+ link?: PaymentMethodDetails.Link;
428
+
425
429
  multibanco?: PaymentMethodDetails.Multibanco;
426
430
 
427
431
  oxxo?: PaymentMethodDetails.Oxxo;
@@ -543,6 +547,8 @@ declare module 'stripe' {
543
547
  transit_number: string | null;
544
548
  }
545
549
 
550
+ interface Affirm {}
551
+
546
552
  interface AfterpayClearpay {
547
553
  /**
548
554
  * Order identifier shown to the merchant in Afterpay's online portal.
@@ -1469,6 +1475,8 @@ declare module 'stripe' {
1469
1475
  }
1470
1476
  }
1471
1477
 
1478
+ interface Link {}
1479
+
1472
1480
  interface Multibanco {
1473
1481
  /**
1474
1482
  * Entity number associated with this Multibanco payment.
@@ -810,6 +810,7 @@ declare module 'stripe' {
810
810
  namespace CustomerListPaymentMethodsParams {
811
811
  type Type =
812
812
  | 'acss_debit'
813
+ | 'affirm'
813
814
  | 'afterpay_clearpay'
814
815
  | 'alipay'
815
816
  | 'au_becs_debit'
@@ -826,6 +827,7 @@ declare module 'stripe' {
826
827
  | 'ideal'
827
828
  | 'klarna'
828
829
  | 'konbini'
830
+ | 'link'
829
831
  | 'oxxo'
830
832
  | 'p24'
831
833
  | 'paynow'
@@ -745,6 +745,7 @@ declare module 'stripe' {
745
745
  | 'grabpay'
746
746
  | 'ideal'
747
747
  | 'konbini'
748
+ | 'link'
748
749
  | 'paynow'
749
750
  | 'sepa_credit_transfer'
750
751
  | 'sepa_debit'
@@ -1193,6 +1194,7 @@ declare module 'stripe' {
1193
1194
  | 'grabpay'
1194
1195
  | 'ideal'
1195
1196
  | 'konbini'
1197
+ | 'link'
1196
1198
  | 'paynow'
1197
1199
  | 'sepa_credit_transfer'
1198
1200
  | 'sepa_debit'
@@ -1533,6 +1535,7 @@ declare module 'stripe' {
1533
1535
  | 'grabpay'
1534
1536
  | 'ideal'
1535
1537
  | 'konbini'
1538
+ | 'link'
1536
1539
  | 'paynow'
1537
1540
  | 'sepa_credit_transfer'
1538
1541
  | 'sepa_debit'
@@ -91,6 +91,8 @@ declare module 'stripe' {
91
91
 
92
92
  card?: PaymentMethodDetails.Card;
93
93
 
94
+ link?: PaymentMethodDetails.Link;
95
+
94
96
  sepa_debit?: PaymentMethodDetails.SepaDebit;
95
97
 
96
98
  /**
@@ -162,6 +164,8 @@ declare module 'stripe' {
162
164
 
163
165
  interface Card {}
164
166
 
167
+ interface Link {}
168
+
165
169
  interface SepaDebit {
166
170
  /**
167
171
  * The unique reference of the mandate.
@@ -1161,6 +1161,11 @@ declare module 'stripe' {
1161
1161
  */
1162
1162
  klarna?: PaymentMethodOptions.Klarna;
1163
1163
 
1164
+ /**
1165
+ * If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.
1166
+ */
1167
+ link?: PaymentMethodOptions.Link;
1168
+
1164
1169
  /**
1165
1170
  * If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.
1166
1171
  */
@@ -1464,6 +1469,37 @@ declare module 'stripe' {
1464
1469
  | 'sv-SE';
1465
1470
  }
1466
1471
 
1472
+ interface Link {
1473
+ /**
1474
+ * Controls when the funds will be captured from the customer's account.
1475
+ *
1476
+ * If provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.
1477
+ *
1478
+ * If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.
1479
+ */
1480
+ capture_method?: Stripe.Emptyable<'manual'>;
1481
+
1482
+ /**
1483
+ * Token used for persistent Link logins.
1484
+ */
1485
+ persistent_token?: string;
1486
+
1487
+ /**
1488
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1489
+ *
1490
+ * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
1491
+ *
1492
+ * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
1493
+ *
1494
+ * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
1495
+ */
1496
+ setup_future_usage?: Stripe.Emptyable<Link.SetupFutureUsage>;
1497
+ }
1498
+
1499
+ namespace Link {
1500
+ type SetupFutureUsage = 'none' | 'off_session';
1501
+ }
1502
+
1467
1503
  interface Oxxo {
1468
1504
  /**
1469
1505
  * The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
@@ -2145,6 +2181,11 @@ declare module 'stripe' {
2145
2181
  */
2146
2182
  klarna?: Stripe.Emptyable<PaymentMethodOptions.Klarna>;
2147
2183
 
2184
+ /**
2185
+ * If paying by `link`, this sub-hash contains details about the Link payment method options to pass to the order's PaymentIntent.
2186
+ */
2187
+ link?: Stripe.Emptyable<PaymentMethodOptions.Link>;
2188
+
2148
2189
  /**
2149
2190
  * If paying by `oxxo`, this sub-hash contains details about the OXXO payment method options to pass to the order's PaymentIntent.
2150
2191
  */
@@ -2448,6 +2489,37 @@ declare module 'stripe' {
2448
2489
  | 'sv-SE';
2449
2490
  }
2450
2491
 
2492
+ interface Link {
2493
+ /**
2494
+ * Controls when the funds will be captured from the customer's account.
2495
+ *
2496
+ * If provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.
2497
+ *
2498
+ * If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.
2499
+ */
2500
+ capture_method?: Stripe.Emptyable<'manual'>;
2501
+
2502
+ /**
2503
+ * Token used for persistent Link logins.
2504
+ */
2505
+ persistent_token?: string;
2506
+
2507
+ /**
2508
+ * Indicates that you intend to make future payments with this PaymentIntent's payment method.
2509
+ *
2510
+ * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.
2511
+ *
2512
+ * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
2513
+ *
2514
+ * If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
2515
+ */
2516
+ setup_future_usage?: Stripe.Emptyable<Link.SetupFutureUsage>;
2517
+ }
2518
+
2519
+ namespace Link {
2520
+ type SetupFutureUsage = 'none' | 'off_session';
2521
+ }
2522
+
2451
2523
  interface Oxxo {
2452
2524
  /**
2453
2525
  * The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.