stripe 16.13.0-beta.1 → 17.1.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 (221) hide show
  1. package/CHANGELOG.md +139 -849
  2. package/README.md +4 -3
  3. package/VERSION +1 -1
  4. package/cjs/Error.js +31 -4
  5. package/cjs/RequestSender.js +114 -74
  6. package/cjs/StripeResource.js +8 -3
  7. package/cjs/apiVersion.js +2 -3
  8. package/cjs/autoPagination.js +51 -7
  9. package/cjs/crypto/CryptoProvider.js +6 -0
  10. package/cjs/crypto/NodeCryptoProvider.js +7 -0
  11. package/cjs/crypto/SubtleCryptoProvider.js +4 -0
  12. package/cjs/resources/{Capital/FinancingSummary.js → Billing/CreditBalanceSummary.js} +3 -3
  13. package/cjs/resources/{FinancialConnections/Institutions.js → Billing/CreditBalanceTransactions.js} +4 -4
  14. package/cjs/resources/Billing/CreditGrants.js +30 -0
  15. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  16. package/cjs/resources/Invoices.js +0 -17
  17. package/cjs/resources/PaymentIntents.js +0 -4
  18. package/cjs/resources/Quotes.js +0 -32
  19. package/cjs/resources/SubscriptionSchedules.js +0 -4
  20. package/cjs/resources/Terminal/Readers.js +0 -12
  21. package/cjs/resources/V2/Billing/MeterEventAdjustments.js +12 -0
  22. package/cjs/resources/V2/Billing/MeterEventSession.js +12 -0
  23. package/cjs/resources/V2/Billing/MeterEventStream.js +13 -0
  24. package/cjs/resources/V2/Billing/MeterEvents.js +9 -0
  25. package/cjs/resources/V2/Billing.js +18 -0
  26. package/cjs/resources/V2/Core/Events.js +14 -0
  27. package/cjs/resources/V2/Core.js +12 -0
  28. package/cjs/resources/V2.js +14 -0
  29. package/cjs/resources.js +18 -42
  30. package/cjs/stripe.core.js +20 -8
  31. package/cjs/utils.js +41 -10
  32. package/esm/Error.js +27 -2
  33. package/esm/RequestSender.js +115 -75
  34. package/esm/StripeResource.js +9 -4
  35. package/esm/apiVersion.js +1 -2
  36. package/esm/autoPagination.js +52 -8
  37. package/esm/crypto/CryptoProvider.js +6 -0
  38. package/esm/crypto/NodeCryptoProvider.js +7 -0
  39. package/esm/crypto/SubtleCryptoProvider.js +4 -0
  40. package/esm/resources/{Capital/FinancingSummary.js → Billing/CreditBalanceSummary.js} +2 -2
  41. package/esm/resources/{FinancialConnections/Institutions.js → Billing/CreditBalanceTransactions.js} +3 -3
  42. package/esm/resources/Billing/CreditGrants.js +27 -0
  43. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  44. package/esm/resources/Invoices.js +0 -17
  45. package/esm/resources/PaymentIntents.js +0 -4
  46. package/esm/resources/Quotes.js +0 -32
  47. package/esm/resources/SubscriptionSchedules.js +0 -4
  48. package/esm/resources/Terminal/Readers.js +0 -12
  49. package/esm/resources/V2/Billing/MeterEventAdjustments.js +9 -0
  50. package/esm/resources/V2/Billing/MeterEventSession.js +9 -0
  51. package/esm/resources/V2/Billing/MeterEventStream.js +10 -0
  52. package/esm/resources/V2/Billing/MeterEvents.js +6 -0
  53. package/esm/resources/V2/Billing.js +15 -0
  54. package/esm/resources/V2/Core/Events.js +11 -0
  55. package/esm/resources/V2/Core.js +9 -0
  56. package/esm/resources/V2.js +11 -0
  57. package/esm/resources.js +7 -29
  58. package/esm/stripe.core.js +21 -9
  59. package/esm/utils.js +38 -9
  60. package/package.json +1 -1
  61. package/types/AccountLinksResource.d.ts +1 -5
  62. package/types/AccountSessions.d.ts +0 -45
  63. package/types/AccountSessionsResource.d.ts +0 -288
  64. package/types/Accounts.d.ts +1 -113
  65. package/types/AccountsResource.d.ts +0 -270
  66. package/types/Billing/Alerts.d.ts +17 -13
  67. package/types/Billing/AlertsResource.d.ts +18 -21
  68. package/types/Billing/CreditBalanceSummary.d.ts +94 -0
  69. package/types/Billing/CreditBalanceSummaryResource.d.ts +64 -0
  70. package/types/Billing/CreditBalanceTransactions.d.ts +159 -0
  71. package/types/Billing/CreditBalanceTransactionsResource.d.ts +54 -0
  72. package/types/Billing/CreditGrants.d.ts +124 -0
  73. package/types/Billing/CreditGrantsResource.d.ts +219 -0
  74. package/types/BillingPortal/ConfigurationsResource.d.ts +2 -2
  75. package/types/Capabilities.d.ts +1 -1
  76. package/types/Charges.d.ts +0 -71
  77. package/types/ChargesResource.d.ts +0 -1294
  78. package/types/Checkout/Sessions.d.ts +4 -296
  79. package/types/Checkout/SessionsResource.d.ts +6 -352
  80. package/types/ConfirmationTokens.d.ts +0 -67
  81. package/types/Coupons.d.ts +1 -1
  82. package/types/CouponsResource.d.ts +1 -1
  83. package/types/CreditNoteLineItems.d.ts +30 -0
  84. package/types/CreditNotes.d.ts +27 -18
  85. package/types/CreditNotesResource.d.ts +0 -51
  86. package/types/Customers.d.ts +2 -3
  87. package/types/CustomersResource.d.ts +0 -3
  88. package/types/Disputes.d.ts +0 -152
  89. package/types/DisputesResource.d.ts +0 -120
  90. package/types/Errors.d.ts +32 -2
  91. package/types/EventTypes.d.ts +2 -545
  92. package/types/Events.d.ts +0 -90
  93. package/types/FinancialConnections/Accounts.d.ts +1 -29
  94. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  95. package/types/FinancialConnections/Sessions.d.ts +1 -49
  96. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  97. package/types/InvoiceItems.d.ts +0 -5
  98. package/types/InvoiceItemsResource.d.ts +0 -98
  99. package/types/InvoiceLineItems.d.ts +29 -20
  100. package/types/Invoices.d.ts +25 -108
  101. package/types/InvoicesResource.d.ts +1835 -5493
  102. package/types/Issuing/CardholdersResource.d.ts +1 -2
  103. package/types/Issuing/Transactions.d.ts +0 -2
  104. package/types/Issuing/TransactionsResource.d.ts +0 -5
  105. package/types/LineItems.d.ts +0 -7
  106. package/types/Mandates.d.ts +0 -77
  107. package/types/PaymentIntents.d.ts +1 -503
  108. package/types/PaymentIntentsResource.d.ts +3464 -7064
  109. package/types/PaymentLinks.d.ts +0 -3
  110. package/types/PaymentLinksResource.d.ts +0 -6
  111. package/types/PaymentMethodConfigurations.d.ts +0 -36
  112. package/types/PaymentMethodConfigurationsResource.d.ts +0 -50
  113. package/types/PaymentMethods.d.ts +0 -67
  114. package/types/PaymentMethodsResource.d.ts +0 -88
  115. package/types/Prices.d.ts +0 -22
  116. package/types/PricesResource.d.ts +0 -22
  117. package/types/Products.d.ts +0 -39
  118. package/types/ProductsResource.d.ts +28 -37
  119. package/types/PromotionCodes.d.ts +1 -1
  120. package/types/PromotionCodesResource.d.ts +3 -1
  121. package/types/Quotes.d.ts +1 -596
  122. package/types/QuotesResource.d.ts +199 -2531
  123. package/types/SetupAttempts.d.ts +0 -10
  124. package/types/SetupIntents.d.ts +1 -111
  125. package/types/SetupIntentsResource.d.ts +3 -522
  126. package/types/Sources.d.ts +0 -23
  127. package/types/SubscriptionItems.d.ts +0 -21
  128. package/types/SubscriptionItemsResource.d.ts +0 -109
  129. package/types/SubscriptionSchedules.d.ts +0 -200
  130. package/types/SubscriptionSchedulesResource.d.ts +13 -1231
  131. package/types/Subscriptions.d.ts +1 -82
  132. package/types/SubscriptionsResource.d.ts +5 -350
  133. package/types/Tax/Settings.d.ts +1 -1
  134. package/types/Terminal/Readers.d.ts +0 -278
  135. package/types/Terminal/ReadersResource.d.ts +13 -212
  136. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -63
  137. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  138. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  139. package/types/ThinEvent.d.ts +36 -0
  140. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  141. package/types/Treasury/FinancialAccountsResource.d.ts +0 -10
  142. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  143. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  144. package/types/Treasury/ReceivedCredits.d.ts +5 -27
  145. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  146. package/types/V2/Billing/MeterEventAdjustments.d.ts +65 -0
  147. package/types/V2/Billing/MeterEventAdjustmentsResource.d.ts +47 -0
  148. package/types/V2/Billing/MeterEventSessionResource.d.ts +26 -0
  149. package/types/V2/Billing/MeterEventSessions.d.ts +45 -0
  150. package/types/V2/Billing/MeterEventStreamResource.d.ts +62 -0
  151. package/types/V2/Billing/MeterEvents.d.ts +54 -0
  152. package/types/V2/Billing/MeterEventsResource.d.ts +52 -0
  153. package/types/V2/BillingResource.d.ts +14 -0
  154. package/types/V2/Core/EventsResource.d.ts +57 -0
  155. package/types/V2/CoreResource.d.ts +11 -0
  156. package/types/V2/EventTypes.d.ts +214 -0
  157. package/types/V2/Events.d.ts +75 -0
  158. package/types/V2Resource.d.ts +10 -0
  159. package/types/WebhookEndpointsResource.d.ts +2 -65
  160. package/types/index.d.ts +67 -53
  161. package/types/lib.d.ts +1 -6
  162. package/types/test/typescriptTest.ts +3 -3
  163. package/cjs/resources/AccountNotices.js +0 -21
  164. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  165. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  166. package/cjs/resources/GiftCards/Cards.js +0 -23
  167. package/cjs/resources/GiftCards/Transactions.js +0 -33
  168. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  169. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  170. package/cjs/resources/Margins.js +0 -22
  171. package/cjs/resources/Orders.js +0 -24
  172. package/cjs/resources/Tax/Associations.js +0 -9
  173. package/cjs/resources/Tax/Forms.js +0 -20
  174. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  175. package/esm/resources/AccountNotices.js +0 -18
  176. package/esm/resources/Capital/FinancingOffers.js +0 -18
  177. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  178. package/esm/resources/GiftCards/Cards.js +0 -20
  179. package/esm/resources/GiftCards/Transactions.js +0 -30
  180. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  181. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  182. package/esm/resources/Margins.js +0 -19
  183. package/esm/resources/Orders.js +0 -21
  184. package/esm/resources/Tax/Associations.js +0 -6
  185. package/esm/resources/Tax/Forms.js +0 -17
  186. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  187. package/types/AccountNotices.d.ts +0 -113
  188. package/types/AccountNoticesResource.d.ts +0 -98
  189. package/types/Billing/MeterErrorReports.d.ts +0 -106
  190. package/types/Capital/FinancingOffers.d.ts +0 -188
  191. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  192. package/types/Capital/FinancingSummary.d.ts +0 -106
  193. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  194. package/types/Capital/FinancingTransactions.d.ts +0 -135
  195. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  196. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  197. package/types/FinancialConnections/Institutions.d.ts +0 -93
  198. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  199. package/types/GiftCards/Cards.d.ts +0 -118
  200. package/types/GiftCards/CardsResource.d.ts +0 -159
  201. package/types/GiftCards/Transactions.d.ts +0 -129
  202. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  203. package/types/InvoicePayments.d.ts +0 -138
  204. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  205. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  206. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -73
  207. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  208. package/types/Issuing/Settlements.d.ts +0 -103
  209. package/types/Margins.d.ts +0 -56
  210. package/types/MarginsResource.d.ts +0 -114
  211. package/types/Orders.d.ts +0 -1084
  212. package/types/OrdersResource.d.ts +0 -2765
  213. package/types/QuoteLines.d.ts +0 -634
  214. package/types/QuotePreviewInvoices.d.ts +0 -1548
  215. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -814
  216. package/types/Tax/Associations.d.ts +0 -126
  217. package/types/Tax/AssociationsResource.d.ts +0 -29
  218. package/types/Tax/Forms.d.ts +0 -133
  219. package/types/Tax/FormsResource.d.ts +0 -90
  220. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  221. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
