1.0.7 • Published 1 year ago
Lightgate Stripe Adapter
This adapter converts the Stripe api into ORMs for LightGate Automation developers.
Installation and Configuration
Install using npm:
npm i lightgate-stripe-adapter
Create an instance of the adapter either in an automation or test. We are using a jest here to define a test:
import {LightgateStripeAdapter} from 'lightgate-stripe-adapter';
describe('Stripe customer tests', () => {
let adapterInstance;
beforeAll(async () => {
try {
adapterInstance = new LightgateStripeAdapter({ apiKey: process.env.STRIPE_SECRET_KEY,
packageDir: '../../..'});
await adapterInstance.initialize();
} catch (error) {
console.error('Error:', error.stack);
expect(true).toBe(false);
}
});
test('find all customers test', async () => {
try {
const customers = await adapterInstance.Customer.listAll();
expect(customers).toBeInstanceOf(Array);
expect(customers.length).toBeGreaterThan(0);
for (const customer of customers) {
expect(customer).toBeInstanceOf(Customer);
}
} catch (error) {
console.error('Error:', error.stack);
expect(true).toBe(false);
}
});
});
Key Features
Customers
| Object | Feature | Returns | Description |
|---|
| Customer | listAll() | Array | Lists all customers |
| Customer | findOne(id) | Array | Finds one customer by the id |
| Customer | findOneOrCreate(data) | Array | Finds one customer by the email address and if not found creates a new customer |
| Customer | create(data) | Array | Creates a customer |
| Customer | removeOne(id) | Array | Removes a customer by the id |
| Customer | listAllWithCharges() | Array | Lists all customers with charges[] as an array for each customer |
| Customer | getTotalCharges() | float | Returns a float of the total charges. |
Charge
| Object | Feature | Returns | Description |
|---|
| Charge | listAll() | Array | Lists all charges |
Product
| Object | Feature | Returns | Description |
|---|
| Product | listAll() | Array | Lists all products |
| Product | findOne(id) | Array | Finds one product by the id |
| Product | search(data) | Array | Search for products by name, status, metadataorder_id |
| Product | create(data) | Array | Creates a product |
Price
| Object | Feature | Returns | Description |
|---|
| Price | listAll() | Array | Lists all prices |
| Price | findOne(id) | Array | Finds one prrice by the id |
| Price | search(data) | Array | Search for price by product: product_id |
| Price | create(data) | Array | Creates a price, requires product: product_id as an argument. |
PaymentLink
| Object | Feature | Returns | Description |
|---|
| Price | listAll() | Array | Lists all prices |
| Price | findOne(id) | Array | Finds one prrice by the id |
| Price | create(data) | Array | Creates a paymentLink, requires price: price_id as an argument |