ugcinc 2.65.1 → 2.67.0

package/README.md

@@ -62,6 +62,11 @@ For complete API documentation, including all endpoints, parameters, and example
 - Get posts with filters (by accountIds, postIds, date range)
 - Get post statistics
 
+### Comments
+- Create comment tasks (comment on TikTok posts using your accounts)
+- Get comment task status (check if comment was posted successfully)
+- Returns comment URL when completed
+
 ### Tasks
 - Get scheduled tasks
 - View task history
@@ -340,6 +345,40 @@ if (response.ok) {
 }
 ```
 
+**Create a comment task:**
+```typescript
+// Create a comment on a TikTok post
+const response = await client.comments.createComment({
+  accountId: 'account-uuid',
+  postUrl: 'https://www.tiktok.com/@user/video/1234567890',
+  commentText: 'Great video! 🔥'
+});
+
+if (response.ok) {
+  console.log('Comment task created:', response.data.taskId);
+  // Use taskId to check status later
+}
+```
+
+**Check comment task status:**
+```typescript
+const response = await client.comments.getStatus({
+  taskId: 'task-uuid'
+});
+
+if (response.ok) {
+  console.log(`Status: ${response.data.status}`);
+  
+  if (response.data.status === 'completed') {
+    console.log(`Comment URL: ${response.data.commentUrl}`);
+  } else if (response.data.status === 'failed') {
+    console.log(`Error: ${response.data.error}`);
+  } else if (response.data.status === 'pending' || response.data.status === 'running') {
+    console.log('Comment is still being processed...');
+  }
+}
+```
+
 **Retry tasks:**
 ```typescript
 const response = await client.tasks.retryTasks({

package/dist/client.d.ts

@@ -5,6 +5,7 @@ import { StatsClient } from './stats';
 import { OrganizationClient } from './org';
 import { AutomationsClient } from './automations';
 import { MediaClient } from './media';
+import { CommentsClient } from './comments';
 import type { ClientConfig } from './base';
 /**
  * Main UGC Inc API Client
@@ -60,5 +61,9 @@ export declare class UGCClient {
      * Client for media operations
      */
     media: MediaClient;
+    /**
+     * Client for comment operations
+     */
+    comments: CommentsClient;
     constructor(config: ClientConfig);
 }

package/dist/client.js

@@ -8,6 +8,7 @@ const stats_1 = require("./stats");
 const org_1 = require("./org");
 const automations_1 = require("./automations");
 const media_1 = require("./media");
+const comments_1 = require("./comments");
 /**
  * Main UGC Inc API Client
  *
@@ -42,6 +43,7 @@ class UGCClient {
         this.org = new org_1.OrganizationClient(config);
         this.automations = new automations_1.AutomationsClient(config);
         this.media = new media_1.MediaClient(config);
+        this.comments = new comments_1.CommentsClient(config);
     }
 }
 exports.UGCClient = UGCClient;

package/dist/comments.d.ts

@@ -0,0 +1,70 @@
+import { BaseClient } from './base';
+import type { CreateCommentParams, CreateCommentResponse, GetCommentStatusParams, CommentStatusResponse, GetCommentsParams, Comment, ApiResponse } from './types';
+/**
+ * Client for managing comments
+ */
+export declare class CommentsClient extends BaseClient {
+    /**
+     * Create a comment task
+     *
+     * Initiates a comment task on a TikTok post using the specified account.
+     * Returns a commentId that can be used to check the status of the comment.
+     *
+     * @example
+     * ```typescript
+     * const response = await client.comments.createComment({
+     *   accountId: 'account-123',
+     *   postUrl: 'https://www.tiktok.com/@user/video/123',
+     *   commentText: 'Great video!'
+     * });
+     *
+     * if (response.ok) {
+     *   console.log('Comment ID:', response.data.commentId);
+     * }
+     * ```
+     */
+    createComment(params: CreateCommentParams): Promise<ApiResponse<CreateCommentResponse>>;
+    /**
+     * Get comment status (live check)
+     *
+     * Check the current status of a comment by querying the automation API.
+     * Returns the current status and comment URL if completed.
+     *
+     * @example
+     * ```typescript
+     * const response = await client.comments.getStatus({
+     *   commentId: 'comment-123'
+     * });
+     *
+     * if (response.ok) {
+     *   if (response.data.status === 'completed') {
+     *     console.log('Comment URL:', response.data.commentUrl);
+     *   } else if (response.data.status === 'failed') {
+     *     console.log('Error:', response.data.error);
+     *   }
+     * }
+     * ```
+     */
+    getStatus(params: GetCommentStatusParams): Promise<ApiResponse<CommentStatusResponse>>;
+    /**
+     * Get comments
+     *
+     * Get comments for the organization, optionally filtered by commentIds, accountIds, or tag.
+     *
+     * @example
+     * ```typescript
+     * // Get all comments
+     * const response = await client.comments.getComments();
+     *
+     * // Get specific comments by IDs
+     * const response = await client.comments.getComments({ commentIds: ['id1', 'id2'] });
+     *
+     * // Get comments for specific accounts
+     * const response = await client.comments.getComments({ accountIds: ['acc1', 'acc2'] });
+     *
+     * // Get comments for accounts with a specific tag
+     * const response = await client.comments.getComments({ tag: 'campaign-1' });
+     * ```
+     */
+    getComments(params?: GetCommentsParams): Promise<ApiResponse<Comment[]>>;
+}

package/dist/comments.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsClient = void 0;
+const base_1 = require("./base");
+/**
+ * Client for managing comments
+ */
+class CommentsClient extends base_1.BaseClient {
+    /**
+     * Create a comment task
+     *
+     * Initiates a comment task on a TikTok post using the specified account.
+     * Returns a commentId that can be used to check the status of the comment.
+     *
+     * @example
+     * ```typescript
+     * const response = await client.comments.createComment({
+     *   accountId: 'account-123',
+     *   postUrl: 'https://www.tiktok.com/@user/video/123',
+     *   commentText: 'Great video!'
+     * });
+     *
+     * if (response.ok) {
+     *   console.log('Comment ID:', response.data.commentId);
+     * }
+     * ```
+     */
+    async createComment(params) {
+        return this.post('/comment/create', params);
+    }
+    /**
+     * Get comment status (live check)
+     *
+     * Check the current status of a comment by querying the automation API.
+     * Returns the current status and comment URL if completed.
+     *
+     * @example
+     * ```typescript
+     * const response = await client.comments.getStatus({
+     *   commentId: 'comment-123'
+     * });
+     *
+     * if (response.ok) {
+     *   if (response.data.status === 'completed') {
+     *     console.log('Comment URL:', response.data.commentUrl);
+     *   } else if (response.data.status === 'failed') {
+     *     console.log('Error:', response.data.error);
+     *   }
+     * }
+     * ```
+     */
+    async getStatus(params) {
+        return this.post('/comment/status', params);
+    }
+    /**
+     * Get comments
+     *
+     * Get comments for the organization, optionally filtered by commentIds, accountIds, or tag.
+     *
+     * @example
+     * ```typescript
+     * // Get all comments
+     * const response = await client.comments.getComments();
+     *
+     * // Get specific comments by IDs
+     * const response = await client.comments.getComments({ commentIds: ['id1', 'id2'] });
+     *
+     * // Get comments for specific accounts
+     * const response = await client.comments.getComments({ accountIds: ['acc1', 'acc2'] });
+     *
+     * // Get comments for accounts with a specific tag
+     * const response = await client.comments.getComments({ tag: 'campaign-1' });
+     * ```
+     */
+    async getComments(params) {
+        return this.post('/comment', params ?? {});
+    }
+}
+exports.CommentsClient = CommentsClient;

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export { OrganizationClient } from './org';
 export { RenderClient } from './render';
 export { AutomationsClient, getAllNodes, getNodeByType } from './automations';
 export { MediaClient } from './media';
+export { CommentsClient } from './comments';
 export type { RenderJobResponse, RenderJobStatus, SubmitImageRenderJobParams, SubmitVideoRenderJobParams, RenderVideoEditorConfig, } from './render';
 export type { ClientConfig, } from './base';
-export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorNodeConfig, VideoEditorChannel, VideoEditorSegment, VideoEditorVideoSegment, VideoEditorAudioSegment, VideoEditorImageSegment, VideoEditorTextSegment, TimeMode, SegmentTimelinePosition, ImageEditorNodeConfig, ImageEditorElement, ImageEditorNodeInput, ImageEditorNodeOutput, DimensionPresetKey, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, PositionAnchor, RelativePositionConfig, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, DailyAggregatedStat, GetDailyAggregatedStatsParams, DailyPostStat, GetDailyPostStatsParams, TopAccount, GetTopAccountsParams, TopPost, GetTopPostsParams, MediaType, NodePort, NodeControlConfig, NodeTypeEnum, WorkflowNodeDefinition, WorkflowDefinition, CanvasState, AutomationTemplate, AutomationRun, NodeRun, OutputSchemaProperty, SelectionMode, ExhaustionBehavior, SelectionConfig, SelectionState, OutputMode, OutputInput, OutputNodeConfig, UserMedia, SocialAudio, Media, GetMediaParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, CreateMediaFromUrlParams, } from './types';
+export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorNodeConfig, VideoEditorChannel, VideoEditorSegment, VideoEditorVideoSegment, VideoEditorAudioSegment, VideoEditorImageSegment, VideoEditorTextSegment, TimeMode, SegmentTimelinePosition, ImageEditorNodeConfig, ImageEditorElement, ImageEditorNodeInput, ImageEditorNodeOutput, DimensionPresetKey, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, PositionAnchor, RelativePositionConfig, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, DailyAggregatedStat, GetDailyAggregatedStatsParams, DailyPostStat, GetDailyPostStatsParams, TopAccount, GetTopAccountsParams, TopPost, GetTopPostsParams, MediaType, NodePort, NodeControlConfig, NodeTypeEnum, WorkflowNodeDefinition, WorkflowDefinition, CanvasState, AutomationTemplate, AutomationRun, NodeRun, OutputSchemaProperty, SelectionMode, ExhaustionBehavior, SelectionConfig, SelectionState, OutputMode, OutputInput, OutputNodeConfig, UserMedia, SocialAudio, Media, GetMediaParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, CreateMediaFromUrlParams, Comment, CreateCommentParams, CreateCommentResponse, GetCommentStatusParams, CommentStatusResponse, GetCommentsParams, } from './types';

