stripe 17.2.1 → 17.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 +38 -0
- package/VERSION +1 -1
- package/cjs/apiVersion.js +1 -1
- package/cjs/resources/TestHelpers/Issuing/Cards.js +4 -0
- package/cjs/resources/V2/Core/EventDestinations.js +41 -0
- package/cjs/resources/V2/Core.js +2 -0
- package/cjs/stripe.core.js +1 -1
- package/esm/apiVersion.js +1 -1
- package/esm/resources/TestHelpers/Issuing/Cards.js +4 -0
- package/esm/resources/V2/Core/EventDestinations.js +38 -0
- package/esm/resources/V2/Core.js +2 -0
- package/esm/stripe.core.js +1 -1
- package/package.json +1 -1
- package/types/AccountSessions.d.ts +30 -5
- package/types/AccountSessionsResource.d.ts +30 -5
- package/types/Accounts.d.ts +56 -2
- package/types/AccountsResource.d.ts +171 -3
- package/types/Billing/CreditBalanceSummary.d.ts +4 -4
- package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
- package/types/Billing/CreditBalanceTransactions.d.ts +10 -10
- package/types/Billing/CreditGrants.d.ts +11 -8
- package/types/Billing/CreditGrantsResource.d.ts +6 -6
- package/types/Billing/Meters.d.ts +2 -0
- package/types/BillingPortal/Configurations.d.ts +22 -0
- package/types/BillingPortal/ConfigurationsResource.d.ts +56 -4
- package/types/Charges.d.ts +85 -0
- package/types/Checkout/Sessions.d.ts +82 -1
- package/types/Checkout/SessionsResource.d.ts +86 -0
- package/types/ConfirmationTokens.d.ts +75 -0
- package/types/CreditNoteLineItems.d.ts +3 -0
- package/types/CreditNotes.d.ts +3 -0
- package/types/CreditNotesResource.d.ts +3 -3
- package/types/CustomersResource.d.ts +21 -3
- package/types/Disputes.d.ts +152 -0
- package/types/DisputesResource.d.ts +120 -0
- package/types/EventTypes.d.ts +37 -2
- package/types/Events.d.ts +2 -0
- package/types/Forwarding/Requests.d.ts +5 -0
- package/types/Forwarding/RequestsResource.d.ts +5 -0
- package/types/InvoiceLineItems.d.ts +3 -0
- package/types/Invoices.d.ts +15 -1
- package/types/InvoicesResource.d.ts +44 -3
- package/types/Issuing/CardsResource.d.ts +1 -1
- package/types/Mandates.d.ts +8 -0
- package/types/PaymentIntents.d.ts +84 -0
- package/types/PaymentIntentsResource.d.ts +554 -7
- package/types/PaymentLinks.d.ts +1 -0
- package/types/PaymentLinksResource.d.ts +2 -0
- package/types/PaymentMethodConfigurations.d.ts +36 -0
- package/types/PaymentMethodConfigurationsResource.d.ts +52 -2
- package/types/PaymentMethodDomains.d.ts +28 -0
- package/types/PaymentMethods.d.ts +75 -0
- package/types/PaymentMethodsResource.d.ts +80 -1
- package/types/Persons.d.ts +1 -1
- package/types/Refunds.d.ts +5 -4
- package/types/SetupAttempts.d.ts +8 -0
- package/types/SetupIntentsResource.d.ts +174 -3
- package/types/Subscriptions.d.ts +5 -0
- package/types/SubscriptionsResource.d.ts +12 -2
- package/types/Tax/CalculationLineItems.d.ts +1 -0
- package/types/Tax/Calculations.d.ts +33 -1
- package/types/Tax/CalculationsResource.d.ts +7 -1
- package/types/Tax/Registrations.d.ts +82 -0
- package/types/Tax/RegistrationsResource.d.ts +109 -0
- package/types/Tax/Transactions.d.ts +8 -1
- package/types/TaxIds.d.ts +7 -1
- package/types/TaxIdsResource.d.ts +7 -1
- package/types/TaxRates.d.ts +25 -0
- package/types/TaxRatesResource.d.ts +2 -0
- package/types/Terminal/Configurations.d.ts +19 -0
- package/types/Terminal/ConfigurationsResource.d.ts +44 -0
- package/types/TestHelpers/ConfirmationTokensResource.d.ts +58 -1
- package/types/TestHelpers/Issuing/CardsResource.d.ts +22 -0
- package/types/TokensResource.d.ts +2 -2
- package/types/Treasury/FinancialAccounts.d.ts +1 -1
- package/types/UsageRecordSummaries.d.ts +1 -1
- package/types/V2/Core/EventDestinationsResource.d.ts +281 -0
- package/types/V2/Core/EventsResource.d.ts +1 -1
- package/types/V2/CoreResource.d.ts +1 -0
- package/types/V2/EventDestinations.d.ts +164 -0
- package/types/WebhookEndpointsResource.d.ts +6 -1
- package/types/index.d.ts +2 -0
|
@@ -135,6 +135,11 @@ declare module 'stripe' {
|
|
|
135
135
|
*/
|
|
136
136
|
nzd?: Tipping.Nzd;
|
|
137
137
|
|
|
138
|
+
/**
|
|
139
|
+
* Tipping configuration for PLN
|
|
140
|
+
*/
|
|
141
|
+
pln?: Tipping.Pln;
|
|
142
|
+
|
|
138
143
|
/**
|
|
139
144
|
* Tipping configuration for SEK
|
|
140
145
|
*/
|
|
@@ -339,6 +344,23 @@ declare module 'stripe' {
|
|
|
339
344
|
smart_tip_threshold?: number;
|
|
340
345
|
}
|
|
341
346
|
|
|
347
|
+
interface Pln {
|
|
348
|
+
/**
|
|
349
|
+
* Fixed amounts displayed when collecting a tip
|
|
350
|
+
*/
|
|
351
|
+
fixed_amounts?: Array<number>;
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* Percentages displayed when collecting a tip
|
|
355
|
+
*/
|
|
356
|
+
percentages?: Array<number>;
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
360
|
+
*/
|
|
361
|
+
smart_tip_threshold?: number;
|
|
362
|
+
}
|
|
363
|
+
|
|
342
364
|
interface Sek {
|
|
343
365
|
/**
|
|
344
366
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -544,6 +566,11 @@ declare module 'stripe' {
|
|
|
544
566
|
*/
|
|
545
567
|
nzd?: Tipping.Nzd;
|
|
546
568
|
|
|
569
|
+
/**
|
|
570
|
+
* Tipping configuration for PLN
|
|
571
|
+
*/
|
|
572
|
+
pln?: Tipping.Pln;
|
|
573
|
+
|
|
547
574
|
/**
|
|
548
575
|
* Tipping configuration for SEK
|
|
549
576
|
*/
|
|
@@ -748,6 +775,23 @@ declare module 'stripe' {
|
|
|
748
775
|
smart_tip_threshold?: number;
|
|
749
776
|
}
|
|
750
777
|
|
|
778
|
+
interface Pln {
|
|
779
|
+
/**
|
|
780
|
+
* Fixed amounts displayed when collecting a tip
|
|
781
|
+
*/
|
|
782
|
+
fixed_amounts?: Array<number>;
|
|
783
|
+
|
|
784
|
+
/**
|
|
785
|
+
* Percentages displayed when collecting a tip
|
|
786
|
+
*/
|
|
787
|
+
percentages?: Array<number>;
|
|
788
|
+
|
|
789
|
+
/**
|
|
790
|
+
* Below this amount, fixed amounts will be displayed; above it, percentages will be displayed
|
|
791
|
+
*/
|
|
792
|
+
smart_tip_threshold?: number;
|
|
793
|
+
}
|
|
794
|
+
|
|
751
795
|
interface Sek {
|
|
752
796
|
/**
|
|
753
797
|
* Fixed amounts displayed when collecting a tip
|
|
@@ -64,6 +64,11 @@ declare module 'stripe' {
|
|
|
64
64
|
*/
|
|
65
65
|
allow_redisplay?: PaymentMethodData.AllowRedisplay;
|
|
66
66
|
|
|
67
|
+
/**
|
|
68
|
+
* If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
|
|
69
|
+
*/
|
|
70
|
+
alma?: PaymentMethodData.Alma;
|
|
71
|
+
|
|
67
72
|
/**
|
|
68
73
|
* If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
|
|
69
74
|
*/
|
|
@@ -139,6 +144,11 @@ declare module 'stripe' {
|
|
|
139
144
|
*/
|
|
140
145
|
interac_present?: PaymentMethodData.InteracPresent;
|
|
141
146
|
|
|
147
|
+
/**
|
|
148
|
+
* If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
|
|
149
|
+
*/
|
|
150
|
+
kakao_pay?: PaymentMethodData.KakaoPay;
|
|
151
|
+
|
|
142
152
|
/**
|
|
143
153
|
* If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
|
|
144
154
|
*/
|
|
@@ -149,6 +159,11 @@ declare module 'stripe' {
|
|
|
149
159
|
*/
|
|
150
160
|
konbini?: PaymentMethodData.Konbini;
|
|
151
161
|
|
|
162
|
+
/**
|
|
163
|
+
* If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
|
|
164
|
+
*/
|
|
165
|
+
kr_card?: PaymentMethodData.KrCard;
|
|
166
|
+
|
|
152
167
|
/**
|
|
153
168
|
* If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
|
|
154
169
|
*/
|
|
@@ -169,6 +184,11 @@ declare module 'stripe' {
|
|
|
169
184
|
*/
|
|
170
185
|
multibanco?: PaymentMethodData.Multibanco;
|
|
171
186
|
|
|
187
|
+
/**
|
|
188
|
+
* If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
|
|
189
|
+
*/
|
|
190
|
+
naver_pay?: PaymentMethodData.NaverPay;
|
|
191
|
+
|
|
172
192
|
/**
|
|
173
193
|
* If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
|
|
174
194
|
*/
|
|
@@ -179,6 +199,11 @@ declare module 'stripe' {
|
|
|
179
199
|
*/
|
|
180
200
|
p24?: PaymentMethodData.P24;
|
|
181
201
|
|
|
202
|
+
/**
|
|
203
|
+
* If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
|
|
204
|
+
*/
|
|
205
|
+
payco?: PaymentMethodData.Payco;
|
|
206
|
+
|
|
182
207
|
/**
|
|
183
208
|
* If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
|
|
184
209
|
*/
|
|
@@ -209,6 +234,11 @@ declare module 'stripe' {
|
|
|
209
234
|
*/
|
|
210
235
|
revolut_pay?: PaymentMethodData.RevolutPay;
|
|
211
236
|
|
|
237
|
+
/**
|
|
238
|
+
* If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
|
|
239
|
+
*/
|
|
240
|
+
samsung_pay?: PaymentMethodData.SamsungPay;
|
|
241
|
+
|
|
212
242
|
/**
|
|
213
243
|
* If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
|
|
214
244
|
*/
|
|
@@ -276,6 +306,8 @@ declare module 'stripe' {
|
|
|
276
306
|
|
|
277
307
|
type AllowRedisplay = 'always' | 'limited' | 'unspecified';
|
|
278
308
|
|
|
309
|
+
interface Alma {}
|
|
310
|
+
|
|
279
311
|
interface AmazonPay {}
|
|
280
312
|
|
|
281
313
|
interface AuBecsDebit {
|
|
@@ -424,7 +456,7 @@ declare module 'stripe' {
|
|
|
424
456
|
|
|
425
457
|
interface Ideal {
|
|
426
458
|
/**
|
|
427
|
-
* The customer's bank.
|
|
459
|
+
* The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
|
|
428
460
|
*/
|
|
429
461
|
bank?: Ideal.Bank;
|
|
430
462
|
}
|
|
@@ -451,6 +483,8 @@ declare module 'stripe' {
|
|
|
451
483
|
|
|
452
484
|
interface InteracPresent {}
|
|
453
485
|
|
|
486
|
+
interface KakaoPay {}
|
|
487
|
+
|
|
454
488
|
interface Klarna {
|
|
455
489
|
/**
|
|
456
490
|
* Customer's date of birth
|
|
@@ -479,12 +513,25 @@ declare module 'stripe' {
|
|
|
479
513
|
|
|
480
514
|
interface Konbini {}
|
|
481
515
|
|
|
516
|
+
interface KrCard {}
|
|
517
|
+
|
|
482
518
|
interface Link {}
|
|
483
519
|
|
|
484
520
|
interface Mobilepay {}
|
|
485
521
|
|
|
486
522
|
interface Multibanco {}
|
|
487
523
|
|
|
524
|
+
interface NaverPay {
|
|
525
|
+
/**
|
|
526
|
+
* Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
|
|
527
|
+
*/
|
|
528
|
+
funding?: NaverPay.Funding;
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
namespace NaverPay {
|
|
532
|
+
type Funding = 'card' | 'points';
|
|
533
|
+
}
|
|
534
|
+
|
|
488
535
|
interface Oxxo {}
|
|
489
536
|
|
|
490
537
|
interface P24 {
|
|
@@ -524,6 +571,8 @@ declare module 'stripe' {
|
|
|
524
571
|
| 'volkswagen_bank';
|
|
525
572
|
}
|
|
526
573
|
|
|
574
|
+
interface Payco {}
|
|
575
|
+
|
|
527
576
|
interface Paynow {}
|
|
528
577
|
|
|
529
578
|
interface Paypal {}
|
|
@@ -541,6 +590,8 @@ declare module 'stripe' {
|
|
|
541
590
|
|
|
542
591
|
interface RevolutPay {}
|
|
543
592
|
|
|
593
|
+
interface SamsungPay {}
|
|
594
|
+
|
|
544
595
|
interface SepaDebit {
|
|
545
596
|
/**
|
|
546
597
|
* IBAN of the bank account.
|
|
@@ -568,6 +619,7 @@ declare module 'stripe' {
|
|
|
568
619
|
| 'affirm'
|
|
569
620
|
| 'afterpay_clearpay'
|
|
570
621
|
| 'alipay'
|
|
622
|
+
| 'alma'
|
|
571
623
|
| 'amazon_pay'
|
|
572
624
|
| 'au_becs_debit'
|
|
573
625
|
| 'bacs_debit'
|
|
@@ -581,18 +633,23 @@ declare module 'stripe' {
|
|
|
581
633
|
| 'giropay'
|
|
582
634
|
| 'grabpay'
|
|
583
635
|
| 'ideal'
|
|
636
|
+
| 'kakao_pay'
|
|
584
637
|
| 'klarna'
|
|
585
638
|
| 'konbini'
|
|
639
|
+
| 'kr_card'
|
|
586
640
|
| 'link'
|
|
587
641
|
| 'mobilepay'
|
|
588
642
|
| 'multibanco'
|
|
643
|
+
| 'naver_pay'
|
|
589
644
|
| 'oxxo'
|
|
590
645
|
| 'p24'
|
|
646
|
+
| 'payco'
|
|
591
647
|
| 'paynow'
|
|
592
648
|
| 'paypal'
|
|
593
649
|
| 'pix'
|
|
594
650
|
| 'promptpay'
|
|
595
651
|
| 'revolut_pay'
|
|
652
|
+
| 'samsung_pay'
|
|
596
653
|
| 'sepa_debit'
|
|
597
654
|
| 'sofort'
|
|
598
655
|
| 'swish'
|
|
@@ -39,6 +39,15 @@ declare module 'stripe' {
|
|
|
39
39
|
}
|
|
40
40
|
}
|
|
41
41
|
|
|
42
|
+
namespace Issuing {
|
|
43
|
+
interface CardSubmitCardParams {
|
|
44
|
+
/**
|
|
45
|
+
* Specifies which fields in the response should be expanded.
|
|
46
|
+
*/
|
|
47
|
+
expand?: Array<string>;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
42
51
|
namespace Issuing {
|
|
43
52
|
class CardsResource {
|
|
44
53
|
/**
|
|
@@ -92,6 +101,19 @@ declare module 'stripe' {
|
|
|
92
101
|
id: string,
|
|
93
102
|
options?: RequestOptions
|
|
94
103
|
): Promise<Stripe.Response<Stripe.Issuing.Card>>;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia' or later.
|
|
107
|
+
*/
|
|
108
|
+
submitCard(
|
|
109
|
+
id: string,
|
|
110
|
+
params?: CardSubmitCardParams,
|
|
111
|
+
options?: RequestOptions
|
|
112
|
+
): Promise<Stripe.Response<Stripe.Issuing.Card>>;
|
|
113
|
+
submitCard(
|
|
114
|
+
id: string,
|
|
115
|
+
options?: RequestOptions
|
|
116
|
+
): Promise<Stripe.Response<Stripe.Issuing.Card>>;
|
|
95
117
|
}
|
|
96
118
|
}
|
|
97
119
|
}
|
|
@@ -288,7 +288,7 @@ declare module 'stripe' {
|
|
|
288
288
|
full_name_aliases?: Stripe.Emptyable<Array<string>>;
|
|
289
289
|
|
|
290
290
|
/**
|
|
291
|
-
* The individual's gender
|
|
291
|
+
* The individual's gender
|
|
292
292
|
*/
|
|
293
293
|
gender?: string;
|
|
294
294
|
|
|
@@ -890,7 +890,7 @@ declare module 'stripe' {
|
|
|
890
890
|
class TokensResource {
|
|
891
891
|
/**
|
|
892
892
|
* Creates a single-use token that represents a bank account's details.
|
|
893
|
-
* You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
|
|
893
|
+
* You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
|
|
894
894
|
*/
|
|
895
895
|
create(
|
|
896
896
|
params?: TokenCreateParams,
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
declare module 'stripe' {
|
|
4
4
|
namespace Stripe {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.
|
|
7
7
|
*/
|
|
8
8
|
interface UsageRecordSummary {
|
|
9
9
|
/**
|
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec
|
|
2
|
+
|
|
3
|
+
declare module 'stripe' {
|
|
4
|
+
namespace Stripe {
|
|
5
|
+
namespace V2 {
|
|
6
|
+
namespace Core {
|
|
7
|
+
interface EventDestinationCreateParams {
|
|
8
|
+
/**
|
|
9
|
+
* The list of events to enable for this endpoint.
|
|
10
|
+
*/
|
|
11
|
+
enabled_events: Array<string>;
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Payload type of events being subscribed to.
|
|
15
|
+
*/
|
|
16
|
+
event_payload: EventDestinationCreateParams.EventPayload;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Event destination name.
|
|
20
|
+
*/
|
|
21
|
+
name: string;
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Event destination type.
|
|
25
|
+
*/
|
|
26
|
+
type: EventDestinationCreateParams.Type;
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Amazon EventBridge configuration.
|
|
30
|
+
*/
|
|
31
|
+
amazon_eventbridge?: EventDestinationCreateParams.AmazonEventbridge;
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* An optional description of what the event destination is used for.
|
|
35
|
+
*/
|
|
36
|
+
description?: string;
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Where events should be routed from.
|
|
40
|
+
*/
|
|
41
|
+
events_from?: Array<EventDestinationCreateParams.EventsFrom>;
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Additional fields to include in the response.
|
|
45
|
+
*/
|
|
46
|
+
include?: Array<EventDestinationCreateParams.Include>;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Metadata.
|
|
50
|
+
*/
|
|
51
|
+
metadata?: Stripe.MetadataParam;
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* If using the snapshot event payload, the API version events are rendered as.
|
|
55
|
+
*/
|
|
56
|
+
snapshot_api_version?: string;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Webhook endpoint configuration.
|
|
60
|
+
*/
|
|
61
|
+
webhook_endpoint?: EventDestinationCreateParams.WebhookEndpoint;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
namespace EventDestinationCreateParams {
|
|
65
|
+
interface AmazonEventbridge {
|
|
66
|
+
/**
|
|
67
|
+
* The AWS account ID.
|
|
68
|
+
*/
|
|
69
|
+
aws_account_id: string;
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* The region of the AWS event source.
|
|
73
|
+
*/
|
|
74
|
+
aws_region: string;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
type EventPayload = 'snapshot' | 'thin';
|
|
78
|
+
|
|
79
|
+
type EventsFrom = 'other_accounts' | 'self';
|
|
80
|
+
|
|
81
|
+
type Include =
|
|
82
|
+
| 'webhook_endpoint.signing_secret'
|
|
83
|
+
| 'webhook_endpoint.url';
|
|
84
|
+
|
|
85
|
+
type Type = 'amazon_eventbridge' | 'webhook_endpoint';
|
|
86
|
+
|
|
87
|
+
interface WebhookEndpoint {
|
|
88
|
+
/**
|
|
89
|
+
* The URL of the webhook endpoint.
|
|
90
|
+
*/
|
|
91
|
+
url: string;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
namespace Core {
|
|
97
|
+
interface EventDestinationRetrieveParams {
|
|
98
|
+
/**
|
|
99
|
+
* Additional fields to include in the response.
|
|
100
|
+
*/
|
|
101
|
+
include?: Array<'webhook_endpoint.url'>;
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
namespace Core {
|
|
106
|
+
interface EventDestinationUpdateParams {
|
|
107
|
+
/**
|
|
108
|
+
* An optional description of what the event destination is used for.
|
|
109
|
+
*/
|
|
110
|
+
description?: string;
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* The list of events to enable for this endpoint.
|
|
114
|
+
*/
|
|
115
|
+
enabled_events?: Array<string>;
|
|
116
|
+
|
|
117
|
+
/**
|
|
118
|
+
* Additional fields to include in the response. Currently supports `webhook_endpoint.url`.
|
|
119
|
+
*/
|
|
120
|
+
include?: Array<'webhook_endpoint.url'>;
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Metadata.
|
|
124
|
+
*/
|
|
125
|
+
metadata?: Stripe.MetadataParam;
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Event destination name.
|
|
129
|
+
*/
|
|
130
|
+
name?: string;
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Webhook endpoint configuration.
|
|
134
|
+
*/
|
|
135
|
+
webhook_endpoint?: EventDestinationUpdateParams.WebhookEndpoint;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
namespace EventDestinationUpdateParams {
|
|
139
|
+
interface WebhookEndpoint {
|
|
140
|
+
/**
|
|
141
|
+
* The URL of the webhook endpoint.
|
|
142
|
+
*/
|
|
143
|
+
url: string;
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
namespace Core {
|
|
149
|
+
interface EventDestinationListParams {
|
|
150
|
+
/**
|
|
151
|
+
* Additional fields to include in the response. Currently supports `webhook_endpoint.url`.
|
|
152
|
+
*/
|
|
153
|
+
include?: Array<'webhook_endpoint.url'>;
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* The page size.
|
|
157
|
+
*/
|
|
158
|
+
limit?: number;
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* The requested page.
|
|
162
|
+
*/
|
|
163
|
+
page?: string;
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
namespace Core {
|
|
168
|
+
interface EventDestinationDeleteParams {}
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
namespace Core {
|
|
172
|
+
interface EventDestinationDisableParams {}
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
namespace Core {
|
|
176
|
+
interface EventDestinationEnableParams {}
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
namespace Core {
|
|
180
|
+
interface EventDestinationPingParams {}
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
namespace Core {
|
|
184
|
+
class EventDestinationsResource {
|
|
185
|
+
/**
|
|
186
|
+
* Create a new event destination.
|
|
187
|
+
*/
|
|
188
|
+
create(
|
|
189
|
+
params: EventDestinationCreateParams,
|
|
190
|
+
options?: RequestOptions
|
|
191
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Retrieves the details of an event destination.
|
|
195
|
+
*/
|
|
196
|
+
retrieve(
|
|
197
|
+
id: string,
|
|
198
|
+
params?: EventDestinationRetrieveParams,
|
|
199
|
+
options?: RequestOptions
|
|
200
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
201
|
+
retrieve(
|
|
202
|
+
id: string,
|
|
203
|
+
options?: RequestOptions
|
|
204
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* Update the details of an event destination.
|
|
208
|
+
*/
|
|
209
|
+
update(
|
|
210
|
+
id: string,
|
|
211
|
+
params?: EventDestinationUpdateParams,
|
|
212
|
+
options?: RequestOptions
|
|
213
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* Lists all event destinations.
|
|
217
|
+
*/
|
|
218
|
+
list(
|
|
219
|
+
params?: EventDestinationListParams,
|
|
220
|
+
options?: RequestOptions
|
|
221
|
+
): ApiListPromise<Stripe.V2.EventDestination>;
|
|
222
|
+
list(
|
|
223
|
+
options?: RequestOptions
|
|
224
|
+
): ApiListPromise<Stripe.V2.EventDestination>;
|
|
225
|
+
|
|
226
|
+
/**
|
|
227
|
+
* Delete an event destination.
|
|
228
|
+
*/
|
|
229
|
+
del(
|
|
230
|
+
id: string,
|
|
231
|
+
params?: EventDestinationDeleteParams,
|
|
232
|
+
options?: RequestOptions
|
|
233
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
234
|
+
del(
|
|
235
|
+
id: string,
|
|
236
|
+
options?: RequestOptions
|
|
237
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* Disable an event destination.
|
|
241
|
+
*/
|
|
242
|
+
disable(
|
|
243
|
+
id: string,
|
|
244
|
+
params?: EventDestinationDisableParams,
|
|
245
|
+
options?: RequestOptions
|
|
246
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
247
|
+
disable(
|
|
248
|
+
id: string,
|
|
249
|
+
options?: RequestOptions
|
|
250
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
251
|
+
|
|
252
|
+
/**
|
|
253
|
+
* Enable an event destination.
|
|
254
|
+
*/
|
|
255
|
+
enable(
|
|
256
|
+
id: string,
|
|
257
|
+
params?: EventDestinationEnableParams,
|
|
258
|
+
options?: RequestOptions
|
|
259
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
260
|
+
enable(
|
|
261
|
+
id: string,
|
|
262
|
+
options?: RequestOptions
|
|
263
|
+
): Promise<Stripe.Response<Stripe.V2.EventDestination>>;
|
|
264
|
+
|
|
265
|
+
/**
|
|
266
|
+
* Send a `ping` event to an event destination.
|
|
267
|
+
*/
|
|
268
|
+
ping(
|
|
269
|
+
id: string,
|
|
270
|
+
params?: EventDestinationPingParams,
|
|
271
|
+
options?: RequestOptions
|
|
272
|
+
): Promise<Stripe.Response<Stripe.V2.Event>>;
|
|
273
|
+
ping(
|
|
274
|
+
id: string,
|
|
275
|
+
options?: RequestOptions
|
|
276
|
+
): Promise<Stripe.Response<Stripe.V2.Event>>;
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
}
|
|
280
|
+
}
|
|
281
|
+
}
|