ugcinc 4.11.0 → 4.12.0

package/README.md

@@ -43,7 +43,7 @@ if (res.ok) {
 
 - `client.accounts`: list, create, update, troubleshoot, quarantine/release, and manage account lifecycle
 - `client.posts`: create video/slideshow posts, update them, retry failures, and preview schedule conflicts
-- `client.media`: upload media, create media records, manage tags/names, and work with social audio
+- `client.media`: upload media, create media records, search profile-picture candidates, manage tags/names, and work with social audio
 - `client.stats`: fetch account/post analytics, daily aggregates, top performers, and refresh stats
 - `client.org`: manage organizations, API keys, and integration keys
 - `client.billing`: inspect subscription state and handle account deactivation, replacements, and refunds

package/dist/index.d.ts

@@ -30,7 +30,7 @@ export type { TaskType, Task, GetTasksParams } from './tasks';
 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';
+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, PfpSearchParams, PfpSearchResponse, PfpCandidate, GetUploadTokenParams, UploadTokenResponse, } from './media';
 export type { CommentStatus, Comment, CreateCommentParams, CreateCommentResponse, GetCommentsParams, } from './comments';
 export type { BillingInfo, PortalUrlResponse, CancelAccountParams, CancelAccountResponse, ReactivateAccountParams, ReactivateAccountResponse, CancelSubscriptionResponse, RequestReplacementParams, RequestReplacementResponse, RequestRefundParams, RequestRefundResponse, BillingRequestInfo, PortalParams, } from './billing';
 export type { RenderJobResponse, RenderJobStatus, SubmitImageRenderJobParams, SubmitVideoRenderJobParams, SubmitScreenshotAnimationRenderJobParams, SubmitAutoCaptionRenderJobParams, SubmitSceneSplitJobParams, SceneSplitDetectorConfig, SubmitInstagramDmRenderJobParams, SubmitIMessageDmRenderJobParams, IgDmMessage, ImDmMessage, RenderVideoEditorConfig, } from './render';

package/dist/media.d.ts

@@ -131,6 +131,25 @@ export interface FilterMediaResponse {
     used_count: number;
     available_count: number;
 }
+export interface PfpSearchParams {
+    /** What to search for, e.g. "black girl selfie" or "asian woman aesthetic". */
+    search_term: string;
+    /** How many pictures to return. Defaults to 12, capped at 40. */
+    count?: number;
+}
+export interface PfpCandidate {
+    /** Stable id for this picture at the source. */
+    source_id: string;
+    /** Full-resolution image — the one an account's avatar is set to. */
+    url: string;
+    /** Smaller variant, for rendering a grid of options. */
+    preview_url: string;
+}
+export interface PfpSearchResponse {
+    pictures: PfpCandidate[];
+    search_term: string;
+    count: number;
+}
 export interface GetUploadTokenParams {
     filename: string;
     contentType?: string;
@@ -212,4 +231,18 @@ export declare class MediaClient extends BaseClient {
      * @param params.name - Use case identifier (e.g., "profile_picture")
      */
     filter(params: FilterMediaParams): Promise<ApiResponse<FilterMediaResponse>>;
+    /**
+     * Search for profile-picture candidates for a search term.
+     *
+     * Pictures already in use as a profile picture are removed before the result
+     * comes back, so two accounts cannot end up wearing the same face. Sourcing
+     * and filtering are one call for that reason — a caller who forgot the second
+     * step would get duplicates across their accounts and find out much later.
+     *
+     * Requires the `media:search` scope on a restricted key.
+     *
+     * @param params.search_term - What to search for
+     * @param params.count - How many to return (default 12, max 40)
+     */
+    pfpSearch(params: PfpSearchParams): Promise<ApiResponse<PfpSearchResponse>>;
 }

package/dist/media.js

@@ -99,5 +99,21 @@ class MediaClient extends base_1.BaseClient {
     async filter(params) {
         return this.post('/media/filter', params);
     }
+    /**
+     * Search for profile-picture candidates for a search term.
+     *
+     * Pictures already in use as a profile picture are removed before the result
+     * comes back, so two accounts cannot end up wearing the same face. Sourcing
+     * and filtering are one call for that reason — a caller who forgot the second
+     * step would get duplicates across their accounts and find out much later.
+     *
+     * Requires the `media:search` scope on a restricted key.
+     *
+     * @param params.search_term - What to search for
+     * @param params.count - How many to return (default 12, max 40)
+     */
+    async pfpSearch(params) {
+        return this.post('/media/pfp-search', params);
+    }
 }
 exports.MediaClient = MediaClient;

package/package.json

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