ugcinc 1.4.4 → 1.5.1
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 +26 -2
- package/dist/types.d.ts +3 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -44,8 +44,8 @@ For complete API documentation, including all endpoints, parameters, and example
|
|
|
44
44
|
## API Features
|
|
45
45
|
|
|
46
46
|
### Accounts
|
|
47
|
-
- Get accounts with filters
|
|
48
|
-
- Get account status
|
|
47
|
+
- Get accounts with filters (tag, org_group, user_group, status)
|
|
48
|
+
- Get account status (tasks)
|
|
49
49
|
- Update account info (tags, groups)
|
|
50
50
|
- Update social profile (avatar, nickname, bio)
|
|
51
51
|
|
|
@@ -72,6 +72,30 @@ For complete API documentation, including all endpoints, parameters, and example
|
|
|
72
72
|
|
|
73
73
|
### Examples
|
|
74
74
|
|
|
75
|
+
**Get accounts with filters:**
|
|
76
|
+
```typescript
|
|
77
|
+
// Get all accounts
|
|
78
|
+
const response = await client.accounts.getAccounts();
|
|
79
|
+
|
|
80
|
+
// Get accounts by status
|
|
81
|
+
const response = await client.accounts.getAccounts({
|
|
82
|
+
status: 'pending' // 'pending' | 'initialized' | 'setup' | 'error'
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
// Get accounts with multiple filters
|
|
86
|
+
const response = await client.accounts.getAccounts({
|
|
87
|
+
tag: 'production',
|
|
88
|
+
org_group: 'group1',
|
|
89
|
+
status: 'setup'
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
if (response.ok) {
|
|
93
|
+
response.data.forEach(account => {
|
|
94
|
+
console.log(`Account ${account.id}: ${account.username} (${account.status})`);
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
75
99
|
**Get your organization's API keys:**
|
|
76
100
|
```typescript
|
|
77
101
|
const response = await client.org.getApiKeys(); // POST /org/api-key
|
package/dist/types.d.ts
CHANGED
|
@@ -26,9 +26,11 @@ export interface Account {
|
|
|
26
26
|
username: string | null;
|
|
27
27
|
nick_name: string | null;
|
|
28
28
|
pfp_url: string | null;
|
|
29
|
+
bio: string | null;
|
|
29
30
|
warmup_enabled: boolean | null;
|
|
30
31
|
keywords: string | null;
|
|
31
32
|
profiles: string | null;
|
|
33
|
+
status: 'pending' | 'initialized' | 'setup' | 'error';
|
|
32
34
|
}
|
|
33
35
|
export interface AccountStat {
|
|
34
36
|
id: string;
|
|
@@ -101,6 +103,7 @@ export interface GetAccountsParams {
|
|
|
101
103
|
tag?: string;
|
|
102
104
|
org_group?: string;
|
|
103
105
|
user_group?: string;
|
|
106
|
+
status?: 'pending' | 'initialized' | 'setup' | 'error';
|
|
104
107
|
}
|
|
105
108
|
export interface GetAccountStatsParams {
|
|
106
109
|
accountIds?: string[];
|