ugcinc 4.7.1 → 4.8.1

package/README.md

@@ -93,6 +93,22 @@ do {
 } while (cursor);
 ```
 
+## Caption Overlays
+
+Video posts can carry text overlays to display on the video. Pass `captionOverlays` to
+`posts.createVideo()`; each `CaptionOverlay` is `{ text, x, y, fontSize }`, where `x`/`y` are the
+overlay center as a fraction (0-1) of the video width/height and `fontSize` is a fraction (0-1) of
+the video height. Overlays are returned on the `Post` as `caption_overlays`.
+
+```typescript
+await client.posts.createVideo({
+  accountId: "acc_123",
+  videoUrl: "https://example.com/video.mp4",
+  caption: "Post description",
+  captionOverlays: [{ text: "Wait for it...", x: 0.5, y: 0.2, fontSize: 0.04 }],
+});
+```
+
 ## Useful Exports
 
 - `UGCClient` for API access

package/dist/index.d.ts

@@ -27,7 +27,7 @@ export type { InputType } from './automations/nodes/types';
 export type { ClientConfig } from './base';
 export type { Account, AccountStat, AccountTask, EditProfileInfo, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, AccountInfoUpdate, UpdateAccountInfoParams, AccountInfoUpdateResult, UpdateAccountInfoResponse, AccountSocialUpdate, UpdateAccountSocialParams, AccountSocialUpdateResult, UpdateAccountSocialResponse, DeleteAccountPostsParams, DeleteAccountPostsResponse, ResetWarmupParams, ResetWarmupResponse, NicheSwitchUpdate, NicheSwitchParams, NicheSwitchResult, NicheSwitchResponse, CreateAccountInput, CreateAccountsParams, CreateAccountResult, CreateAccountsResponse, TroubleshootFailReason, TroubleshootAccount, TroubleshootParams, } from './accounts';
 export type { TaskType, Task, GetTasksParams } from './tasks';
-export type { PostType, PostStatus, Post, PostStat, GetPostsParams, CreateDraftParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, UpdatePostParams, DeletePostsParams, DeletePostsResponse, RetryPostsParams, SetPostStatusParams, SetPostStatusResponse, PreviewScheduleEntry, PreviewScheduleParams, PreviewScheduleResult, } from './posts';
+export type { PostType, PostStatus, Post, PostStat, CaptionOverlay, GetPostsParams, CreateDraftParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, UpdatePostParams, DeletePostsParams, DeletePostsResponse, RetryPostsParams, SetPostStatusParams, SetPostStatusResponse, PreviewScheduleEntry, PreviewScheduleParams, PreviewScheduleResult, } from './posts';
 export type { RefreshStatsParams, RefreshStatsError, RefreshStatsResponse, RefreshStatsProgressResponse, RefreshStartEvent, RefreshProgressEvent, RefreshDoneEvent, RefreshStreamEvent, DailyAggregatedStat, GetDailyAggregatedStatsParams, DailyAccountStat, GetDailyAccountStatsParams, DailyPostStat, GetDailyPostStatsParams, DashboardDailyStat, GetDashboardDailyStatsParams, TopAccount, GetTopAccountsParams, TopPost, GetTopPostsParams, } from './stats';
 export type { Org, ApiKey, DeleteApiKeyParams, EditApiKeyParams, IntegrationKey, IntegrationProvider, UpsertIntegrationKeyParams, DeleteIntegrationKeyParams } from './org';
 export type { UserMedia, MediaUse, SocialAudio, Media, GetMediaParams, GetSocialAudioParams, UploadMediaParams, UploadMediaResponse, MediaTagUpdate, UpdateMediaTagsParams, MediaTagUpdateResult, UpdateMediaTagsResponse, UpdateMediaTagParams, UpdateMediaNameParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, ImportTextParams, ImportTextResponse, CreateMediaFromUrlParams, GetMediaUseParams, GetMediaUseResponse, FilterMediaParams, FilterMediaResponse, GetUploadTokenParams, UploadTokenResponse, } from './media';

package/dist/posts.d.ts

@@ -2,6 +2,17 @@ import { BaseClient } from './base';
 import type { ApiResponse } from './types';
 export type PostType = 'video' | 'slideshow';
 export type PostStatus = 'draft' | 'scheduled' | 'pending' | 'complete' | 'failed' | 'retrying' | 'deleting' | 'deleted' | 'hidden' | 'require-approval';
+/**
+ * A text overlay to display on top of a video post.
+ * x/y are the overlay center as a fraction (0-1) of the video width/height;
+ * fontSize is a fraction (0-1) of the video height.
+ */
+export interface CaptionOverlay {
+    text: string;
+    x: number;
+    y: number;
+    fontSize: number;
+}
 export interface Post {
     id: string;
     account_id: string | null;
@@ -9,6 +20,8 @@ export interface Post {
     status: PostStatus;
     social_id: string | null;
     caption: string | null;
+    /** Only returned by createVideo; other post endpoints omit it */
+    caption_overlays?: CaptionOverlay[] | null;
     title: string | null;
     media_urls: string[] | null;
     thumbnail_url: string | null;
@@ -62,6 +75,7 @@ export interface GetPostStatusParams {
 export interface CreateVideoParams {
     accountId: string | null;
     caption?: string;
+    captionOverlays?: CaptionOverlay[];
     socialAudioId?: string;
     postTime?: string;
     videoUrl: string;

package/package.json

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