> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ugc.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# NPM Package Types

> Complete exported type index for the ugcinc npm package

All public TypeScript data structures exported by `ugcinc` are listed below, grouped by module or domain.

## `./accounts`

`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`

## `./tasks`

`TaskType`, `Task`, `GetTasksParams`

## `./posts`

`PostType`, `PostStatus`, `Post`, `PostStat`, `CaptionOverlay`, `GetPostsParams`, `CreateSlideshowParams`, `GetPostStatsParams`, `GetPostStatusParams`, `CreateVideoParams`, `UpdatePostParams`, `DeletePostsParams`, `DeletePostsResponse`, `RetryPostsParams`, `SetPostStatusParams`, `SetPostStatusResponse`, `PreviewScheduleEntry`, `PreviewScheduleParams`, `PreviewScheduleResult`

`CaptionOverlay` is the item type of the `captionOverlays` request field on `posts.createVideo()` and the `caption_overlays` field on `Post`.

## `./comments`

`CommentStatus`, `Comment`, `CreateCommentParams`, `CreateCommentResponse`, `GetCommentsParams`

## `./media`

`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`

## `./stats`

`RefreshStatsParams`, `RefreshStatsError`, `RefreshStatsResponse`, `RefreshStartEvent`, `RefreshProgressEvent`, `RefreshDoneEvent`, `RefreshStreamEvent`, `DailyAggregatedStat`, `GetDailyAggregatedStatsParams`, `DailyAccountStat`, `GetDailyAccountStatsParams`, `DailyPostStat`, `GetDailyPostStatsParams`, `DashboardDailyStat`, `GetDashboardDailyStatsParams`, `TopAccount`, `GetTopAccountsParams`, `TopPost`, `GetTopPostsParams`

## `./org`

`Org`, `ApiKey`, `DeleteApiKeyParams`, `EditApiKeyParams`, `IntegrationKey`, `IntegrationProvider`, `UpsertIntegrationKeyParams`, `DeleteIntegrationKeyParams`

## `./billing`

`BillingInfo`, `CancelSubscriptionResponse`, `PortalUrlResponse`, `DeactivateAccountParams`, `DeactivateAccountResponse`, `RequestReplacementParams`, `RequestReplacementResponse`, `RequestRefundParams`, `RequestRefundResponse`, `BillingRequestInfo`, `PortalParams`

## `./types`

`SuccessResponse`, `ErrorResponse`, `ApiResponse`

## `./base`

`ClientConfig`

## `./render`

`RenderJobResponse`, `RenderJobStatus`, `SubmitImageRenderJobParams`, `SubmitVideoRenderJobParams`, `SubmitScreenshotAnimationRenderJobParams`, `SubmitAutoCaptionRenderJobParams`, `SubmitInstagramDmRenderJobParams`, `SubmitIMessageDmRenderJobParams`, `IgDmMessage`, `ImDmMessage`, `RenderVideoEditorConfig`

## `./render/types`

`VideoEditorNodeConfig`, `VideoEditorChannel`, `VideoEditorSegment`, `VideoEditorVideoSegment`, `VideoEditorAudioSegment`, `VideoEditorImageSegment`, `VideoEditorTextSegment`, `VideoEditorImageSequenceSegment`, `VideoEditorVideoSequenceSegment`, `TimeValue`, `TimeMode`, `SegmentTimelinePosition`, `DeduplicationLevel`, `DeduplicationInput`, `ImageEditorElement`, `DimensionPresetKey`

## `./automations/types`

`DayOfWeek`, `ScheduleConfig`, `AccountIterationConfig`, `MediaType`, `BasePortType`, `EnumOption`, `ImageValue`, `VideoValue`, `AudioValue`, `TextValue`, `NumberValue`, `BooleanValue`, `DateValue`, `EnumValue`, `SocialAudioValue`, `ObjectValue`, `PortValueFor`, `PortValue`, `NodeOutputValues`, `NodePort`, `NodePortWithPreview`, `ResolvedPorts`, `ComputedNode`, `OutputSchemaProperty`, `WorkflowNodeDefinition`, `WorkflowNodeInput`, `CanvasState`, `WorkflowDefinition`, `TemplateNode`, `AutomationTemplate`, `AutomationRun`, `ExecutorNode`, `ExecutionEdge`, `AccountData`, `FlowControlOutput`, `ExecutorContext`, `NodeExecutor`, `AsyncNodeExecutor`, `AnyNodeExecutor`, `AnyAsyncNodeExecutor`, `ExecutorAsyncJobStatus`, `ValidationErrorType`, `ValidationError`, `ExportedNode`, `ExportedConnection`, `ExportedTemplate`, `AutomationExport`, `ExportedExecutor`, `ExportedEdge`, `ExportedRun`, `AutomationRunExport`, `AutomationRunLog`, `InternalWorkflowConfig`, `AllWorkflowConfig`, `InternalNodeInputs`, `AllNodeInputs`, `InternalNodeOutputs`, `AllNodeOutputs`, `SchemaField`, `ObjectSchemaField`, `NestedSchemaField`

