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

retrieveUpcoming on Invoice can now take one hash as parameter #593

Merged
merged 1 commit into from
Apr 22, 2019
Merged

retrieveUpcoming on Invoice can now take one hash as parameter #593

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
25 changes: 19 additions & 6 deletions lib/resources/Invoices.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,29 @@ module.exports = StripeResource.extend({
retrieveUpcoming: stripeMethod({
method: 'GET',
path: function(urlData) {
var url = 'upcoming?customer=' + urlData.customerId;
var url = 'upcoming?';
var hasParam = false;

// If you pass just a hash with the relevant parameters, including customer id inside.
if (urlData.invoiceOptionsOrCustomerId && typeof urlData.invoiceOptionsOrCustomerId === 'object') {
return url + utils.stringifyRequestData(urlData.invoiceOptionsOrCustomerId);
}

// Legacy implementation where the first parameter is a customer id as a string
if (urlData.invoiceOptionsOrCustomerId && typeof urlData.invoiceOptionsOrCustomerId === 'string') {
url = url + 'customer=' + urlData.invoiceOptionsOrCustomerId;
hasParam = true;
}

// Legacy support where second argument is the subscription id
if (urlData.invoiceOptions && typeof urlData.invoiceOptions === 'string') {
return url + '&subscription=' + urlData.invoiceOptions;
} else if (urlData.invoiceOptions && typeof urlData.invoiceOptions === 'object') {
return url + '&' + utils.stringifyRequestData(urlData.invoiceOptions);
if (urlData.invoiceOptionsOrSubscriptionId && typeof urlData.invoiceOptionsOrSubscriptionId === 'string') {
return url + (hasParam ? '&' : '') + 'subscription=' + urlData.invoiceOptionsOrSubscriptionId;
} else if (urlData.invoiceOptionsOrSubscriptionId && typeof urlData.invoiceOptionsOrSubscriptionId === 'object') {
return url + (hasParam ? '&' : '') + utils.stringifyRequestData(urlData.invoiceOptionsOrSubscriptionId);
}
return url;
},
urlParams: ['customerId', 'optional!invoiceOptions'],
urlParams: ['optional!invoiceOptionsOrCustomerId', 'optional!invoiceOptionsOrSubscriptionId'],
}),

sendInvoice: stripeMethod({
Expand Down
20 changes: 20 additions & 0 deletions test/resources/Invoices.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,26 @@ describe('Invoices Resource', function() {
});
});

describe('Without a customer id but options', function() {
it('Sends the correct request', function() {
stripe.invoices.retrieveUpcoming({
customer: 'cus_abc',
subscription_items: [
{plan: 'potato'},
{plan: 'rutabaga'},
],
});

expect(stripe.LAST_REQUEST).to.deep.equal({
method: 'GET',
url: '/v1/invoices/upcoming?customer=cus_abc&' +
'subscription_items[0][plan]=potato&subscription_items[1][plan]=rutabaga',
headers: {},
data: {},
});
});
});

describe('With an options object that includes `subscription_items` in addition to a subscription ID', function() {
it('Sends the correct request', function() {
stripe.invoices.retrieveUpcoming('cus_123', 'sub_123',
Expand Down