ugcinc 1.0.4 → 1.0.6

package/README.md

@@ -68,7 +68,7 @@ if (response.ok) {
 
 #### Refresh Account Statistics
 
-Fetch live statistics from TikTok API and create new stat records.
+Fetch live statistics from TikTok/Instagram API and create new stat records.
 
 ```typescript
 const response = await client.accounts.refreshStats({
@@ -101,19 +101,41 @@ if (response.ok) {
 
 #### Update Account Info
 
-Update account profile information.
+Update account metadata (tag, org_group, user_group).
 
 ```typescript
 const response = await client.accounts.updateInfo({
+  accountId: 'account-id',
+  tag: 'influencer',
+  org_group: 'group1',
+  user_group: 'users1'
+});
+
+if (response.ok) {
+  console.log(response.data.message);
+  console.log(response.data.account); // Updated account
+}
+```
+
+#### Update Account Social Profile
+
+Update account social profile information (avatar, nickname, bio).
+
+**Important:** Nicknames can only be updated once every 7 days.
+
+```typescript
+const response = await client.accounts.updateSocial({
   accountId: 'account-id',
   nickName: 'New Name',
   bio: 'New bio text',
-  avatarUrl: 'https://example.com/avatar.jpg',
-  site: 'https://example.com'
+  avatarUrl: 'https://example.com/avatar.jpg'
 });
 
 if (response.ok) {
   console.log(response.data.message);
+} else {
+  // Error response includes when nickname can be updated again
+  console.error(response.message);
 }
 ```
 
@@ -220,7 +242,7 @@ if (response.ok) {
 
 #### Refresh Post Statistics
 
-Fetch live statistics from TikTok API and create new stat records.
+Fetch live statistics from TikTok/Instagram API and create new stat records.
 
 ```typescript
 const response = await client.posts.refreshStats({
@@ -461,7 +483,7 @@ const response = await client.accounts.getStats({
 
 #### `client.accounts.refreshStats(params?)`
 
-Refresh account statistics by fetching live data from TikTok API.
+Refresh account statistics by fetching live data from TikTok/Instagram API.
 
 **Endpoint:** `POST /accounts/stats/refresh`
 
@@ -476,10 +498,10 @@ Refresh account statistics by fetching live data from TikTok API.
 
 **Returns:** `ApiResponse<AccountStat[]>`
 
-Returns an array of newly created AccountStat objects with live data from TikTok. This endpoint fetches fresh statistics directly from the TikTok API and creates new stat records in the database. Use this when you need up-to-date metrics instead of historical data.
+Returns an array of newly created AccountStat objects with live data from TikTok or Instagram. This endpoint fetches fresh statistics directly from the platform APIs and creates new stat records in the database. Use this when you need up-to-date metrics instead of historical data. The API automatically determines which platform to query based on the account type.
 
 **Key Differences from `getStats()`:**
-- `refreshStats()` fetches **live data** from TikTok API and creates new records
+- `refreshStats()` fetches **live data** from TikTok/Instagram API and creates new records
 - `getStats()` retrieves **historical data** from your database
 
 **Example:**
@@ -556,7 +578,7 @@ const response = await client.accounts.getStatus({
 
 #### `client.accounts.updateInfo(params)`
 
-Update account profile information.
+Update account metadata (tag, org_group, user_group).
 
 **Endpoint:** `POST /accounts/update-info`
 
@@ -565,15 +587,62 @@ Update account profile information.
 | Parameter | Type | Required | Description |
 |-----------|------|----------|-------------|
 | `accountId` | `string` | **Yes** | Account ID to update |
-| `scheduledTime` | `string` | No | When to schedule the update (ISO 8601 format) |
+| `tag` | `string` | No | New tag value for categorization |
+| `org_group` | `string` | No | New organization group identifier |
+| `user_group` | `string` | No | New user group identifier |
+
+**Note:** At least one of `tag`, `org_group`, or `user_group` must be provided.
+
+**Returns:** `ApiResponse<{ message: string; account: Account }>`
+
+Returns a success message and the updated account object. The update is applied immediately to the database.
+
+**Response Object:**
+
+```typescript
+{
+  message: string;  // Success message (e.g., "Account info updated successfully")
+  account: Account; // Updated account object with new values
+}
+```
+
+**Example:**
+
+```typescript
+const response = await client.accounts.updateInfo({
+  accountId: 'account-id',
+  tag: 'influencer',
+  org_group: 'group1',
+  user_group: 'users1'
+});
+
+if (response.ok) {
+  console.log(response.data.account.tag); // 'influencer'
+}
+```
+
+---
+
+#### `client.accounts.updateSocial(params)`
+
+Update account social profile (avatar, nickname, bio).
+
+**Endpoint:** `POST /accounts/update-social`
+
+**Parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `accountId` | `string` | **Yes** | Account ID to update |
 | `avatarUrl` | `string` | No | New avatar/profile picture URL |
 | `nickName` | `string` | No | New display name |
 | `bio` | `string` | No | New bio text |
-| `site` | `string` | No | New website URL |
+
+**Important:** Nicknames can only be updated **once every 7 days**. If you attempt to update a nickname before the 7-day period has elapsed, the API will return an error with details about when the next update is allowed.
 
 **Returns:** `ApiResponse<{ message: string }>`
 
-Returns a success message when the profile update task has been successfully created and queued. The actual profile update will be processed asynchronously.
+Returns a success message when the profile update task has been successfully created and queued. The actual profile update will be processed asynchronously through the GeeLark API.
 
 **Response Object:**
 
@@ -583,15 +652,34 @@ Returns a success message when the profile update task has been successfully cre
 }
 ```
 
+**Error Response (Nickname Restriction):**
+
+If you attempt to update the nickname too soon:
+
+```typescript
+{
+  ok: false,
+  code: 400,
+  message: "Nickname can only be updated once every 7 days. Last update was X days ago. You can update again in Y day(s) on YYYY-MM-DD"
+}
+```
+
 **Example:**
 
 ```typescript
-const response = await client.accounts.updateInfo({
+const response = await client.accounts.updateSocial({
   accountId: 'account-id',
   nickName: 'Cool Creator',
   bio: 'Content creator 🎥',
   avatarUrl: 'https://storage.example.com/avatar.jpg'
 });
+
+if (response.ok) {
+  console.log(response.data.message);
+} else {
+  // Handle nickname restriction error
+  console.error(response.message);
+}
 ```
 
 ---
@@ -687,7 +775,7 @@ Returns an array of Post objects (videos and slideshows) for the specified accou
   account_id: string;      // Account that posted this
   type: 'video' | 'slideshow';  // Post type
   status: string;          // Current post status
-  post_url: string | null;      // URL to the live post
+  social_id: string | null;     // Platform post ID (TikTok video ID or Instagram reel code)
   caption: string | null;       // Post caption/description
   media_urls: string[] | null;  // URLs to media files
   music_post_id: string | null; // Associated music/audio ID
@@ -700,7 +788,7 @@ Returns an array of Post objects (videos and slideshows) for the specified accou
 | `account_id` | `string` | ID of the account that created this post |
 | `type` | `'video' \| 'slideshow'` | Type of post content |
 | `status` | `string` | Current status: `'scheduled'`, `'pending'`, `'complete'`, or `'failed'` |
-| `post_url` | `string \| null` | URL to the live post on the platform (available after posting) |
+| `social_id` | `string \| null` | Platform-specific post ID (TikTok video ID or Instagram reel code, available after posting) |
 | `caption` | `string \| null` | Post caption/description text (max 500 characters) |
 | `media_urls` | `string[] \| null` | Array of URLs to video/image files used in the post |
 | `music_post_id` | `string \| null` | ID of the music/audio track used in the post |
@@ -855,7 +943,7 @@ if (response.ok) {
 
 #### `client.posts.refreshStats(params?)`
 
-Refresh post statistics by fetching live data from TikTok API.
+Refresh post statistics by fetching live data from TikTok/Instagram API.
 
 **Endpoint:** `POST /post/stats/refresh`
 
@@ -867,13 +955,13 @@ Refresh post statistics by fetching live data from TikTok API.
 
 **Returns:** `ApiResponse<PostStat[]>`
 
-Returns an array of newly created PostStat objects with live data from TikTok. This endpoint fetches fresh statistics directly from the TikTok API and creates new stat records in the database. Use this when you need up-to-date engagement metrics instead of historical data.
+Returns an array of newly created PostStat objects with live data from TikTok or Instagram. This endpoint fetches fresh statistics directly from the platform APIs and creates new stat records in the database. Use this when you need up-to-date engagement metrics instead of historical data. The API automatically determines which platform to query based on the account type.
 
 **Key Differences from `getStats()`:**
-- `refreshStats()` fetches **live data** from TikTok API and creates new records
+- `refreshStats()` fetches **live data** from TikTok/Instagram API and creates new records
 - `getStats()` retrieves **historical data** from your database
 
-**Important:** Posts must have a valid `post_url` to refresh statistics. The endpoint extracts the TikTok post ID from the URL to fetch live metrics.
+**Important:** Posts must have a valid `social_id` (TikTok video ID or Instagram reel code) to refresh statistics. The endpoint uses this ID to fetch live metrics from the platform.
 
 **Example:**
 

package/dist/accounts.d.ts

@@ -1,5 +1,5 @@
 import { BaseClient } from './base';
-import type { Account, AccountStat, AccountTask, GetAccountsParams, GetAccountStatsParams, RefreshAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, ApiResponse } from './types';
+import type { Account, AccountStat, AccountTask, GetAccountsParams, GetAccountStatsParams, RefreshAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, ApiResponse } from './types';
 /**
  * Client for managing accounts
  */
@@ -13,7 +13,7 @@ export declare class AccountsClient extends BaseClient {
      */
     getStats(params?: GetAccountStatsParams): Promise<ApiResponse<AccountStat[]>>;
     /**
-     * Refresh account statistics from TikTok API
+     * Refresh account statistics from TikTok/Instagram API
      */
     refreshStats(params?: RefreshAccountStatsParams): Promise<ApiResponse<AccountStat[]>>;
     /**
@@ -21,9 +21,17 @@ export declare class AccountsClient extends BaseClient {
      */
     getStatus(params: GetAccountStatusParams): Promise<ApiResponse<AccountTask[]>>;
     /**
-     * Update account profile information
+     * Update account metadata (tag, org_group, user_group)
      */
     updateInfo(params: UpdateAccountInfoParams): Promise<ApiResponse<{
         message: string;
+        account: Account;
+    }>>;
+    /**
+     * Update account social profile (avatar, nickname, bio)
+     * Note: Nickname can only be updated once every 7 days
+     */
+    updateSocial(params: UpdateAccountSocialParams): Promise<ApiResponse<{
+        message: string;
     }>>;
 }

package/dist/accounts.js

@@ -19,7 +19,7 @@ class AccountsClient extends base_1.BaseClient {
         return this.post('/accounts/stats', params ?? {});
     }
     /**
-     * Refresh account statistics from TikTok API
+     * Refresh account statistics from TikTok/Instagram API
      */
     async refreshStats(params) {
         return this.post('/accounts/stats/refresh', params ?? {});
@@ -31,10 +31,17 @@ class AccountsClient extends base_1.BaseClient {
         return this.post('/accounts/status', params);
     }
     /**
-     * Update account profile information
+     * Update account metadata (tag, org_group, user_group)
      */
     async updateInfo(params) {
         return this.post('/accounts/update-info', params);
     }
+    /**
+     * Update account social profile (avatar, nickname, bio)
+     * Note: Nickname can only be updated once every 7 days
+     */
+    async updateSocial(params) {
+        return this.post('/accounts/update-social', params);
+    }
 }
 exports.AccountsClient = AccountsClient;

package/dist/posts.d.ts

@@ -17,7 +17,8 @@ export declare class PostsClient extends BaseClient {
      */
     getStats(params?: GetPostStatsParams): Promise<ApiResponse<PostStat[]>>;
     /**
-     * Refresh post statistics from TikTok API
+  
+    * Refresh post statistics from TikTok/Instagram API
      */
     refreshStats(params?: RefreshPostStatsParams): Promise<ApiResponse<PostStat[]>>;
     /**

package/dist/posts.js

@@ -25,7 +25,8 @@ class PostsClient extends base_1.BaseClient {
         return this.post('/post/stats', params ?? {});
     }
     /**
-     * Refresh post statistics from TikTok API
+  
+    * Refresh post statistics from TikTok/Instagram API
      */
     async refreshStats(params) {
         return this.post('/post/stats/refresh', params ?? {});

package/dist/types.d.ts

@@ -49,7 +49,6 @@ export interface EditProfileInfo {
     avatarUrl?: string;
     nickName?: string;
     bio?: string;
-    site?: string;
 }
 /**
  * Task types
@@ -75,7 +74,7 @@ export interface Post {
     account_id: string;
     type: PostType;
     status: string;
-    post_url: string | null;
+    social_id: string | null;
     caption: string | null;
     media_urls: string[] | null;
     music_post_id: string | null;
@@ -118,11 +117,15 @@ export interface GetAccountStatusParams {
 }
 export interface UpdateAccountInfoParams {
     accountId: string;
-    scheduledTime?: string;
+    tag?: string;
+    org_group?: string;
+    user_group?: string;
+}
+export interface UpdateAccountSocialParams {
+    accountId: string;
     avatarUrl?: string;
     nickName?: string;
     bio?: string;
-    site?: string;
 }
 export interface GetTasksParams {
     accountIds?: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "TypeScript/JavaScript client for the UGC Inc API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",