@blitzreels/sdk 0.1.3 → 0.1.4

package/README.md

@@ -107,6 +107,31 @@ await client.media.folders.create({
   iconType: "video",
 });
 
+const audioResults = await client.audioLibrary.search({
+  query: "ambient riser",
+  provider: "all",
+  license: "cc0",
+  audioType: "sound_effect",
+  minDurationSeconds: undefined,
+  maxDurationSeconds: 12,
+  limit: 10,
+  page: undefined,
+});
+
+await client.audioLibrary.importAsset({
+  provider: audioResults.items[0].provider,
+  externalId: audioResults.items[0].external_id,
+  folderId: undefined,
+  projectId: "project_id",
+  startSeconds: 0,
+  durationSeconds: 12,
+  volume: 0.5,
+  fadeInSeconds: undefined,
+  fadeOutSeconds: undefined,
+  loop: true,
+  audioType: "sound_effect",
+});
+
 const project = await client.projects.inspect({
   projectId: "project_id",
   mode: "full",

package/dist/index.d.ts

@@ -170,6 +170,7 @@ export type MediaAttachResult = {
         timeline_item_id: string | null;
         message: string | null;
         animation_applied: string | null;
+        layer_index: number | null;
     }>;
     summary: {
         total: number;
@@ -179,6 +180,89 @@ export type MediaAttachResult = {
     };
     message: string;
 };
+export type MediaShortSuggestionList = {
+    saved: JsonObject[];
+    drafts: JsonObject[];
+};
+export type GenerateMediaShortSuggestionsOptions = {
+    assetId: string;
+    contentProfile: "auto" | "podcast" | "tutorial" | "generic" | undefined;
+    autoTrimSilence: boolean | undefined;
+};
+export type ApplyMediaShortSuggestionOptions = {
+    assetId: string;
+    suggestionId: string;
+    projectId: string;
+    captionStyleId: string | null | undefined;
+    markSaved: boolean | undefined;
+    allowUnverifiedExport: boolean | undefined;
+    automaticLayout: JsonObject | undefined;
+};
+export type ApplyMediaShortSuggestionResult = {
+    success: boolean;
+    project_id: string;
+    asset_id: string;
+    suggestion_id: string;
+    timeline_item_id: string;
+    [key: string]: unknown;
+};
+export type ClipSelectionMode = "auto_best" | "suggestion" | "time_range";
+export type ClipLayoutMode = "auto" | "prefer_split" | "prefer_focus";
+export type ClipContentTypeHint = "auto" | "podcast" | "tutorial" | "generic";
+export type ClipQaMode = "required" | "permissive";
+export type ClipTargetOptions = {
+    minDurationSeconds: number | null | undefined;
+    maxDurationSeconds: number;
+};
+export type CreateClipOptions = {
+    projectName: string | null | undefined;
+    source: {
+        sourceType: "asset" | "youtube";
+        assetId: string | null | undefined;
+        youtubeUrl: string | null | undefined;
+    };
+    selection: {
+        mode: ClipSelectionMode;
+        suggestionId: string | null | undefined;
+        startSeconds: number | null | undefined;
+        endSeconds: number | null | undefined;
+    };
+    target: ClipTargetOptions & {
+        aspectRatio: "9:16";
+    };
+    layout: {
+        mode: ClipLayoutMode;
+        contentTypeHint: ClipContentTypeHint | undefined;
+    };
+    captions: {
+        enabled: boolean;
+        styleId: string | null | undefined;
+    };
+    qa: {
+        mode: ClipQaMode;
+    };
+    export: {
+        autoExport: boolean;
+    };
+};
+export type ReselectClipOptions = {
+    clipId: string;
+    selection: CreateClipOptions["selection"];
+    target: ClipTargetOptions | null | undefined;
+};
+export type RepairClipOptions = {
+    clipId: string;
+    repairMode: "auto" | "prefer_split" | "prefer_focus" | "prefer_tutorial" | "move_captions_off_faces";
+};
+export type ExportClipOptions = {
+    clipId: string;
+    resolution: "720p" | "1080p";
+    format: "mp4" | "mov";
+    allowBlockingQaBypass: boolean;
+};
+export type ClipEnvelope = {
+    clip: JsonObject;
+};
 export type MediaAssetDetails = {
     asset: {
         id: string;
@@ -192,6 +276,26 @@ export type MediaAssetDetails = {
         aiMood: string | null;
         aiCameraMovement: string | null;
         fileSizeBytes: number;
+        processingStatus: string | null | undefined;
+        processingSubstage: string | null;
+        processingError: string | null;
+        processingErrors: JsonObject;
+        processingAttempts: number | null;
+        retryable: boolean;
+        providerRequestIds: {
+            processJobRunId: string | null;
+            transcribeJobRunId: string | null;
+            providerRequestId: string | null;
+        };
+        processing_substage: string | null;
+        processing_error: string | null;
+        processing_errors: JsonObject;
+        processing_attempts: number | null;
+        provider_request_ids: {
+            process_job_run_id: string | null;
+            transcribe_job_run_id: string | null;
+            provider_request_id: string | null;
+        };
         durationSeconds: number | null;
         dimensionsWidth: number | null;
         dimensionsHeight: number | null;
@@ -257,6 +361,23 @@ export type InsertAudioResult = {
     };
     txid: number | null;
 };
+export type UpdateAudioResult = {
+    success: boolean;
+    timeline_item_id: string;
+    duration_seconds: number;
+    volume: number;
+    fade_in_seconds: number;
+    fade_out_seconds: number;
+    txid: number | null;
+};
+export type UpdateMediaOverlayResult = {
+    success: boolean;
+    timelineItemId: string;
+    updated: JsonObject;
+    animationApplied: string | null;
+    keyframeCount: number;
+    message: string;
+};
 export type TimelineEditResult = {
     action: string;
     result: unknown;
@@ -312,6 +433,7 @@ export type CaptionWordBatchTextResult = {
 export type CaptionWordCountResult = {
     success: boolean;
     updated_count: number;
+    updated_word_ids: string[] | undefined;
     emphasis: boolean | undefined;
     message: string | undefined;
 };
@@ -325,10 +447,27 @@ export type CaptionWordMutationResult = {
     words: JsonObject[];
     message: string;
 };
+export type CaptionTrackSelectorOptions = {
+    projectId: string;
+    all: boolean | undefined;
+    captionId: string | undefined;
+    timelineItemId: string | undefined;
+    fromSeconds: number | undefined;
+    toSeconds: number | undefined;
+};
+export type CaptionTrackMutationResult = {
+    success: boolean;
+    action: "delete" | "hide" | "show";
+    affected_count: number;
+    caption_ids: string[];
+    timeline_item_ids: string[];
+    message: string;
+};
 export type CaptionThemeList = {
     themes: JsonObject[];
     total: number;
 };
+export type CaptionTheme = JsonObject;
 export type CaptionThemePreview = {
     preview_url: string;
     expires_at: string;
@@ -501,6 +640,7 @@ export type UpdateTextOptions = {
     text: string | undefined;
     name: string | undefined;
     spec: JsonObject | undefined;
+    durationSeconds: number | undefined;
 };
 export type RemoveTextOptions = {
     projectId: string;
@@ -516,14 +656,215 @@ export type AddAudioOptions = {
     fadeOutSeconds: number | undefined;
     loop: boolean | undefined;
 };
-export type MediaPositionPreset = "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "full-screen";
-export type MediaAnimationPreset = "none" | "fadeIn" | "fadeOut" | "zoomIn" | "slideIn" | "popIn" | "bounce" | "spin";
+export type UpdateAudioOptions = {
+    projectId: string;
+    timelineItemId: string;
+    durationSeconds: number | undefined;
+    volume: number | undefined;
+    fadeInSeconds: number | undefined;
+    fadeOutSeconds: number | undefined;
+};
+export type AudioLibraryProvider = "openverse" | "freesound" | "wikimedia";
+export type AudioLibraryProviderFilter = AudioLibraryProvider | "all";
+export type AudioLibraryLicenseFilter = "cc0" | "public_domain" | "attribution" | "all";
+export type AudioLibraryTypeFilter = "music" | "sound_effect" | "ambient" | "other";
+export type StockMediaProvider = "pexels" | "freesound";
+export type StockMediaAssetType = "image" | "video" | "audio";
+export type StockMediaOrientation = "landscape" | "portrait" | "square";
+export type StockAudioType = "sound_effect" | "ambient" | "background_music" | "other";
+export type GlobalBrollLibraryAssetType = "image" | "video" | "audio";
+export type GlobalBrollLibraryAudioType = "music" | "sound_effect" | "ambient" | "background_music" | "other";
+export type AudioLibraryItem = {
+    provider: AudioLibraryProvider;
+    external_id: string;
+    title: string;
+    creator_name: string | null;
+    creator_url: string | null;
+    source_url: string;
+    preview_url: string | null;
+    download_url: string | null;
+    duration_seconds: number | null;
+    license_code: string;
+    license_url: string | null;
+    requires_attribution: boolean;
+    attribution_text: string | null;
+    commercial_use_allowed: boolean;
+    tags: string[];
+};
+export type SearchAudioLibraryOptions = {
+    query: string;
+    provider: AudioLibraryProviderFilter | undefined;
+    license: AudioLibraryLicenseFilter | undefined;
+    audioType: AudioLibraryTypeFilter | undefined;
+    minDurationSeconds: number | null | undefined;
+    maxDurationSeconds: number | null | undefined;
+    limit: number | undefined;
+    page: number | undefined;
+};
+export type SearchAudioLibraryResult = {
+    items: AudioLibraryItem[];
+    warnings: string[];
+    providers: AudioLibraryProvider[];
+};
+export type ImportAudioLibraryAssetOptions = {
+    provider: AudioLibraryProvider;
+    externalId: string;
+    folderId: string | null | undefined;
+    projectId: string | null | undefined;
+    startSeconds: number | undefined;
+    durationSeconds: number | null | undefined;
+    volume: number | undefined;
+    fadeInSeconds: number | undefined;
+    fadeOutSeconds: number | undefined;
+    loop: boolean | undefined;
+    audioType: AudioLibraryTypeFilter | undefined;
+};
+export type ImportAudioLibraryAssetResult = {
+    asset: {
+        id: string;
+        name: string;
+        asset_type: "audio";
+        audio_type: string;
+        duration_seconds: number | null;
+        source_url: string;
+        license_code: string;
+        license_url: string | null;
+        attribution_text: string | null;
+    };
+    imported: boolean;
+    deduped: boolean;
+    timeline_item_id: string | null;
+    txid: number | null;
+};
+export type StockMediaVariant = {
+    id: string;
+    label: string;
+    url: string;
+    mime_type: string;
+    width: number | null;
+    height: number | null;
+    quality: string | null;
+};
+export type StockMediaItem = {
+    provider: StockMediaProvider;
+    provider_asset_id: string;
+    asset_type: StockMediaAssetType;
+    title: string;
+    preview_url: string | null;
+    thumbnail_url: string | null;
+    source_url: string;
+    author_name: string | null;
+    author_url: string | null;
+    license_code: string;
+    license_url: string | null;
+    requires_attribution: boolean;
+    width: number | null;
+    height: number | null;
+    duration_seconds: number | null;
+    variants: StockMediaVariant[];
+};
+export type SearchStockMediaOptions = {
+    query: string;
+    assetType: StockMediaAssetType;
+    provider: StockMediaProvider | null | undefined;
+    orientation: StockMediaOrientation | null | undefined;
+    page: number | undefined;
+    limit: number | undefined;
+};
+export type SearchStockMediaResult = {
+    items: StockMediaItem[];
+    warnings: string[];
+};
+export type ImportStockMediaOptions = {
+    provider: StockMediaProvider;
+    providerAssetId: string;
+    assetType: StockMediaAssetType;
+    variantId: string | null | undefined;
+    folderId: string | null | undefined;
+    audioType: StockAudioType | undefined;
+};
+export type ImportStockMediaResult = {
+    asset: {
+        id: string;
+        name: string;
+        asset_type: StockMediaAssetType;
+        processing_status: string;
+        source_url: string;
+        license_code: string;
+        license_url: string | null;
+    };
+    imported: boolean;
+    deduped: boolean;
+};
+export type GlobalBrollLibraryItem = {
+    id: string;
+    asset_type: GlobalBrollLibraryAssetType;
+    title: string;
+    description: string;
+    tags: string[];
+    preview_url: string | null;
+    thumbnail_url: string | null;
+    mime_type: string;
+    file_size_bytes: number;
+    duration_seconds: number | null;
+    width: number | null;
+    height: number | null;
+    audio_type: GlobalBrollLibraryAudioType;
+    license_code: string;
+    license_url: string | null;
+    requires_attribution: boolean;
+    attribution_text: string | null;
+    source_url: string | null;
+};
+export type SearchGlobalBrollLibraryOptions = {
+    query: string | null | undefined;
+    assetType: GlobalBrollLibraryAssetType | null | undefined;
+    audioType: GlobalBrollLibraryAudioType | null | undefined;
+    limit: number | undefined;
+    offset: number | undefined;
+};
+export type SearchGlobalBrollLibraryResult = {
+    items: GlobalBrollLibraryItem[];
+};
+export type ImportGlobalBrollLibraryAssetOptions = {
+    libraryAssetId: string;
+    folderId: string | null | undefined;
+};
+export type ImportGlobalBrollLibraryAssetResult = {
+    asset: {
+        id: string;
+        name: string;
+        asset_type: GlobalBrollLibraryAssetType;
+        processing_status: string;
+        library_asset_id: string;
+    };
+    imported: boolean;
+    deduped: boolean;
+};
+export type MediaPositionPreset = "center" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "fullscreen" | "full-screen";
+export type MediaAnimationPreset = "none" | "fadeIn" | "fadeOut" | "zoomIn" | "zoomOut" | "slideIn" | "slideLeft" | "slideRight" | "slideUp" | "slideDown" | "popIn" | "bounce" | "spin";
+export type UpdateMediaOverlayOptions = {
+    projectId: string;
+    timelineItemId: string;
+    positionPreset: MediaPositionPreset | undefined;
+    positionX: number | undefined;
+    positionY: number | undefined;
+    widthPx: number | undefined;
+    heightPx: number | undefined;
+    scale: number | undefined;
+    animationPreset: MediaAnimationPreset | undefined;
+    removeAnimations: boolean | undefined;
+    blurredBackground: boolean | undefined;
+};
 export type CaptionWordSelectorOptions = {
     projectId: string;
     wordIds: string[] | undefined;
     matchText: string | undefined;
     matchPattern: "numbers" | "caps" | "exclamations" | undefined;
     timelineItemId: string | undefined;
+    all: boolean | undefined;
+    fromSeconds: number | undefined;
+    toSeconds: number | undefined;
 };
 export type ListCaptionWordsOptions = {
     projectId: string;
@@ -572,11 +913,16 @@ export type PreviewCaptionThemeOptions = {
     targetWidth: number | undefined;
     imageFormat: "png" | "jpeg" | undefined;
 };
+export type UpdateCaptionThemeOptions = {
+    themeId: string;
+    name: string | undefined;
+    description: string | undefined;
+    settings: JsonObject | undefined;
+};
 export type StartExportOptions = {
     projectId: string;
     resolution: string | undefined;
     format: string | undefined;
-    includeCaptions: boolean | undefined;
 };
 export type WaitExportOptions = {
     exportId: string;
@@ -585,7 +931,8 @@ export type WaitExportOptions = {
 };
 export type SilencePlanOptions = {
     projectId: string;
-    timelineItemId: string;
+    timelineItemId: string | undefined;
+    allMediaItems: boolean | undefined;
     paddingMs: number | undefined;
     silenceThresholdDb: number | undefined;
     minSilenceDurationSeconds: number | undefined;
@@ -607,6 +954,63 @@ export type MistakeApplyOptions = MistakePlanOptions & {
     deleteMistakes: boolean | undefined;
     previewConfirmed: true;
 };
+export type EffectEasing = "linear" | "easeIn" | "easeOut" | "easeInOut";
+export type ZoomEffectSettings = {
+    scale: {
+        start: number;
+        end: number;
+    } | undefined;
+    translate: {
+        start: {
+            x: number;
+            y: number;
+        };
+        end: {
+            x: number;
+            y: number;
+        };
+    } | undefined;
+    anchor: {
+        x: number;
+        y: number;
+    } | undefined;
+    style: "transition" | "hard" | undefined;
+    phase: "in" | "out" | "both" | "none" | undefined;
+    inDurationSeconds: number | undefined;
+    outDurationSeconds: number | null | undefined;
+    outScale: number | null | undefined;
+};
+export type MaskEffectSettings = JsonObject;
+export type ColorGradeEffectSettings = JsonObject;
+export type AddEffectOptions<TSettings> = {
+    projectId: string;
+    timelineItemId: string | undefined;
+    contentItemId: string | undefined;
+    effectId: string | undefined;
+    name: string | undefined;
+    startTimeSeconds: number | undefined;
+    durationSeconds: number | undefined;
+    easing: EffectEasing | undefined;
+    layerIndex: number | undefined;
+    orderIndex: number | undefined;
+    settings: TSettings | undefined;
+};
+export type UpdateEffectOptions<TSettings> = {
+    projectId: string;
+    timelineItemId: string;
+    durationSeconds: number | undefined;
+    easing: EffectEasing | undefined;
+    settings: TSettings | undefined;
+};
+export type EffectMutationResult = {
+    success: true;
+    project_id: string;
+    timeline_item_id: string;
+    content_item_id: string;
+    effect_id: string;
+    effect_type: "zoom" | "mask" | "colorgrade";
+    txid: number | null;
+};
 export declare class BlitzReelsClient {
     private apiKey;
     private baseUrl;
@@ -643,6 +1047,20 @@ export declare class BlitzReelsClient {
             timelineItemId: string;
         }) => Promise<TimelineItemDeleteResult>;
     };
+    effects: {
+        zoom: {
+            add: (options: AddEffectOptions<ZoomEffectSettings>) => Promise<EffectMutationResult>;
+            update: (options: UpdateEffectOptions<ZoomEffectSettings>) => Promise<EffectMutationResult>;
+        };
+        mask: {
+            add: (options: AddEffectOptions<MaskEffectSettings>) => Promise<EffectMutationResult>;
+            update: (options: UpdateEffectOptions<MaskEffectSettings>) => Promise<EffectMutationResult>;
+        };
+        colorgrade: {
+            add: (options: AddEffectOptions<ColorGradeEffectSettings>) => Promise<EffectMutationResult>;
+            update: (options: UpdateEffectOptions<ColorGradeEffectSettings>) => Promise<EffectMutationResult>;
+        };
+    };
     workspace: {
         getSettings: () => Promise<WorkspaceSettings>;
         updateSettings: (options: UpdateWorkspaceSettingsOptions) => Promise<WorkspaceSettingsUpdate>;
@@ -652,6 +1070,10 @@ export declare class BlitzReelsClient {
         get: (options: {
             assetId: string;
         }) => Promise<MediaAssetDetails>;
+        clippingStatus: (options: {
+            assetId: string;
+            projectId: string | undefined;
+        }) => Promise<JsonObject>;
         delete: (options: {
             assetId: string;
         }) => Promise<{
@@ -663,6 +1085,16 @@ export declare class BlitzReelsClient {
         update: (options: UpdateMediaOptions) => Promise<MediaAssetUpdateResult>;
         move: (options: MoveMediaOptions) => Promise<MediaMoveResult>;
         attachToProject: (options: AttachMediaToProjectOptions) => Promise<MediaAttachResult>;
+        updateOverlay: (options: UpdateMediaOverlayOptions) => Promise<UpdateMediaOverlayResult>;
+        shorts: {
+            list: (options: {
+                assetId: string;
+            }) => Promise<MediaShortSuggestionList>;
+            generate: (options: GenerateMediaShortSuggestionsOptions) => Promise<{
+                run_id: string;
+            }>;
+            apply: (options: ApplyMediaShortSuggestionOptions) => Promise<ApplyMediaShortSuggestionResult>;
+        };
         folders: {
             list: (options: ListMediaFoldersOptions) => Promise<MediaFoldersList>;
             create: (options: CreateMediaFolderOptions) => Promise<{
@@ -681,6 +1113,15 @@ export declare class BlitzReelsClient {
             }>;
         };
     };
+    clips: {
+        create: (options: CreateClipOptions) => Promise<ClipEnvelope>;
+        get: (options: {
+            clipId: string;
+        }) => Promise<ClipEnvelope>;
+        reselect: (options: ReselectClipOptions) => Promise<ClipEnvelope>;
+        repair: (options: RepairClipOptions) => Promise<ClipEnvelope>;
+        export: (options: ExportClipOptions) => Promise<ClipEnvelope>;
+    };
     text: {
         add: (options: AddTextOptions) => Promise<CreateContentItemResult>;
         list: (options: {
@@ -695,6 +1136,19 @@ export declare class BlitzReelsClient {
     };
     audio: {
         add: (options: AddAudioOptions) => Promise<InsertAudioResult>;
+        update: (options: UpdateAudioOptions) => Promise<UpdateAudioResult>;
+    };
+    audioLibrary: {
+        search: (options: SearchAudioLibraryOptions) => Promise<SearchAudioLibraryResult>;
+        importAsset: (options: ImportAudioLibraryAssetOptions) => Promise<ImportAudioLibraryAssetResult>;
+    };
+    stockMedia: {
+        search: (options: SearchStockMediaOptions) => Promise<SearchStockMediaResult>;
+        importAsset: (options: ImportStockMediaOptions) => Promise<ImportStockMediaResult>;
+    };
+    library: {
+        search: (options: SearchGlobalBrollLibraryOptions) => Promise<SearchGlobalBrollLibraryResult>;
+        importAsset: (options: ImportGlobalBrollLibraryAssetOptions) => Promise<ImportGlobalBrollLibraryAssetResult>;
     };
     silence: {
         plan: (options: SilencePlanOptions) => Promise<unknown>;
@@ -711,9 +1165,13 @@ export declare class BlitzReelsClient {
         setWordStyle: (options: SetCaptionWordStyleOptions) => Promise<CaptionWordCountResult>;
         setWordEmphasis: (options: SetCaptionWordEmphasisOptions) => Promise<CaptionWordCountResult>;
         deleteWords: (options: DeleteCaptionWordsOptions) => Promise<CaptionWordMutationResult>;
+        delete: (options: CaptionTrackSelectorOptions) => Promise<CaptionTrackMutationResult>;
+        hide: (options: CaptionTrackSelectorOptions) => Promise<CaptionTrackMutationResult>;
+        show: (options: CaptionTrackSelectorOptions) => Promise<CaptionTrackMutationResult>;
         mergeWords: (options: MergeCaptionWordsOptions) => Promise<CaptionWordMutationResult>;
         splitWord: (options: SplitCaptionWordOptions) => Promise<CaptionWordMutationResult>;
         listThemes: () => Promise<CaptionThemeList>;
+        updateTheme: (options: UpdateCaptionThemeOptions) => Promise<CaptionTheme>;
         setDefaultTheme: (options: {
             themeId: string;
         }) => Promise<{