## `./automations/nodes`

`NodeDefinition`, `NodeType`, `UserCreatableNodeType`, `NodeConfig`, `WorkflowConfig`, `NodeInputs`, `NodeOutputs`, `InternalNodeType`

## `./automations/nodes/types`

`InputType`, `SelectionMode`, `ExhaustionBehavior`, `SelectionConfig`, `SelectionState`, `OutputMode`, `NodeCategory`, `TriggerIterationMode`, `IterationExhaustionBehavior`, `CollectionSelectionMode`, `TriggerCollectionConfig`, `MediaItemType`, `MediaNodeSelectionType`, `ResolvedPreview`, `PreviewSelectionState`, `PreviewContext`, `NullableOutputs`

## `./automations/nodes/*` specific configs

`AccountNodeConfig`, `AutoCaptionNodeConfig`, `AutoCaptionPreset`, `AutoCaptionFontWeight`, `AutoCaptionPosition`, `AutoPostNodeConfig`, `AutoPostMode`, `PostSchedulingMode`, `BranchNodeConfig`, `BranchDefinition`, `BranchPassthroughInput`, `BranchValueConfig`, `CollectNodeConfig`, `CollectedValues`, `CollectInputValue`, `ComposeWorkflowNodeConfig`, `ComposeWorkflowNodeInputs`, `ComposeWorkflowNodeOutputs`, `CreateDmNodeConfig`, `CreateDmMessage`, `DmPlatform`, `CustomModelNodeConfig`, `CustomModelOutputType`, `CustomModelInputParam`, `CustomModelParamType`, `OpenAPISchema`, `OpenAPIProperty`, `DeduplicateNodeConfig`, `DestructureNodeConfig`, `DestructureNodeInputs`, `DestructureNodeOutputs`, `DestructureSelection`, `IndexExpression`, `ForEachNodeConfig`, `ForEachNodeInputs`, `ForEachNodeOutputs`, `ForEachOutputProperty`, `GenerateImageNodeConfig`, `ImageGenerationEditModel`, `ImageGenerationModel`, `ImageModelProvider`, `ImageModelOption`, `AspectRatioOption`, `ImageInput`, `ImageMediaItem`, `GenerateVideoNodeConfig`, `VideoGenerationTextToVideoModel`, `VideoGenerationImageToVideoModel`, `VideoGenerationFirstLastFrameModel`, `VideoGenerationReferenceModel`, `VideoGenerationModel`, `VideoInputMode`, `VideoModelProvider`, `VideoModelTier`, `VideoAspectRatioOption`, `VideoDurationOption`, `VideoModelOption`, `VideoMediaItem`, `ReferenceImageInput`, `IfNodeConfig`, `IfLogicOperator`, `IfBooleanInput`, `ImageEditorNodeConfig`, `ImageComposerNodeConfig`, `ImageComposerRenderInput`, `LLMNodeConfig`, `LLMNodeOutputs`, `LLMProvider`, `MediaNodeConfig`, `MediaNodeOutput`, `NotNodeConfig`, `OutputNodeConfig`, `OutputNodeOutputs`, `RandomNodeConfig`, `RandomInputPort`, `RandomNodeMode`, `RandomNodeOutputs`, `RandomRouteNodeConfig`, `RandomRouteBranch`, `RandomRoutePassthroughInput`, `RecurrenceNodeConfig`, `RecurrenceMediaOutput`, `RecurrenceMediaConfig`, `RecurrenceNodeOutputs`, `SaveToMediaNodeConfig`, `SaveToMediaInput`, `SaveToMediaType`, `ScreenshotAnimationNodeConfig`, `SocialAudioNodeConfig`, `TextNodeConfig`, `TranscriptNodeConfig`, `InputNodeConfig`, `InputNodeOutputs`, `VideoComposerNodeConfig`, `VideoComposerRenderInput`, `VideoImportNodeConfig`, `VideoImportNodeInputs`, `VideoImportNodeOutputs`, `VideoImportPlatform`, `VideoImportQuality`

## `./port-id`

`PortId`

## `./tools`

`ToolDefinition`