@realforce-software/api-client 0.0.11

package/README.md

@@ -0,0 +1,76 @@
+# Realforce API - TypeScript SDK
+
+Auto-generated TypeScript / JavaScript client SDK for the Realforce API.
+
+**Version:** 0.0.11
+
+## Installation
+
+```bash
+npm install @realforce-software/api-client
+```
+
+## Quick Start
+
+```typescript
+import { PropertyClient } from '@realforce-software/api-client';
+
+const propertyClient = new PropertyClient({
+  baseURL: 'https://api.realforce.com',
+  headers: { Authorization: `Bearer ${yourJwtToken}` }
+});
+
+const properties = await propertyClient.getProperties(hqId);
+```
+
+## Authentication
+
+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.
+
+## Error Handling
+
+```typescript
+try {
+  const result = await client.someMethod();
+} catch (error: any) {
+  if (error.response) {
+    console.error('Status:', error.response.status);
+    console.error('Body:',   error.response.data);
+  } else if (error.request) {
+    console.error('No response received:', error.request);
+  } else {
+    console.error('Request error:', error.message);
+  }
+}
+```
+
+## Custom Axios Instance
+
+```typescript
+import axios from 'axios';
+import { PropertyClient } from '@realforce-software/api-client';
+
+const customAxios = axios.create({
+  baseURL: 'https://api.realforce.com',
+  timeout: 30000,
+  headers: { Authorization: `Bearer ${token}` }
+});
+
+const client = new PropertyClient({}, customAxios);
+```
+
+## Requirements
+
+- Node.js 16+ or a modern browser
+- axios ^1.6.0
+
+## Support
+
+- Issues: https://github.com/adfenix/realforce-api-service/issues
+- Or contact your Realforce API administrator
+
+---
+
+*This SDK was automatically generated. Do not edit the generated code directly.*