Update generated code (stripe#2171)

stripe-openapi[bot] · helenye-stripe · web-flow · commit 4dfbdd4b522c · 2024-09-12T21:57:46.000Z
* Update generated code for v1249

* Update generated code for v1250

* Update generated code for v1252

* Update generated code for v1255

* Update generated code for v1257

* Update generated code for v1259

* Update generated code for v1260

---------

Co-authored-by: Stripe OpenAPI &lt;105521251+stripe-openapi[bot]@users.noreply.github.com&gt;
Co-authored-by: helenye-stripe &lt;111009531+helenye-stripe@users.noreply.github.com&gt;
diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION
@@ -1 +1 @@
-v1246
+v1260
diff --git a/src/resources.ts b/src/resources.ts
@@ -88,6 +88,7 @@ export {ExchangeRates} from './resources/ExchangeRates.js';
 export {FileLinks} from './resources/FileLinks.js';
 export {Files} from './resources/Files.js';
 export {InvoiceItems} from './resources/InvoiceItems.js';
+export {InvoiceRenderingTemplates} from './resources/InvoiceRenderingTemplates.js';
 export {Invoices} from './resources/Invoices.js';
 export {Mandates} from './resources/Mandates.js';
 export {OAuth} from './resources/OAuth.js';
diff --git a/src/resources/InvoiceRenderingTemplates.ts b/src/resources/InvoiceRenderingTemplates.ts
@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec
+
+import {StripeResource} from '../StripeResource.js';
+const stripeMethod = StripeResource.method;
+export const InvoiceRenderingTemplates = StripeResource.extend({
+  retrieve: stripeMethod({
+    method: 'GET',
+    fullPath: '/v1/invoice_rendering_templates/{template}',
+  }),
+  list: stripeMethod({
+    method: 'GET',
+    fullPath: '/v1/invoice_rendering_templates',
+    methodType: 'list',
+  }),
+  archive: stripeMethod({
+    method: 'POST',
+    fullPath: '/v1/invoice_rendering_templates/{template}/archive',
+  }),
+  unarchive: stripeMethod({
+    method: 'POST',
+    fullPath: '/v1/invoice_rendering_templates/{template}/unarchive',
+  }),
+});
diff --git a/test/resources/generated_examples_test.spec.js b/test/resources/generated_examples_test.spec.js
diff --git a/types/Checkout/Sessions.d.ts b/types/Checkout/Sessions.d.ts
@@ -2026,6 +2026,15 @@ declare module 'stripe' {
            * Indicates whether tax ID collection is enabled for the session
            */
           enabled: boolean;
+
+          /**
+           * Indicates whether a tax ID is required on the payment page
+           */
+          required: TaxIdCollection.Required;
+        }
+
+        namespace TaxIdCollection {
+          type Required = 'if_supported' | 'never';
         }
 
         interface TotalDetails {
diff --git a/types/Checkout/SessionsResource.d.ts b/types/Checkout/SessionsResource.d.ts
@@ -2478,6 +2478,15 @@ declare module 'stripe' {
            * Enable tax ID collection during checkout. Defaults to `false`.
            */
           enabled: boolean;
+
+          /**
+           * Describes whether a tax ID is required during checkout. Defaults to `never`.
+           */
+          required?: TaxIdCollection.Required;
+        }
+
+        namespace TaxIdCollection {
+          type Required = 'if_supported' | 'never';
         }
 
         type UiMode = 'embedded' | 'hosted';
diff --git a/types/Customers.d.ts b/types/Customers.d.ts
@@ -197,6 +197,11 @@ declare module 'stripe' {
            * How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
            */
           amount_tax_display: string | null;
+
+          /**
+           * ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.
+           */
+          template: string | null;
         }
       }
 
diff --git a/types/CustomersResource.d.ts b/types/CustomersResource.d.ts
@@ -171,6 +171,11 @@ declare module 'stripe' {
           amount_tax_display?: Stripe.Emptyable<
             RenderingOptions.AmountTaxDisplay
           >;
+
+          /**
+           * ID of the invoice rendering template to use for future invoices.
+           */
+          template?: string;
         }
 
         namespace RenderingOptions {
@@ -477,6 +482,11 @@ declare module 'stripe' {
           amount_tax_display?: Stripe.Emptyable<
             RenderingOptions.AmountTaxDisplay
           >;
+
+          /**
+           * ID of the invoice rendering template to use for future invoices.
+           */
+          template?: string;
         }
 
         namespace RenderingOptions {
diff --git a/types/InvoiceLineItems.d.ts b/types/InvoiceLineItems.d.ts
@@ -113,12 +113,12 @@ declare module 'stripe' {
       /**
        * The amount of tax calculated per tax rate for this line item
        */
-      tax_amounts?: Array<InvoiceLineItem.TaxAmount>;
+      tax_amounts: Array<InvoiceLineItem.TaxAmount>;
 
       /**
        * The tax rates which apply to the line item.
        */
-      tax_rates?: Array<Stripe.TaxRate>;
+      tax_rates: Array<Stripe.TaxRate>;
 
       /**
        * A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.
diff --git a/types/InvoiceRenderingTemplates.d.ts b/types/InvoiceRenderingTemplates.d.ts
@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The InvoiceRenderingTemplate object.
+     */
+    interface InvoiceRenderingTemplate {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'invoice_rendering_template';
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+       */
+      livemode: boolean;
+
+      /**
+       * 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.
+       */
+      metadata: Stripe.Metadata | null;
+
+      /**
+       * A brief description of the template, hidden from customers
+       */
+      nickname: string | null;
+
+      /**
+       * The status of the template, one of `active` or `archived`.
+       */
+      status: InvoiceRenderingTemplate.Status;
+
+      /**
+       * Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
+       */
+      version: number;
+    }
+
+    namespace InvoiceRenderingTemplate {
+      type Status = 'active' | 'archived';
+    }
+  }
+}
diff --git a/types/InvoiceRenderingTemplatesResource.d.ts b/types/InvoiceRenderingTemplatesResource.d.ts
@@ -0,0 +1,93 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface InvoiceRenderingTemplateRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      version?: number;
+    }
+
+    interface InvoiceRenderingTemplateListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      status?: InvoiceRenderingTemplateListParams.Status;
+    }
+
+    namespace InvoiceRenderingTemplateListParams {
+      type Status = 'active' | 'archived';
+    }
+
+    interface InvoiceRenderingTemplateArchiveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface InvoiceRenderingTemplateUnarchiveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class InvoiceRenderingTemplatesResource {
+      /**
+       * Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.
+       */
+      retrieve(
+        id: string,
+        params?: InvoiceRenderingTemplateRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoiceRenderingTemplate>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoiceRenderingTemplate>>;
+
+      /**
+       * List all templates, ordered by creation date, with the most recently created template appearing first.
+       */
+      list(
+        params?: InvoiceRenderingTemplateListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.InvoiceRenderingTemplate>;
+      list(
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.InvoiceRenderingTemplate>;
+
+      /**
+       * Updates the status of an invoice rendering template to ‘archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.
+       */
+      archive(
+        id: string,
+        params?: InvoiceRenderingTemplateArchiveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoiceRenderingTemplate>>;
+      archive(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoiceRenderingTemplate>>;
+
+      /**
+       * Unarchive an invoice rendering template so it can be used on new Stripe objects again.
+       */
+      unarchive(
+        id: string,
+        params?: InvoiceRenderingTemplateUnarchiveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoiceRenderingTemplate>>;
+      unarchive(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoiceRenderingTemplate>>;
+    }
+  }
+}
diff --git a/types/Invoices.d.ts b/types/Invoices.d.ts
@@ -1199,6 +1199,16 @@ declare module 'stripe' {
          * Invoice pdf rendering options
          */
         pdf: Rendering.Pdf | null;
+
+        /**
+         * ID of the rendering template that the invoice is formatted by.
+         */
+        template: string | null;
+
+        /**
+         * Version of the rendering template that the invoice is using.
+         */
+        template_version: number | null;
       }
 
       namespace Rendering {
diff --git a/types/InvoicesResource.d.ts b/types/InvoicesResource.d.ts
@@ -539,6 +539,16 @@ declare module 'stripe' {
          * Invoice pdf rendering options
          */
         pdf?: Rendering.Pdf;
+
+        /**
+         * ID of the invoice rendering template to use for this invoice.
+         */
+        template?: string;
+
+        /**
+         * The specific version of invoice rendering template to use for this invoice.
+         */
+        template_version?: Stripe.Emptyable<number>;
       }
 
       namespace Rendering {
@@ -1231,6 +1241,16 @@ declare module 'stripe' {
          * Invoice pdf rendering options
          */
         pdf?: Rendering.Pdf;
+
+        /**
+         * ID of the invoice rendering template to use for this invoice.
+         */
+        template?: string;
+
+        /**
+         * The specific version of invoice rendering template to use for this invoice.
+         */
+        template_version?: Stripe.Emptyable<number>;
       }
 
       namespace Rendering {
diff --git a/types/Issuing/Cards.d.ts b/types/Issuing/Cards.d.ts
@@ -246,7 +246,8 @@ declare module 'stripe' {
             | 'failure'
             | 'pending'
             | 'returned'
-            | 'shipped';
+            | 'shipped'
+            | 'submitted';
 
           type Type = 'bulk' | 'individual';
         }
diff --git a/types/PaymentLinks.d.ts b/types/PaymentLinks.d.ts
@@ -933,6 +933,12 @@ declare module 'stripe' {
          * Indicates whether tax ID collection is enabled for the session.
          */
         enabled: boolean;
+
+        required: TaxIdCollection.Required;
+      }
+
+      namespace TaxIdCollection {
+        type Required = 'if_supported' | 'never';
       }
 
       interface TransferData {
diff --git a/types/PaymentLinksResource.d.ts b/types/PaymentLinksResource.d.ts
@@ -992,6 +992,15 @@ declare module 'stripe' {
          * Enable tax ID collection during checkout. Defaults to `false`.
          */
         enabled: boolean;
+
+        /**
+         * Describes whether a tax ID is required during checkout. Defaults to `never`.
+         */
+        required?: TaxIdCollection.Required;
+      }
+
+      namespace TaxIdCollection {
+        type Required = 'if_supported' | 'never';
       }
 
       interface TransferData {
@@ -1881,6 +1890,15 @@ declare module 'stripe' {
          * Enable tax ID collection during checkout. Defaults to `false`.
          */
         enabled: boolean;
+
+        /**
+         * Describes whether a tax ID is required during checkout. Defaults to `never`.
+         */
+        required?: TaxIdCollection.Required;
+      }
+
+      namespace TaxIdCollection {
+        type Required = 'if_supported' | 'never';
       }
     }
 
diff --git a/types/QuotesResource.d.ts b/types/QuotesResource.d.ts
@@ -39,7 +39,7 @@ declare module 'stripe' {
       description?: Stripe.Emptyable<string>;
 
       /**
-       * The discounts applied to the quote. You can only set up to one discount.
+       * The discounts applied to the quote.
        */
       discounts?: Stripe.Emptyable<Array<QuoteCreateParams.Discount>>;
 
@@ -378,7 +378,7 @@ declare module 'stripe' {
       description?: Stripe.Emptyable<string>;
 
       /**
-       * The discounts applied to the quote. You can only set up to one discount.
+       * The discounts applied to the quote.
        */
       discounts?: Stripe.Emptyable<Array<QuoteUpdateParams.Discount>>;
 
diff --git a/types/SubscriptionsResource.d.ts b/types/SubscriptionsResource.d.ts
diff --git a/types/Terminal/LocationsResource.d.ts b/types/Terminal/LocationsResource.d.ts
diff --git a/types/TestHelpers/TestClocks.d.ts b/types/TestHelpers/TestClocks.d.ts
diff --git a/types/index.d.ts b/types/index.d.ts

Original file line number	Diff line number	Diff line change
`@@ -197,6 +197,11 @@ declare module 'stripe' {`
`197`	`197`	`* How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.`
`198`	`198`	`*/`
`199`	`199`	`amount_tax_display: string \| null;`
	`200`	`+`
	`201`	`+ /**`
	`202`	`+ * ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.`
	`203`	`+ */`
	`204`	`+ template: string \| null;`
`200`	`205`	`}`
`201`	`206`	`}`
`202`	`207`