payrex-node 0.1.7 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.0.0] - 2024-09-04
+
+- Add billing statement endpoints
+- Add customer endpoints
+
+Breaking change
+- Standardize the use of arrays in resources. The `payment_intent` attribute of CheckoutSession resource is now an array. Previously, this attribute is a PaymentIntent resource.
+
 ## [0.1.7] - 2024-07-30
 
 - Add amount_capturable and amount_received for hold then capture partial amount support.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payrex-node",
-  "version": "0.1.7",
+  "version": "1.0.0",
   "description": "PayRex Node JS Library",
   "keywords": [
     "payrex",

package/src/entities/BillingStatementEntity.js

@@ -0,0 +1,24 @@
+function BillingStatementEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.amount = data.amount;
+  this.currency = data.currency;
+  this.customerId = data.customer_id;
+  this.description = data.description;
+  this.dueAt = data.due_at;
+  this.finalizedAt = data.finalized_at;
+  this.billingStatementNumber = data.billing_statement_number;
+  this.billingStatementUrl = data.billing_statement_url;
+  this.lineItems = data.line_items;
+  this.livemode = data.livemode;
+  this.metadata = data.metadata;
+  this.paymentIntent = data.payment_intent;
+  this.status = data.status;
+  this.paymentSettings = data.payment_settings;
+  this.customer = data.customer;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = BillingStatementEntity;

package/src/entities/BillingStatementLineItemEntity.js

@@ -0,0 +1,14 @@
+function BillingStatementLineItemEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.unitPrice = data.unit_price;
+  this.quantity = data.quantity;
+  this.billingStatementId = data.billing_statement_id;
+  this.description = data.description;
+  this.livemode = data.livemode;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = BillingStatementLineItemEntity;

package/src/entities/CheckoutSessionEntity.js

@@ -1,5 +1,3 @@
-const PaymentIntentEntity = require("./PaymentIntentEntity");
-
 function CheckoutSessionEntity(apiResource) {
   const data = apiResource.data;
 
@@ -11,9 +9,7 @@ function CheckoutSessionEntity(apiResource) {
   this.lineItems = data.line_items;
   this.livemode = data.livemode;
   this.url = data.url;
-  this.paymentIntent = new PaymentIntentEntity({
-    data: data.payment_intent
-  });
+  this.paymentIntent = data.payment_intent;
   this.metadata = data.metadata;
   this.successUrl = data.success_url;
   this.cancelUrl = data.cancel_url;

package/src/entities/CustomerEntity.js

@@ -0,0 +1,16 @@
+function CustomerEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.billingStatementPrefix = data.billing_statement_prefix;
+  this.currency = data.currency;
+  this.email = data.email;
+  this.livemode = data.livemode;
+  this.name = data.name;
+  this.metadata = data.metadata;
+  this.nextBillingStatementSequenceNumber = data.next_billing_statement_sequence_number;
+  this.createdAt = data.created_at;
+  this.updatedAt = data.updated_at;
+}
+
+module.exports = CustomerEntity;

package/src/entities/DeletedEntity.js

@@ -0,0 +1,8 @@
+function DeletedEntity(apiResource) {
+  const data = apiResource.data;
+
+  this.id = data.id;
+  this.deleted = data.deleted;
+}
+
+module.exports = DeletedEntity;

package/src/services/BillingStatementLineItemService.js

@@ -0,0 +1,51 @@
+const BaseService = require('./BaseService');
+const BillingStatementLineItemEntity = require('../entities/BillingStatementLineItemEntity');
+const DeletedEntity = require('../entities/DeletedEntity');
+
+function BillingStatementLineItemService(client) {
+  BaseService.call(this, client);
+
+  this.path = 'billing_statement_line_items';
+}
+
+BillingStatementLineItemService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new BillingStatementLineItemEntity(response);
+  });
+};
+
+BillingStatementLineItemService.prototype.retrieve = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'get',
+  }).then(function (response) {
+    return new BillingStatementLineItemEntity(response);
+  });
+};
+
+BillingStatementLineItemService.prototype.update = function (id, payload) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    payload: payload,
+    method: 'put',
+  }).then(function (response) {
+    return new BillingStatementLineItemEntity(response);
+  });
+};
+
+BillingStatementLineItemService.prototype.delete = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'delete',
+  }).then(function (response) {
+    return new DeletedEntity(response);
+  });
+};
+
+Object.setPrototypeOf(BillingStatementLineItemService.prototype, BaseService.prototype);
+
+module.exports = BillingStatementLineItemService;

