@wix/auto_sdk_data_scheduled-workflows 1.0.3 → 1.0.5

package/build/es/index.typings.d.mts

@@ -1210,6 +1210,83 @@ interface TransformationTransformationOneOf {
 }
 interface TestTransformation {
 }
+/** Maps and filters source fields onto destination fields. */
+interface FieldMapping {
+    /**
+     * Column mappings. Any source field not listed here is excluded from the import.
+     * @minSize 1
+     * @maxSize 1000
+     */
+    mappings?: FieldMappingEntry[];
+}
+interface FieldMappingEntry extends FieldMappingEntryConversionOneOf {
+    /** Boolean token mapping. Set when field_type is BOOLEAN. */
+    booleanOptions?: BooleanOptions;
+    /** Date-time format. Set when field_type is DATETIME. */
+    datetimeOptions?: DateTimeOptions;
+    /**
+     * Source field key (e.g. a CSV column header).
+     * @minLength 1
+     * @maxLength 1024
+     */
+    sourceKey?: string;
+    /**
+     * Destination field key. Must already exist in the destination collection.
+     * Use "_id" to control the item ID. May target a multi-reference or array
+     * field (use field_type = ARRAY; the cell must be a JSON array).
+     * @minLength 1
+     * @maxLength 1024
+     */
+    targetKey?: string;
+    /**
+     * Destination field data type, used to coerce the source string value.
+     * ARRAY / OBJECT parse the cell as JSON. Default: ANY (pass-through).
+     */
+    fieldType?: FieldTypeWithLiterals;
+}
+/** @oneof */
+interface FieldMappingEntryConversionOneOf {
+    /** Boolean token mapping. Set when field_type is BOOLEAN. */
+    booleanOptions?: BooleanOptions;
+    /** Date-time format. Set when field_type is DATETIME. */
+    datetimeOptions?: DateTimeOptions;
+}
+/**
+ * Maps source tokens to boolean values. Matching is case-insensitive.
+ * When both lists are empty, booleans are converted best-effort ("true"/"false").
+ * Values matching neither list are kept as-is.
+ */
+interface BooleanOptions {
+    /**
+     * Source tokens representing boolean true (e.g. "true", "yes", "1").
+     * @maxSize 64
+     * @maxLength 256
+     */
+    trueValues?: string[];
+    /**
+     * Source tokens representing boolean false (e.g. "false", "no", "0").
+     * @maxSize 64
+     * @maxLength 256
+     */
+    falseValues?: string[];
+}
+/** How to parse a source date-time value. */
+interface DateTimeOptions {
+    format?: DateFormatWithLiterals;
+}
+/** Known source date / date-time formats. Extend with new formats as needed. */
+declare enum DateFormat {
+    /** Try to detect and parse the value automatically. */
+    BEST_EFFORT = "BEST_EFFORT",
+    /** ISO 8601, e.g. "2026-07-03T14:04:31.000Z". */
+    ISO_8601 = "ISO_8601",
+    /** "MM/DD/YYYY HH:mm", e.g. "07/03/2026 14:04". */
+    MM_DD_YYYY_HH_MM = "MM_DD_YYYY_HH_MM",
+    /** "DD/MM/YYYY HH:mm", e.g. "03/07/2026 14:04". */
+    DD_MM_YYYY_HH_MM = "DD_MM_YYYY_HH_MM"
+}
+/** @enumType */
+type DateFormatWithLiterals = DateFormat | 'BEST_EFFORT' | 'ISO_8601' | 'MM_DD_YYYY_HH_MM' | 'DD_MM_YYYY_HH_MM';
 interface CreateScheduledDataWorkflowRequest {
     /** Scheduled data movement workflow to create. */
     scheduledDataWorkflow: ScheduledDataWorkflow;
@@ -1571,7 +1648,6 @@ interface JobsCreatedEnvelope {
  * @webhook
  * @eventType wix.data.sync.v1.jobs_created
  * @slug created
- * @documentationMaturity preview
  */
 declare function onJobsCreated(handler: (event: JobsCreatedEnvelope) => void | Promise<void>): void;
 interface JobsDeletedEnvelope {
@@ -1583,7 +1659,6 @@ interface JobsDeletedEnvelope {
  * @webhook
  * @eventType wix.data.sync.v1.jobs_deleted
  * @slug deleted
- * @documentationMaturity preview
  */
 declare function onJobsDeleted(handler: (event: JobsDeletedEnvelope) => void | Promise<void>): void;
 interface JobsUpdatedEnvelope {
@@ -1596,7 +1671,6 @@ interface JobsUpdatedEnvelope {
  * @webhook
  * @eventType wix.data.sync.v1.jobs_updated
  * @slug updated
- * @documentationMaturity preview
  */
 declare function onJobsUpdated(handler: (event: JobsUpdatedEnvelope) => void | Promise<void>): void;
 /**
@@ -1606,7 +1680,6 @@ declare function onJobsUpdated(handler: (event: JobsUpdatedEnvelope) => void | P
  * Each execution creates a new [data workflow](https://dev.wix.com/docs/api-reference/business-solutions/cms/operations/data-movement-jobs/introduction) with its `scheduleId` set to this scheduled data workflow's ID.
  * @param scheduledDataWorkflow - Scheduled data movement workflow to create.
  * @public
- * @documentationMaturity preview
  * @requiredField scheduledDataWorkflow
  * @requiredField scheduledDataWorkflow._id
  * @requiredField scheduledDataWorkflow.workflow
@@ -1633,7 +1706,6 @@ interface CreateScheduledDataWorkflowOptions {
  * Only applies to `enabled` scheduled data workflows.
  * @param scheduledDataWorkflowId - ID of the scheduled data movement workflow to reschedule.
  * @public
- * @documentationMaturity preview
  * @requiredField scheduledDataWorkflowId
  * @permissionId data:sync:v1:jobs:reschedule_scheduled_data_workflow
  * @fqn wix.hub.v1.DataMovementSchedulerService.RescheduleScheduledDataWorkflow
@@ -1654,7 +1726,6 @@ interface RescheduleScheduledDataWorkflowOptions {
  * TimeCapsule runs.
  * @param scheduledDataWorkflowId - ID of the scheduled data movement workflow to run immediately.
  * @public
- * @documentationMaturity preview
  * @requiredField scheduledDataWorkflowId
  * @permissionId data:sync:v1:jobs:trigger_scheduled_data_workflow_now
  * @fqn wix.hub.v1.DataMovementSchedulerService.TriggerScheduledDataWorkflowNow
@@ -1664,7 +1735,6 @@ declare function triggerScheduledDataWorkflowNow(scheduledDataWorkflowId: string
  * Updates an existing scheduled data workflow.
  * @param scheduledDataWorkflow - Scheduled data movement workflow information to update.
  * @public
- * @documentationMaturity preview
  * @requiredField scheduledDataWorkflow
  * @requiredField scheduledDataWorkflow.workflow
  * @requiredField scheduledDataWorkflow.workflow.steps
@@ -1686,7 +1756,6 @@ interface UpdateScheduledDataWorkflowOptions {
  * This permanently removes the schedule and prevents future executions. Any currently running data workflows triggered by the schedule continue to completion.
  * @param scheduledDataWorkflowId - ID of the scheduled data movement workflow to delete.
  * @public
- * @documentationMaturity preview
  * @requiredField scheduledDataWorkflowId
  * @permissionId data:sync:v1:jobs:delete_scheduled_data_workflow
  * @fqn wix.hub.v1.DataMovementSchedulerService.DeleteScheduledDataWorkflow
@@ -1696,7 +1765,6 @@ declare function deleteScheduledDataWorkflow(scheduledDataWorkflowId: string): P
  * Retrieves a scheduled data workflow by ID.
  * @param scheduledDataWorkflowId - ID of the scheduled data movement workflow to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField scheduledDataWorkflowId
  * @permissionId data:sync:v1:jobs:get_scheduled_data_workflow
  * @returns Retrieved scheduled data movement workflow.
@@ -1715,7 +1783,6 @@ interface GetScheduledDataWorkflowOptions {
  *
  * The current implementation returns both enabled and disabled schedules. Request `paging` and `filter` fields are accepted for forward compatibility but are not applied by the service.
  * @public
- * @documentationMaturity preview
  * @permissionId data:sync:v1:jobs:list_scheduled_data_workflows
  * @fqn wix.hub.v1.DataMovementSchedulerService.ListScheduledDataWorkflows
  */
@@ -1732,4 +1799,4 @@ interface ListScheduledDataWorkflowsOptions {
     filter?: Record<string, any> | null;
 }
 
-export { type AbsOperation, type AccountInfo, type AccountInfoMetadata, type Accumulator, type AccumulatorExpressionOneOf, type ActionEvent, type AddField, type AddFields, type AddOperation, type AggregationPipeline, type AggregationPipelinePagingMethodOneOf, type AggregationQuery, type Avg, type BaseEventMetadata, type CeilOperation, type CommonCursorPaging, type CommonSorting, type ConcatOperation, type ConditionOperation, type CreateScheduledDataWorkflowOptions, type CreateScheduledDataWorkflowRequest, type CreateScheduledDataWorkflowResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DataMovementJobLogs, type DeleteScheduledDataWorkflowRequest, type DeleteScheduledDataWorkflowResponse, type Destination, type DestinationDestinationOneOf, type DivideOperation, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Exclude, type Expression, type ExpressionValueOneOf, type ExternalFileSource, type Field, type FieldProjectionOneOf, FieldType, type FieldTypeWithLiterals, Fields, type FieldsWithLiterals, type FileDestination, FileFormat, type FileFormatWithLiterals, type FileSource, type FilterQuery, type First, type FloorOperation, type GetScheduledDataWorkflowOptions, type GetScheduledDataWorkflowRequest, type GetScheduledDataWorkflowResponse, type GoogleSheetsSource, type GreaterThanOperation, type Group, type GroupId, type IdentificationData, type IdentificationDataIdOneOf, type Include, type JobSpec, type JobSpecSiteOverrideOneOf, type JobsCreatedEnvelope, type JobsDeletedEnvelope, type JobsUpdatedEnvelope, type Last, type LengthOperation, type ListScheduledDataWorkflowsOptions, type ListScheduledDataWorkflowsRequest, type ListScheduledDataWorkflowsResponse, type LocalizationDestination, type LocalizationSource, type Lookup, type Max, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Min, type ModOperation, type MultiplyOperation, type ObjectToArray, type Paging, type ProjectNested, type Projection, type Push, type RescheduleScheduledDataWorkflowOptions, type RescheduleScheduledDataWorkflowRequest, type RescheduleScheduledDataWorkflowResponse, type Reshape, type RestoreInfo, type ScheduledDataWorkflow, type ScheduledDataWorkflowSpec, type Schema, type SizeOperation, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, type SourceSourceOneOf, type Stage, type StageStageOneOf, type StoresCatalogInventoryDestination, type StoresCatalogProductsDestination, type StringifyOperation, type SubstringOperation, type SubtractOperation, type Sum, type SumOperation, type TestDestination, type TestSource, type TestTransformation, type ToLowerOperation, type ToUpperOperation, type Transformation, type TransformationTransformationOneOf, type TriggerScheduledDataWorkflowNowRequest, type TriggerScheduledDataWorkflowNowResponse, type UnionWith, type UnwindArray, type UpdateScheduledDataWorkflowOptions, type UpdateScheduledDataWorkflowRequest, type UpdateScheduledDataWorkflowResponse, type V1Field, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixDataCollectionDefinitionDestination, type WixDataCollectionDefinitionSource, type WixDataDestination, WixDataDestinationWritePolicy, type WixDataDestinationWritePolicyWithLiterals, WixDataEnvironment, type WixDataEnvironmentWithLiterals, type WixDataSource, type WixDataSourceQueryOneOf, type WixMediaDestination, WixMediaDestinationWritePolicy, type WixMediaDestinationWritePolicyWithLiterals, type WixMediaSource, WritePolicy, type WritePolicyWithLiterals, createScheduledDataWorkflow, deleteScheduledDataWorkflow, getScheduledDataWorkflow, listScheduledDataWorkflows, onJobsCreated, onJobsDeleted, onJobsUpdated, rescheduleScheduledDataWorkflow, triggerScheduledDataWorkflowNow, updateScheduledDataWorkflow };
+export { type AbsOperation, type AccountInfo, type AccountInfoMetadata, type Accumulator, type AccumulatorExpressionOneOf, type ActionEvent, type AddField, type AddFields, type AddOperation, type AggregationPipeline, type AggregationPipelinePagingMethodOneOf, type AggregationQuery, type Avg, type BaseEventMetadata, type BooleanOptions, type CeilOperation, type CommonCursorPaging, type CommonSorting, type ConcatOperation, type ConditionOperation, type CreateScheduledDataWorkflowOptions, type CreateScheduledDataWorkflowRequest, type CreateScheduledDataWorkflowResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DataMovementJobLogs, DateFormat, type DateFormatWithLiterals, type DateTimeOptions, type DeleteScheduledDataWorkflowRequest, type DeleteScheduledDataWorkflowResponse, type Destination, type DestinationDestinationOneOf, type DivideOperation, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Exclude, type Expression, type ExpressionValueOneOf, type ExternalFileSource, type Field, type FieldMapping, type FieldMappingEntry, type FieldMappingEntryConversionOneOf, type FieldProjectionOneOf, FieldType, type FieldTypeWithLiterals, Fields, type FieldsWithLiterals, type FileDestination, FileFormat, type FileFormatWithLiterals, type FileSource, type FilterQuery, type First, type FloorOperation, type GetScheduledDataWorkflowOptions, type GetScheduledDataWorkflowRequest, type GetScheduledDataWorkflowResponse, type GoogleSheetsSource, type GreaterThanOperation, type Group, type GroupId, type IdentificationData, type IdentificationDataIdOneOf, type Include, type JobSpec, type JobSpecSiteOverrideOneOf, type JobsCreatedEnvelope, type JobsDeletedEnvelope, type JobsUpdatedEnvelope, type Last, type LengthOperation, type ListScheduledDataWorkflowsOptions, type ListScheduledDataWorkflowsRequest, type ListScheduledDataWorkflowsResponse, type LocalizationDestination, type LocalizationSource, type Lookup, type Max, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type Min, type ModOperation, type MultiplyOperation, type ObjectToArray, type Paging, type ProjectNested, type Projection, type Push, type RescheduleScheduledDataWorkflowOptions, type RescheduleScheduledDataWorkflowRequest, type RescheduleScheduledDataWorkflowResponse, type Reshape, type RestoreInfo, type ScheduledDataWorkflow, type ScheduledDataWorkflowSpec, type Schema, type SizeOperation, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, type SourceSourceOneOf, type Stage, type StageStageOneOf, type StoresCatalogInventoryDestination, type StoresCatalogProductsDestination, type StringifyOperation, type SubstringOperation, type SubtractOperation, type Sum, type SumOperation, type TestDestination, type TestSource, type TestTransformation, type ToLowerOperation, type ToUpperOperation, type Transformation, type TransformationTransformationOneOf, type TriggerScheduledDataWorkflowNowRequest, type TriggerScheduledDataWorkflowNowResponse, type UnionWith, type UnwindArray, type UpdateScheduledDataWorkflowOptions, type UpdateScheduledDataWorkflowRequest, type UpdateScheduledDataWorkflowResponse, type V1Field, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixDataCollectionDefinitionDestination, type WixDataCollectionDefinitionSource, type WixDataDestination, WixDataDestinationWritePolicy, type WixDataDestinationWritePolicyWithLiterals, WixDataEnvironment, type WixDataEnvironmentWithLiterals, type WixDataSource, type WixDataSourceQueryOneOf, type WixMediaDestination, WixMediaDestinationWritePolicy, type WixMediaDestinationWritePolicyWithLiterals, type WixMediaSource, WritePolicy, type WritePolicyWithLiterals, createScheduledDataWorkflow, deleteScheduledDataWorkflow, getScheduledDataWorkflow, listScheduledDataWorkflows, onJobsCreated, onJobsDeleted, onJobsUpdated, rescheduleScheduledDataWorkflow, triggerScheduledDataWorkflowNow, updateScheduledDataWorkflow };

package/build/es/index.typings.mjs

@@ -544,6 +544,13 @@ var WritePolicy = /* @__PURE__ */ ((WritePolicy2) => {
   WritePolicy2["OVERWRITE"] = "OVERWRITE";
   return WritePolicy2;
 })(WritePolicy || {});
+var DateFormat = /* @__PURE__ */ ((DateFormat2) => {
+  DateFormat2["BEST_EFFORT"] = "BEST_EFFORT";
+  DateFormat2["ISO_8601"] = "ISO_8601";
+  DateFormat2["MM_DD_YYYY_HH_MM"] = "MM_DD_YYYY_HH_MM";
+  DateFormat2["DD_MM_YYYY_HH_MM"] = "DD_MM_YYYY_HH_MM";
+  return DateFormat2;
+})(DateFormat || {});
 var Fields = /* @__PURE__ */ ((Fields2) => {
   Fields2["NEXT_SCHEDULE_EXECUTION"] = "NEXT_SCHEDULE_EXECUTION";
   return Fields2;
@@ -752,6 +759,7 @@ async function listScheduledDataWorkflows2(options) {
   }
 }
 export {
+  DateFormat,
   FieldType,
   Fields,
   FileFormat,