@oppulence/stripe-sync-engine-sdk 1.10.9 → 1.14.15

package/README.md

@@ -1,180 +1,77 @@
-# Oppulence Stripe Sync SDK for TypeScript
+# @oppulence/stripe-sync-sdk
 
-TypeScript/JavaScript SDK for interacting with the Oppulence Stripe Sync Engine API.
+TypeScript SDK for Stripe Sync Engine - REST API for managing Stripe data synchronization and tenant operations.
 
 ## Installation
 
 ```bash
-npm install @oppulence/stripe-sync-engine-sdk
-```
-
-or with yarn:
-
-```bash
-yarn add @oppulence/stripe-sync-engine-sdk
-```
-
-or with pnpm:
-
-```bash
-pnpm add @oppulence/stripe-sync-engine-sdk
+npm install @oppulence/stripe-sync-sdk
+# or
+yarn add @oppulence/stripe-sync-sdk
+# or
+pnpm add @oppulence/stripe-sync-sdk
 ```
 
 ## Usage
 
-### Basic Setup
-
 ```typescript
-import { Configuration, TenantsApi, SyncApi } from '@oppulence/stripe-sync-engine-sdk'
+import { Configuration, TenantsApi, StripeCustomersApi } from '@oppulence/stripe-sync-sdk'
 
-// Configure the SDK with your API credentials
+// Configure the API client
 const config = new Configuration({
-  basePath: 'https://your-sync-engine.example.com',
-  headers: {
-    'x-api-key': 'your-api-key-here',
-  },
+  basePath: 'https://your-api-endpoint.com',
+  apiKey: 'your-api-key',
 })
 
-// Initialize API clients
+// Use the Tenants API
 const tenantsApi = new TenantsApi(config)
-const syncApi = new SyncApi(config)
-```
-
-### Create a Tenant
-
-```typescript
-const createTenantResponse = await tenantsApi.createTenant({
-  createTenantRequest: {
-    tenantId: 'customer-123',
-    stripeSecretKey: 'sk_test_...',
-    // optional fields
-    webhookSecret: 'whsec_...',
-    metadata: { customerId: '123' },
-  },
-})
+const tenants = await tenantsApi.listTenants()
 
-console.log('Tenant created:', createTenantResponse)
+// Use the Stripe Customers API
+const customersApi = new StripeCustomersApi(config)
+const customers = await customersApi.apiV1StripeCustomersGet()
 ```
 
-### Trigger a Sync
+## Available APIs
 
-```typescript
-const syncResponse = await syncApi.syncTenant({
-  tenantId: 'customer-123',
-})
-
-console.log('Sync initiated:', syncResponse)
-```
-
-### List Tenants
-
-```typescript
-const tenants = await tenantsApi.listTenants({
-  limit: 100,
-  offset: 0,
-})
+- `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
 
-console.log('Tenants:', tenants.data)
-```
+## Authentication
 
-### Get Tenant Health
+The SDK supports multiple authentication methods:
 
 ```typescript
-const health = await tenantsApi.getTenantHealth({
-  tenantId: 'customer-123',
+// API Key authentication
+const config = new Configuration({
+  apiKey: 'your-api-key',
 })
 
-console.log('Tenant health:', health)
-```
-
-### Trigger Backfill
-
-```typescript
-const backfillResponse = await syncApi.syncBackfill({
-  tenantId: 'customer-123',
-  syncBackfillRequest: {
-    entities: ['customer', 'subscription', 'invoice'],
-    startDate: '2024-01-01',
-    endDate: '2024-12-31',
-  },
+// Bearer token authentication
+const config = new Configuration({
+  accessToken: 'your-bearer-token',
 })
 
-console.log('Backfill initiated:', backfillResponse)
-```
-
-## API Reference
-
-### Available APIs
-
-- **TenantsApi**: Manage tenants (create, update, list, delete)
-- **SyncApi**: Trigger sync operations
-- **HealthApi**: Check API and tenant health status
-- **WebhooksApi**: Process webhooks
-
-### Configuration Options
-
-```typescript
+// Basic authentication
 const config = new Configuration({
-  basePath: 'https://api.example.com', // API base URL
-  headers: {
-    'x-api-key': 'your-api-key', // API key for authentication
-    'Content-Type': 'application/json',
-  },
-  fetchApi: fetch, // Optional: custom fetch implementation
+  username: 'your-username',
+  password: 'your-password',
 })
 ```
 
-## Error Handling
-
-```typescript
-try {
-  const response = await tenantsApi.createTenant({
-    createTenantRequest: {
-      /* ... */
-    },
-  })
-} catch (error) {
-  if (error instanceof Response) {
-    const errorData = await error.json()
-    console.error('API Error:', errorData)
-  } else {
-    console.error('Unexpected error:', error)
-  }
-}
-```
-
-## TypeScript Support
-
-This SDK is written in TypeScript and provides full type definitions out of the box. All request and response types are exported and can be imported:
-
-```typescript
-import type {
-  CreateTenantRequest,
-  CreateTenant201Response,
-  ListTenants200Response,
-  SyncBackfillRequest,
-} from '@oppulence/stripe-sync-engine-sdk'
-```
-
-## Development
-
-### Building
-
-```bash
-npm run build
-```
-
-### Publishing
-
-This SDK is automatically published to npm when a new release is created. See the main repository documentation for release procedures.
-
-## Support
-
-For issues and questions, please visit:
-
-- GitHub Issues: https://github.com/Oppulence-Engineering/oppulence-sync-engine/issues
-- Documentation: https://github.com/Oppulence-Engineering/oppulence-sync-engine
-
 ## License
 
 MIT