@realforce-software/api-client 0.0.11 → 0.0.12

package/README.md

@@ -1,8 +1,8 @@
 # Realforce API - TypeScript SDK
 
-Auto-generated TypeScript / JavaScript client SDK for the Realforce API.
+TypeScript client SDK for the Realforce API.
 
-**Version:** 0.0.11
+**Version:** 0.0.12
 
 ## Installation
 
@@ -10,34 +10,61 @@ Auto-generated TypeScript / JavaScript client SDK for the Realforce API.
 npm install @realforce-software/api-client
 ```
 
-## Quick Start
+## Authentication
+
+Use a Realforce **Personal Access Token (PAT)** — tokens are prefixed `rfk_`
+or `rfp_`. Generate one in the Realforce dashboard. Send it as a Bearer token
+in the `Authorization` header.
 
 ```typescript
-import { PropertyClient } from '@realforce-software/api-client';
+import axios from 'axios';
+import { RealforceApiClient } from '@realforce-software/api-client';
 
-const propertyClient = new PropertyClient({
-  baseURL: 'https://api.realforce.com',
-  headers: { Authorization: `Bearer ${yourJwtToken}` }
+const http = axios.create({
+  headers: { Authorization: 'Bearer rfk_xxxxxxxxxxxxxxxx' }
 });
 
-const properties = await propertyClient.getProperties(hqId);
+const client = new RealforceApiClient('https://api.realforce.com', http);
 ```
 
-## Authentication
+## Workspace ID
+
+Most endpoints are scoped to a workspace. The generated client surfaces this as
+an `x_Workspace_ID` parameter (string GUID) on each method — pass the workspace
+your token has access to on every call:
+
+```typescript
+const workspaceId = '00000000-0000-0000-0000-000000000000';
+const agent = await client.getAgent(agentId, workspaceId);
+```
+
+## Quick Start
+
+```typescript
+import axios from 'axios';
+import { RealforceApiClient } from '@realforce-software/api-client';
+
+const http = axios.create({
+  headers: { Authorization: 'Bearer rfk_xxxxxxxxxxxxxxxx' }
+});
+
+const client = new RealforceApiClient('https://api.realforce.com', http);
 
-The Realforce API uses JWT Bearer token authentication. Obtain a JWT
-by authenticating with your AWS Cognito credentials through the Realforce
-authentication system, and include it in the `Authorization` header.
+const workspaceId = '...';
+const agents = await client.queryAgents(workspaceId, {});
+```
 
 ## Error Handling
 
+The SDK throws `ApiException` for non-2xx responses, surfacing the status code
+and parsed body:
+
 ```typescript
 try {
-  const result = await client.someMethod();
+  const result = await client.getAgent(agentId, workspaceId);
 } catch (error: any) {
-  if (error.response) {
-    console.error('Status:', error.response.status);
-    console.error('Body:',   error.response.data);
+  if (error.status) {
+    console.error(`HTTP ${error.status}:`, error.response);
   } else if (error.request) {
     console.error('No response received:', error.request);
   } else {
@@ -48,17 +75,19 @@ try {
 
 ## Custom Axios Instance
 
+The constructor's second argument accepts any pre-configured `AxiosInstance`,
+so you can attach interceptors, set timeouts, retry, etc.:
+
 ```typescript
 import axios from 'axios';
-import { PropertyClient } from '@realforce-software/api-client';
+import { RealforceApiClient } from '@realforce-software/api-client';
 
-const customAxios = axios.create({
-  baseURL: 'https://api.realforce.com',
+const http = axios.create({
   timeout: 30000,
   headers: { Authorization: `Bearer ${token}` }
 });
 
-const client = new PropertyClient({}, customAxios);
+const client = new RealforceApiClient('https://api.realforce.com', http);
 ```
 
 ## Requirements
@@ -73,4 +102,4 @@ const client = new PropertyClient({}, customAxios);
 
 ---
 
-*This SDK was automatically generated. Do not edit the generated code directly.*
+*This SDK is automatically generated from the Realforce OpenAPI spec.*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@realforce-software/api-client",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Auto-generated TypeScript client SDK for the Realforce API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",