package/src/services/BillingStatementService.js

@@ -0,0 +1,98 @@
+const BaseService = require('./BaseService');
+const BillingStatementEntity = require('../entities/BillingStatementEntity');
+const DeletedEntity = require('../entities/DeletedEntity');
+const ListingEntity = require('../entities/ListingEntity');
+const ApiResource = require('../ApiResource');
+
+function BillingStatementService(client) {
+  BaseService.call(this, client);
+
+  this.path = 'billing_statements';
+}
+
+BillingStatementService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new BillingStatementEntity(response);
+  });
+};
+
+BillingStatementService.prototype.retrieve = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'get',
+  }).then(function (response) {
+    return new BillingStatementEntity(response);
+  });
+};
+
+BillingStatementService.prototype.list = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'get',
+  }).then(function (response) {
+    const sessionsData = response.data.data;
+
+    const data = sessionsData.map((session) => {
+      const apiResource = new ApiResource(session);
+
+      return new BillingStatementEntity(apiResource);
+    });
+
+    return new ListingEntity(data, response.data.has_more);
+  });
+};
+
+BillingStatementService.prototype.update = function (id, payload) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    payload: payload,
+    method: 'put',
+  }).then(function (response) {
+    return new BillingStatementEntity(response);
+  });
+};
+
+BillingStatementService.prototype.delete = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'delete',
+  }).then(function (response) {
+    return new DeletedEntity(response);
+  });
+};
+
+BillingStatementService.prototype.finalize = function (id) {
+  return this.request({
+    path: `${this.path}/${id}/finalize`,
+    method: 'post',
+  }).then(function (response) {
+    return new BillingStatementEntity(response);
+  });
+};
+
+BillingStatementService.prototype.void = function (id) {
+  return this.request({
+    path: `${this.path}/${id}/void`,
+    method: 'post',
+  }).then(function (response) {
+    return new BillingStatementEntity(response);
+  });
+};
+
+BillingStatementService.prototype.markUncollectible = function (id) {
+  return this.request({
+    path: `${this.path}/${id}/mark_uncollectible`,
+    method: 'post',
+  }).then(function (response) {
+    return new BillingStatementEntity(response);
+  });
+};
+
+Object.setPrototypeOf(BillingStatementService.prototype, BaseService.prototype);
+
+module.exports = BillingStatementService;

package/src/services/CustomerService.js

@@ -0,0 +1,71 @@
+const BaseService = require('./BaseService');
+const CustomerEntity = require('../entities/CustomerEntity');
+const DeletedEntity = require('../entities/DeletedEntity');
+const ListingEntity = require('../entities/ListingEntity');
+const ApiResource = require('../ApiResource');
+
+function CustomerService(client) {
+  BaseService.call(this, client);
+
+  this.path = 'customers';
+}
+
+CustomerService.prototype.create = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'post',
+  }).then(function (response) {
+    return new CustomerEntity(response);
+  });
+};
+
+CustomerService.prototype.retrieve = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'get',
+  }).then(function (response) {
+    return new CustomerEntity(response);
+  });
+};
+
+CustomerService.prototype.list = function (payload) {
+  return this.request({
+    path: this.path,
+    payload: payload,
+    method: 'get',
+  }).then(function (response) {
+    const sessionsData = response.data.data;
+
+    const data = sessionsData.map((session) => {
+      const apiResource = new ApiResource(session);
+
+      return new CustomerEntity(apiResource);
+    });
+
+    return new ListingEntity(data, response.data.has_more);
+  });
+};
+
+CustomerService.prototype.update = function (id, payload) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    payload: payload,
+    method: 'put',
+  }).then(function (response) {
+    return new CustomerEntity(response);
+  });
+};
+
+CustomerService.prototype.delete = function (id) {
+  return this.request({
+    path: `${this.path}/${id}`,
+    method: 'delete',
+  }).then(function (response) {
+    return new DeletedEntity(response);
+  });
+};
+
+Object.setPrototypeOf(CustomerService.prototype, BaseService.prototype);
+
+module.exports = CustomerService;

