@devrev/typescript-sdk 1.1.51 → 1.1.53

package/README.md

@@ -50,3 +50,109 @@ test()
 npm test
 ```
 
+# Devrev SDK Utils Guide
+
+## Basic Setup
+
+First, initialize the SDK with your DevRev credentials:
+
+```typescript
+import { client } from '@devrev/typescript-sdk';
+import { BetaSdkUtil } from '@devrev/sdk-utils';
+
+// Initialize the DevRev SDK
+const devrevSDK = new client.setupBeta({
+  // Your DevRev credentials
+  endpoint: "https://api.devrev.ai",
+  token: "YOUR_TOKEN"
+});
+
+// Initialize the utils SDK
+const sdkUtil = new BetaSdkUtil(devrevSDK);
+```
+
+## Core Features
+
+### 1. User Management
+
+Fetch all Rev users associated with an account:
+
+```typescript
+const accountId = "ACC-12345";
+const revUsers = await sdkUtil.getAllRevUsersFromAccount(accountId);
+// Returns array of RevUser objects
+```
+
+### 2. File Management
+
+#### Upload Files
+```typescript
+import { FileTypes } from '@devrev/sdk-utils';
+
+// Prepare file object
+const fileObject = {
+  file_name: "example.txt",
+  file_type: FileTypes.OTHERS,
+  file: Buffer.from("Hello World"),
+  custom_file_type: "text/plain" // Required when file_type is OTHERS
+};
+
+// Upload file
+const artifactId = await sdkUtil.uploadFileToArtifact(fileObject);
+```
+
+#### Retrieve File Content
+```typescript
+const artifactId = "ART-12345";
+const fileContent = await sdkUtil.getFileContentFromArtifact(artifactId);
+```
+
+## Error Handling
+
+The SDK includes built-in `API` error handling that provides detailed error information:
+
+```typescript
+try {
+  await sdkUtil.uploadFileToArtifact(fileObject);
+} catch (error) {
+  // Error will be automatically handled with detailed logging:
+  // === Error Details ===
+  // Service: [function name]
+  // API: [API endpoint]
+  // Error Type: [error type]
+  // Status Code: [status code]
+  // Message: [error message]
+}
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and provides comprehensive type definitions for:
+- File management operations
+- User management
+- API Error handling
+
+## How to Contribute?
+
+1. **Create a New Branch**  
+   - Start by creating a separate branch for your feature or bug fix.  
+
+2. **Follow Best Coding Practices**  
+   - Ensure your code adheres to the following guidelines:  
+     - Handle potential errors using `try-catch` blocks.  
+     - Use TypeScript types/interfaces from the SDK for type safety.  
+     - Check file type requirements before uploading.  
+     - Utilize built-in API error handling for consistent logging.  
+
+3. **Enhance `BetaSDKUtil`**  
+   - Modify the `BetaSDKUtil` class to add new utilities.  
+   - Write comprehensive test cases to ensure functionality.  
+
+4. **Run Tests**  
+   - Execute tests using:  
+     ```
+     npm test
+     ```
+
+5. **Submit a Pull Request**  
+   - Open a pull request with a clear and detailed description of your changes.