Explicitly define basic methods. (#1199)

stripe · Jul 28, 2021 · 93ce450 · 93ce450
1 parent 604d2ec
commit 93ce450
Show file tree

Hide file tree

Showing 65 changed files with 1,091 additions and 65 deletions.
diff --git a/lib/StripeMethod.basic.js b/lib/StripeMethod.basic.js
@@ -2,6 +2,8 @@
 
 const stripeMethod = require('./StripeMethod');
 
+// DEPRECATED: These were kept for backwards compatibility in case users were
+// using this, but basic methods are now explicitly defined on a resource.
 module.exports = {
   create: stripeMethod({
     method: 'POST',

diff --git a/lib/StripeResource.js b/lib/StripeResource.js
@@ -44,6 +44,8 @@ function StripeResource(stripe, deprecatedUrlData) {
   this.resourcePath = this.path;
   this.path = utils.makeURLInterpolator(this.path);
 
+  // DEPRECATED: This was kept for backwards compatibility in case users were
+  // using this, but basic methods are now explicitly defined on a resource.
   if (this.includeBasic) {
     this.includeBasic.forEach(function(methodName) {
       this[methodName] = StripeResource.BASIC_METHODS[methodName];

diff --git a/lib/resources/AccountLinks.js b/lib/resources/AccountLinks.js
@@ -3,9 +3,13 @@
 'use strict';
 
 const StripeResource = require('../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'account_links',
 
-  includeBasic: ['create'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
 });
diff --git a/lib/resources/ApplePayDomains.js b/lib/resources/ApplePayDomains.js
@@ -3,9 +3,29 @@
 'use strict';
 
 const StripeResource = require('../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'apple_pay/domains',
 
-  includeBasic: ['create', 'retrieve', 'list', 'del'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{domain}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
+
+  del: stripeMethod({
+    method: 'DELETE',
+    path: '/{domain}',
+  }),
 });
diff --git a/lib/resources/ApplicationFees.js b/lib/resources/ApplicationFees.js
@@ -8,7 +8,16 @@ const stripeMethod = StripeResource.method;
 module.exports = StripeResource.extend({
   path: 'application_fees',
 
-  includeBasic: ['retrieve', 'list'],
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{id}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 
   createRefund: stripeMethod({
     method: 'POST',

diff --git a/lib/resources/BalanceTransactions.js b/lib/resources/BalanceTransactions.js
@@ -3,9 +3,19 @@
 'use strict';
 
 const StripeResource = require('../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'balance_transactions',
 
-  includeBasic: ['retrieve', 'list'],
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{id}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 });
diff --git a/lib/resources/BillingPortal/Configurations.js b/lib/resources/BillingPortal/Configurations.js
@@ -3,9 +3,29 @@
 'use strict';
 
 const StripeResource = require('../../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'billing_portal/configurations',
 
-  includeBasic: ['create', 'retrieve', 'update', 'list'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{configuration}',
+  }),
+
+  update: stripeMethod({
+    method: 'POST',
+    path: '/{configuration}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 });
diff --git a/lib/resources/BillingPortal/Sessions.js b/lib/resources/BillingPortal/Sessions.js
@@ -3,9 +3,13 @@
 'use strict';
 
 const StripeResource = require('../../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'billing_portal/sessions',
 
-  includeBasic: ['create'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
 });
diff --git a/lib/resources/Charges.js b/lib/resources/Charges.js
@@ -8,7 +8,26 @@ const stripeMethod = StripeResource.method;
 module.exports = StripeResource.extend({
   path: 'charges',
 
-  includeBasic: ['create', 'retrieve', 'update', 'list'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{charge}',
+  }),
+
+  update: stripeMethod({
+    method: 'POST',
+    path: '/{charge}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 
   capture: stripeMethod({
     method: 'POST',

diff --git a/lib/resources/Checkout/Sessions.js b/lib/resources/Checkout/Sessions.js
@@ -8,7 +8,21 @@ const stripeMethod = StripeResource.method;
 module.exports = StripeResource.extend({
   path: 'checkout/sessions',
 
-  includeBasic: ['create', 'retrieve', 'list'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{session}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 
   listLineItems: stripeMethod({
     method: 'GET',

diff --git a/lib/resources/CountrySpecs.js b/lib/resources/CountrySpecs.js
@@ -3,9 +3,19 @@
 'use strict';
 
 const StripeResource = require('../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'country_specs',
 
-  includeBasic: ['retrieve', 'list'],
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{country}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 });
diff --git a/lib/resources/Coupons.js b/lib/resources/Coupons.js
@@ -3,9 +3,34 @@
 'use strict';
 
 const StripeResource = require('../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'coupons',
 
-  includeBasic: ['create', 'retrieve', 'update', 'list', 'del'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{coupon}',
+  }),
+
+  update: stripeMethod({
+    method: 'POST',
+    path: '/{coupon}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
+
+  del: stripeMethod({
+    method: 'DELETE',
+    path: '/{coupon}',
+  }),
 });
diff --git a/lib/resources/CreditNotes.js b/lib/resources/CreditNotes.js
@@ -8,7 +8,26 @@ const stripeMethod = StripeResource.method;
 module.exports = StripeResource.extend({
   path: 'credit_notes',
 
-  includeBasic: ['create', 'retrieve', 'update', 'list'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{id}',
+  }),
+
+  update: stripeMethod({
+    method: 'POST',
+    path: '/{id}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 
   preview: stripeMethod({
     method: 'GET',

diff --git a/lib/resources/Customers.js b/lib/resources/Customers.js
@@ -8,7 +8,31 @@ const stripeMethod = StripeResource.method;
 module.exports = StripeResource.extend({
   path: 'customers',
 
-  includeBasic: ['create', 'retrieve', 'update', 'list', 'del'],
+  create: stripeMethod({
+    method: 'POST',
+    path: '',
+  }),
+
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{customer}',
+  }),
+
+  update: stripeMethod({
+    method: 'POST',
+    path: '/{customer}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
+
+  del: stripeMethod({
+    method: 'DELETE',
+    path: '/{customer}',
+  }),
 
   deleteDiscount: stripeMethod({
     method: 'DELETE',

diff --git a/lib/resources/Disputes.js b/lib/resources/Disputes.js
@@ -8,7 +8,21 @@ const stripeMethod = StripeResource.method;
 module.exports = StripeResource.extend({
   path: 'disputes',
 
-  includeBasic: ['retrieve', 'update', 'list'],
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{dispute}',
+  }),
+
+  update: stripeMethod({
+    method: 'POST',
+    path: '/{dispute}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 
   close: stripeMethod({
     method: 'POST',

diff --git a/lib/resources/EphemeralKeys.js b/lib/resources/EphemeralKeys.js
@@ -8,8 +8,6 @@ const stripeMethod = StripeResource.method;
 module.exports = StripeResource.extend({
   path: 'ephemeral_keys',
 
-  includeBasic: ['del'],
-
   create: stripeMethod({
     method: 'POST',
     path: '',
@@ -21,4 +19,9 @@ module.exports = StripeResource.extend({
       }
     },
   }),
+
+  del: stripeMethod({
+    method: 'DELETE',
+    path: '/{key}',
+  }),
 });
diff --git a/lib/resources/Events.js b/lib/resources/Events.js
@@ -3,9 +3,19 @@
 'use strict';
 
 const StripeResource = require('../StripeResource');
+const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({
   path: 'events',
 
-  includeBasic: ['retrieve', 'list'],
+  retrieve: stripeMethod({
+    method: 'GET',
+    path: '/{id}',
+  }),
+
+  list: stripeMethod({
+    method: 'GET',
+    path: '',
+    methodType: 'list',
+  }),
 });