TypeScript SDK for Stripe Sync Engine - REST API for managing Stripe data synchronization and tenant operations
npm install @oppulence/stripe-sync-engine-sdkTypeScript SDK for Stripe Sync Engine - REST API for managing Stripe data synchronization and tenant operations.
``bash`
npm install @oppulence/stripe-sync-sdkor
yarn add @oppulence/stripe-sync-sdkor
pnpm add @oppulence/stripe-sync-sdk
`typescript
import { Configuration, TenantsApi, StripeCustomersApi } from '@oppulence/stripe-sync-sdk'
// Configure the API client
const config = new Configuration({
basePath: 'https://your-api-endpoint.com',
apiKey: 'your-api-key',
})
// Use the Tenants API
const tenantsApi = new TenantsApi(config)
const tenants = await tenantsApi.listTenants()
// Use the Stripe Customers API
const customersApi = new StripeCustomersApi(config)
const customers = await customersApi.apiV1StripeCustomersGet()
`
- BillingApi - Billing managementBusinessMetricsApi
- - Business metrics and analyticsHealthApi
- - Health check endpointsRecurringTransactionsApi
- - Recurring transaction managementStripeChargesApi
- - Stripe charges dataStripeCustomersApi
- - Stripe customers dataStripeInvoicesApi
- - Stripe invoices dataStripePaymentIntentsApi
- - Stripe payment intentsStripePricesApi
- - Stripe prices dataStripeProductsApi
- - Stripe products dataStripeSubscriptionsApi
- - Stripe subscriptions dataStripeTransactionsApi
- - Stripe transactions dataTenantsApi
- - Multi-tenant managementTransactionsApi
- - Transaction managementWebhooksApi
- - Webhook management
The SDK supports multiple authentication methods:
`typescript
// API Key authentication
const config = new Configuration({
apiKey: 'your-api-key',
})
// Bearer token authentication
const config = new Configuration({
accessToken: 'your-bearer-token',
})
// Basic authentication
const config = new Configuration({
username: 'your-username',
password: 'your-password',
})
``
MIT