stripe 18.4.0-beta.2 → 18.5.0-beta.1
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 +39 -10
- package/OPENAPI_VERSION +1 -1
- package/VERSION +1 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/Billing/MeterUsage.js +12 -0
- package/cjs/resources/Terminal/OnboardingLinks.js +12 -0
- package/cjs/resources.js +4 -0
- package/cjs/stripe.core.js +2 -1
- package/esm/apiVersion.js +1 -1
- package/esm/resources/Billing/MeterUsage.js +9 -0
- package/esm/resources/Terminal/OnboardingLinks.js +9 -0
- package/esm/resources.js +4 -0
- package/esm/stripe.core.js +2 -1
- package/package.json +1 -1
- package/types/AccountLinksResource.d.ts +3 -1
- package/types/AccountSessions.d.ts +30 -0
- package/types/AccountSessionsResource.d.ts +36 -0
- package/types/Accounts.d.ts +1 -1
- package/types/AccountsResource.d.ts +3 -3
- package/types/BalanceSettings.d.ts +6 -4
- package/types/BalanceSettingsResource.d.ts +8 -6
- package/types/Billing/CreditGrantsResource.d.ts +1 -1
- package/types/Billing/MeterUsage.d.ts +32 -0
- package/types/Billing/MeterUsageResource.d.ts +685 -0
- package/types/Billing/MeterUsageRows.d.ts +49 -0
- package/types/BillingPortal/Configurations.d.ts +21 -0
- package/types/BillingPortal/ConfigurationsResource.d.ts +48 -0
- package/types/Capabilities.d.ts +1 -6
- package/types/Charges.d.ts +10 -5
- package/types/Checkout/Sessions.d.ts +24 -1
- package/types/Checkout/SessionsResource.d.ts +108 -0
- package/types/ConfirmationTokens.d.ts +3 -3
- package/types/Customers.d.ts +1 -1
- package/types/Disputes.d.ts +23 -1
- package/types/Events.d.ts +14 -26
- package/types/FxQuotes.d.ts +6 -4
- package/types/Identity/VerificationSessions.d.ts +2 -2
- package/types/InvoiceItemsResource.d.ts +1 -1
- package/types/Invoices.d.ts +38 -0
- package/types/InvoicesResource.d.ts +115 -6
- package/types/PaymentAttemptRecords.d.ts +9 -4
- package/types/PaymentIntents.d.ts +1 -1
- package/types/PaymentIntentsResource.d.ts +966 -40
- package/types/PaymentLinks.d.ts +5 -0
- package/types/PaymentLinksResource.d.ts +102 -3
- package/types/PaymentMethods.d.ts +3 -3
- package/types/PaymentMethodsResource.d.ts +1 -1
- package/types/PaymentRecords.d.ts +9 -4
- package/types/QuotePreviewInvoices.d.ts +38 -0
- package/types/QuotesResource.d.ts +3 -0
- package/types/Radar/ValueLists.d.ts +1 -1
- package/types/Radar/ValueListsResource.d.ts +1 -1
- package/types/Refunds.d.ts +1 -1
- package/types/Reporting/ReportRunsResource.d.ts +1 -0
- package/types/Reviews.d.ts +2 -2
- package/types/SetupAttempts.d.ts +1 -1
- package/types/SubscriptionItemsResource.d.ts +2 -2
- package/types/SubscriptionSchedulesResource.d.ts +47 -2
- package/types/Subscriptions.d.ts +38 -0
- package/types/SubscriptionsResource.d.ts +86 -1
- package/types/Tax/Registrations.d.ts +228 -27
- package/types/Tax/RegistrationsResource.d.ts +648 -27
- package/types/Terminal/Configurations.d.ts +76 -0
- package/types/Terminal/ConfigurationsResource.d.ts +176 -0
- package/types/Terminal/OnboardingLinks.d.ts +57 -0
- package/types/Terminal/OnboardingLinksResource.d.ts +62 -0
- package/types/V2/Core/AccountLinks.d.ts +66 -4
- package/types/V2/Core/AccountLinksResource.d.ts +65 -3
- package/types/V2/Core/Accounts.d.ts +22 -0
- package/types/V2/Core/AccountsResource.d.ts +44 -0
- package/types/V2/EventTypes.d.ts +32 -25
- package/types/V2/MoneyManagement/PayoutMethods.d.ts +9 -0
- package/types/V2/Payments/OffSessionPayments.d.ts +40 -23
- package/types/V2/Payments/OffSessionPaymentsResource.d.ts +34 -19
- package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +2 -0
- package/types/WebhookEndpointsResource.d.ts +2 -1
- package/types/index.d.ts +7 -0
- package/types/lib.d.ts +2 -1
- package/types/test/typescriptTest.ts +3 -3
|
@@ -88,8 +88,12 @@ declare module 'stripe' {
|
|
|
88
88
|
}
|
|
89
89
|
|
|
90
90
|
interface Tipping {
|
|
91
|
+
aed?: Tipping.Aed;
|
|
92
|
+
|
|
91
93
|
aud?: Tipping.Aud;
|
|
92
94
|
|
|
95
|
+
bgn?: Tipping.Bgn;
|
|
96
|
+
|
|
93
97
|
cad?: Tipping.Cad;
|
|
94
98
|
|
|
95
99
|
chf?: Tipping.Chf;
|
|
@@ -104,6 +108,8 @@ declare module 'stripe' {
|
|
|
104
108
|
|
|
105
109
|
hkd?: Tipping.Hkd;
|
|
106
110
|
|
|
111
|
+
huf?: Tipping.Huf;
|
|
112
|
+
|
|
107
113
|
jpy?: Tipping.Jpy;
|
|
108
114
|
|
|
109
115
|
myr?: Tipping.Myr;
|
|
@@ -114,6 +120,8 @@ declare module 'stripe' {
|
|
|
114
120
|
|
|
115
121
|
pln?: Tipping.Pln;
|
|
116
122
|
|
|
123
|
+
ron?: Tipping.Ron;
|
|
124
|
+
|
|
117
125
|
sek?: Tipping.Sek;
|
|
118
126
|
|
|
119
127
|
sgd?: Tipping.Sgd;
|
|
@@ -122,6 +130,23 @@ declare module 'stripe' {
|
|
|
122
130
|
}
|
|
123
131
|
|
|
124
132
|
namespace Tipping {
|
|
133
|
+
interface Aed {
|
|
134
|
+
/**
|
|
135
|
+
* Fixed amounts displayed when collecting a tip
|
|
136
|
+
*/
|
|
137
|
+
fixed_amounts?: Array<number> | null;
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Percentages displayed when collecting a tip
|
|
141
|
+
*/
|
|
142
|
+
percentages?: Array<number> | null;
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
146
|
+
*/
|
|
147
|
+
smart_tip_threshold?: number;
|
|
148
|
+
}
|
|
149
|
+
|
|
125
150
|
interface Aud {
|
|
126
151
|
/**
|
|
127
152
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -139,6 +164,23 @@ declare module 'stripe' {
|
|
|
139
164
|
smart_tip_threshold?: number;
|
|
140
165
|
}
|
|
141
166
|
|
|
167
|
+
interface Bgn {
|
|
168
|
+
/**
|
|
169
|
+
* Fixed amounts displayed when collecting a tip
|
|
170
|
+
*/
|
|
171
|
+
fixed_amounts?: Array<number> | null;
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Percentages displayed when collecting a tip
|
|
175
|
+
*/
|
|
176
|
+
percentages?: Array<number> | null;
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
180
|
+
*/
|
|
181
|
+
smart_tip_threshold?: number;
|
|
182
|
+
}
|
|
183
|
+
|
|
142
184
|
interface Cad {
|
|
143
185
|
/**
|
|
144
186
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -258,6 +300,23 @@ declare module 'stripe' {
|
|
|
258
300
|
smart_tip_threshold?: number;
|
|
259
301
|
}
|
|
260
302
|
|
|
303
|
+
interface Huf {
|
|
304
|
+
/**
|
|
305
|
+
* Fixed amounts displayed when collecting a tip
|
|
306
|
+
*/
|
|
307
|
+
fixed_amounts?: Array<number> | null;
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* Percentages displayed when collecting a tip
|
|
311
|
+
*/
|
|
312
|
+
percentages?: Array<number> | null;
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
316
|
+
*/
|
|
317
|
+
smart_tip_threshold?: number;
|
|
318
|
+
}
|
|
319
|
+
|
|
261
320
|
interface Jpy {
|
|
262
321
|
/**
|
|
263
322
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -343,6 +402,23 @@ declare module 'stripe' {
|
|
|
343
402
|
smart_tip_threshold?: number;
|
|
344
403
|
}
|
|
345
404
|
|
|
405
|
+
interface Ron {
|
|
406
|
+
/**
|
|
407
|
+
* Fixed amounts displayed when collecting a tip
|
|
408
|
+
*/
|
|
409
|
+
fixed_amounts?: Array<number> | null;
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Percentages displayed when collecting a tip
|
|
413
|
+
*/
|
|
414
|
+
percentages?: Array<number> | null;
|
|
415
|
+
|
|
416
|
+
/**
|
|
417
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
418
|
+
*/
|
|
419
|
+
smart_tip_threshold?: number;
|
|
420
|
+
}
|
|
421
|
+
|
|
346
422
|
interface Sek {
|
|
347
423
|
/**
|
|
348
424
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -85,11 +85,21 @@ declare module 'stripe' {
|
|
|
85
85
|
}
|
|
86
86
|
|
|
87
87
|
interface Tipping {
|
|
88
|
+
/**
|
|
89
|
+
* Tipping configuration for AED
|
|
90
|
+
*/
|
|
91
|
+
aed?: Tipping.Aed;
|
|
92
|
+
|
|
88
93
|
/**
|
|
89
94
|
* Tipping configuration for AUD
|
|
90
95
|
*/
|
|
91
96
|
aud?: Tipping.Aud;
|
|
92
97
|
|
|
98
|
+
/**
|
|
99
|
+
* Tipping configuration for BGN
|
|
100
|
+
*/
|
|
101
|
+
bgn?: Tipping.Bgn;
|
|
102
|
+
|
|
93
103
|
/**
|
|
94
104
|
* Tipping configuration for CAD
|
|
95
105
|
*/
|
|
@@ -125,6 +135,11 @@ declare module 'stripe' {
|
|
|
125
135
|
*/
|
|
126
136
|
hkd?: Tipping.Hkd;
|
|
127
137
|
|
|
138
|
+
/**
|
|
139
|
+
* Tipping configuration for HUF
|
|
140
|
+
*/
|
|
141
|
+
huf?: Tipping.Huf;
|
|
142
|
+
|
|
128
143
|
/**
|
|
129
144
|
* Tipping configuration for JPY
|
|
130
145
|
*/
|
|
@@ -150,6 +165,11 @@ declare module 'stripe' {
|
|
|
150
165
|
*/
|
|
151
166
|
pln?: Tipping.Pln;
|
|
152
167
|
|
|
168
|
+
/**
|
|
169
|
+
* Tipping configuration for RON
|
|
170
|
+
*/
|
|
171
|
+
ron?: Tipping.Ron;
|
|
172
|
+
|
|
153
173
|
/**
|
|
154
174
|
* Tipping configuration for SEK
|
|
155
175
|
*/
|
|
@@ -167,6 +187,23 @@ declare module 'stripe' {
|
|
|
167
187
|
}
|
|
168
188
|
|
|
169
189
|
namespace Tipping {
|
|
190
|
+
interface Aed {
|
|
191
|
+
/**
|
|
192
|
+
* Fixed amounts displayed when collecting a tip
|
|
193
|
+
*/
|
|
194
|
+
fixed_amounts?: Array<number>;
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Percentages displayed when collecting a tip
|
|
198
|
+
*/
|
|
199
|
+
percentages?: Array<number>;
|
|
200
|
+
|
|
201
|
+
/**
|
|
202
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
203
|
+
*/
|
|
204
|
+
smart_tip_threshold?: number;
|
|
205
|
+
}
|
|
206
|
+
|
|
170
207
|
interface Aud {
|
|
171
208
|
/**
|
|
172
209
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -184,6 +221,23 @@ declare module 'stripe' {
|
|
|
184
221
|
smart_tip_threshold?: number;
|
|
185
222
|
}
|
|
186
223
|
|
|
224
|
+
interface Bgn {
|
|
225
|
+
/**
|
|
226
|
+
* Fixed amounts displayed when collecting a tip
|
|
227
|
+
*/
|
|
228
|
+
fixed_amounts?: Array<number>;
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Percentages displayed when collecting a tip
|
|
232
|
+
*/
|
|
233
|
+
percentages?: Array<number>;
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
237
|
+
*/
|
|
238
|
+
smart_tip_threshold?: number;
|
|
239
|
+
}
|
|
240
|
+
|
|
187
241
|
interface Cad {
|
|
188
242
|
/**
|
|
189
243
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -303,6 +357,23 @@ declare module 'stripe' {
|
|
|
303
357
|
smart_tip_threshold?: number;
|
|
304
358
|
}
|
|
305
359
|
|
|
360
|
+
interface Huf {
|
|
361
|
+
/**
|
|
362
|
+
* Fixed amounts displayed when collecting a tip
|
|
363
|
+
*/
|
|
364
|
+
fixed_amounts?: Array<number>;
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* Percentages displayed when collecting a tip
|
|
368
|
+
*/
|
|
369
|
+
percentages?: Array<number>;
|
|
370
|
+
|
|
371
|
+
/**
|
|
372
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
373
|
+
*/
|
|
374
|
+
smart_tip_threshold?: number;
|
|
375
|
+
}
|
|
376
|
+
|
|
306
377
|
interface Jpy {
|
|
307
378
|
/**
|
|
308
379
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -388,6 +459,23 @@ declare module 'stripe' {
|
|
|
388
459
|
smart_tip_threshold?: number;
|
|
389
460
|
}
|
|
390
461
|
|
|
462
|
+
interface Ron {
|
|
463
|
+
/**
|
|
464
|
+
* Fixed amounts displayed when collecting a tip
|
|
465
|
+
*/
|
|
466
|
+
fixed_amounts?: Array<number>;
|
|
467
|
+
|
|
468
|
+
/**
|
|
469
|
+
* Percentages displayed when collecting a tip
|
|
470
|
+
*/
|
|
471
|
+
percentages?: Array<number>;
|
|
472
|
+
|
|
473
|
+
/**
|
|
474
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
475
|
+
*/
|
|
476
|
+
smart_tip_threshold?: number;
|
|
477
|
+
}
|
|
478
|
+
|
|
391
479
|
interface Sek {
|
|
392
480
|
/**
|
|
393
481
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -633,11 +721,21 @@ declare module 'stripe' {
|
|
|
633
721
|
}
|
|
634
722
|
|
|
635
723
|
interface Tipping {
|
|
724
|
+
/**
|
|
725
|
+
* Tipping configuration for AED
|
|
726
|
+
*/
|
|
727
|
+
aed?: Tipping.Aed;
|
|
728
|
+
|
|
636
729
|
/**
|
|
637
730
|
* Tipping configuration for AUD
|
|
638
731
|
*/
|
|
639
732
|
aud?: Tipping.Aud;
|
|
640
733
|
|
|
734
|
+
/**
|
|
735
|
+
* Tipping configuration for BGN
|
|
736
|
+
*/
|
|
737
|
+
bgn?: Tipping.Bgn;
|
|
738
|
+
|
|
641
739
|
/**
|
|
642
740
|
* Tipping configuration for CAD
|
|
643
741
|
*/
|
|
@@ -673,6 +771,11 @@ declare module 'stripe' {
|
|
|
673
771
|
*/
|
|
674
772
|
hkd?: Tipping.Hkd;
|
|
675
773
|
|
|
774
|
+
/**
|
|
775
|
+
* Tipping configuration for HUF
|
|
776
|
+
*/
|
|
777
|
+
huf?: Tipping.Huf;
|
|
778
|
+
|
|
676
779
|
/**
|
|
677
780
|
* Tipping configuration for JPY
|
|
678
781
|
*/
|
|
@@ -698,6 +801,11 @@ declare module 'stripe' {
|
|
|
698
801
|
*/
|
|
699
802
|
pln?: Tipping.Pln;
|
|
700
803
|
|
|
804
|
+
/**
|
|
805
|
+
* Tipping configuration for RON
|
|
806
|
+
*/
|
|
807
|
+
ron?: Tipping.Ron;
|
|
808
|
+
|
|
701
809
|
/**
|
|
702
810
|
* Tipping configuration for SEK
|
|
703
811
|
*/
|
|
@@ -715,6 +823,23 @@ declare module 'stripe' {
|
|
|
715
823
|
}
|
|
716
824
|
|
|
717
825
|
namespace Tipping {
|
|
826
|
+
interface Aed {
|
|
827
|
+
/**
|
|
828
|
+
* Fixed amounts displayed when collecting a tip
|
|
829
|
+
*/
|
|
830
|
+
fixed_amounts?: Array<number>;
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* Percentages displayed when collecting a tip
|
|
834
|
+
*/
|
|
835
|
+
percentages?: Array<number>;
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
839
|
+
*/
|
|
840
|
+
smart_tip_threshold?: number;
|
|
841
|
+
}
|
|
842
|
+
|
|
718
843
|
interface Aud {
|
|
719
844
|
/**
|
|
720
845
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -732,6 +857,23 @@ declare module 'stripe' {
|
|
|
732
857
|
smart_tip_threshold?: number;
|
|
733
858
|
}
|
|
734
859
|
|
|
860
|
+
interface Bgn {
|
|
861
|
+
/**
|
|
862
|
+
* Fixed amounts displayed when collecting a tip
|
|
863
|
+
*/
|
|
864
|
+
fixed_amounts?: Array<number>;
|
|
865
|
+
|
|
866
|
+
/**
|
|
867
|
+
* Percentages displayed when collecting a tip
|
|
868
|
+
*/
|
|
869
|
+
percentages?: Array<number>;
|
|
870
|
+
|
|
871
|
+
/**
|
|
872
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
873
|
+
*/
|
|
874
|
+
smart_tip_threshold?: number;
|
|
875
|
+
}
|
|
876
|
+
|
|
735
877
|
interface Cad {
|
|
736
878
|
/**
|
|
737
879
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -851,6 +993,23 @@ declare module 'stripe' {
|
|
|
851
993
|
smart_tip_threshold?: number;
|
|
852
994
|
}
|
|
853
995
|
|
|
996
|
+
interface Huf {
|
|
997
|
+
/**
|
|
998
|
+
* Fixed amounts displayed when collecting a tip
|
|
999
|
+
*/
|
|
1000
|
+
fixed_amounts?: Array<number>;
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* Percentages displayed when collecting a tip
|
|
1004
|
+
*/
|
|
1005
|
+
percentages?: Array<number>;
|
|
1006
|
+
|
|
1007
|
+
/**
|
|
1008
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
1009
|
+
*/
|
|
1010
|
+
smart_tip_threshold?: number;
|
|
1011
|
+
}
|
|
1012
|
+
|
|
854
1013
|
interface Jpy {
|
|
855
1014
|
/**
|
|
856
1015
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -936,6 +1095,23 @@ declare module 'stripe' {
|
|
|
936
1095
|
smart_tip_threshold?: number;
|
|
937
1096
|
}
|
|
938
1097
|
|
|
1098
|
+
interface Ron {
|
|
1099
|
+
/**
|
|
1100
|
+
* Fixed amounts displayed when collecting a tip
|
|
1101
|
+
*/
|
|
1102
|
+
fixed_amounts?: Array<number>;
|
|
1103
|
+
|
|
1104
|
+
/**
|
|
1105
|
+
* Percentages displayed when collecting a tip
|
|
1106
|
+
*/
|
|
1107
|
+
percentages?: Array<number>;
|
|
1108
|
+
|
|
1109
|
+
/**
|
|
1110
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
1111
|
+
*/
|
|
1112
|
+
smart_tip_threshold?: number;
|
|
1113
|
+
}
|
|
1114
|
+
|
|
939
1115
|
interface Sek {
|
|
940
1116
|
/**
|
|
941
1117
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec
|
|
2
|
+
|
|
3
|
+
declare module 'stripe' {
|
|
4
|
+
namespace Stripe {
|
|
5
|
+
namespace Terminal {
|
|
6
|
+
/**
|
|
7
|
+
* Returns redirect links used for onboarding onto Tap to Pay on iPhone.
|
|
8
|
+
*/
|
|
9
|
+
interface OnboardingLink {
|
|
10
|
+
object: 'terminal.onboarding_link';
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Link type options associated with the current onboarding link object.
|
|
14
|
+
*/
|
|
15
|
+
link_options: OnboardingLink.LinkOptions;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* The type of link being generated.
|
|
19
|
+
*/
|
|
20
|
+
link_type: 'apple_terms_and_conditions';
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Stripe account ID to generate the link for.
|
|
24
|
+
*/
|
|
25
|
+
on_behalf_of: string | null;
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* The link passed back to the user for their onboarding.
|
|
29
|
+
*/
|
|
30
|
+
redirect_url: string;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
namespace OnboardingLink {
|
|
34
|
+
interface LinkOptions {
|
|
35
|
+
/**
|
|
36
|
+
* The options associated with the Apple Terms and Conditions link type.
|
|
37
|
+
*/
|
|
38
|
+
apple_terms_and_conditions: LinkOptions.AppleTermsAndConditions | null;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
namespace LinkOptions {
|
|
42
|
+
interface AppleTermsAndConditions {
|
|
43
|
+
/**
|
|
44
|
+
* Whether the link should also support users relinking their Apple account.
|
|
45
|
+
*/
|
|
46
|
+
allow_relinking: boolean | null;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* The business name of the merchant accepting Apple's Terms and Conditions.
|
|
50
|
+
*/
|
|
51
|
+
merchant_display_name: string;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec
|
|
2
|
+
|
|
3
|
+
declare module 'stripe' {
|
|
4
|
+
namespace Stripe {
|
|
5
|
+
namespace Terminal {
|
|
6
|
+
interface OnboardingLinkCreateParams {
|
|
7
|
+
/**
|
|
8
|
+
* Specific fields needed to generate the desired link type.
|
|
9
|
+
*/
|
|
10
|
+
link_options: OnboardingLinkCreateParams.LinkOptions;
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* The type of link being generated.
|
|
14
|
+
*/
|
|
15
|
+
link_type: 'apple_terms_and_conditions';
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Specifies which fields in the response should be expanded.
|
|
19
|
+
*/
|
|
20
|
+
expand?: Array<string>;
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Stripe account ID to generate the link for.
|
|
24
|
+
*/
|
|
25
|
+
on_behalf_of?: string;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
namespace OnboardingLinkCreateParams {
|
|
29
|
+
interface LinkOptions {
|
|
30
|
+
/**
|
|
31
|
+
* The options associated with the Apple Terms and Conditions link type.
|
|
32
|
+
*/
|
|
33
|
+
apple_terms_and_conditions?: LinkOptions.AppleTermsAndConditions;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
namespace LinkOptions {
|
|
37
|
+
interface AppleTermsAndConditions {
|
|
38
|
+
/**
|
|
39
|
+
* Whether the link should also support users relinking their Apple account.
|
|
40
|
+
*/
|
|
41
|
+
allow_relinking?: boolean;
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* The business name of the merchant accepting Apple's Terms and Conditions.
|
|
45
|
+
*/
|
|
46
|
+
merchant_display_name: string;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
class OnboardingLinksResource {
|
|
52
|
+
/**
|
|
53
|
+
* Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
|
|
54
|
+
*/
|
|
55
|
+
create(
|
|
56
|
+
params: OnboardingLinkCreateParams,
|
|
57
|
+
options?: RequestOptions
|
|
58
|
+
): Promise<Stripe.Response<Stripe.Terminal.OnboardingLink>>;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
@@ -5,7 +5,7 @@ declare module 'stripe' {
|
|
|
5
5
|
namespace V2 {
|
|
6
6
|
namespace Core {
|
|
7
7
|
/**
|
|
8
|
-
* AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users enrolled in the public preview for
|
|
8
|
+
* AccountLinks are the means by which a Merchant grants an Account permission to access Stripe-hosted applications, such as Recipient Onboarding. This API is only available for users enrolled in the public preview for Accounts v2.
|
|
9
9
|
*/
|
|
10
10
|
interface AccountLink {
|
|
11
11
|
/**
|
|
@@ -65,9 +65,14 @@ declare module 'stripe' {
|
|
|
65
65
|
namespace UseCase {
|
|
66
66
|
interface AccountOnboarding {
|
|
67
67
|
/**
|
|
68
|
-
*
|
|
68
|
+
* Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
|
|
69
|
+
*/
|
|
70
|
+
collection_options: AccountOnboarding.CollectionOptions | null;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
|
|
69
74
|
*/
|
|
70
|
-
configurations: Array<
|
|
75
|
+
configurations: Array<AccountOnboarding.Configuration>;
|
|
71
76
|
|
|
72
77
|
/**
|
|
73
78
|
* The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
|
|
@@ -80,11 +85,42 @@ declare module 'stripe' {
|
|
|
80
85
|
return_url: string | null;
|
|
81
86
|
}
|
|
82
87
|
|
|
88
|
+
namespace AccountOnboarding {
|
|
89
|
+
interface CollectionOptions {
|
|
90
|
+
/**
|
|
91
|
+
* Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
|
|
92
|
+
*/
|
|
93
|
+
fields: CollectionOptions.Fields | null;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
|
|
97
|
+
*/
|
|
98
|
+
future_requirements: CollectionOptions.FutureRequirements | null;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
namespace CollectionOptions {
|
|
102
|
+
type Fields = 'currently_due' | 'eventually_due';
|
|
103
|
+
|
|
104
|
+
type FutureRequirements = 'include' | 'omit';
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
type Configuration =
|
|
108
|
+
| 'customer'
|
|
109
|
+
| 'merchant'
|
|
110
|
+
| 'recipient'
|
|
111
|
+
| 'storer';
|
|
112
|
+
}
|
|
113
|
+
|
|
83
114
|
interface AccountUpdate {
|
|
115
|
+
/**
|
|
116
|
+
* Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
|
|
117
|
+
*/
|
|
118
|
+
collection_options: AccountUpdate.CollectionOptions | null;
|
|
119
|
+
|
|
84
120
|
/**
|
|
85
121
|
* Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
|
|
86
122
|
*/
|
|
87
|
-
configurations: Array<
|
|
123
|
+
configurations: Array<AccountUpdate.Configuration>;
|
|
88
124
|
|
|
89
125
|
/**
|
|
90
126
|
* The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
|
|
@@ -97,6 +133,32 @@ declare module 'stripe' {
|
|
|
97
133
|
return_url: string | null;
|
|
98
134
|
}
|
|
99
135
|
|
|
136
|
+
namespace AccountUpdate {
|
|
137
|
+
interface CollectionOptions {
|
|
138
|
+
/**
|
|
139
|
+
* Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify collection_options, the default value is currently_due.
|
|
140
|
+
*/
|
|
141
|
+
fields: CollectionOptions.Fields | null;
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
|
|
145
|
+
*/
|
|
146
|
+
future_requirements: CollectionOptions.FutureRequirements | null;
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
namespace CollectionOptions {
|
|
150
|
+
type Fields = 'currently_due' | 'eventually_due';
|
|
151
|
+
|
|
152
|
+
type FutureRequirements = 'include' | 'omit';
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
type Configuration =
|
|
156
|
+
| 'customer'
|
|
157
|
+
| 'merchant'
|
|
158
|
+
| 'recipient'
|
|
159
|
+
| 'storer';
|
|
160
|
+
}
|
|
161
|
+
|
|
100
162
|
type Type = 'account_onboarding' | 'account_update';
|
|
101
163
|
}
|
|
102
164
|
}
|