stripe 15.12.0-beta.1 → 16.0.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.
Files changed (167) hide show
  1. package/CHANGELOG.md +155 -746
  2. package/README.md +0 -33
  3. package/VERSION +1 -1
  4. package/cjs/RequestSender.js +5 -66
  5. package/cjs/StripeResource.js +1 -1
  6. package/cjs/apiVersion.js +2 -3
  7. package/cjs/multipart.js +1 -1
  8. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  9. package/cjs/resources/Invoices.js +0 -25
  10. package/cjs/resources/OAuth.js +1 -1
  11. package/cjs/resources/PaymentIntents.js +0 -4
  12. package/cjs/resources/Quotes.js +0 -32
  13. package/cjs/resources/SubscriptionSchedules.js +0 -4
  14. package/cjs/resources/Terminal/Readers.js +0 -12
  15. package/cjs/resources/TestHelpers/Issuing/Authorizations.js +4 -0
  16. package/cjs/resources.js +10 -36
  17. package/cjs/stripe.core.js +3 -6
  18. package/cjs/utils.js +3 -30
  19. package/esm/RequestSender.js +6 -67
  20. package/esm/StripeResource.js +2 -2
  21. package/esm/apiVersion.js +1 -2
  22. package/esm/multipart.js +2 -2
  23. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  24. package/esm/resources/Invoices.js +0 -25
  25. package/esm/resources/OAuth.js +2 -2
  26. package/esm/resources/PaymentIntents.js +0 -4
  27. package/esm/resources/Quotes.js +0 -32
  28. package/esm/resources/SubscriptionSchedules.js +0 -4
  29. package/esm/resources/Terminal/Readers.js +0 -12
  30. package/esm/resources/TestHelpers/Issuing/Authorizations.js +4 -0
  31. package/esm/resources.js +0 -22
  32. package/esm/stripe.core.js +3 -6
  33. package/esm/utils.js +1 -27
  34. package/package.json +5 -1
  35. package/types/AccountLinksResource.d.ts +1 -5
  36. package/types/AccountSessions.d.ts +0 -15
  37. package/types/AccountSessionsResource.d.ts +0 -205
  38. package/types/Accounts.d.ts +1 -88
  39. package/types/AccountsResource.d.ts +1 -205
  40. package/types/BalanceTransactionSources.d.ts +0 -1
  41. package/types/Capabilities.d.ts +27 -7
  42. package/types/Charges.d.ts +0 -67
  43. package/types/ChargesResource.d.ts +0 -1294
  44. package/types/Checkout/Sessions.d.ts +3 -24
  45. package/types/Checkout/SessionsResource.d.ts +3 -17
  46. package/types/ConfirmationTokens.d.ts +0 -83
  47. package/types/Coupons.d.ts +1 -1
  48. package/types/CouponsResource.d.ts +1 -1
  49. package/types/CreditNotes.d.ts +0 -21
  50. package/types/CreditNotesResource.d.ts +0 -51
  51. package/types/CustomerSessions.d.ts +0 -55
  52. package/types/CustomerSessionsResource.d.ts +0 -55
  53. package/types/CustomersResource.d.ts +4 -4
  54. package/types/Disputes.d.ts +0 -167
  55. package/types/DisputesResource.d.ts +0 -120
  56. package/types/EventTypes.d.ts +0 -426
  57. package/types/Events.d.ts +0 -83
  58. package/types/FinancialConnections/Accounts.d.ts +1 -29
  59. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  60. package/types/FinancialConnections/Sessions.d.ts +1 -44
  61. package/types/FinancialConnections/SessionsResource.d.ts +1 -33
  62. package/types/InvoiceItems.d.ts +0 -5
  63. package/types/InvoiceItemsResource.d.ts +0 -98
  64. package/types/InvoiceLineItems.d.ts +0 -22
  65. package/types/Invoices.d.ts +3 -111
  66. package/types/InvoicesResource.d.ts +2171 -6311
  67. package/types/Issuing/Authorizations.d.ts +173 -0
  68. package/types/Issuing/CardholdersResource.d.ts +1 -2
  69. package/types/Issuing/Cards.d.ts +0 -34
  70. package/types/Issuing/CardsResource.d.ts +0 -125
  71. package/types/Issuing/Transactions.d.ts +112 -6
  72. package/types/LineItems.d.ts +0 -7
  73. package/types/Mandates.d.ts +0 -77
  74. package/types/PaymentIntents.d.ts +1 -463
  75. package/types/PaymentIntentsResource.d.ts +3360 -6731
  76. package/types/PaymentLinks.d.ts +1 -0
  77. package/types/PaymentLinksResource.d.ts +15 -1
  78. package/types/PaymentMethods.d.ts +0 -62
  79. package/types/PaymentMethodsResource.d.ts +12 -124
  80. package/types/Prices.d.ts +0 -22
  81. package/types/PricesResource.d.ts +0 -22
  82. package/types/Products.d.ts +0 -39
  83. package/types/ProductsResource.d.ts +0 -36
  84. package/types/Quotes.d.ts +1 -578
  85. package/types/QuotesResource.d.ts +266 -3175
  86. package/types/SetupAttempts.d.ts +0 -8
  87. package/types/SetupIntents.d.ts +1 -104
  88. package/types/SetupIntentsResource.d.ts +9 -527
  89. package/types/Sources.d.ts +0 -23
  90. package/types/SubscriptionItems.d.ts +0 -21
  91. package/types/SubscriptionItemsResource.d.ts +0 -109
  92. package/types/SubscriptionSchedules.d.ts +0 -164
  93. package/types/SubscriptionSchedulesResource.d.ts +13 -1231
  94. package/types/Subscriptions.d.ts +1 -41
  95. package/types/SubscriptionsResource.d.ts +2 -337
  96. package/types/Tax/Calculations.d.ts +2 -1
  97. package/types/Tax/CalculationsResource.d.ts +4 -3
  98. package/types/Tax/Transactions.d.ts +2 -1
  99. package/types/TaxIds.d.ts +2 -1
  100. package/types/TaxIdsResource.d.ts +2 -1
  101. package/types/Terminal/ConnectionTokens.d.ts +1 -1
  102. package/types/Terminal/ConnectionTokensResource.d.ts +1 -1
  103. package/types/Terminal/Readers.d.ts +0 -278
  104. package/types/Terminal/ReadersResource.d.ts +0 -208
  105. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -55
  106. package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +480 -7
  107. package/types/TestHelpers/Issuing/TransactionsResource.d.ts +262 -14
  108. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  109. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  110. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  111. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  112. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  113. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  114. package/types/WebhookEndpointsResource.d.ts +2 -51
  115. package/types/index.d.ts +0 -62
  116. package/types/lib.d.ts +1 -13
  117. package/types/test/typescriptTest.ts +3 -3
  118. package/cjs/resources/AccountNotices.js +0 -21
  119. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  120. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  121. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  122. package/cjs/resources/GiftCards/Cards.js +0 -23
  123. package/cjs/resources/GiftCards/Transactions.js +0 -33
  124. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  125. package/cjs/resources/Margins.js +0 -22
  126. package/cjs/resources/Orders.js +0 -24
  127. package/cjs/resources/QuotePhases.js +0 -22
  128. package/cjs/resources/Tax/Forms.js +0 -20
  129. package/esm/resources/AccountNotices.js +0 -18
  130. package/esm/resources/Capital/FinancingOffers.js +0 -18
  131. package/esm/resources/Capital/FinancingSummary.js +0 -9
  132. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  133. package/esm/resources/GiftCards/Cards.js +0 -20
  134. package/esm/resources/GiftCards/Transactions.js +0 -30
  135. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  136. package/esm/resources/Margins.js +0 -19
  137. package/esm/resources/Orders.js +0 -21
  138. package/esm/resources/QuotePhases.js +0 -19
  139. package/esm/resources/Tax/Forms.js +0 -17
  140. package/types/AccountNotices.d.ts +0 -110
  141. package/types/AccountNoticesResource.d.ts +0 -98
  142. package/types/Capital/FinancingOffers.d.ts +0 -188
  143. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  144. package/types/Capital/FinancingSummary.d.ts +0 -106
  145. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  146. package/types/Capital/FinancingTransactions.d.ts +0 -135
  147. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  148. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  149. package/types/GiftCards/Cards.d.ts +0 -118
  150. package/types/GiftCards/CardsResource.d.ts +0 -159
  151. package/types/GiftCards/Transactions.d.ts +0 -129
  152. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  153. package/types/InvoicePayments.d.ts +0 -91
  154. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -446
  155. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1017
  156. package/types/Margins.d.ts +0 -56
  157. package/types/MarginsResource.d.ts +0 -114
  158. package/types/Orders.d.ts +0 -1056
  159. package/types/OrdersResource.d.ts +0 -2709
  160. package/types/PlatformTaxFees.d.ts +0 -35
  161. package/types/QuoteLines.d.ts +0 -634
  162. package/types/QuotePhases.d.ts +0 -198
  163. package/types/QuotePhasesResource.d.ts +0 -67
  164. package/types/QuotePreviewInvoices.d.ts +0 -1514
  165. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -778
  166. package/types/Tax/Forms.d.ts +0 -133
  167. package/types/Tax/FormsResource.d.ts +0 -90
