ugcinc 2.66.0 → 2.67.0

package/dist/comments.d.ts

@@ -1,5 +1,5 @@
 import { BaseClient } from './base';
-import type { CreateCommentParams, CreateCommentResponse, GetCommentStatusParams, CommentStatusResponse, ApiResponse } from './types';
+import type { CreateCommentParams, CreateCommentResponse, GetCommentStatusParams, CommentStatusResponse, GetCommentsParams, Comment, ApiResponse } from './types';
 /**
  * Client for managing comments
  */
@@ -8,7 +8,7 @@ export declare class CommentsClient extends BaseClient {
      * Create a comment task
      *
      * Initiates a comment task on a TikTok post using the specified account.
-     * Returns a taskId that can be used to check the status of the comment.
+     * Returns a commentId that can be used to check the status of the comment.
      *
      * @example
      * ```typescript
@@ -19,21 +19,21 @@ export declare class CommentsClient extends BaseClient {
      * });
      *
      * if (response.ok) {
-     *   console.log('Task ID:', response.data.taskId);
+     *   console.log('Comment ID:', response.data.commentId);
      * }
      * ```
      */
     createComment(params: CreateCommentParams): Promise<ApiResponse<CreateCommentResponse>>;
     /**
-     * Get comment task status
+     * Get comment status (live check)
      *
-     * Check the status of a previously created comment task.
+     * 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({
-     *   taskId: 'task-123'
+     *   commentId: 'comment-123'
      * });
      *
      * if (response.ok) {
@@ -46,4 +46,25 @@ export declare class CommentsClient extends BaseClient {
      * ```
      */
     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

@@ -10,7 +10,7 @@ class CommentsClient extends base_1.BaseClient {
      * Create a comment task
      *
      * Initiates a comment task on a TikTok post using the specified account.
-     * Returns a taskId that can be used to check the status of the comment.
+     * Returns a commentId that can be used to check the status of the comment.
      *
      * @example
      * ```typescript
@@ -21,7 +21,7 @@ class CommentsClient extends base_1.BaseClient {
      * });
      *
      * if (response.ok) {
-     *   console.log('Task ID:', response.data.taskId);
+     *   console.log('Comment ID:', response.data.commentId);
      * }
      * ```
      */
@@ -29,15 +29,15 @@ class CommentsClient extends base_1.BaseClient {
         return this.post('/comment/create', params);
     }
     /**
-     * Get comment task status
+     * Get comment status (live check)
      *
-     * Check the status of a previously created comment task.
+     * 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({
-     *   taskId: 'task-123'
+     *   commentId: 'comment-123'
      * });
      *
      * if (response.ok) {
@@ -50,7 +50,30 @@ class CommentsClient extends base_1.BaseClient {
      * ```
      */
     async getStatus(params) {
-        return this.post('/comment', 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

@@ -15,4 +15,4 @@ 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, CreateCommentParams, CreateCommentResponse, GetCommentStatusParams, CommentStatusResponse, } 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/types.d.ts

@@ -880,16 +880,27 @@ export interface UploadTokenResponse {
 /**
  * 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 {
-    taskId: string;
+    commentId: string;
 }
 export interface GetCommentStatusParams {
-    taskId: string;
+    commentId: string;
 }
 export type CommentStatusResponse = {
     status: "pending";
@@ -902,3 +913,8 @@ export type CommentStatusResponse = {
     status: "completed";
     commentUrl: string;
 };
+export interface GetCommentsParams {
+    commentIds?: string[];
+    accountIds?: string[];
+    tag?: string;
+}

package/package.json

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