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.

Sign up for GitHub

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 #1014

Merged
merged 1 commit into from
Sep 23, 2020
Merged

Multiple API changes #1014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions types/2020-08-27/Balance.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ declare module 'stripe' {
*/
connect_reserved?: Array<Balance.ConnectReserved>;

/**
* Funds that can be paid out using Instant Payouts.
*/
instant_available?: Array<Balance.InstantAvailable>;

issuing?: Balance.Issuing;

/**
Expand Down Expand Up @@ -100,6 +105,39 @@ declare module 'stripe' {
}
}

interface InstantAvailable {
/**
* Balance amount.
*/
amount: 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;

source_types?: InstantAvailable.SourceTypes;
}

namespace InstantAvailable {
interface SourceTypes {
/**
* Amount for bank account.
*/
bank_account?: number;

/**
* Amount for card.
*/
card?: number;

/**
* Amount for FPX.
*/
fpx?: number;
}
}

interface Issuing {
/**
* Funds that are available for use.
Expand Down
4 changes: 2 additions & 2 deletions types/2020-08-27/Checkout/Sessions.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,12 +731,12 @@ declare module 'stripe' {
recurring?: PriceData.Recurring;

/**
* A positive integer in %s representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
* A non-negative integer in %s representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
*/
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set, but at least one is required.
* 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;
}
Expand Down
16 changes: 8 additions & 8 deletions types/2020-08-27/CreditNoteLineItems.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ declare module 'stripe' {
object: 'credit_note_line_item';

/**
* The integer amount in **%s** representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
* The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.
*/
amount: number;

Expand All @@ -26,7 +26,7 @@ declare module 'stripe' {
description: string | null;

/**
* The integer amount in **%s** representing the discount being credited for this line item.
* The integer amount in %s representing the discount being credited for this line item.
*/
discount_amount: number;

Expand Down Expand Up @@ -123,12 +123,12 @@ declare module 'stripe' {
invoice: string;

/**
* The integer amount in **%s** representing the total amount of the credit note.
* The integer amount in %s representing the total amount of the credit note.
*/
amount?: number;

/**
* The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
* The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
*/
credit_amount?: number;

Expand All @@ -153,7 +153,7 @@ declare module 'stripe' {
metadata?: MetadataParam;

/**
* The integer amount in **%s** representing the amount that is credited outside of Stripe.
* The integer amount in %s representing the amount that is credited outside of Stripe.
*/
out_of_band_amount?: number;

Expand All @@ -168,7 +168,7 @@ declare module 'stripe' {
refund?: string;

/**
* The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
* The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
*/
refund_amount?: number;
}
Expand Down Expand Up @@ -206,12 +206,12 @@ declare module 'stripe' {
type: Line.Type;

/**
* The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
* The integer unit amount in %s of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
*/
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
* 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;
}
Expand Down
32 changes: 16 additions & 16 deletions types/2020-08-27/CreditNotes.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ declare module 'stripe' {
object: 'credit_note';

/**
* The integer amount in **%s** representing the total amount of the credit note, including tax.
* The integer amount in %s representing the total amount of the credit note, including tax.
*/
amount: number;

Expand Down Expand Up @@ -44,7 +44,7 @@ declare module 'stripe' {
| null;

/**
* The integer amount in **%s** representing the total amount of discount that was credited.
* The integer amount in %s representing the total amount of discount that was credited.
*/
discount_amount: number;

Expand Down Expand Up @@ -109,7 +109,7 @@ declare module 'stripe' {
status: CreditNote.Status;

/**
* The integer amount in **%s** representing the amount of the credit note, excluding tax and invoice level discounts.
* The integer amount in %s representing the amount of the credit note, excluding tax and invoice level discounts.
*/
subtotal: number;

Expand All @@ -119,7 +119,7 @@ declare module 'stripe' {
tax_amounts: Array<CreditNote.TaxAmount>;

/**
* The integer amount in **%s** representing the total amount of the credit note, including tax and all discount.
* The integer amount in %s representing the total amount of the credit note, including tax and all discount.
*/
total: number;

Expand Down Expand Up @@ -182,12 +182,12 @@ declare module 'stripe' {
invoice: string;

/**
* The integer amount in **%s** representing the total amount of the credit note.
* The integer amount in %s representing the total amount of the credit note.
*/
amount?: number;

/**
* The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
* The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
*/
credit_amount?: number;

Expand All @@ -212,7 +212,7 @@ declare module 'stripe' {
metadata?: MetadataParam;

/**
* The integer amount in **%s** representing the amount that is credited outside of Stripe.
* The integer amount in %s representing the amount that is credited outside of Stripe.
*/
out_of_band_amount?: number;

Expand All @@ -227,7 +227,7 @@ declare module 'stripe' {
refund?: string;

/**
* The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
* The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
*/
refund_amount?: number;
}
Expand Down Expand Up @@ -265,12 +265,12 @@ declare module 'stripe' {
type: Line.Type;

/**
* The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
* The integer unit amount in %s of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
*/
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
* 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;
}
Expand Down Expand Up @@ -334,12 +334,12 @@ declare module 'stripe' {
invoice: string;

/**
* The integer amount in **%s** representing the total amount of the credit note.
* The integer amount in %s representing the total amount of the credit note.
*/
amount?: number;

/**
* The integer amount in **%s** representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
* The integer amount in %s representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
*/
credit_amount?: number;

Expand All @@ -364,7 +364,7 @@ declare module 'stripe' {
metadata?: MetadataParam;

/**
* The integer amount in **%s** representing the amount that is credited outside of Stripe.
* The integer amount in %s representing the amount that is credited outside of Stripe.
*/
out_of_band_amount?: number;

Expand All @@ -379,7 +379,7 @@ declare module 'stripe' {
refund?: string;

/**
* The integer amount in **%s** representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
* The integer amount in %s representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
*/
refund_amount?: number;
}
Expand Down Expand Up @@ -417,12 +417,12 @@ declare module 'stripe' {
type: Line.Type;

/**
* The integer unit amount in **%s** of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
* The integer unit amount in %s of the credit note line item. This `unit_amount` will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when `type` is `custom_line_item`.
*/
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
* 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;
}
Expand Down
18 changes: 9 additions & 9 deletions types/2020-08-27/InvoiceItems.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ declare module 'stripe' {
tax_rates: Array<Stripe.TaxRate> | null;

/**
* Unit Amount (in the `currency` specified) of the invoice item.
* Unit amount (in the `currency` specified) of the invoice item.
*/
unit_amount: number | null;

Expand Down Expand Up @@ -156,7 +156,7 @@ declare module 'stripe' {
customer: string;

/**
* The integer amount in **%s** of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
* The integer amount in %s of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
*/
amount?: number;

Expand Down Expand Up @@ -226,12 +226,12 @@ declare module 'stripe' {
tax_rates?: Array<string>;

/**
* The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.
* The integer unit amount in %s of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.
*/
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
* 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;
}
Expand Down Expand Up @@ -278,7 +278,7 @@ declare module 'stripe' {
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set, but at least one is required.
* 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;
}
Expand All @@ -293,7 +293,7 @@ declare module 'stripe' {

interface InvoiceItemUpdateParams {
/**
* The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
* The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
*/
amount?: number;

Expand Down Expand Up @@ -348,12 +348,12 @@ declare module 'stripe' {
tax_rates?: Array<string> | null;

/**
* The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
* The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
*/
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
* 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;
}
Expand Down Expand Up @@ -400,7 +400,7 @@ declare module 'stripe' {
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set, but at least one is required.
* 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;
}
Expand Down
10 changes: 5 additions & 5 deletions types/2020-08-27/InvoiceLineItems.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ declare module 'stripe' {

interface InvoiceItem {
/**
* The integer amount in **%s** of previewed invoice item.
* The integer amount in %s of previewed invoice item.
*/
amount?: number;

Expand Down Expand Up @@ -329,12 +329,12 @@ declare module 'stripe' {
tax_rates?: Array<string> | null;

/**
* The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
* The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
*/
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal string with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
* 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;
}
Expand Down Expand Up @@ -381,7 +381,7 @@ declare module 'stripe' {
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set, but at least one is required.
* 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;
}
Expand Down Expand Up @@ -471,7 +471,7 @@ declare module 'stripe' {
unit_amount?: number;

/**
* Same as `unit_amount`, but accepts a decimal value with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set, but at least one is required.
* 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;
}
Expand Down
Loading