@@ -1,24 +0,0 @@
1
- "use strict";
2
- // File generated from our OpenAPI spec
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.Orders = void 0;
5
- const StripeResource_js_1 = require("../StripeResource.js");
6
- const stripeMethod = StripeResource_js_1.StripeResource.method;
7
- exports.Orders = StripeResource_js_1.StripeResource.extend({
8
- create: stripeMethod({ method: 'POST', fullPath: '/v1/orders' }),
9
- retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/orders/{id}' }),
10
- update: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}' }),
11
- list: stripeMethod({
12
- method: 'GET',
13
- fullPath: '/v1/orders',
14
- methodType: 'list',
15
- }),
16
- cancel: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/cancel' }),
17
- listLineItems: stripeMethod({
18
- method: 'GET',
19
- fullPath: '/v1/orders/{id}/line_items',
20
- methodType: 'list',
21
- }),
22
- reopen: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/reopen' }),
23
- submit: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/submit' }),
24
- });
@@ -1,22 +0,0 @@
1
- "use strict";
2
- // File generated from our OpenAPI spec
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.QuotePhases = void 0;
5
- const StripeResource_js_1 = require("../StripeResource.js");
6
- const stripeMethod = StripeResource_js_1.StripeResource.method;
7
- exports.QuotePhases = StripeResource_js_1.StripeResource.extend({
8
- retrieve: stripeMethod({
9
- method: 'GET',
10
- fullPath: '/v1/quote_phases/{quote_phase}',
11
- }),
12
- list: stripeMethod({
13
- method: 'GET',
14
- fullPath: '/v1/quote_phases',
15
- methodType: 'list',
16
- }),
17
- listLineItems: stripeMethod({
18
- method: 'GET',
19
- fullPath: '/v1/quote_phases/{quote_phase}/line_items',
20
- methodType: 'list',
21
- }),
22
- });
@@ -1,20 +0,0 @@
1
- "use strict";
2
- // File generated from our OpenAPI spec
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.Forms = void 0;
5
- const StripeResource_js_1 = require("../../StripeResource.js");
6
- const stripeMethod = StripeResource_js_1.StripeResource.method;
7
- exports.Forms = StripeResource_js_1.StripeResource.extend({
8
- retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/tax/forms/{id}' }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/tax/forms',
12
- methodType: 'list',
13
- }),
14
- pdf: stripeMethod({
15
- method: 'GET',
16
- fullPath: '/v1/tax/forms/{id}/pdf',
17
- host: 'files.stripe.com',
18
- streaming: true,
19
- }),
20
- });
@@ -1,18 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const AccountNotices = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/account_notices/{account_notice}',
8
- }),
9
- update: stripeMethod({
10
- method: 'POST',
11
- fullPath: '/v1/account_notices/{account_notice}',
12
- }),
13
- list: stripeMethod({
14
- method: 'GET',
15
- fullPath: '/v1/account_notices',
16
- methodType: 'list',
17
- }),
18
- });
@@ -1,18 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const FinancingOffers = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/capital/financing_offers/{financing_offer}',
8
- }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/capital/financing_offers',
12
- methodType: 'list',
13
- }),
14
- markDelivered: stripeMethod({
15
- method: 'POST',
16
- fullPath: '/v1/capital/financing_offers/{financing_offer}/mark_delivered',
17
- }),
18
- });
@@ -1,9 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const FinancingSummary = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/capital/financing_summary',
8
- }),
9
- });
@@ -1,14 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const FinancingTransactions = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/capital/financing_transactions/{financing_transaction}',
8
- }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/capital/financing_transactions',
12
- methodType: 'list',
13
- }),
14
- });
@@ -1,20 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Cards = StripeResource.extend({
5
- create: stripeMethod({ method: 'POST', fullPath: '/v1/gift_cards/cards' }),
6
- retrieve: stripeMethod({
7
- method: 'GET',
8
- fullPath: '/v1/gift_cards/cards/{id}',
9
- }),
10
- update: stripeMethod({ method: 'POST', fullPath: '/v1/gift_cards/cards/{id}' }),
11
- list: stripeMethod({
12
- method: 'GET',
13
- fullPath: '/v1/gift_cards/cards',
14
- methodType: 'list',
15
- }),
16
- validate: stripeMethod({
17
- method: 'POST',
18
- fullPath: '/v1/gift_cards/cards/validate',
19
- }),
20
- });
@@ -1,30 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Transactions = StripeResource.extend({
5
- create: stripeMethod({
6
- method: 'POST',
7
- fullPath: '/v1/gift_cards/transactions',
8
- }),
9
- retrieve: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/gift_cards/transactions/{id}',
12
- }),
13
- update: stripeMethod({
14
- method: 'POST',
15
- fullPath: '/v1/gift_cards/transactions/{id}',
16
- }),
17
- list: stripeMethod({
18
- method: 'GET',
19
- fullPath: '/v1/gift_cards/transactions',
20
- methodType: 'list',
21
- }),
22
- cancel: stripeMethod({
23
- method: 'POST',
24
- fullPath: '/v1/gift_cards/transactions/{id}/cancel',
25
- }),
26
- confirm: stripeMethod({
27
- method: 'POST',
28
- fullPath: '/v1/gift_cards/transactions/{id}/confirm',
29
- }),
30
- });
@@ -1,30 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const CreditUnderwritingRecords = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/issuing/credit_underwriting_records/{credit_underwriting_record}',
8
- }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/issuing/credit_underwriting_records',
12
- methodType: 'list',
13
- }),
14
- correct: stripeMethod({
15
- method: 'POST',
16
- fullPath: '/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/correct',
17
- }),
18
- createFromApplication: stripeMethod({
19
- method: 'POST',
20
- fullPath: '/v1/issuing/credit_underwriting_records/create_from_application',
21
- }),
22
- createFromProactiveReview: stripeMethod({
23
- method: 'POST',
24
- fullPath: '/v1/issuing/credit_underwriting_records/create_from_proactive_review',
25
- }),
26
- reportDecision: stripeMethod({
27
- method: 'POST',
28
- fullPath: '/v1/issuing/credit_underwriting_records/{credit_underwriting_record}/report_decision',
29
- }),
30
- });
@@ -1,19 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Margins = StripeResource.extend({
5
- create: stripeMethod({ method: 'POST', fullPath: '/v1/billing/margins' }),
6
- retrieve: stripeMethod({
7
- method: 'GET',
8
- fullPath: '/v1/billing/margins/{margin}',
9
- }),
10
- update: stripeMethod({
11
- method: 'POST',
12
- fullPath: '/v1/billing/margins/{margin}',
13
- }),
14
- list: stripeMethod({
15
- method: 'GET',
16
- fullPath: '/v1/billing/margins',
17
- methodType: 'list',
18
- }),
19
- });
@@ -1,21 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Orders = StripeResource.extend({
5
- create: stripeMethod({ method: 'POST', fullPath: '/v1/orders' }),
6
- retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/orders/{id}' }),
7
- update: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}' }),
8
- list: stripeMethod({
9
- method: 'GET',
10
- fullPath: '/v1/orders',
11
- methodType: 'list',
12
- }),
13
- cancel: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/cancel' }),
14
- listLineItems: stripeMethod({
15
- method: 'GET',
16
- fullPath: '/v1/orders/{id}/line_items',
17
- methodType: 'list',
18
- }),
19
- reopen: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/reopen' }),
20
- submit: stripeMethod({ method: 'POST', fullPath: '/v1/orders/{id}/submit' }),
21
- });
@@ -1,19 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const QuotePhases = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/quote_phases/{quote_phase}',
8
- }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/quote_phases',
12
- methodType: 'list',
13
- }),
14
- listLineItems: stripeMethod({
15
- method: 'GET',
16
- fullPath: '/v1/quote_phases/{quote_phase}/line_items',
17
- methodType: 'list',
18
- }),
19
- });
@@ -1,17 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Forms = StripeResource.extend({
5
- retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/tax/forms/{id}' }),
6
- list: stripeMethod({
7
- method: 'GET',
8
- fullPath: '/v1/tax/forms',
9
- methodType: 'list',
10
- }),
11
- pdf: stripeMethod({
12
- method: 'GET',
13
- fullPath: '/v1/tax/forms/{id}/pdf',
14
- host: 'files.stripe.com',
15
- streaming: true,
16
- }),
17
- });
@@ -1,110 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- /**
6
- * A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
7
- *
8
- * See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
9
- */
10
- interface AccountNotice {
11
- /**
12
- * Unique identifier for the object.
13
- */
14
- id: string;
15
-
16
- /**
17
- * String representing the object's type. Objects of the same type share the same value.
18
- */
19
- object: 'account_notice';
20
-
21
- /**
22
- * Time at which the object was created. Measured in seconds since the Unix epoch.
23
- */
24
- created: number;
25
-
26
- /**
27
- * When present, the deadline for sending the notice to meet the relevant regulations.
28
- */
29
- deadline: number | null;
30
-
31
- /**
32
- * Information about the email when sent.
33
- */
34
- email: AccountNotice.Email | null;
35
-
36
- /**
37
- * Information about objects related to the notice.
38
- */
39
- linked_objects: AccountNotice.LinkedObjects | null;
40
-
41
- /**
42
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
43
- */
44
- livemode: boolean;
45
-
46
- /**
47
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
48
- */
49
- metadata: Stripe.Metadata | null;
50
-
51
- /**
52
- * Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
53
- */
54
- reason: AccountNotice.Reason;
55
-
56
- /**
57
- * Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
58
- */
59
- sent_at: number | null;
60
- }
61
-
62
- namespace AccountNotice {
63
- interface Email {
64
- /**
65
- * Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
66
- */
67
- plain_text: string;
68
-
69
- /**
70
- * Email address of the recipient.
71
- */
72
- recipient: string;
73
-
74
- /**
75
- * Subject of the email.
76
- */
77
- subject: string;
78
- }
79
-
80
- interface LinkedObjects {
81
- /**
82
- * Associated [Capability](https://stripe.com/docs/api/capabilities)
83
- */
84
- capability: string | null;
85
-
86
- /**
87
- * Associated [Credit Underwriting Record](https://stripe.com/docs/api/issuing/credit_underwriting_record)
88
- */
89
- issuing_credit_underwriting_record?: string | null;
90
-
91
- /**
92
- * Associated [Issuing Dispute](https://stripe.com/docs/api/issuing/disputes)
93
- */
94
- issuing_dispute: string | null;
95
- }
96
-
97
- type Reason =
98
- | 'issuing.account_closed_for_inactivity'
99
- | 'issuing.account_closed_for_terms_of_service_violation'
100
- | 'issuing.application_rejected_for_failure_to_verify'
101
- | 'issuing.credit_application_rejected'
102
- | 'issuing.credit_increase_application_rejected'
103
- | 'issuing.credit_limit_decreased'
104
- | 'issuing.credit_line_closed'
105
- | 'issuing.dispute_lost'
106
- | 'issuing.dispute_submitted'
107
- | 'issuing.dispute_won';
108
- }
109
- }
110
- }
@@ -1,98 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- interface AccountNoticeRetrieveParams {
6
- /**
7
- * Specifies which fields in the response should be expanded.
8
- */
9
- expand?: Array<string>;
10
- }
11
-
12
- interface AccountNoticeUpdateParams {
13
- /**
14
- * Information about the email you sent.
15
- */
16
- email: AccountNoticeUpdateParams.Email;
17
-
18
- /**
19
- * Date when you sent the notice.
20
- */
21
- sent_at: number;
22
-
23
- /**
24
- * Specifies which fields in the response should be expanded.
25
- */
26
- expand?: Array<string>;
27
-
28
- /**
29
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
30
- */
31
- metadata?: Stripe.MetadataParam;
32
- }
33
-
34
- namespace AccountNoticeUpdateParams {
35
- interface Email {
36
- /**
37
- * Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
38
- */
39
- plain_text: string;
40
-
41
- /**
42
- * Email address of the recipient.
43
- */
44
- recipient: string;
45
-
46
- /**
47
- * Subject of the email.
48
- */
49
- subject: string;
50
- }
51
- }
52
-
53
- interface AccountNoticeListParams extends PaginationParams {
54
- /**
55
- * Specifies which fields in the response should be expanded.
56
- */
57
- expand?: Array<string>;
58
-
59
- /**
60
- * Set to false to only return unsent AccountNotices.
61
- */
62
- sent?: boolean;
63
- }
64
-
65
- class AccountNoticesResource {
66
- /**
67
- * Retrieves an AccountNotice object.
68
- */
69
- retrieve(
70
- id: string,
71
- params?: AccountNoticeRetrieveParams,
72
- options?: RequestOptions
73
- ): Promise<Stripe.Response<Stripe.AccountNotice>>;
74
- retrieve(
75
- id: string,
76
- options?: RequestOptions
77
- ): Promise<Stripe.Response<Stripe.AccountNotice>>;
78
-
79
- /**
80
- * Updates an AccountNotice object.
81
- */
82
- update(
83
- id: string,
84
- params: AccountNoticeUpdateParams,
85
- options?: RequestOptions
86
- ): Promise<Stripe.Response<Stripe.AccountNotice>>;
87
-
88
- /**
89
- * Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
90
- */
91
- list(
92
- params?: AccountNoticeListParams,
93
- options?: RequestOptions
94
- ): ApiListPromise<Stripe.AccountNotice>;
95
- list(options?: RequestOptions): ApiListPromise<Stripe.AccountNotice>;
96
- }
97
- }
98
- }