@raba7ni/raba7ni 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,7 +20,6 @@ import { Raba7niSDK } from '@raba7ni/raba7ni';
|
|
|
20
20
|
const sdk = new Raba7niSDK({
|
|
21
21
|
appId: 'app_your_app_id',
|
|
22
22
|
apiKey: 'dev_your_api_key'
|
|
23
|
-
// baseUrl defaults to 'https://api.raba7ni.com'
|
|
24
23
|
});
|
|
25
24
|
|
|
26
25
|
// Test connection
|
|
@@ -32,29 +31,24 @@ const result = await sdk.validateMember(5, '+1234567890');
|
|
|
32
31
|
console.log('Is member:', result.is_member);
|
|
33
32
|
```
|
|
34
33
|
|
|
35
|
-
### Local Development
|
|
36
|
-
|
|
37
|
-
For local testing, specify your development server:
|
|
38
|
-
|
|
39
|
-
```typescript
|
|
40
|
-
const sdk = new Raba7niSDK({
|
|
41
|
-
appId: 'app_your_app_id',
|
|
42
|
-
apiKey: 'dev_your_api_key',
|
|
43
|
-
baseUrl: 'http://localhost:8000' // Only for local testing
|
|
44
|
-
});
|
|
45
|
-
```
|
|
46
|
-
|
|
47
34
|
## Configuration
|
|
48
35
|
|
|
36
|
+
| Option | Type | Default | Description |
|
|
37
|
+
|--------|------|---------|-------------|
|
|
38
|
+
| `appId` | `string` | *required* | Application ID (starts with `app_`) |
|
|
39
|
+
| `apiKey` | `string` | *required* | API Key (starts with `dev_`) |
|
|
40
|
+
| `baseUrl` | `string` | `https://app.raba7ni.com` | API base URL |
|
|
41
|
+
| `locale` | `string` | `en-us` | Locale for responses |
|
|
42
|
+
| `timeout` | `number` | `30000` | Request timeout (ms) |
|
|
43
|
+
| `maxRetries` | `number` | `3` | Max retry attempts |
|
|
44
|
+
| `retryDelay` | `number` | `1000` | Initial retry delay (ms) |
|
|
45
|
+
|
|
49
46
|
```typescript
|
|
50
47
|
const sdk = new Raba7niSDK({
|
|
51
|
-
appId: 'app_...',
|
|
52
|
-
apiKey: 'dev_...',
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
timeout: 30000, // Optional: Request timeout ms (default: 30000)
|
|
56
|
-
maxRetries: 3, // Optional: Max retry attempts (default: 3)
|
|
57
|
-
retryDelay: 1000 // Optional: Initial retry delay ms (default: 1000)
|
|
48
|
+
appId: 'app_...',
|
|
49
|
+
apiKey: 'dev_...',
|
|
50
|
+
timeout: 60000, // 60 seconds
|
|
51
|
+
maxRetries: 5
|
|
58
52
|
});
|
|
59
53
|
```
|
|
60
54
|
|
|
@@ -420,6 +414,11 @@ import type {
|
|
|
420
414
|
|
|
421
415
|
---
|
|
422
416
|
|
|
417
|
+
## Support
|
|
418
|
+
|
|
419
|
+
- **Documentation**: [https://app.raba7ni.com/docs/developer-api](https://app.raba7ni.com/docs/developer-api)
|
|
420
|
+
- **Issues**: [GitHub Issues](https://github.com/raba7ni/raba7ni-sdk/issues)
|
|
421
|
+
|
|
423
422
|
## Requirements
|
|
424
423
|
|
|
425
424
|
- Node.js 18+
|