stripe 12.17.0 → 12.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,8 +1,14 @@
1
1
  # Changelog
2
2
 
3
+ ## 12.18.0 - 2023-08-10
4
+ * [#1867](https://github.com/stripe/stripe-node/pull/1867) Update generated code
5
+ * Add support for new values `incorporated_partnership` and `unincorporated_partnership` on enums `Account.company.structure`, `AccountCreateParams.company.structure`, `AccountUpdateParams.company.structure`, and `TokenCreateParams.account.company.structure`
6
+ * Add support for new value `payment_reversal` on enum `BalanceTransaction.type`
7
+ * Change `Invoice.subscription_details.metadata` and `Invoice.subscription_details` to be required
8
+
3
9
  ## 12.17.0 - 2023-08-03
4
10
  * [#1863](https://github.com/stripe/stripe-node/pull/1863) Update generated code
5
- * Change type of `AccountCreateParams.settings.card_issuing.tos_acceptance.user_agent`, `AccountCreateParams.settings.treasury.tos_acceptance.user_agent`, `AccountUpdateParams.settings.card_issuing.tos_acceptance.user_agent`, `AccountUpdateParams.settings.treasury.tos_acceptance.user_agent`, `BillingPortal.ConfigurationCreateParams.business_profile.headline`, `BillingPortal.ConfigurationUpdateParams.business_profile.headline`, `InvoiceCreateParams.payment_settings.default_mandate`, `InvoiceCreateParams.shipping_details.phone`, `InvoicePayParams.mandate`, `InvoiceUpdateParams.default_source`, `InvoiceUpdateParams.payment_settings.default_mandate`, `InvoiceUpdateParams.shipping_details.phone`, `Issuing.CardholderCreateParams.individual.card_issuing.user_terms_acceptance.user_agent`, `Issuing.CardholderUpdateParams.individual.card_issuing.user_terms_acceptance.user_agent`, `Issuing.DisputeCreateParams.evidence.canceled.cancellation_reason`, `Issuing.DisputeCreateParams.evidence.canceled.explanation`, `Issuing.DisputeCreateParams.evidence.canceled.product_description`, `Issuing.DisputeCreateParams.evidence.duplicate.explanation`, `Issuing.DisputeCreateParams.evidence.fraudulent.explanation`, `Issuing.DisputeCreateParams.evidence.merchandise_not_as_described.explanation`, `Issuing.DisputeCreateParams.evidence.merchandise_not_as_described.return_description`, `Issuing.DisputeCreateParams.evidence.not_received.explanation`, `Issuing.DisputeCreateParams.evidence.not_received.product_description`, `Issuing.DisputeCreateParams.evidence.other.explanation`, `Issuing.DisputeCreateParams.evidence.other.product_description`, `Issuing.DisputeCreateParams.evidence.service_not_as_described.cancellation_reason`, `Issuing.DisputeCreateParams.evidence.service_not_as_described.explanation`, `Issuing.DisputeUpdateParams.evidence.canceled.cancellation_reason`, `Issuing.DisputeUpdateParams.evidence.canceled.explanation`, `Issuing.DisputeUpdateParams.evidence.canceled.product_description`, `Issuing.DisputeUpdateParams.evidence.duplicate.explanation`, `Issuing.DisputeUpdateParams.evidence.fraudulent.explanation`, `Issuing.DisputeUpdateParams.evidence.merchandise_not_as_described.explanation`, `Issuing.DisputeUpdateParams.evidence.merchandise_not_as_described.return_description`, `Issuing.DisputeUpdateParams.evidence.not_received.explanation`, `Issuing.DisputeUpdateParams.evidence.not_received.product_description`, `Issuing.DisputeUpdateParams.evidence.other.explanation`, `Issuing.DisputeUpdateParams.evidence.other.product_description`, `Issuing.DisputeUpdateParams.evidence.service_not_as_described.cancellation_reason`, `Issuing.DisputeUpdateParams.evidence.service_not_as_described.explanation`, `PaymentIntentConfirmParams.payment_method_data.billing_details.name`, `PaymentIntentConfirmParams.payment_method_data.billing_details.phone`, `PaymentIntentConfirmParams.payment_method_options.konbini.confirmation_number`, `PaymentIntentConfirmParams.payment_method_options.konbini.product_description`, `PaymentIntentCreateParams.payment_method_data.billing_details.name`, `PaymentIntentCreateParams.payment_method_data.billing_details.phone`, `PaymentIntentCreateParams.payment_method_options.konbini.confirmation_number`, `PaymentIntentCreateParams.payment_method_options.konbini.product_description`, `PaymentIntentUpdateParams.payment_method_data.billing_details.name`, `PaymentIntentUpdateParams.payment_method_data.billing_details.phone`, `PaymentIntentUpdateParams.payment_method_options.konbini.confirmation_number`, `PaymentIntentUpdateParams.payment_method_options.konbini.product_description`, `PaymentMethodCreateParams.billing_details.name`, `PaymentMethodCreateParams.billing_details.phone`, `PaymentMethodUpdateParams.billing_details.name`, `PaymentMethodUpdateParams.billing_details.phone`, `ProductUpdateParams.caption`, `ProductUpdateParams.description`, `ProductUpdateParams.unit_label`, `QuoteCreateParams.description`, `QuoteCreateParams.footer`, `QuoteCreateParams.header`, `QuoteUpdateParams.description`, `QuoteUpdateParams.footer`, `QuoteUpdateParams.header`, `QuoteUpdateParams.subscription_data.description`, `SetupIntentConfirmParams.payment_method_data.billing_details.name`, `SetupIntentConfirmParams.payment_method_data.billing_details.phone`, `SetupIntentCreateParams.payment_method_data.billing_details.name`, `SetupIntentCreateParams.payment_method_data.billing_details.phone`, `SetupIntentUpdateParams.payment_method_data.billing_details.name`, `SetupIntentUpdateParams.payment_method_data.billing_details.phone`, `SubscriptionCancelParams.cancellation_details.comment`, `SubscriptionScheduleCreateParams.default_settings.description`, `SubscriptionScheduleCreateParams.phases[].description`, `SubscriptionScheduleUpdateParams.default_settings.description`, `SubscriptionScheduleUpdateParams.phases[].description`, `SubscriptionUpdateParams.cancellation_details.comment`, `SubscriptionUpdateParams.default_source`, `SubscriptionUpdateParams.description`, `Tax.CalculationCreateParams.customer_details.address.city`, `Tax.CalculationCreateParams.customer_details.address.line1`, `Tax.CalculationCreateParams.customer_details.address.line2`, `Tax.CalculationCreateParams.customer_details.address.postal_code`, `Tax.CalculationCreateParams.customer_details.address.state`, `Terminal.LocationUpdateParams.configuration_overrides`, `Terminal.ReaderUpdateParams.label`, `TokenCreateParams.person.documents.company_authorization.files[]`, `TokenCreateParams.person.documents.passport.files[]`, `TokenCreateParams.person.documents.visa.files[]`, `Treasury.OutboundPaymentCreateParams.destination_payment_method_data.billing_details.name`, `Treasury.OutboundPaymentCreateParams.destination_payment_method_data.billing_details.phone`, `WebhookEndpointCreateParams.description`, and `WebhookEndpointUpdateParams.description` from `string` to `emptyStringable(string)`
11
+ * Change many types from `string` to `emptyStringable(string)`
6
12
  * Add support for `subscription_details` on `Invoice`
7
13
  * Add support for `preferred_settlement_speed` on `PaymentIntent.payment_method_options.us_bank_account`, `PaymentIntentConfirmParams.payment_method_options.us_bank_account`, `PaymentIntentCreateParams.payment_method_options.us_bank_account`, and `PaymentIntentUpdateParams.payment_method_options.us_bank_account`
8
14
  * Add support for new values `sepa_debit_fingerprint` and `us_bank_account_fingerprint` on enums `Radar.ValueList.item_type` and `Radar.ValueListCreateParams.item_type`
package/VERSION CHANGED
@@ -1 +1 @@
1
- 12.17.0
1
+ 12.18.0
@@ -34,7 +34,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
34
34
  ];
35
35
  const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
36
36
  function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
37
- Stripe.PACKAGE_VERSION = '12.17.0';
37
+ Stripe.PACKAGE_VERSION = '12.18.0';
38
38
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
39
39
  Stripe.StripeResource = StripeResource_js_1.StripeResource;
40
40
  Stripe.resources = resources;
@@ -31,7 +31,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
31
31
  ];
