From 404b08a821c30a068f6aca2f123129ff34c70b41 Mon Sep 17 00:00:00 2001 From: Richard Marmorstein Date: Fri, 9 Jul 2021 11:59:39 -0400 Subject: [PATCH 1/3] Codegen for openapi 15c00c6 --- lib/resources.js | 1 + lib/resources/Quotes.js | 39 + types/2020-08-27/Charges.d.ts | 4 +- types/2020-08-27/Invoices.d.ts | 6 + types/2020-08-27/Issuing/Authorizations.d.ts | 2 +- types/2020-08-27/Quotes.d.ts | 1170 ++++++++++++++++++ types/2020-08-27/SetupAttempts.d.ts | 4 +- types/2020-08-27/index.d.ts | 2 + 8 files changed, 1223 insertions(+), 5 deletions(-) create mode 100644 lib/resources/Quotes.js create mode 100644 types/2020-08-27/Quotes.d.ts diff --git a/lib/resources.js b/lib/resources.js index e44fc6b7f1..dad08ccfa9 100644 --- a/lib/resources.js +++ b/lib/resources.js @@ -38,6 +38,7 @@ module.exports = { Prices: require('./resources/Prices'), Products: require('./resources/Products'), PromotionCodes: require('./resources/PromotionCodes'), + Quotes: require('./resources/Quotes'), Refunds: require('./resources/Refunds'), Reviews: require('./resources/Reviews'), SetupAttempts: require('./resources/SetupAttempts'), diff --git a/lib/resources/Quotes.js b/lib/resources/Quotes.js new file mode 100644 index 0000000000..119c23cdef --- /dev/null +++ b/lib/resources/Quotes.js @@ -0,0 +1,39 @@ +// File generated from our OpenAPI spec + +'use strict'; + +const StripeResource = require('../StripeResource'); +const stripeMethod = StripeResource.method; + +module.exports = StripeResource.extend({ + path: 'quotes', + + includeBasic: ['create', 'retrieve', 'update', 'list'], + + accept: stripeMethod({ + method: 'POST', + path: '/{quote}/accept', + }), + + cancel: stripeMethod({ + method: 'POST', + path: '/{quote}/cancel', + }), + + finalizeQuote: stripeMethod({ + method: 'POST', + path: '/{quote}/finalize', + }), + + listLineItems: stripeMethod({ + method: 'GET', + path: '/{quote}/line_items', + }), + + pdf: stripeMethod({ + host: 'files.stripe.com', + method: 'GET', + path: '/{quote}/pdf', + streaming: true, + }), +}); diff --git a/types/2020-08-27/Charges.d.ts b/types/2020-08-27/Charges.d.ts index 94549340ad..a513e99537 100644 --- a/types/2020-08-27/Charges.d.ts +++ b/types/2020-08-27/Charges.d.ts @@ -794,7 +794,7 @@ declare module 'stripe' { /** * Indicates the outcome of 3D Secure authentication. */ - result: ThreeDSecure.Result; + result: ThreeDSecure.Result | null; /** * Additional information about why 3D Secure succeeded or failed based @@ -805,7 +805,7 @@ declare module 'stripe' { /** * The version of 3D Secure that was used. */ - version: ThreeDSecure.Version; + version: ThreeDSecure.Version | null; } namespace ThreeDSecure { diff --git a/types/2020-08-27/Invoices.d.ts b/types/2020-08-27/Invoices.d.ts index 90538d4ed9..c9ea4081bb 100644 --- a/types/2020-08-27/Invoices.d.ts +++ b/types/2020-08-27/Invoices.d.ts @@ -266,6 +266,11 @@ declare module 'stripe' { */ pre_payment_credit_notes_amount: number; + /** + * The quote this invoice was generated from. + */ + quote?: string | Stripe.Quote | null; + /** * This is the transaction number that appears on email receipts sent for this invoice. */ @@ -356,6 +361,7 @@ declare module 'stripe' { type BillingReason = | 'automatic_pending_invoice_item_invoice' | 'manual' + | 'quote_accept' | 'subscription' | 'subscription_create' | 'subscription_cycle' diff --git a/types/2020-08-27/Issuing/Authorizations.d.ts b/types/2020-08-27/Issuing/Authorizations.d.ts index 223f9f950a..a9699a0f93 100644 --- a/types/2020-08-27/Issuing/Authorizations.d.ts +++ b/types/2020-08-27/Issuing/Authorizations.d.ts @@ -107,7 +107,7 @@ declare module 'stripe' { verification_data: Authorization.VerificationData; /** - * What, if any, digital wallet was used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. + * The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ wallet: string | null; } diff --git a/types/2020-08-27/Quotes.d.ts b/types/2020-08-27/Quotes.d.ts new file mode 100644 index 0000000000..f4a73ea756 --- /dev/null +++ b/types/2020-08-27/Quotes.d.ts @@ -0,0 +1,1170 @@ +// File generated from our OpenAPI spec + +declare module 'stripe' { + namespace Stripe { + /** + * The Quote object. + */ + interface Quote { + /** + * Unique identifier for the object. + */ + id: string; + + /** + * String representing the object's type. Objects of the same type share the same value. + */ + object: 'quote'; + + /** + * Total before any discounts or taxes are applied. + */ + amount_subtotal: number; + + /** + * Total after discounts and taxes are applied. + */ + amount_total: number; + + /** + * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. + */ + application_fee_amount: number | null; + + /** + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. + */ + application_fee_percent: number | null; + + automatic_tax?: Quote.AutomaticTax; + + /** + * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. + */ + collection_method: Quote.CollectionMethod; + + computed: Quote.Computed; + + /** + * Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + + /** + * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ + currency: string | null; + + /** + * The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. + */ + customer: string | Stripe.Customer | Stripe.DeletedCustomer | null; + + /** + * The tax rates applied to this quote. + */ + default_tax_rates?: Array; + + /** + * A description that will be displayed on the quote PDF. + */ + description: string | null; + + /** + * The discounts applied to this quote. + */ + discounts: Array; + + /** + * The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + */ + expires_at: number; + + /** + * A footer that will be displayed on the quote PDF. + */ + footer: string | null; + + /** + * Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. + */ + from_quote: Quote.FromQuote | null; + + /** + * A header that will be displayed on the quote PDF. + */ + header: string | null; + + /** + * The invoice that was created from this quote. + */ + invoice: string | Stripe.Invoice | Stripe.DeletedInvoice | null; + + /** + * All invoices will be billed using the specified settings. + */ + invoice_settings: Quote.InvoiceSettings | null; + + /** + * A list of items the customer is being quoted for. + */ + line_items?: ApiList; + + /** + * 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; + + /** + * A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). + */ + number: string | null; + + /** + * The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. + */ + on_behalf_of: string | Stripe.Account | null; + + /** + * The status of the quote. + */ + status: Quote.Status; + + status_transitions: Quote.StatusTransitions; + + /** + * The subscription that was created or updated from this quote. + */ + subscription: string | Stripe.Subscription | null; + + subscription_data: Quote.SubscriptionData; + + /** + * The subscription schedule that was created or updated from this quote. + */ + subscription_schedule: string | Stripe.SubscriptionSchedule | null; + + total_details: Quote.TotalDetails; + + /** + * The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. + */ + transfer_data: Quote.TransferData | null; + } + + namespace Quote { + interface AutomaticTax { + /** + * Automatically calculate taxes + */ + enabled: boolean; + + /** + * The status of the most recent automated tax calculation for this quote. + */ + status: AutomaticTax.Status | null; + } + + namespace AutomaticTax { + type Status = 'complete' | 'failed' | 'requires_location_inputs'; + } + + type CollectionMethod = 'charge_automatically' | 'send_invoice'; + + interface Computed { + /** + * The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. + */ + recurring: Computed.Recurring | null; + + upfront: Computed.Upfront; + } + + namespace Computed { + interface Recurring { + /** + * Total before any discounts or taxes are applied. + */ + amount_subtotal: number; + + /** + * Total after discounts and taxes are applied. + */ + amount_total: number; + + /** + * The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. + */ + interval: Recurring.Interval; + + /** + * The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. + */ + interval_count: number; + + total_details: Recurring.TotalDetails; + } + + namespace Recurring { + type Interval = 'day' | 'month' | 'week' | 'year'; + + interface TotalDetails { + /** + * This is the sum of all the line item discounts. + */ + amount_discount: number; + + /** + * This is the sum of all the line item shipping amounts. + */ + amount_shipping: number | null; + + /** + * This is the sum of all the line item tax amounts. + */ + amount_tax: number; + + breakdown?: TotalDetails.Breakdown; + } + + namespace TotalDetails { + interface Breakdown { + /** + * The aggregated line item discounts. + */ + discounts: Array; + + /** + * The aggregated line item tax amounts by rate. + */ + taxes: Array; + } + + namespace Breakdown { + interface Discount { + /** + * The amount discounted. + */ + amount: number; + + /** + * A discount represents the actual application of a coupon to a particular + * customer. It contains information about when the discount began and when it + * will end. + * + * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts). + */ + discount: Stripe.Discount; + } + + interface Tax { + /** + * Amount of tax applied for this rate. + */ + amount: number; + + /** + * Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. + * + * Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates). + */ + rate: Stripe.TaxRate; + } + } + } + } + + interface Upfront { + /** + * Total before any discounts or taxes are applied. + */ + amount_subtotal: number; + + /** + * Total after discounts and taxes are applied. + */ + amount_total: number; + + /** + * The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. + */ + line_items?: ApiList; + + total_details: Upfront.TotalDetails; + } + + namespace Upfront { + interface TotalDetails { + /** + * This is the sum of all the line item discounts. + */ + amount_discount: number; + + /** + * This is the sum of all the line item shipping amounts. + */ + amount_shipping: number | null; + + /** + * This is the sum of all the line item tax amounts. + */ + amount_tax: number; + + breakdown?: TotalDetails.Breakdown; + } + + namespace TotalDetails { + interface Breakdown { + /** + * The aggregated line item discounts. + */ + discounts: Array; + + /** + * The aggregated line item tax amounts by rate. + */ + taxes: Array; + } + + namespace Breakdown { + interface Discount { + /** + * The amount discounted. + */ + amount: number; + + /** + * A discount represents the actual application of a coupon to a particular + * customer. It contains information about when the discount began and when it + * will end. + * + * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts). + */ + discount: Stripe.Discount; + } + + interface Tax { + /** + * Amount of tax applied for this rate. + */ + amount: number; + + /** + * Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. + * + * Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates). + */ + rate: Stripe.TaxRate; + } + } + } + } + } + + interface FromQuote { + /** + * Whether this quote is a revision of a different quote. + */ + is_revision: boolean; + + /** + * The quote that was cloned. + */ + quote: string | Stripe.Quote; + } + + interface InvoiceSettings { + /** + * Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. + */ + days_until_due: number | null; + } + + type Status = 'accepted' | 'canceled' | 'draft' | 'open'; + + interface StatusTransitions { + /** + * The time that the quote was accepted. Measured in seconds since Unix epoch. + */ + accepted_at: number | null; + + /** + * The time that the quote was canceled. Measured in seconds since Unix epoch. + */ + canceled_at: number | null; + + /** + * The time that the quote was finalized. Measured in seconds since Unix epoch. + */ + finalized_at: number | null; + } + + interface SubscriptionData { + /** + * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch. + */ + effective_date: number | null; + + /** + * Integer representing the number of trial period days before the customer is charged for the first time. + */ + trial_period_days: number | null; + } + + interface TotalDetails { + /** + * This is the sum of all the line item discounts. + */ + amount_discount: number; + + /** + * This is the sum of all the line item shipping amounts. + */ + amount_shipping: number | null; + + /** + * This is the sum of all the line item tax amounts. + */ + amount_tax: number; + + breakdown?: TotalDetails.Breakdown; + } + + namespace TotalDetails { + interface Breakdown { + /** + * The aggregated line item discounts. + */ + discounts: Array; + + /** + * The aggregated line item tax amounts by rate. + */ + taxes: Array; + } + + namespace Breakdown { + interface Discount { + /** + * The amount discounted. + */ + amount: number; + + /** + * A discount represents the actual application of a coupon to a particular + * customer. It contains information about when the discount began and when it + * will end. + * + * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts). + */ + discount: Stripe.Discount; + } + + interface Tax { + /** + * Amount of tax applied for this rate. + */ + amount: number; + + /** + * Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. + * + * Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates). + */ + rate: Stripe.TaxRate; + } + } + } + + interface TransferData { + /** + * The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. + */ + amount: number | null; + + /** + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. + */ + amount_percent: number | null; + + /** + * The account where funds from the payment will be transferred to upon payment success. + */ + destination: string | Stripe.Account; + } + } + + interface QuoteCreateParams { + /** + * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field. + */ + application_fee_amount?: Stripe.Emptyable; + + /** + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. + */ + application_fee_percent?: Stripe.Emptyable; + + /** + * Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. + */ + automatic_tax?: QuoteCreateParams.AutomaticTax; + + /** + * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. + */ + collection_method?: QuoteCreateParams.CollectionMethod; + + /** + * The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. + */ + customer?: string; + + /** + * The tax rates that will apply to any line item that does not have `tax_rates` set. + */ + default_tax_rates?: Stripe.Emptyable>; + + /** + * A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. + */ + description?: string; + + /** + * The discounts applied to the quote. You can only set up to one discount. + */ + discounts?: Stripe.Emptyable>; + + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + + /** + * A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. If no value is passed, the default expiration date configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. + */ + expires_at?: number; + + /** + * A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. + */ + footer?: string; + + /** + * Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`. + */ + from_quote?: QuoteCreateParams.FromQuote; + + /** + * A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. + */ + header?: string; + + /** + * All invoices will be billed using the specified settings. + */ + invoice_settings?: QuoteCreateParams.InvoiceSettings; + + /** + * A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. + */ + line_items?: Array; + + /** + * 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`. + */ + metadata?: Stripe.MetadataParam; + + /** + * The account on behalf of which to charge. + */ + on_behalf_of?: Stripe.Emptyable; + + /** + * When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. + */ + subscription_data?: QuoteCreateParams.SubscriptionData; + + /** + * The data with which to automatically create a Transfer for each of the invoices. + */ + transfer_data?: Stripe.Emptyable; + } + + namespace QuoteCreateParams { + interface AutomaticTax { + /** + * Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself. + */ + enabled: boolean; + } + + type CollectionMethod = 'charge_automatically' | 'send_invoice'; + + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + } + + interface FromQuote { + /** + * Whether this quote is a revision of the previous quote. + */ + is_revision?: boolean; + + /** + * The `id` of the quote that will be cloned. + */ + quote: string; + } + + interface InvoiceSettings { + /** + * Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. + */ + days_until_due?: number; + } + + interface LineItem { + /** + * The ID of the price object. One of `price` or `price_data` is required. + */ + price?: string; + + /** + * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + */ + price_data?: LineItem.PriceData; + + /** + * The quantity of the line item. + */ + quantity?: number; + + /** + * The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item. + */ + tax_rates?: Stripe.Emptyable>; + } + + namespace LineItem { + interface PriceData { + /** + * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ + currency: string; + + /** + * The ID of the product that this price will belong to. + */ + product: string; + + /** + * The recurring components of a price such as `interval` and `usage_type`. + */ + recurring?: PriceData.Recurring; + + /** + * Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + */ + tax_behavior?: PriceData.TaxBehavior; + + /** + * A positive integer in %s (or 0 for a free price) representing how much to charge. + */ + unit_amount?: number; + + /** + * Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + */ + unit_amount_decimal?: string; + } + + namespace PriceData { + interface Recurring { + /** + * Specifies billing frequency. Either `day`, `week`, `month` or `year`. + */ + interval: Recurring.Interval; + + /** + * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). + */ + interval_count?: number; + } + + namespace Recurring { + type Interval = 'day' | 'month' | 'week' | 'year'; + } + + type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified'; + } + } + + interface SubscriptionData { + /** + * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted. + */ + effective_date?: Stripe.Emptyable<'current_period_end' | number>; + + /** + * Integer representing the number of trial period days before the customer is charged for the first time. + */ + trial_period_days?: Stripe.Emptyable; + } + + interface TransferData { + /** + * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. + */ + amount?: number; + + /** + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. + */ + amount_percent?: number; + + /** + * ID of an existing, connected Stripe account. + */ + destination: string; + } + } + + interface QuoteRetrieveParams { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + } + + interface QuoteUpdateParams { + /** + * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field. + */ + application_fee_amount?: Stripe.Emptyable; + + /** + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field. + */ + application_fee_percent?: Stripe.Emptyable; + + /** + * Settings for automatic tax lookup for this quote and resulting invoices and subscriptions. + */ + automatic_tax?: QuoteUpdateParams.AutomaticTax; + + /** + * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`. + */ + collection_method?: QuoteUpdateParams.CollectionMethod; + + /** + * The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. + */ + customer?: string; + + /** + * The tax rates that will apply to any line item that does not have `tax_rates` set. + */ + default_tax_rates?: Stripe.Emptyable>; + + /** + * A description that will be displayed on the quote PDF. + */ + description?: string; + + /** + * The discounts applied to the quote. You can only set up to one discount. + */ + discounts?: Stripe.Emptyable>; + + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + + /** + * A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + */ + expires_at?: number; + + /** + * A footer that will be displayed on the quote PDF. + */ + footer?: string; + + /** + * A header that will be displayed on the quote PDF. + */ + header?: string; + + /** + * All invoices will be billed using the specified settings. + */ + invoice_settings?: QuoteUpdateParams.InvoiceSettings; + + /** + * A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. + */ + line_items?: Array; + + /** + * 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`. + */ + metadata?: Stripe.MetadataParam; + + /** + * The account on behalf of which to charge. + */ + on_behalf_of?: Stripe.Emptyable; + + /** + * When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. + */ + subscription_data?: QuoteUpdateParams.SubscriptionData; + + /** + * The data with which to automatically create a Transfer for each of the invoices. + */ + transfer_data?: Stripe.Emptyable; + } + + namespace QuoteUpdateParams { + interface AutomaticTax { + /** + * Controls whether Stripe will automatically compute tax on the resulting invoices or subscriptions as well as the quote itself. + */ + enabled: boolean; + } + + type CollectionMethod = 'charge_automatically' | 'send_invoice'; + + interface Discount { + /** + * ID of the coupon to create a new discount for. + */ + coupon?: string; + + /** + * ID of an existing discount on the object (or one of its ancestors) to reuse. + */ + discount?: string; + } + + interface InvoiceSettings { + /** + * Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. + */ + days_until_due?: number; + } + + interface LineItem { + /** + * The ID of an existing line item on the quote. + */ + id?: string; + + /** + * The ID of the price object. One of `price` or `price_data` is required. + */ + price?: string; + + /** + * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + */ + price_data?: LineItem.PriceData; + + /** + * The quantity of the line item. + */ + quantity?: number; + + /** + * The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item. + */ + tax_rates?: Stripe.Emptyable>; + } + + namespace LineItem { + interface PriceData { + /** + * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + */ + currency: string; + + /** + * The ID of the product that this price will belong to. + */ + product: string; + + /** + * The recurring components of a price such as `interval` and `usage_type`. + */ + recurring?: PriceData.Recurring; + + /** + * Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + */ + tax_behavior?: PriceData.TaxBehavior; + + /** + * A positive integer in %s (or 0 for a free price) representing how much to charge. + */ + unit_amount?: number; + + /** + * Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + */ + unit_amount_decimal?: string; + } + + namespace PriceData { + interface Recurring { + /** + * Specifies billing frequency. Either `day`, `week`, `month` or `year`. + */ + interval: Recurring.Interval; + + /** + * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). + */ + interval_count?: number; + } + + namespace Recurring { + type Interval = 'day' | 'month' | 'week' | 'year'; + } + + type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified'; + } + } + + interface SubscriptionData { + /** + * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted. + */ + effective_date?: Stripe.Emptyable<'current_period_end' | number>; + + /** + * Integer representing the number of trial period days before the customer is charged for the first time. + */ + trial_period_days?: Stripe.Emptyable; + } + + interface TransferData { + /** + * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field. + */ + amount?: number; + + /** + * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field. + */ + amount_percent?: number; + + /** + * ID of an existing, connected Stripe account. + */ + destination: string; + } + } + + interface QuoteListParams extends PaginationParams { + /** + * The ID of the customer whose quotes will be retrieved. + */ + customer?: string; + + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + + /** + * The status of the quote. + */ + status?: QuoteListParams.Status; + } + + namespace QuoteListParams { + type Status = 'accepted' | 'canceled' | 'draft' | 'open'; + } + + interface QuoteListParams extends PaginationParams { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + } + + interface QuoteAcceptParams { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + } + + interface QuoteCancelParams { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + } + + interface QuoteFinalizeQuoteParams { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + + /** + * A future timestamp on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. + */ + expires_at?: number; + } + + interface QuoteListLineItemsParams extends PaginationParams { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + } + + interface QuotePdfParams { + /** + * Specifies which fields in the response should be expanded. + */ + expand?: Array; + } + + class QuotesResource { + /** + * A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the [quote template](https://dashboard.stripe.com/settings/billing/quote). + */ + create( + params?: QuoteCreateParams, + options?: RequestOptions + ): Promise>; + create(options?: RequestOptions): Promise>; + + /** + * Retrieves the quote with the given ID. + */ + retrieve( + id: string, + params?: QuoteRetrieveParams, + options?: RequestOptions + ): Promise>; + retrieve( + id: string, + options?: RequestOptions + ): Promise>; + + /** + * A quote models prices and services for a customer. + */ + update( + id: string, + params?: QuoteUpdateParams, + options?: RequestOptions + ): Promise>; + + /** + * Returns a list of your quotes. + */ + list( + params?: QuoteListParams, + options?: RequestOptions + ): ApiListPromise; + list(options?: RequestOptions): ApiListPromise; + + /** + * When retrieving a quote, there is an includable upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items. + */ + list( + id: string, + params?: QuoteListParams, + options?: RequestOptions + ): ApiListPromise; + list( + id: string, + options?: RequestOptions + ): ApiListPromise; + + /** + * Accepts the specified quote. + */ + accept( + id: string, + params?: QuoteAcceptParams, + options?: RequestOptions + ): Promise>; + accept( + id: string, + options?: RequestOptions + ): Promise>; + + /** + * Cancels the quote. + */ + cancel( + id: string, + params?: QuoteCancelParams, + options?: RequestOptions + ): Promise>; + cancel( + id: string, + options?: RequestOptions + ): Promise>; + + /** + * Finalizes the quote. + */ + finalizeQuote( + id: string, + params?: QuoteFinalizeQuoteParams, + options?: RequestOptions + ): Promise>; + finalizeQuote( + id: string, + options?: RequestOptions + ): Promise>; + + /** + * When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. + */ + listLineItems( + id: string, + params?: QuoteListLineItemsParams, + options?: RequestOptions + ): ApiListPromise; + listLineItems( + id: string, + options?: RequestOptions + ): ApiListPromise; + + /** + * Download the PDF for a finalized quote + */ + pdf( + id: string, + params?: QuotePdfParams, + options?: RequestOptions + ): Promise; + pdf(id: string, options?: RequestOptions): Promise; + } + } +} diff --git a/types/2020-08-27/SetupAttempts.d.ts b/types/2020-08-27/SetupAttempts.d.ts index 44f16a5b9a..f5b1e4cb59 100644 --- a/types/2020-08-27/SetupAttempts.d.ts +++ b/types/2020-08-27/SetupAttempts.d.ts @@ -168,7 +168,7 @@ declare module 'stripe' { /** * Indicates the outcome of 3D Secure authentication. */ - result: ThreeDSecure.Result; + result: ThreeDSecure.Result | null; /** * Additional information about why 3D Secure succeeded or failed based @@ -179,7 +179,7 @@ declare module 'stripe' { /** * The version of 3D Secure that was used. */ - version: ThreeDSecure.Version; + version: ThreeDSecure.Version | null; } namespace ThreeDSecure { diff --git a/types/2020-08-27/index.d.ts b/types/2020-08-27/index.d.ts index b4c9806272..489f2dced8 100644 --- a/types/2020-08-27/index.d.ts +++ b/types/2020-08-27/index.d.ts @@ -66,6 +66,7 @@ /// /// /// +/// /// /// /// @@ -146,6 +147,7 @@ declare module 'stripe' { prices: Stripe.PricesResource; products: Stripe.ProductsResource; promotionCodes: Stripe.PromotionCodesResource; + quotes: Stripe.QuotesResource; refunds: Stripe.RefundsResource; reviews: Stripe.ReviewsResource; setupAttempts: Stripe.SetupAttemptsResource; From 73e370183de6b4b71efa689a13a53cdf620291dd Mon Sep 17 00:00:00 2001 From: Richard Marmorstein Date: Fri, 9 Jul 2021 13:49:48 -0400 Subject: [PATCH 2/3] test --- test/resources/Quotes.spec.js | 132 ++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 test/resources/Quotes.spec.js diff --git a/test/resources/Quotes.spec.js b/test/resources/Quotes.spec.js new file mode 100644 index 0000000000..7fb11f6ec6 --- /dev/null +++ b/test/resources/Quotes.spec.js @@ -0,0 +1,132 @@ +'use strict'; + +const stripe = require('../../testUtils').getSpyableStripe(); +const expect = require('chai').expect; + +const QUOTE_TEST_ID = 'qt_123'; + +describe('Quotes Resource', () => { + describe('create', () => { + it('Sends the correct request', () => { + const params = { + customer: 'cus_xyz', + line_items: [{price: 'price_abc', quantity: 5}, {price: 'price_xyz'}], + }; + stripe.quotes.create(params); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'POST', + url: '/v1/quotes', + headers: {}, + data: params, + settings: {}, + }); + }); + }); + + describe('list', () => { + it('Sends the correct request', () => { + stripe.quotes.list(); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'GET', + url: '/v1/quotes', + headers: {}, + data: {}, + settings: {}, + }); + }); + }); + + describe('retrieve', () => { + it('Sends the correct request', () => { + stripe.quotes.retrieve(QUOTE_TEST_ID); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'GET', + url: `/v1/quotes/${QUOTE_TEST_ID}`, + headers: {}, + data: {}, + settings: {}, + }); + }); + }); + + describe('update', () => { + it('Sends the correct request', () => { + stripe.quotes.update(QUOTE_TEST_ID, { + metadata: {key: 'value'}, + }); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'POST', + url: `/v1/quotes/${QUOTE_TEST_ID}`, + headers: {}, + data: {metadata: {key: 'value'}}, + settings: {}, + }); + }); + }); + + describe('accept', () => { + it('Sends the correct request', () => { + stripe.quotes.accept(QUOTE_TEST_ID); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'POST', + url: `/v1/quotes/${QUOTE_TEST_ID}/accept`, + headers: {}, + data: {}, + settings: {}, + }); + }); + }); + + describe('cancel', () => { + it('Sends the correct request', () => { + stripe.quotes.cancel(QUOTE_TEST_ID); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'POST', + url: `/v1/quotes/${QUOTE_TEST_ID}/cancel`, + headers: {}, + data: {}, + settings: {}, + }); + }); + }); + + describe('finalize', () => { + it('Sends the correct request', () => { + stripe.quotes.finalizeQuote(QUOTE_TEST_ID); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'POST', + url: `/v1/quotes/${QUOTE_TEST_ID}/finalize`, + headers: {}, + data: {}, + settings: {}, + }); + }); + }); + + describe('listLineItems', () => { + it('Sends the correct request', () => { + stripe.quotes.listLineItems(QUOTE_TEST_ID); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'GET', + url: `/v1/quotes/${QUOTE_TEST_ID}/line_items`, + headers: {}, + data: {}, + settings: {}, + }); + }); + }); + + describe('pdf', () => { + it('Sends the correct request', () => { + stripe.quotes.pdf(QUOTE_TEST_ID); + expect(stripe.LAST_REQUEST).to.deep.equal({ + method: 'GET', + host: 'files.stripe.com', + url: `/v1/quotes/${QUOTE_TEST_ID}/pdf`, + headers: {}, + data: {}, + settings: {}, + }); + }); + }); +}); From 96068278c0c096c90ea4e38c2bfd87d4308fdf59 Mon Sep 17 00:00:00 2001 From: Richard Marmorstein Date: Fri, 9 Jul 2021 13:56:23 -0400 Subject: [PATCH 3/3] Test --- test/resources/Quotes.spec.js | 82 ++++++++++++++++++++++++++++++----- 1 file changed, 72 insertions(+), 10 deletions(-) diff --git a/test/resources/Quotes.spec.js b/test/resources/Quotes.spec.js index 7fb11f6ec6..1e73489796 100644 --- a/test/resources/Quotes.spec.js +++ b/test/resources/Quotes.spec.js @@ -1,6 +1,7 @@ 'use strict'; const stripe = require('../../testUtils').getSpyableStripe(); +const testUtils = require('../../testUtils'); const expect = require('chai').expect; const QUOTE_TEST_ID = 'qt_123'; @@ -117,16 +118,77 @@ describe('Quotes Resource', () => { }); describe('pdf', () => { - it('Sends the correct request', () => { - stripe.quotes.pdf(QUOTE_TEST_ID); - expect(stripe.LAST_REQUEST).to.deep.equal({ - method: 'GET', - host: 'files.stripe.com', - url: `/v1/quotes/${QUOTE_TEST_ID}/pdf`, - headers: {}, - data: {}, - settings: {}, - }); + it('success', (callback) => { + const handleRequest = (req, res) => { + res.write('Stripe binary response'); + res.end(); + }; + + testUtils.getTestServerStripe( + {}, + handleRequest, + (err, stripe, closeServer) => { + if (err) { + return callback(err); + } + + return stripe.quotes.pdf( + 'foo_123', + {host: 'localhost'}, + (err, res) => { + closeServer(); + if (err) { + return callback(err); + } + const chunks = []; + res.on('data', (chunk) => chunks.push(chunk)); + res.on('error', callback); + res.on('end', () => { + expect(Buffer.concat(chunks).toString()).to.equal( + 'Stripe binary response' + ); + return callback(); + }); + } + ); + } + ); + }); + + it('failure', (callback) => { + const handleRequest = (req, res) => { + setTimeout(() => res.writeHead(500)); + setTimeout( + () => + res.write( + '{"error": "api_error", "error_description": "this is bad"}' + ), + 10 + ); + setTimeout(() => res.end(), 20); + }; + + testUtils.getTestServerStripe( + {}, + handleRequest, + (err, stripe, closeServer) => { + if (err) { + return callback(err); + } + + return stripe.quotes.pdf( + 'foo_123', + {host: 'localhost'}, + (err, res) => { + closeServer(); + expect(err).to.exist; + expect(err.raw.type).to.equal('api_error'); + expect(err.raw.message).to.equal('this is bad'); + return callback(); + } + ); + } + ); }); }); });