ugcinc 2.39.0 → 2.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -36,12 +36,14 @@ export declare class AutomationsClient extends BaseClient {
36
36
  * Run an automation template
37
37
  * @param variableInputs - Optional map of variable node IDs to their runtime values
38
38
  * @param saveAsPreview - If true, saves the output as a preview for sub-workflows
39
+ * @param tag - Optional tag for organizing runs
39
40
  */
40
41
  run(params: {
41
42
  templateId: string;
42
43
  orgId: string;
43
44
  variableInputs?: Record<string, string>;
44
45
  saveAsPreview?: boolean;
46
+ tag?: string;
45
47
  }): Promise<ApiResponse<{
46
48
  runId: string;
47
49
  }>>;
@@ -47,6 +47,7 @@ class AutomationsClient extends base_1.BaseClient {
47
47
  * Run an automation template
48
48
  * @param variableInputs - Optional map of variable node IDs to their runtime values
49
49
  * @param saveAsPreview - If true, saves the output as a preview for sub-workflows
50
+ * @param tag - Optional tag for organizing runs
50
51
  */
51
52
  async run(params) {
52
53
  return this.request('/automations/run', {
package/dist/index.d.ts CHANGED
@@ -13,4 +13,4 @@ export { RenderClient } from './render';
13
13
  export { AutomationsClient, getAllNodes, getNodeByType } from './automations';
14
14
  export { MediaClient } from './media';
15
15
  export type { ClientConfig, } from './base';
16
- export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorConfig, ImageEditorConfig, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, RenderJobSubmit, RenderVideoRequest, RenderImageRequest, RenderJobResponse, RenderJobStatus, 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, UserMedia, SocialAudio, Media, GetMediaParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, CreateMediaFromUrlParams, } from './types';
16
+ export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorConfig, ImageEditorConfig, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, PositionAnchor, RelativePositionConfig, RenderJobSubmit, RenderVideoRequest, RenderImageRequest, RenderJobResponse, RenderJobStatus, 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, UserMedia, SocialAudio, Media, GetMediaParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, CreateMediaFromUrlParams, } from './types';
package/dist/types.d.ts CHANGED
@@ -430,6 +430,23 @@ export interface BorderRadiusConfig {
430
430
  /** Bottom-left corner radius in pixels */
431
431
  bottomLeft?: number;
432
432
  }
433
+ /**
434
+ * Position anchor for relative positioning
435
+ * Specifies which edge of the reference element to anchor to
436
+ */
437
+ export type PositionAnchor = 'top' | 'bottom' | 'left' | 'right';
438
+ /**
439
+ * Relative position configuration
440
+ * When set on a segment, its position is calculated relative to another segment
441
+ */
442
+ export interface RelativePositionConfig {
443
+ /** ID of the segment to position relative to */
444
+ elementId: string;
445
+ /** Which edge of the reference segment to anchor to */
446
+ anchor: PositionAnchor;
447
+ /** Offset in pixels from the anchor point (positive = away from reference) */
448
+ offset: number;
449
+ }
433
450
  /**
434
451
  * Visual segment properties (video, image, text, editor)
435
452
  */
@@ -450,6 +467,16 @@ export interface VisualSegmentProps extends BaseSegmentProps {
450
467
  rotation?: number;
451
468
  /** Opacity percentage 0-100 (default: 100) */
452
469
  opacity?: number;
470
+ /**
471
+ * Relative positioning - when set, xOffset/yOffset are calculated from the reference segment
472
+ * This is useful for stacking elements like text messages where the reference element's
473
+ * height may vary based on text content.
474
+ *
475
+ * @example
476
+ * // Position this segment below another segment with a 10px gap
477
+ * relativePosition: { elementId: 'message-1', anchor: 'bottom', offset: 10 }
478
+ */
479
+ relativePosition?: RelativePositionConfig;
453
480
  }
454
481
  /**
455
482
  * Video segment - displays video content with optional audio
@@ -695,8 +722,10 @@ export interface AutomationRun {
695
722
  id: string;
696
723
  template_id: string;
697
724
  org_id: string;
725
+ tag: string | null;
698
726
  status: 'pending' | 'running' | 'completed' | 'failed';
699
727
  variable_inputs: Record<string, string> | null;
728
+ save_as_preview: boolean | null;
700
729
  created_at: string;
701
730
  completed_at: string | null;
702
731
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ugcinc",
3
- "version": "2.39.0",
3
+ "version": "2.41.0",
4
4
  "description": "TypeScript/JavaScript client for the UGC Inc API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",