package/dist/index.js

@@ -5,7 +5,7 @@
  * Official TypeScript/JavaScript client for the UGC Inc API
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MediaClient = exports.getNodeByType = exports.getAllNodes = exports.AutomationsClient = exports.RenderClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
+exports.CommentsClient = exports.MediaClient = exports.getNodeByType = exports.getAllNodes = exports.AutomationsClient = exports.RenderClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
 var client_1 = require("./client");
 Object.defineProperty(exports, "UGCClient", { enumerable: true, get: function () { return client_1.UGCClient; } });
 var accounts_1 = require("./accounts");
@@ -26,3 +26,5 @@ Object.defineProperty(exports, "getAllNodes", { enumerable: true, get: function
 Object.defineProperty(exports, "getNodeByType", { enumerable: true, get: function () { return automations_1.getNodeByType; } });
 var media_1 = require("./media");
 Object.defineProperty(exports, "MediaClient", { enumerable: true, get: function () { return media_1.MediaClient; } });
+var comments_1 = require("./comments");
+Object.defineProperty(exports, "CommentsClient", { enumerable: true, get: function () { return comments_1.CommentsClient; } });

package/dist/types.d.ts

@@ -877,3 +877,44 @@ export interface UploadTokenResponse {
     clientToken: string;
     pathname: string;
 }
+/**
+ * Comment types
+ */
+export interface Comment {
+    id: string;
+    accountId: string;
+    postUrl: string;
+    commentText: string;
+    status: 'pending' | 'running' | 'completed' | 'failed';
+    commentUrl?: string | null;
+    error?: string | null;
+    createdAt?: string;
+    completedAt?: string | null;
+}
+export interface CreateCommentParams {
+    accountId: string;
+    postUrl: string;
+    commentText: string;
+}
+export interface CreateCommentResponse {
+    commentId: string;
+}
+export interface GetCommentStatusParams {
+    commentId: string;
+}
+export type CommentStatusResponse = {
+    status: "pending";
+} | {
+    status: "running";
+} | {
+    status: "failed";
+    error: string;
+} | {
+    status: "completed";
+    commentUrl: string;
+};
+export interface GetCommentsParams {
+    commentIds?: string[];
+    accountIds?: string[];
+    tag?: string;
+}

package/package.json

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