Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple API changes #813

Merged
merged 1 commit into from
Feb 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions types/2019-12-03/Accounts.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@ declare module 'stripe' {
*/
external_accounts?: ApiList<Stripe.BankAccount | Stripe.Card>;

/**
* This is an object representing a person associated with a Stripe account.
*
* Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).
*/
individual?: Stripe.Person;

/**
Expand Down
20 changes: 19 additions & 1 deletion types/2019-12-03/Checkout/Sessions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,31 @@ declare module 'stripe' {

custom?: DisplayItem.Custom;

/**
* Plans define the base price, currency, and billing cycle for subscriptions.
* For example, you might have a 5/month plan
* that provides limited access to your products, and a
* 15/month plan that allows full access.
*
* Related guide: [Managing Products and Plans](https://stripe.com/docs/billing/subscriptions/products-and-plans).
*/
plan?: Stripe.Plan;

/**
* Quantity of the display item being purchased.
*/
quantity?: number;

/**
* Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit).
* SKUs describe specific product variations, taking into account any combination of: attributes,
* currency, and cost. For example, a product may be a T-shirt, whereas a specific SKU represents
* the `size: large`, `color: red` version of that shirt.
*
* Can also be used to manage inventory.
*
* Related guide: [Tax, Shipping, and Inventory](https://stripe.com/docs/orders).
*/
sku?: Stripe.Sku;

/**
Expand Down Expand Up @@ -386,7 +404,7 @@ declare module 'stripe' {
*
* If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.
*
* For more, learn to [save card details after a payment](https://stripe.com/docs/payments/save-after-payment).
* For more, learn to [save card details during payment](https://stripe.com/docs/payments/save-during-payment).
*
* Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.
*/
Expand Down
5 changes: 5 additions & 0 deletions types/2019-12-03/Discounts.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ declare module 'stripe' {
*/
object: 'discount';

/**
* A coupon contains information about a percent-off or amount-off discount you
* might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or
* [orders](https://stripe.com/docs/api#create_order-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
*/
coupon: Stripe.Coupon;

/**
Expand Down
3 changes: 3 additions & 0 deletions types/2019-12-03/Issuing/Authorizations.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ declare module 'stripe' {
*/
balance_transactions: Array<Stripe.BalanceTransaction>;

/**
* You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders.
*/
card: Stripe.Issuing.Card;

/**
Expand Down
3 changes: 3 additions & 0 deletions types/2019-12-03/Issuing/CardDetails.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ declare module 'stripe' {
*/
object: 'issuing.card_details';

/**
* You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders.
*/
card: Stripe.Issuing.Card;

/**
Expand Down
42 changes: 40 additions & 2 deletions types/2019-12-03/PaymentIntents.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ declare module 'stripe' {
*
* If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.
*
* For more, learn to [save card details after a payment](https://stripe.com/docs/payments/save-after-payment).
* For more, learn to [save card details during payment](https://stripe.com/docs/payments/save-during-payment).
*
* Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.
*/
Expand Down Expand Up @@ -246,10 +246,48 @@ declare module 'stripe' {
*/
param?: string;

/**
* A PaymentIntent guides you through the process of collecting a payment from your customer.
* We recommend that you create exactly one PaymentIntent for each order or
* customer session in your system. You can reference the PaymentIntent later to
* see the history of payment attempts for a particular session.
*
* A PaymentIntent transitions through
* [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
* throughout its lifetime as it interfaces with Stripe.js to perform
* authentication flows and ultimately creates at most one successful charge.
*
* Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents/creating-payment-intents).
*/
payment_intent?: Stripe.PaymentIntent;

/**
* PaymentMethod objects represent your customer's payment instruments.
* They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to
* Customer objects to store instrument details for future payments.
*
* Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
*/
payment_method?: Stripe.PaymentMethod;

/**
* A SetupIntent guides you through the process of setting up a customer's payment credentials for future payments.
* For example, you could use a SetupIntent to set up your customer's card without immediately collecting a payment.
* Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
*
* Create a SetupIntent as soon as you're ready to collect your customer's payment credentials.
* Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.
* The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides
* you through the setup process.
*
* Successful SetupIntents result in payment credentials that are optimized for future payments.
* For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) may need to be run through
* [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection
* in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).
*
* By using SetupIntents, you ensure that your customers experience the minimum set of required friction,
* even as regulations change over time.
*/
setup_intent?: Stripe.SetupIntent;

source?: CustomerSource;
Expand Down Expand Up @@ -548,7 +586,7 @@ declare module 'stripe' {
*
* If present, the payment method used with this PaymentIntent can be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer, even after the transaction completes.
*
* For more, learn to [save card details after a payment](https://stripe.com/docs/payments/save-after-payment).
* For more, learn to [save card details during payment](https://stripe.com/docs/payments/save-during-payment).
*
* Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.
*/
Expand Down
4 changes: 2 additions & 2 deletions types/2019-12-03/Products.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ declare module 'stripe' {
id?: string;

/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer. May only be set if type=`good`.
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
images?: Array<string>;

Expand Down Expand Up @@ -298,7 +298,7 @@ declare module 'stripe' {
expand?: Array<string>;

/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer. May only be set if `type=good`.
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
images?: Array<string> | null;

Expand Down