32
32
  const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
33
33
  export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
34
- Stripe.PACKAGE_VERSION = '12.17.0';
34
+ Stripe.PACKAGE_VERSION = '12.18.0';
35
35
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
36
36
  Stripe.StripeResource = StripeResource;
37
37
  Stripe.resources = resources;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stripe",
3
- "version": "12.17.0",
3
+ "version": "12.18.0",
4
4
  "description": "Stripe API wrapper",
5
5
  "keywords": [
6
6
  "stripe",
@@ -621,6 +621,7 @@ declare module 'stripe' {
621
621
  | 'government_instrumentality'
622
622
  | 'governmental_unit'
623
623
  | 'incorporated_non_profit'
624
+ | 'incorporated_partnership'
624
625
  | 'limited_liability_partnership'
625
626
  | 'llc'
626
627
  | 'multi_member_llc'
@@ -635,7 +636,8 @@ declare module 'stripe' {
635
636
  | 'sole_proprietorship'
636
637
  | 'tax_exempt_government_instrumentality'
637
638
  | 'unincorporated_association'
638
- | 'unincorporated_non_profit';
639
+ | 'unincorporated_non_profit'
640
+ | 'unincorporated_partnership';
639
641
 
640
642
  interface Verification {
641
643
  document: Verification.Document;
@@ -711,6 +711,7 @@ declare module 'stripe' {
711
711
  | 'government_instrumentality'
712
712
  | 'governmental_unit'
713
713
  | 'incorporated_non_profit'
714
+ | 'incorporated_partnership'
714
715
  | 'limited_liability_partnership'
715
716
  | 'llc'
716
717
  | 'multi_member_llc'
@@ -725,7 +726,8 @@ declare module 'stripe' {
725
726
  | 'sole_proprietorship'
726
727
  | 'tax_exempt_government_instrumentality'
727
728
  | 'unincorporated_association'
728
- | 'unincorporated_non_profit';
729
+ | 'unincorporated_non_profit'
730
+ | 'unincorporated_partnership';
729
731
 
730
732
  interface Verification {
731
733
  /**
@@ -1991,6 +1993,7 @@ declare module 'stripe' {
1991
1993
  | 'government_instrumentality'
1992
1994
  | 'governmental_unit'
1993
1995
  | 'incorporated_non_profit'
1996
+ | 'incorporated_partnership'
1994
1997
  | 'limited_liability_partnership'
1995
1998
  | 'llc'
1996
1999
  | 'multi_member_llc'
@@ -2005,7 +2008,8 @@ declare module 'stripe' {
2005
2008
  | 'sole_proprietorship'
2006
2009
  | 'tax_exempt_government_instrumentality'
2007
2010
  | 'unincorporated_association'
2008
- | 'unincorporated_non_profit';
2011
+ | 'unincorporated_non_profit'
2012
+ | 'unincorporated_partnership';
2009
2013
 
2010
2014
  interface Verification {
2011
2015
  /**
@@ -3359,7 +3363,7 @@ declare module 'stripe' {
3359
3363
  * for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express
3360
3364
  * below.
3361
3365
  *
3362
- * To update your own account, use the [Dashboard](https://dashboard.stripe.com/account). Refer to our
3366
+ * To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
3363
3367
  * [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
3364
3368
  */
3365
3369
  update(
@@ -3382,7 +3386,7 @@ declare module 'stripe' {
3382
3386
  *
3383
3387
  * Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
3384
3388
  *
3385
- * If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/account) instead.
3389
+ * If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
3386
3390
  */
3387
3391
  del(
3388
3392
  id: string,
@@ -98,7 +98,7 @@ declare module 'stripe' {
98
98
  status: string;
99
99
 
100
100
  /**
101
- * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead.
101
+ * Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead.
102
102
  */
103
103
  type: BalanceTransaction.Type;
104
104
  }
@@ -148,6 +148,7 @@ declare module 'stripe' {
148
148
  | 'payment'
149
149
  | 'payment_failure_refund'
150
150
  | 'payment_refund'
151
+ | 'payment_reversal'
151
152
  | 'payout'
152
153
  | 'payout_cancel'
153
154
  | 'payout_failure'
@@ -38,7 +38,7 @@ declare module 'stripe' {
38
38
  source?: string;
39
39
 
40
40
  /**
41
- * Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
41
+ * Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
42
42
  */
43
43
  type?: string;
44
44
  }
@@ -25,7 +25,7 @@ declare module 'stripe' {
25
25
  flow_data?: SessionCreateParams.FlowData;
26
26
 
27
27
  /**
28
- * The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used.
28
+ * The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer's `preferred_locales` or browser's locale is used.
29
29
  */
30
30
  locale?: SessionCreateParams.Locale;
31
31
 
@@ -3,7 +3,7 @@
3
3
  declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  /**
6
- * The CreditNoteLineItem object.
6
+ * The credit note line item object
7
7
  */
8
8
  interface CreditNoteLineItem {
9
9
  /**
@@ -19,6 +19,8 @@ declare module 'stripe' {
19
19
  */
20
20
  object: 'customer_cash_balance_transaction';
21
21
 
22
+ adjusted_for_overdraft?: CustomerCashBalanceTransaction.AdjustedForOverdraft;
23
+
22
24
  applied_to_payment?: CustomerCashBalanceTransaction.AppliedToPayment;
23
25
 
24
26
  /**
@@ -64,6 +66,13 @@ declare module 'stripe' {
64
66
  }
65
67
 
66
68
  namespace CustomerCashBalanceTransaction {
69
+ interface AdjustedForOverdraft {
70
+ /**
71
+ * The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
72
+ */
73
+ linked_transaction: string | Stripe.CustomerCashBalanceTransaction;
74
+ }
75
+
67
76
  interface AppliedToPayment {
68
77
  /**
69
78
  * The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.
@@ -181,6 +190,7 @@ declare module 'stripe' {
181
190
  }
182
191
 
183
192
  type Type =
193
+ | 'adjusted_for_overdraft'
184
194
  | 'applied_to_payment'
185
195
  | 'funded'
186
196
  | 'funding_reversed'
@@ -381,7 +381,7 @@ declare module 'stripe' {
381
381
  /**
382
382
  * Details about the subscription that created this invoice.
383
383
  */
384
- subscription_details?: Invoice.SubscriptionDetails | null;
384
+ subscription_details: Invoice.SubscriptionDetails | null;
385
385
 
386
386
  /**
387
387
  * Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
@@ -1196,7 +1196,7 @@ declare module 'stripe' {
1196
1196
  /**
1197
1197
  * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will reflect the metadata of the subscription at the time of invoice creation. *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
1198
1198
  */
1199
- metadata?: Stripe.Metadata | null;
1199
+ metadata: Stripe.Metadata | null;
1200
1200
  }
1201
1201
 
1202
1202
  interface ThresholdReason {
@@ -44,7 +44,9 @@ declare module 'stripe' {
44
44
  display_name: string;
45
45
 
46
46
  /**
47
- * Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage does not include the statutory tax rate of non-taxable jurisdictions.
47
+ * Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,
48
+ * this percentage reflects the rate actually used to calculate tax based on the product's taxability
49
+ * and whether the user is registered to collect taxes in the corresponding jurisdiction.
48
50
  */
49
51
  effective_percentage: number | null;
50
52
 
@@ -197,6 +197,7 @@ declare module 'stripe' {
197
197
  | 'government_instrumentality'
198
198
  | 'governmental_unit'
199
199
  | 'incorporated_non_profit'
200
+ | 'incorporated_partnership'
200
201
  | 'limited_liability_partnership'
201
202
  | 'llc'
202
203
  | 'multi_member_llc'
@@ -211,7 +212,8 @@ declare module 'stripe' {
211
212
  | 'sole_proprietorship'
212
213
  | 'tax_exempt_government_instrumentality'
213
214
  | 'unincorporated_association'
214
- | 'unincorporated_non_profit';
215
+ | 'unincorporated_non_profit'
216
+ | 'unincorporated_partnership';
215
217
 
216
218
  interface Verification {
217
219
  /**