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

API Updates #1398

Merged
merged 3 commits into from
Apr 21, 2022
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/resources.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ module.exports = {
Readers: require('./resources/Terminal/Readers'),
}),
TestHelpers: resourceNamespace('testHelpers', {
Refunds: require('./resources/TestHelpers/Refunds'),
TestClocks: require('./resources/TestHelpers/TestClocks'),
Terminal: resourceNamespace('terminal', {
Readers: require('./resources/TestHelpers/Terminal/Readers'),
Expand Down
15 changes: 15 additions & 0 deletions lib/resources/TestHelpers/Refunds.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// File generated from our OpenAPI spec

'use strict';

const StripeResource = require('../../StripeResource');
const stripeMethod = StripeResource.method;

module.exports = StripeResource.extend({
path: 'test_helpers/refunds',

expire: stripeMethod({
method: 'POST',
path: '/{refund}/expire',
}),
});
5 changes: 5 additions & 0 deletions test/resources/generated_examples_test.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,11 @@ describe('Refund', function() {
const refunds = await stripe.refunds.list({limit: 3});
expect(refunds).not.to.be.null;
});

it('expire method', async function() {
const refund = await stripe.testHelpers.refunds.expire('re_123');
expect(refund).not.to.be.null;
});
});

describe('Token', function() {
Expand Down
2 changes: 1 addition & 1 deletion types/2020-08-27/BillingPortal/Configurations.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare module 'stripe' {
/**
* ID of the Connect Application that created the configuration.
*/
application: string | null;
application: string | Stripe.Application | null;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is technically breaking? Are we allowing this in TS?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that is the present policy.


business_profile: Configuration.BusinessProfile;

Expand Down
7 changes: 4 additions & 3 deletions types/2020-08-27/Checkout/Sessions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -979,7 +979,8 @@ declare module 'stripe' {
* When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
* with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
*
* Sessions that do not create Customers will instead create [Guest Customers](https://support.stripe.com/questions/guest-customer-faq) in the Dashboard.
* Sessions that don't create Customers instead create [Guest Customers](https://support.stripe.com/questions/guest-customer-faq)
* in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
*
* Can only be set in `payment` and `setup` mode.
*/
Expand Down Expand Up @@ -1325,7 +1326,7 @@ declare module 'stripe' {
name: string;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;
}
Expand Down Expand Up @@ -2009,7 +2010,7 @@ declare module 'stripe' {
tax_behavior?: ShippingRateData.TaxBehavior;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
*/
tax_code?: string;

Expand Down
15 changes: 9 additions & 6 deletions types/2020-08-27/Issuing/Disputes.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -319,11 +319,6 @@ declare module 'stripe' {
}

interface DisputeCreateParams {
/**
* The ID of the issuing transaction to create a dispute for.
*/
transaction: string;

/**
* Evidence provided for the dispute.
*/
Expand All @@ -338,6 +333,11 @@ declare module 'stripe' {
* 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 ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
*/
transaction?: string;
}

namespace DisputeCreateParams {
Expand Down Expand Up @@ -973,7 +973,10 @@ declare module 'stripe' {
* Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
*/
create(
params: DisputeCreateParams,
params?: DisputeCreateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;
create(
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Dispute>>;

Expand Down
2 changes: 1 addition & 1 deletion types/2020-08-27/Plans.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ declare module 'stripe' {
statement_descriptor?: string;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;

Expand Down
2 changes: 1 addition & 1 deletion types/2020-08-27/Prices.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ declare module 'stripe' {
statement_descriptor?: string;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;

Expand Down
6 changes: 3 additions & 3 deletions types/2020-08-27/Products.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ declare module 'stripe' {
statement_descriptor: string | null;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code: string | Stripe.TaxCode | null;

Expand Down Expand Up @@ -225,7 +225,7 @@ declare module 'stripe' {
statement_descriptor?: string;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;

Expand Down Expand Up @@ -345,7 +345,7 @@ declare module 'stripe' {
statement_descriptor?: string;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: Stripe.Emptyable<string>;

Expand Down
4 changes: 2 additions & 2 deletions types/2020-08-27/ShippingRates.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ declare module 'stripe' {
tax_behavior: ShippingRate.TaxBehavior | null;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
*/
tax_code: string | Stripe.TaxCode | null;

Expand Down Expand Up @@ -158,7 +158,7 @@ declare module 'stripe' {
tax_behavior?: ShippingRateCreateParams.TaxBehavior;

/**
* A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
*/
tax_code?: string;

Expand Down
2 changes: 1 addition & 1 deletion types/2020-08-27/TaxCodes.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ declare module 'stripe' {
): Promise<Stripe.Response<Stripe.TaxCode>>;

/**
* A list of [all tax codes available](https://stripe.com/docs/tax/tax-codes) to add to Products in order to allow specific tax calculations.
* A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
*/
list(
params?: TaxCodeListParams,
Expand Down
29 changes: 29 additions & 0 deletions types/2020-08-27/TestHelpers/Refunds.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// File generated from our OpenAPI spec

declare module 'stripe' {
namespace Stripe {
namespace TestHelpers {
interface RefundExpireParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}

class RefundsResource {
/**
* Expire a refund with a status of requires_action.
*/
expire(
id: string,
params?: RefundExpireParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Refund>>;
expire(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Refund>>;
}
}
}
}
2 changes: 2 additions & 0 deletions types/2020-08-27/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@
///<reference path='./Terminal/ConnectionTokens.d.ts' />
///<reference path='./Terminal/Locations.d.ts' />
///<reference path='./Terminal/Readers.d.ts' />
///<reference path='./TestHelpers/Refunds.d.ts' />
///<reference path='./TestHelpers/Terminal/Readers.d.ts' />
///<reference path='./TestHelpers/TestClocks.d.ts' />
///<reference path='./Tokens.d.ts' />
Expand Down Expand Up @@ -217,6 +218,7 @@ declare module 'stripe' {
};
testHelpers: {
testClocks: Stripe.TestHelpers.TestClocksResource;
refunds: Stripe.TestHelpers.RefundsResource;
terminal: {
readers: Stripe.TestHelpers.Terminal.ReadersResource;
};
Expand Down