@oppulence/stripe-sync-sdk

TypeScript SDK for Stripe Sync Engine - REST API for managing Stripe data synchronization and tenant operations.

Installation

npm install @oppulence/stripe-sync-sdk
# or
yarn add @oppulence/stripe-sync-sdk
# or
pnpm add @oppulence/stripe-sync-sdk

Usage

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()

Available APIs

• BillingApi - Billing management
• BusinessMetricsApi - Business metrics and analytics
• HealthApi - Health check endpoints
• RecurringTransactionsApi - Recurring transaction management
• StripeChargesApi - Stripe charges data
• StripeCustomersApi - Stripe customers data
• StripeInvoicesApi - Stripe invoices data
• StripePaymentIntentsApi - Stripe payment intents
• StripePricesApi - Stripe prices data
• StripeProductsApi - Stripe products data
• StripeSubscriptionsApi - Stripe subscriptions data
• StripeTransactionsApi - Stripe transactions data
• TenantsApi - Multi-tenant management
• TransactionsApi - Transaction management
• WebhooksApi - Webhook management

Authentication

The SDK supports multiple authentication methods:

// 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',
})

License

MIT