@@ -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,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,14 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const DisputeSettlementDetails = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/issuing/dispute_settlement_details/{dispute_settlement_detail}',
8
- }),
9
- list: stripeMethod({
10
- method: 'GET',
11
- fullPath: '/v1/issuing/dispute_settlement_details',
12
- methodType: 'list',
13
- }),
14
- });
@@ -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,6 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const Associations = StripeResource.extend({
5
- find: stripeMethod({ method: 'GET', fullPath: '/v1/tax/associations/find' }),
6
- });
@@ -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,9 +0,0 @@
1
- // File generated from our OpenAPI spec
2
- import { StripeResource } from '../../StripeResource.js';
3
- const stripeMethod = StripeResource.method;
4
- export const ReaderCollectedData = StripeResource.extend({
5
- retrieve: stripeMethod({
6
- method: 'GET',
7
- fullPath: '/v1/terminal/reader_collected_data/{reader_collected_data}',
8
- }),
9
- });
@@ -1,113 +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_not_providing_business_model_clarification'
100
- | 'issuing.account_closed_for_not_providing_url_clarification'
101
- | 'issuing.account_closed_for_not_providing_use_case_clarification'
102
- | 'issuing.account_closed_for_terms_of_service_violation'
103
- | 'issuing.application_rejected_for_failure_to_verify'
104
- | 'issuing.credit_application_rejected'
105
- | 'issuing.credit_increase_application_rejected'
106
- | 'issuing.credit_limit_decreased'
107
- | 'issuing.credit_line_closed'
108
- | 'issuing.dispute_lost'
109
- | 'issuing.dispute_submitted'
110
- | 'issuing.dispute_won';
111
- }
112
- }
113
- }
@@ -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
- }
@@ -1,106 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Billing {
6
- /**
7
- * The MeterErrorReport object.
8
- */
9
- interface MeterErrorReport {
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: 'billing.meter_error_report';
19
-
20
- reason: MeterErrorReport.Reason;
21
-
22
- /**
23
- * The related objects about the error
24
- */
25
- related_object: MeterErrorReport.RelatedObject | null;
26
-
27
- /**
28
- * Summary of invalid events
29
- */
30
- summary: string;
31
-
32
- /**
33
- * Time when validation ended. Measured in seconds since the Unix epoch
34
- */
35
- validation_end: number;
36
-
37
- /**
38
- * Time when validation started. Measured in seconds since the Unix epoch
39
- */
40
- validation_start: number;
41
- }
42
-
43
- namespace MeterErrorReport {
44
- interface Reason {
45
- /**
46
- * The number of errors generated
47
- */
48
- error_count: number;
49
-
50
- /**
51
- * More information about errors
52
- */
53
- error_types: Array<Reason.ErrorType>;
54
- }
55
-
56
- namespace Reason {
57
- interface ErrorType {
58
- sample_errors: Array<ErrorType.SampleError>;
59
- }
60
-
61
- namespace ErrorType {
62
- interface SampleError {
63
- api_request: SampleError.ApiRequest | null;
64
-
65
- /**
66
- * message of the error
67
- */
68
- error_message: string;
69
- }
70
-
71
- namespace SampleError {
72
- interface ApiRequest {
73
- /**
74
- * Unique identifier for the object.
75
- */
76
- id: string;
77
-
78
- /**
79
- * idempotency_key of the request
80
- */
81
- idempotency_key: string;
82
- }
83
- }
84
- }
85
- }
86
-
87
- interface RelatedObject {
88
- /**
89
- * Unique identifier for the object.
90
- */
91
- id: string;
92
-
93
- /**
94
- * The type of meter error related object. Should be 'meter'
95
- */
96
- object: string;
97
-
98
- /**
99
- * The url of the meter object
100
- */
101
- url: string;
102
- }
103
- }
104
- }
105
- }
106
- }