package/src/services/WebhookService.js

@@ -1,6 +1,7 @@
 const crypto = require('crypto');
 const BaseService = require('./BaseService');
 const WebhookEntity = require('../entities/WebhookEntity');
+const DeletedEntity = require('../entities/DeletedEntity');
 const ListingEntity = require('../entities/ListingEntity');
 const ApiResource = require('../ApiResource');
 const EventEntity = require('../entities/EventEntity');
@@ -82,7 +83,7 @@ WebhookService.prototype.delete = function (id) {
     path: `${this.path}/${id}`,
     method: 'delete',
   }).then(function (response) {
-    return new WebhookEntity(response);
+    return new DeletedEntity(response);
   });
 };
 

package/src/services/index.js

@@ -1,15 +1,17 @@
+const BillingStatementLineItemService = require('./BillingStatementLineItemService');
+const BillingStatementService = require('./BillingStatementService');
 const CheckoutSessionService = require('./CheckoutSessionService');
-const MerchantService = require('./MerchantService');
+const CustomerService = require('./CustomerService');
 const PaymentIntentService = require('./PaymentIntentService');
-const PaymentMethodService = require('./PaymentMethodService');
 const RefundService = require('./RefundService');
 const WebhookService = require('./WebhookService');
 
 module.exports = {
   checkoutSessions: CheckoutSessionService,
-  merchants: MerchantService,
   paymentIntents: PaymentIntentService,
-  paymentMethods: PaymentMethodService,
+  customers: CustomerService,
+  billingStatements: BillingStatementService,
+  billingStatementLineItems: BillingStatementLineItemService,
   refunds: RefundService,
   webhooks: WebhookService,
 };

package/src/entities/MerchantEntity.js

@@ -1,11 +0,0 @@
-function MerchantEntity(apiResource) {
-  const data = apiResource.data;
-
-  this.id = data.id;
-  this.connectionType = data.connection_type;
-  this.livemode = data.livemode;
-  this.createdAt = data.created_at;
-  this.updatedAt = data.updated_at;
-}
-
-module.exports = MerchantEntity;

package/src/entities/PaymentMethodEntity.js

@@ -1,13 +0,0 @@
-function PaymentMethodEntity(apiResource) {
-  const data = apiResource.data;
-
-  this.id = data.id;
-  this.type = data.type;
-  this.billingDetails = data.billing_details;
-  this.livemode = data.livemode;
-  this.metadata = data.metadata;
-  this.createdAt = data.created_at;
-  this.updatedAt = data.updated_at;
-}
-
-module.exports = PaymentMethodEntity;

package/src/services/MerchantService.js

@@ -1,21 +0,0 @@
-const BaseService = require('./BaseService');
-const MerchantEntity = require('../entities/MerchantEntity');
-
-function MerchantService(client) {
-  BaseService.call(this, client);
-  this.path = 'merchants';
-}
-
-MerchantService.prototype.create = function (payload) {
-  return this.request({
-    path: this.path,
-    payload: payload,
-    method: 'post',
-  }).then(function (response) {
-    return new MerchantEntity(response);
-  });
-};
-
-Object.setPrototypeOf(MerchantService.prototype, BaseService.prototype);
-
-module.exports = MerchantService;

package/src/services/PaymentMethodService.js

@@ -1,21 +0,0 @@
-const BaseService = require('./BaseService');
-const PaymentMethodEntity = require('../entities/PaymentMethodEntity');
-
-function PaymentMethodService(client) {
-  BaseService.call(this, client);
-  this.path = 'payment_methods';
-}
-
-PaymentMethodService.prototype.create = function (payload) {
-  return this.request({
-    path: this.path,
-    payload: payload,
-    method: 'post',
-  }).then(function (response) {
-    return new PaymentMethodEntity(response);
-  });
-};
-
-Object.setPrototypeOf(PaymentMethodService.prototype, BaseService.prototype);
-
-module.exports = PaymentMethodService;