@dalmore/api-contracts 1.0.3 → 1.0.6

package/README.md

@@ -5,80 +5,54 @@ Type-safe API contracts for Dalmore Client Portal, powered by [ts-rest](https://
 ## Installation
 
 ```bash
-# Production (stable releases from main branch)
 npm install @dalmore/api-contracts
-
-# Development (latest from dev branch)
-npm install @dalmore/api-contracts@dev
-```
-
-## Usage
-
-### Import specific contracts (recommended for tree-shaking)
-
-```typescript
-import { complianceContract } from '@dalmore/api-contracts/compliance';
-import { investorsContract } from '@dalmore/api-contracts/investors';
-import { issuersContract } from '@dalmore/api-contracts/issuers';
-import { clientsContract } from '@dalmore/api-contracts/clients';
 ```
 
-### Import types
+### Peer Dependencies
 
-```typescript
-import type { IInvestorAccount } from '@dalmore/api-contracts/types';
-import type { ITrade } from '@dalmore/api-contracts/types';
+```bash
+npm install @ts-rest/core zod @anatine/zod-openapi @nestjs/common libphonenumber-js neverthrow typeid-js
 ```
 
-### Create a typed client
+## Usage
 
 ```typescript
-import { complianceContract } from '@dalmore/api-contracts/compliance';
+import { clientsContract } from '@dalmore/api-contracts';
 import { initClient } from '@ts-rest/core';
 
-const client = initClient(complianceContract, {
-  baseUrl: 'https://platform.dalmoregroup.com',
+const client = initClient(clientsContract, {
+  baseUrl: 'https://api.example.com',
   baseHeaders: {
-    Authorization: `Bearer ${token}`,
+    'x-api-key': 'your-api-key',
   },
 });
 
 // Fully typed API calls
-const { status, body } = await client.accounts.getAccounts({
-  query: { page: 1, limit: 10 },
-});
-```
-
-## Peer Dependencies
-
-This package requires the following peer dependencies:
-
-- `@ts-rest/core` ^3.52.1
-- `@anatine/zod-openapi` ^1.14.2
-- `zod` ^3.24.4
-- `typeid-js` ^1.2.0
-- `@nestjs/common` ^11.0.0
-- `libphonenumber-js` ^1.12.0
-- `neverthrow` ^8.0.0
+const { status, body } = await client.accounts.getAccounts();
 
-## Available Contracts
-
-- `complianceContract` - Compliance portal API
-- `investorsContract` - Investor portal API
-- `issuersContract` - Issuer portal API
-- `clientsContract` - Client API (API key auth)
-- `secondariesContract` - Secondaries API
-- `complianceApiKeyContract` - Compliance API (API key auth)
-
-## TypeScript Configuration
-
-Add `skipLibCheck: true` to your `tsconfig.json` for best compatibility:
-
-```json
-{
-  "compilerOptions": {
-    "moduleResolution": "bundler",
-    "skipLibCheck": true
-  }
-}
+// Access nested endpoints
+const trade = await client.trades.getTrade({ params: { id: 'trade_123' } });
 ```
+
+## Available Endpoints
+
+The `clientsContract` includes:
+
+| Endpoint           | Description             |
+| ------------------ | ----------------------- |
+| `accounts`         | Account management      |
+| `aic`              | AIC verification        |
+| `auth`             | Authentication          |
+| `apiKeys`          | API key management      |
+| `apiKeyLogs`       | API key usage logs      |
+| `assets`           | Asset management        |
+| `files`            | File uploads            |
+| `filesPublic`      | Public file access      |
+| `individuals`      | Individual management   |
+| `investorAccounts` | Investor accounts       |
+| `issuers`          | Issuer information      |
+| `legalEntities`    | Legal entity management |
+| `offerings`        | Offering data           |
+| `secureRequests`   | Secure request handling |
+| `sites`            | Site configuration      |
+| `trades`           | Trade management        |