@wix/auto_sdk_data_scheduled-workflows 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,98 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { ScheduledDataWorkflow, CreateScheduledDataWorkflowOptions, RescheduleScheduledDataWorkflowOptions, RescheduleScheduledDataWorkflowResponse, UpdateScheduledDataWorkflowOptions, GetScheduledDataWorkflowOptions, ListScheduledDataWorkflowsOptions, ListScheduledDataWorkflowsResponse, JobsCreatedEnvelope, JobsDeletedEnvelope, JobsUpdatedEnvelope } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, BaseEventMetadata, CreateScheduledDataWorkflowRequest, CreateScheduledDataWorkflowResponse, CursorPaging, CursorPagingMetadata, Cursors, DataMovementJobLogs, DeleteScheduledDataWorkflowRequest, DeleteScheduledDataWorkflowResponse, Destination, DestinationDestinationOneOf, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExternalFileSource, Field, FieldType, FieldTypeWithLiterals, Fields, FieldsWithLiterals, FileDestination, FileFormat, FileFormatWithLiterals, FileSource, GetScheduledDataWorkflowRequest, GetScheduledDataWorkflowResponse, GoogleSheetsSource, IdentificationData, IdentificationDataIdOneOf, JobSpec, JobSpecSiteOverrideOneOf, ListScheduledDataWorkflowsRequest, LocalizationDestination, LocalizationSource, MediaType, MediaTypeWithLiterals, MessageEnvelope, RescheduleScheduledDataWorkflowRequest, RestoreInfo, ScheduledDataWorkflowSpec, Schema, Source, SourceSourceOneOf, StoresCatalogInventoryDestination, StoresCatalogProductsDestination, TestDestination, TestSource, TestTransformation, Transformation, TransformationTransformationOneOf, TriggerScheduledDataWorkflowNowRequest, TriggerScheduledDataWorkflowNowResponse, UpdateScheduledDataWorkflowRequest, UpdateScheduledDataWorkflowResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixDataCollectionDefinitionDestination, WixDataCollectionDefinitionSource, WixDataDestination, WixDataDestinationWritePolicy, WixDataDestinationWritePolicyWithLiterals, WixDataEnvironment, WixDataEnvironmentWithLiterals, WixDataSource, WixMediaDestination, WixMediaDestinationWritePolicy, WixMediaDestinationWritePolicyWithLiterals, WixMediaSource, WritePolicy, WritePolicyWithLiterals } from './index.typings.js';
+
+declare function createScheduledDataWorkflow$1(httpClient: HttpClient): CreateScheduledDataWorkflowSignature;
+interface CreateScheduledDataWorkflowSignature {
+    /**
+     * Creates a scheduled data workflow with a cron schedule.
+     *
+     * The scheduled data workflow automatically runs according to the specified cron expression.
+     * 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 - Scheduled data movement workflow to create.
+     * @returns Created scheduled data movement workflow.
+     */
+    (scheduledDataWorkflow: NonNullablePaths<ScheduledDataWorkflow, `_id` | `workflow` | `workflow.steps`, 3>, options?: CreateScheduledDataWorkflowOptions): Promise<NonNullablePaths<ScheduledDataWorkflow, `_id` | `name` | `enabled` | `cronExpression` | `workflow.steps` | `workflow.steps.${number}.sourceSiteId` | `workflow.steps.${number}.destinationSiteId` | `workflow.steps.${number}.source.wixDataCollection.collectionId` | `workflow.steps.${number}.source.file.format` | `workflow.steps.${number}.source.file.fileId` | `workflow.steps.${number}.source.file.url` | `workflow.steps.${number}.destination.wixDataCollection.collectionId` | `workflow.steps.${number}.destination.wixDataCollection.writePolicy` | `workflow.steps.${number}.destination.file.format` | `workflow.steps.${number}.destination.file.url` | `lastWorkflowId`, 7>>;
+}
+declare function rescheduleScheduledDataWorkflow$1(httpClient: HttpClient): RescheduleScheduledDataWorkflowSignature;
+interface RescheduleScheduledDataWorkflowSignature {
+    /**
+     * Reinitializes a scheduled data workflow based on the current cron expression.
+     *
+     * This is needed in case an [updated](https://dev.wix.com/docs/api-reference/business-solutions/cms/operations/data-sync-jobs/update-data-sync-job) scheduled data workflow gets out of sync.
+     * For example, if you update the cron expression, it may not initially run according to the new expression.
+     * This reschedules it to run according to the new expression.
+     *
+     * Only applies to `enabled` scheduled data workflows.
+     * @param - ID of the scheduled data movement workflow to reschedule.
+     */
+    (scheduledDataWorkflowId: string, options?: RescheduleScheduledDataWorkflowOptions): Promise<RescheduleScheduledDataWorkflowResponse>;
+}
+declare function triggerScheduledDataWorkflowNow$1(httpClient: HttpClient): TriggerScheduledDataWorkflowNowSignature;
+interface TriggerScheduledDataWorkflowNowSignature {
+    /**
+     * Enqueues an immediate execution for a scheduled data workflow.
+     *
+     * This custom action doesn't change the cron schedule.
+     * It triggers the same data workflow execution path used by scheduled
+     * TimeCapsule runs.
+     * @param - ID of the scheduled data movement workflow to run immediately.
+     */
+    (scheduledDataWorkflowId: string): Promise<void>;
+}
+declare function updateScheduledDataWorkflow$1(httpClient: HttpClient): UpdateScheduledDataWorkflowSignature;
+interface UpdateScheduledDataWorkflowSignature {
+    /**
+     * Updates an existing scheduled data workflow.
+     * @param - Scheduled data movement workflow information to update.
+     * @returns Updated scheduled data movement workflow.
+     */
+    (scheduledDataWorkflow: NonNullablePaths<ScheduledDataWorkflow, `workflow` | `workflow.steps`, 3>, options?: UpdateScheduledDataWorkflowOptions): Promise<NonNullablePaths<ScheduledDataWorkflow, `_id` | `name` | `enabled` | `cronExpression` | `workflow.steps` | `workflow.steps.${number}.sourceSiteId` | `workflow.steps.${number}.destinationSiteId` | `workflow.steps.${number}.source.wixDataCollection.collectionId` | `workflow.steps.${number}.source.file.format` | `workflow.steps.${number}.source.file.fileId` | `workflow.steps.${number}.source.file.url` | `workflow.steps.${number}.destination.wixDataCollection.collectionId` | `workflow.steps.${number}.destination.wixDataCollection.writePolicy` | `workflow.steps.${number}.destination.file.format` | `workflow.steps.${number}.destination.file.url` | `lastWorkflowId`, 7>>;
+}
+declare function deleteScheduledDataWorkflow$1(httpClient: HttpClient): DeleteScheduledDataWorkflowSignature;
+interface DeleteScheduledDataWorkflowSignature {
+    /**
+     * Deletes a scheduled data workflow.
+     *
+     * This permanently removes the schedule and prevents future executions. Any currently running data workflows triggered by the schedule continue to completion.
+     * @param - ID of the scheduled data movement workflow to delete.
+     */
+    (scheduledDataWorkflowId: string): Promise<void>;
+}
+declare function getScheduledDataWorkflow$1(httpClient: HttpClient): GetScheduledDataWorkflowSignature;
+interface GetScheduledDataWorkflowSignature {
+    /**
+     * Retrieves a scheduled data workflow by ID.
+     * @param - ID of the scheduled data movement workflow to retrieve.
+     * @returns Retrieved scheduled data movement workflow.
+     */
+    (scheduledDataWorkflowId: string, options?: GetScheduledDataWorkflowOptions): Promise<NonNullablePaths<ScheduledDataWorkflow, `_id` | `name` | `enabled` | `cronExpression` | `workflow.steps` | `workflow.steps.${number}.sourceSiteId` | `workflow.steps.${number}.destinationSiteId` | `workflow.steps.${number}.source.wixDataCollection.collectionId` | `workflow.steps.${number}.source.file.format` | `workflow.steps.${number}.source.file.fileId` | `workflow.steps.${number}.source.file.url` | `workflow.steps.${number}.destination.wixDataCollection.collectionId` | `workflow.steps.${number}.destination.wixDataCollection.writePolicy` | `workflow.steps.${number}.destination.file.format` | `workflow.steps.${number}.destination.file.url` | `lastWorkflowId`, 7>>;
+}
+declare function listScheduledDataWorkflows$1(httpClient: HttpClient): ListScheduledDataWorkflowsSignature;
+interface ListScheduledDataWorkflowsSignature {
+    /**
+     * Retrieves all scheduled data workflows for the current site.
+     *
+     * 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.
+     */
+    (options?: ListScheduledDataWorkflowsOptions): Promise<NonNullablePaths<ListScheduledDataWorkflowsResponse, `scheduledDataWorkflows` | `scheduledDataWorkflows.${number}._id` | `scheduledDataWorkflows.${number}.name` | `scheduledDataWorkflows.${number}.enabled` | `scheduledDataWorkflows.${number}.cronExpression` | `scheduledDataWorkflows.${number}.lastWorkflowId`, 4>>;
+}
+declare const onJobsCreated$1: EventDefinition<JobsCreatedEnvelope, "wix.data.sync.v1.jobs_created">;
+declare const onJobsDeleted$1: EventDefinition<JobsDeletedEnvelope, "wix.data.sync.v1.jobs_deleted">;
+declare const onJobsUpdated$1: EventDefinition<JobsUpdatedEnvelope, "wix.data.sync.v1.jobs_updated">;
+
+declare const createScheduledDataWorkflow: MaybeContext<BuildRESTFunction<typeof createScheduledDataWorkflow$1> & typeof createScheduledDataWorkflow$1>;
+declare const rescheduleScheduledDataWorkflow: MaybeContext<BuildRESTFunction<typeof rescheduleScheduledDataWorkflow$1> & typeof rescheduleScheduledDataWorkflow$1>;
+declare const triggerScheduledDataWorkflowNow: MaybeContext<BuildRESTFunction<typeof triggerScheduledDataWorkflowNow$1> & typeof triggerScheduledDataWorkflowNow$1>;
+declare const updateScheduledDataWorkflow: MaybeContext<BuildRESTFunction<typeof updateScheduledDataWorkflow$1> & typeof updateScheduledDataWorkflow$1>;
+declare const deleteScheduledDataWorkflow: MaybeContext<BuildRESTFunction<typeof deleteScheduledDataWorkflow$1> & typeof deleteScheduledDataWorkflow$1>;
+declare const getScheduledDataWorkflow: MaybeContext<BuildRESTFunction<typeof getScheduledDataWorkflow$1> & typeof getScheduledDataWorkflow$1>;
+declare const listScheduledDataWorkflows: MaybeContext<BuildRESTFunction<typeof listScheduledDataWorkflows$1> & typeof listScheduledDataWorkflows$1>;
+/** */
+declare const onJobsCreated: BuildEventDefinition<typeof onJobsCreated$1> & typeof onJobsCreated$1;
+/** */
+declare const onJobsDeleted: BuildEventDefinition<typeof onJobsDeleted$1> & typeof onJobsDeleted$1;
+/** */
+declare const onJobsUpdated: BuildEventDefinition<typeof onJobsUpdated$1> & typeof onJobsUpdated$1;
+
+export { CreateScheduledDataWorkflowOptions, GetScheduledDataWorkflowOptions, JobsCreatedEnvelope, JobsDeletedEnvelope, JobsUpdatedEnvelope, ListScheduledDataWorkflowsOptions, ListScheduledDataWorkflowsResponse, RescheduleScheduledDataWorkflowOptions, RescheduleScheduledDataWorkflowResponse, ScheduledDataWorkflow, UpdateScheduledDataWorkflowOptions, createScheduledDataWorkflow, deleteScheduledDataWorkflow, getScheduledDataWorkflow, listScheduledDataWorkflows, onJobsCreated, onJobsDeleted, onJobsUpdated, rescheduleScheduledDataWorkflow, triggerScheduledDataWorkflowNow, updateScheduledDataWorkflow };