stripe 12.12.0 → 12.13.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 12.13.0 - 2023-07-13
+* [#1838](https://github.com/stripe/stripe-node/pull/1838) Update generated code
+  * Add support for new resource `Tax.Settings`
+  * Add support for `retrieve` and `update` methods on resource `Settings`
+  * Add support for new value `invalid_tax_location` on enums `Invoice.last_finalization_error.code`, `PaymentIntent.last_payment_error.code`, `SetupAttempt.setup_error.code`, `SetupIntent.last_setup_error.code`, and `StripeError.code`
+  * Add support for `order_id` on `Charge.payment_method_details.afterpay_clearpay`
+  * Add support for `allow_redirects` on `PaymentIntent.automatic_payment_methods`, `PaymentIntentCreateParams.automatic_payment_methods`, `SetupIntent.automatic_payment_methods`, and `SetupIntentCreateParams.automatic_payment_methods`
+  * Add support for new values `amusement_tax` and `communications_tax` on enums `Tax.Calculation.shipping_cost.tax_breakdown[].tax_rate_details.tax_type`, `Tax.Calculation.tax_breakdown[].tax_rate_details.tax_type`, `Tax.CalculationLineItem.tax_breakdown[].tax_rate_details.tax_type`, and `Tax.Transaction.shipping_cost.tax_breakdown[].tax_rate_details.tax_type`
+  * Add support for `product` on `Tax.TransactionLineItem`
+  * Add support for new value `tax.settings.updated` on enums `WebhookEndpointCreateParams.enabled_events[]` and `WebhookEndpointUpdateParams.enabled_events[]`
+
 ## 12.12.0 - 2023-07-06
 * [#1831](https://github.com/stripe/stripe-node/pull/1831) Update generated code
   * Add support for `numeric` and `text` on `PaymentLink.custom_fields[]`

package/VERSION

@@ -1 +1 @@
-12.12.0
+12.13.0

package/cjs/resources/Tax/Settings.js

@@ -0,0 +1,10 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Settings = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+const stripeMethod = StripeResource_js_1.StripeResource.method;
+exports.Settings = StripeResource_js_1.StripeResource.extend({
+    retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/tax/settings' }),
+    update: stripeMethod({ method: 'POST', fullPath: '/v1/tax/settings' }),
+});

package/cjs/resources.js

@@ -40,6 +40,7 @@ const Secrets_js_1 = require("./resources/Apps/Secrets.js");
 const Sessions_js_1 = require("./resources/BillingPortal/Sessions.js");
 const Sessions_js_2 = require("./resources/Checkout/Sessions.js");
 const Sessions_js_3 = require("./resources/FinancialConnections/Sessions.js");
+const Settings_js_1 = require("./resources/Tax/Settings.js");
 const TestClocks_js_1 = require("./resources/TestHelpers/TestClocks.js");
 const TransactionEntries_js_1 = require("./resources/Treasury/TransactionEntries.js");
 const Transactions_js_1 = require("./resources/Issuing/Transactions.js");
@@ -178,6 +179,7 @@ exports.Sigma = (0, ResourceNamespace_js_1.resourceNamespace)('sigma', {
 });
 exports.Tax = (0, ResourceNamespace_js_1.resourceNamespace)('tax', {
     Calculations: Calculations_js_1.Calculations,
+    Settings: Settings_js_1.Settings,
     Transactions: Transactions_js_2.Transactions,
 });
 exports.Terminal = (0, ResourceNamespace_js_1.resourceNamespace)('terminal', {

package/cjs/stripe.core.js

@@ -34,7 +34,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '12.12.0';
+    Stripe.PACKAGE_VERSION = '12.13.0';
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
     Stripe.StripeResource = StripeResource_js_1.StripeResource;
     Stripe.resources = resources;

package/esm/resources/Tax/Settings.js

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../StripeResource.js';
+const stripeMethod = StripeResource.method;
+export const Settings = StripeResource.extend({
+    retrieve: stripeMethod({ method: 'GET', fullPath: '/v1/tax/settings' }),
+    update: stripeMethod({ method: 'POST', fullPath: '/v1/tax/settings' }),
+});

package/esm/resources.js

@@ -36,6 +36,7 @@ import { Secrets as AppsSecrets } from './resources/Apps/Secrets.js';
 import { Sessions as BillingPortalSessions } from './resources/BillingPortal/Sessions.js';
 import { Sessions as CheckoutSessions } from './resources/Checkout/Sessions.js';
 import { Sessions as FinancialConnectionsSessions } from './resources/FinancialConnections/Sessions.js';
+import { Settings as TaxSettings } from './resources/Tax/Settings.js';
 import { TestClocks as TestHelpersTestClocks } from './resources/TestHelpers/TestClocks.js';
 import { TransactionEntries as TreasuryTransactionEntries } from './resources/Treasury/TransactionEntries.js';
 import { Transactions as IssuingTransactions } from './resources/Issuing/Transactions.js';
@@ -128,6 +129,7 @@ export const Sigma = resourceNamespace('sigma', {
 });
 export const Tax = resourceNamespace('tax', {
     Calculations: TaxCalculations,
+    Settings: TaxSettings,
     Transactions: TaxTransactions,
 });
 export const Terminal = resourceNamespace('terminal', {

package/esm/stripe.core.js

@@ -31,7 +31,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '12.12.0';
+    Stripe.PACKAGE_VERSION = '12.13.0';
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
     Stripe.StripeResource = StripeResource;
     Stripe.resources = resources;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "12.12.0",
+  "version": "12.13.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

package/types/Charges.d.ts

@@ -570,6 +570,11 @@ declare module 'stripe' {
         interface Affirm {}
 
         interface AfterpayClearpay {
+          /**
+           * The Afterpay order ID associated with this payment intent.
+           */
+          order_id: string | null;
+
           /**
            * Order identifier shown to the merchant in Afterpay's online portal.
            */

package/types/Invoices.d.ts

@@ -763,6 +763,7 @@ declare module 'stripe' {
           | 'invalid_expiry_year'
           | 'invalid_number'
           | 'invalid_source_usage'
+          | 'invalid_tax_location'
           | 'invoice_no_customer_line_items'
           | 'invoice_no_payment_method_types'
           | 'invoice_no_subscription_line_items'

package/types/PaymentIntents.d.ts

@@ -238,12 +238,23 @@ declare module 'stripe' {
       }
 
       interface AutomaticPaymentMethods {
+        /**
+         * Controls whether this PaymentIntent will accept redirect-based payment methods.
+         *
+         * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.
+         */
+        allow_redirects?: AutomaticPaymentMethods.AllowRedirects;
+
         /**
          * Automatically calculates compatible payment methods
          */
         enabled: boolean;
       }
 
+      namespace AutomaticPaymentMethods {
+        type AllowRedirects = 'always' | 'never';
+      }
+
       type CancellationReason =
         | 'abandoned'
         | 'automatic'
@@ -422,6 +433,7 @@ declare module 'stripe' {
           | 'invalid_expiry_year'
           | 'invalid_number'
           | 'invalid_source_usage'
+          | 'invalid_tax_location'
           | 'invoice_no_customer_line_items'
           | 'invoice_no_payment_method_types'
           | 'invoice_no_subscription_line_items'

package/types/PaymentIntentsResource.d.ts

@@ -166,12 +166,23 @@ declare module 'stripe' {
 
     namespace PaymentIntentCreateParams {
       interface AutomaticPaymentMethods {
+        /**
+         * Controls whether this PaymentIntent will accept redirect-based payment methods.
+         *
+         * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment.
+         */
+        allow_redirects?: AutomaticPaymentMethods.AllowRedirects;
+
         /**
          * Whether this feature is enabled.
          */
         enabled: boolean;
       }
 
+      namespace AutomaticPaymentMethods {
+        type AllowRedirects = 'always' | 'never';
+      }
+
       type CaptureMethod = 'automatic' | 'automatic_async' | 'manual';
 
       type ConfirmationMethod = 'automatic' | 'manual';

package/types/SetupAttempts.d.ts

@@ -647,6 +647,7 @@ declare module 'stripe' {
           | 'invalid_expiry_year'
           | 'invalid_number'
           | 'invalid_source_usage'
+          | 'invalid_tax_location'
           | 'invoice_no_customer_line_items'
           | 'invoice_no_payment_method_types'
           | 'invoice_no_subscription_line_items'

package/types/SetupIntents.d.ts

@@ -160,12 +160,23 @@ declare module 'stripe' {
 
     namespace SetupIntent {
       interface AutomaticPaymentMethods {
+        /**
+         * Controls whether this SetupIntent will accept redirect-based payment methods.
+         *
+         * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.
+         */
+        allow_redirects?: AutomaticPaymentMethods.AllowRedirects;
+
         /**
          * Automatically calculates compatible payment methods
          */
         enabled: boolean | null;
       }
 
+      namespace AutomaticPaymentMethods {
+        type AllowRedirects = 'always' | 'never';
+      }
+
       type CancellationReason =
         | 'abandoned'
         | 'duplicate'
@@ -338,6 +349,7 @@ declare module 'stripe' {
           | 'invalid_expiry_year'
           | 'invalid_number'
           | 'invalid_source_usage'
+          | 'invalid_tax_location'
           | 'invoice_no_customer_line_items'
           | 'invoice_no_payment_method_types'
           | 'invoice_no_subscription_line_items'

package/types/SetupIntentsResource.d.ts

@@ -98,12 +98,23 @@ declare module 'stripe' {
 
     namespace SetupIntentCreateParams {
       interface AutomaticPaymentMethods {
+        /**
+         * Controls whether this SetupIntent will accept redirect-based payment methods.
+         *
+         * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.
+         */
+        allow_redirects?: AutomaticPaymentMethods.AllowRedirects;
+
         /**
          * Whether this feature is enabled.
          */
         enabled: boolean;
       }
 
+      namespace AutomaticPaymentMethods {
+        type AllowRedirects = 'always' | 'never';
+      }
+
       type FlowDirection = 'inbound' | 'outbound';
 
       interface MandateData {

package/types/Tax/CalculationLineItems.d.ts

@@ -33,7 +33,7 @@ declare module 'stripe' {
         livemode: boolean;
 
         /**
-         * A Product ID.
+         * The ID of an existing [Product](https://stripe.com/docs/api/products/object).
          */
         product: string | null;
 
@@ -160,6 +160,8 @@ declare module 'stripe' {
 
           namespace TaxRateDetails {
             type TaxType =
+              | 'amusement_tax'
+              | 'communications_tax'
               | 'gst'
               | 'hst'
               | 'igst'

package/types/Tax/Calculations.d.ts

@@ -208,7 +208,7 @@ declare module 'stripe' {
           amount_tax: number;
 
           /**
-           * The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object)
+           * The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).
            */
           shipping_rate?: string;
 
@@ -325,6 +325,8 @@ declare module 'stripe' {
 
             namespace TaxRateDetails {
               type TaxType =
+                | 'amusement_tax'
+                | 'communications_tax'
                 | 'gst'
                 | 'hst'
                 | 'igst'
@@ -405,6 +407,8 @@ declare module 'stripe' {
 
           namespace TaxRateDetails {
             type TaxType =
+              | 'amusement_tax'
+              | 'communications_tax'
               | 'gst'
               | 'hst'
               | 'igst'

package/types/Tax/Settings.d.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Tax {
+      /**
+       * You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.
+       *
+       * Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)
+       */
+      interface Settings {
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'tax.settings';
+
+        defaults: Settings.Defaults;
+
+        /**
+         * The place where your business is located.
+         */
+        head_office: Settings.HeadOffice | null;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * The `active` status indicates you have all required settings to calculate tax. A status can transition out of `active` when new required settings are introduced.
+         */
+        status: Settings.Status;
+
+        status_details: Settings.StatusDetails;
+      }
+
+      namespace Settings {
+        interface Defaults {
+          /**
+           * Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior.
+           */
+          tax_behavior: Defaults.TaxBehavior | null;
+
+          /**
+           * Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.
+           */
+          tax_code: string | null;
+        }
+
+        namespace Defaults {
+          type TaxBehavior = 'exclusive' | 'inclusive' | 'inferred_by_currency';
+        }
+
+        interface HeadOffice {
+          address: Stripe.Address;
+        }
+
+        type Status = 'active' | 'pending';
+
+        interface StatusDetails {
+          active?: StatusDetails.Active;
+
+          pending?: StatusDetails.Pending;
+        }
+
+        namespace StatusDetails {
+          interface Active {}
+
+          interface Pending {
+            /**
+             * The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.
+             */
+            missing_fields: Array<string> | null;
+          }
+        }
+      }
+    }
+  }
+}

package/types/Tax/SettingsResource.d.ts

@@ -0,0 +1,77 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Tax {
+      interface SettingsRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      interface SettingsUpdateParams {
+        /**
+         * Default configuration to be used on Stripe Tax calculations.
+         */
+        defaults?: SettingsUpdateParams.Defaults;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * The place where your business is located.
+         */
+        head_office?: SettingsUpdateParams.HeadOffice;
+      }
+
+      namespace SettingsUpdateParams {
+        interface Defaults {
+          /**
+           * Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.
+           */
+          tax_behavior?: Defaults.TaxBehavior;
+
+          /**
+           * A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+           */
+          tax_code?: string;
+        }
+
+        namespace Defaults {
+          type TaxBehavior = 'exclusive' | 'inclusive' | 'inferred_by_currency';
+        }
+
+        interface HeadOffice {
+          /**
+           * The location of the business for tax purposes.
+           */
+          address: Stripe.AddressParam;
+        }
+      }
+
+      class SettingsResource {
+        /**
+         * Retrieves Tax Settings for a merchant.
+         */
+        retrieve(
+          params?: SettingsRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Settings>>;
+        retrieve(
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Settings>>;
+
+        /**
+         * Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
+         */
+        update(
+          params?: SettingsUpdateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Tax.Settings>>;
+      }
+    }
+  }
+}

package/types/Tax/TransactionLineItems.d.ts

@@ -37,6 +37,11 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata | null;
 
+        /**
+         * The ID of an existing [Product](https://stripe.com/docs/api/products/object).
+         */
+        product: string | null;
+
         /**
          * The number of units of the item being purchased. For reversals, this is the quantity reversed.
          */

package/types/Tax/Transactions.d.ts

@@ -215,7 +215,7 @@ declare module 'stripe' {
           amount_tax: number;
 
           /**
-           * The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). (It is not populated for the transaction resource object and will be removed in the next API version.)
+           * The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).
            */
           shipping_rate?: string;
 
@@ -332,6 +332,8 @@ declare module 'stripe' {
 
             namespace TaxRateDetails {
               type TaxType =
+                | 'amusement_tax'
+                | 'communications_tax'
                 | 'gst'
                 | 'hst'
                 | 'igst'

package/types/WebhookEndpointsResource.d.ts

@@ -319,6 +319,7 @@ declare module 'stripe' {
         | 'subscription_schedule.expiring'
         | 'subscription_schedule.released'
         | 'subscription_schedule.updated'
+        | 'tax.settings.updated'
         | 'tax_rate.created'
         | 'tax_rate.updated'
         | 'terminal.reader.action_failed'
@@ -585,6 +586,7 @@ declare module 'stripe' {
         | 'subscription_schedule.expiring'
         | 'subscription_schedule.released'
         | 'subscription_schedule.updated'
+        | 'tax.settings.updated'
         | 'tax_rate.created'
         | 'tax_rate.updated'
         | 'terminal.reader.action_failed'

package/types/index.d.ts

@@ -65,6 +65,7 @@
 ///<reference path='./SubscriptionSchedulesResource.d.ts' />
 ///<reference path='./SubscriptionsResource.d.ts' />
 ///<reference path='./Tax/CalculationsResource.d.ts' />
+///<reference path='./Tax/SettingsResource.d.ts' />
 ///<reference path='./Tax/TransactionsResource.d.ts' />
 ///<reference path='./TaxCodesResource.d.ts' />
 ///<reference path='./TaxRatesResource.d.ts' />
@@ -177,6 +178,7 @@
 ///<reference path='./Subscriptions.d.ts' />
 ///<reference path='./Tax/CalculationLineItems.d.ts' />
 ///<reference path='./Tax/Calculations.d.ts' />
+///<reference path='./Tax/Settings.d.ts' />
 ///<reference path='./Tax/TransactionLineItems.d.ts' />
 ///<reference path='./Tax/Transactions.d.ts' />
 ///<reference path='./TaxCodes.d.ts' />
@@ -303,6 +305,7 @@ declare module 'stripe' {
     };
     tax: {
       calculations: Stripe.Tax.CalculationsResource;
+      settings: Stripe.Tax.SettingsResource;
       transactions: Stripe.Tax.TransactionsResource;
     };
     terminal: {