@wix/auto_sdk_automations_automations-v-2 1.0.9 → 1.0.10

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { Automation, UpdateAutomation, BulkDeleteAutomationsResponse, GeneratePreinstalledAutomationOptions, GeneratePreinstalledAutomationResponse, AutomationsQueryBuilder, GetAggregatedUsageInfoOptions, GetAggregatedUsageInfoResponse, CopyAutomationOptions, CopyAutomationResponse, CreateDraftAutomationOptions, CreateDraftAutomationResponse, GetOrCreateDraftAutomationResponse, UpdateDraftAutomation, UpdateDraftAutomationResponse, QueryAutomationsWithDraftsOptions, QueryAutomationsWithDraftsResponse, BulkCountAutomationsWithDraftsOptions, BulkCountAutomationsWithDraftsResponse, PublishDraftAutomationResponse, ValidateAutomationOptions, ValidateAutomationResponse, ValidateAutomationByIdOptions, ValidateAutomationByIdResponse, GetAutomationRevisionOptions, GetAutomationRevisionResponse, AutomationCreatedEnvelope, AutomationDeletedEnvelope, AutomationUpdatedEnvelope } from './index.typings.js';
-export { Action, ActionConfigurationError, ActionErrorType, ActionEvent, ActionInfoOneOf, ActionProviderQuotaInfo, ActionQuotaInfo, ActionSettings, ActionUsageSummary, ActionValidationError, ActionValidationErrorErrorOneOf, ActionValidationInfo, AdditionalInfo, AppDefinedAction, ApplicationError, ApplicationOrigin, Asset, AuditInfo, AuditInfoIdOneOf, AutomationConfiguration, AutomationConfigurationError, AutomationErrorType, AutomationMigrationRequest, AutomationOriginInfoOneOf, AutomationSettings, AutomationValidationError, AutomationValidationErrorErrorOneOf, AutomationValidationErrorValidationErrorType, AutomationsQueryResult, BaseEventMetadata, BulkActionMetadata, BulkCountAutomationsWithDraftsRequest, BulkDeleteAutomationsRequest, BulkDeleteResult, CTA, CodeConditionAction, CodeSnippet, ConditionAction, ConditionExpressionGroup, CopyAutomationRequest, CreateAutomationRequest, CreateAutomationResponse, CreateDraftAutomationRequest, CreatePreinstalledAutomationRequest, CreatePreinstalledAutomationResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DelayAction, DeleteAutomationRequest, DeleteAutomationResponse, DeleteContext, DeleteDraftAutomationRequest, DeleteDraftAutomationResponse, DeletePreinstalledAutomationRequest, DeletePreinstalledAutomationResponse, DeleteStatus, DeletedWithEntity, Domain, DomainEvent, DomainEventBodyOneOf, DraftInfo, DraftPublished, DraftsInfo, Empty, Enrichment, Enrichments, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, Filter, FilterValueSelection, FilterableAppDefinedActions, FutureDateActivationOffset, GeneratePreinstalledAutomationRequest, GetActionsQuotaInfoRequest, GetActionsQuotaInfoResponse, GetAggregatedUsageInfoRequest, GetAutomationActionSchemaRequest, GetAutomationActionSchemaResponse, GetAutomationRequest, GetAutomationResponse, GetAutomationRevisionRequest, GetOrCreateDraftAutomationRequest, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, Language, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, MigrateVeloActionAutomationsRequest, MigrateVeloActionAutomationsResponse, Namespace, NamespaceChanged, OdeditorAssigned, OdeditorUnassigned, Operator, Origin, OriginAutomationInfo, OutputAction, Path, PicassoAssigned, PicassoUnassigned, Plan, PreinstalledAutomationSpecInfo, PreinstalledOrigin, ProviderConfigurationError, PublishDraftAutomationRequest, QueryAutomationsRequest, QueryAutomationsResponse, QueryAutomationsWithDraftsRequest, QueryPreinstalledAutomationsForAppRequest, QueryPreinstalledAutomationsForAppResponse, QueryPreinstalledAutomationsRequest, QueryPreinstalledAutomationsResponse, Quota, QuotaInfo, RateLimit, RateLimitAction, RequestedFields, RestoreInfo, ServiceProvisioned, ServiceRemoved, SetVariablesAction, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, Sorting, SplitAction, State, Status, StudioAssigned, StudioUnassigned, TestUpdateApplicationAutomationRequest, TestUpdateApplicationAutomationResponse, TimeUnit, Trigger, TriggerConfigurationError, TriggerErrorType, TriggerUsageSummary, TriggerValidationError, TriggerValidationErrorErrorOneOf, TriggerValidationErrorValidationErrorType, Type, UpdateApplicationAutomationsRequest, UpdateApplicationAutomationsResponse, UpdateAutomationRequest, UpdateAutomationResponse, UpdateDraftAutomationRequest, UpdatePreinstalledAutomationRequest, UpdatePreinstalledAutomationResponse, UpdatedWithPreviousEntity, UpgradeCTA, ValidateAutomationByIdRequest, ValidateAutomationRequest, ValidationErrorSeverity, ValidationErrorType, ValidationSettings, WebhookIdentityType } from './index.typings.js';
+export { Action, ActionConfigurationError, ActionErrorType, ActionEvent, ActionInfoOneOf, ActionProviderQuotaInfo, ActionQuotaInfo, ActionSettings, ActionUsageSummary, ActionValidationError, ActionValidationErrorErrorOneOf, ActionValidationInfo, AdditionalInfo, AppDefinedAction, ApplicationError, ApplicationOrigin, Asset, AuditInfo, AuditInfoIdOneOf, AutomationConfiguration, AutomationConfigurationError, AutomationErrorType, AutomationMigrationRequest, AutomationOriginInfoOneOf, AutomationSettings, AutomationValidationError, AutomationValidationErrorErrorOneOf, AutomationValidationErrorValidationErrorType, AutomationsQueryResult, BaseEventMetadata, BulkActionMetadata, BulkCountAutomationsWithDraftsRequest, BulkDeleteAutomationsRequest, BulkDeleteResult, CTA, CodeConditionAction, CodeSnippet, ConditionAction, ConditionExpressionGroup, CopyAutomationRequest, CreateAutomationRequest, CreateAutomationResponse, CreateDraftAutomationRequest, CreatePreinstalledAutomationRequest, CreatePreinstalledAutomationResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DelayAction, DeleteAutomationRequest, DeleteAutomationResponse, DeleteContext, DeleteDraftAutomationRequest, DeleteDraftAutomationResponse, DeletePreinstalledAutomationRequest, DeletePreinstalledAutomationResponse, DeleteStatus, DeletedWithEntity, Domain, DomainEvent, DomainEventBodyOneOf, DraftInfo, DraftPublished, DraftsInfo, Empty, Enrichment, Enrichments, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, Filter, FilterValueSelection, FilterableAppDefinedActions, FutureDateActivationOffset, GeneratePreinstalledAutomationRequest, GetActionsQuotaInfoRequest, GetActionsQuotaInfoResponse, GetAggregatedUsageInfoRequest, GetAutomationActionSchemaRequest, GetAutomationActionSchemaResponse, GetAutomationRequest, GetAutomationResponse, GetAutomationRevisionRequest, GetOrCreateDraftAutomationRequest, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, Language, MergeOverridePreinstalledWithRuntimeVersionRequest, MergeOverridePreinstalledWithRuntimeVersionResponse, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, MigrateVeloActionAutomationsRequest, MigrateVeloActionAutomationsResponse, Namespace, NamespaceChanged, OdeditorAssigned, OdeditorUnassigned, Operator, Origin, OriginAutomationInfo, OutputAction, Path, PicassoAssigned, PicassoUnassigned, Plan, PreinstalledAutomationSpecInfo, PreinstalledOrigin, ProviderConfigurationError, PublishDraftAutomationRequest, QueryAutomationsRequest, QueryAutomationsResponse, QueryAutomationsWithDraftsRequest, QueryPreinstalledAutomationsForAppRequest, QueryPreinstalledAutomationsForAppResponse, QueryPreinstalledAutomationsRequest, QueryPreinstalledAutomationsResponse, Quota, QuotaInfo, RateLimit, RateLimitAction, RequestedFields, RestoreInfo, ServiceProvisioned, ServiceRemoved, SetVariablesAction, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, Sorting, SplitAction, State, Status, StudioAssigned, StudioUnassigned, TestUpdateApplicationAutomationRequest, TestUpdateApplicationAutomationResponse, TimeUnit, Trigger, TriggerConfigurationError, TriggerErrorType, TriggerUsageSummary, TriggerValidationError, TriggerValidationErrorErrorOneOf, TriggerValidationErrorValidationErrorType, Type, UpdateApplicationAutomationsRequest, UpdateApplicationAutomationsResponse, UpdateAutomationRequest, UpdateAutomationResponse, UpdateDraftAutomationRequest, UpdatePreinstalledAutomationRequest, UpdatePreinstalledAutomationResponse, UpdatedWithPreviousEntity, UpgradeCTA, ValidateAutomationByIdRequest, ValidateAutomationRequest, ValidationErrorSeverity, ValidationErrorType, ValidationSettings, WebhookIdentityType } from './index.typings.js';
 
+type AutomationNonNullablePaths = `applicationInfo.appId` | `preinstalledInfo.appId` | `createdBy.userId` | `createdBy.appId` | `updatedBy.userId` | `updatedBy.appId` | `name` | `configuration.status` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `configuration.trigger.filters` | `configuration.trigger.filters.${number}._id` | `configuration.trigger.filters.${number}.fieldKey` | `configuration.trigger.filters.${number}.filterExpression` | `configuration.trigger.scheduledEventOffset.preScheduledEventOffsetExpression` | `configuration.trigger.scheduledEventOffset.scheduledEventOffsetTimeUnit` | `configuration.trigger.rateLimit.maxActivationsExpression` | `configuration.trigger.rateLimit.durationTimeUnit` | `configuration.rootActionIds` | `origin` | `settings.hidden` | `settings.readonly` | `settings.disableDelete` | `settings.disableStatusChange` | `settings.actionSettings.permanentActionIds` | `settings.actionSettings.readonlyActionIds` | `settings.actionSettings.disableDelayAddition` | `settings.actionSettings.disableConditionAddition` | `archived`;
 declare function createAutomation$1(httpClient: HttpClient): CreateAutomationSignature;
 interface CreateAutomationSignature {
     /**
@@ -9,7 +10,7 @@ interface CreateAutomationSignature {
      * @param - Automation to create.
      * @returns Details of the created automation.
      */
-    (automation: Automation): Promise<Automation>;
+    (automation: NonNullablePaths<Automation, `configuration` | `configuration.actions` | `configuration.rootActionIds` | `configuration.status` | `configuration.trigger` | `configuration.trigger.appId` | `configuration.trigger.triggerKey` | `name` | `origin`>): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
 }
 declare function getAutomation$1(httpClient: HttpClient): GetAutomationSignature;
 interface GetAutomationSignature {
@@ -18,7 +19,7 @@ interface GetAutomationSignature {
      * @param - Automation ID.
      * @returns Retrieved automation.
      */
-    (automationId: string): Promise<Automation>;
+    (automationId: string): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
 }
 declare function updateAutomation$1(httpClient: HttpClient): UpdateAutomationSignature;
 interface UpdateAutomationSignature {
@@ -29,7 +30,7 @@ interface UpdateAutomationSignature {
      * @param - Automation ID.
      * @returns Updated automation.
      */
-    (_id: string, automation: UpdateAutomation): Promise<Automation>;
+    (_id: string, automation: NonNullablePaths<UpdateAutomation, `revision`>): Promise<NonNullablePaths<Automation, AutomationNonNullablePaths>>;
 }
 declare function deleteAutomation$1(httpClient: HttpClient): DeleteAutomationSignature;
 interface DeleteAutomationSignature {
@@ -45,7 +46,7 @@ interface BulkDeleteAutomationsSignature {
      * Deletes one or more automations.
      * @param - IDs of the automations to delete.
      */
-    (automationIds: string[]): Promise<BulkDeleteAutomationsResponse>;
+    (automationIds: string[]): Promise<NonNullablePaths<BulkDeleteAutomationsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 }
 declare function generatePreinstalledAutomation$1(httpClient: HttpClient): GeneratePreinstalledAutomationSignature;
 interface GeneratePreinstalledAutomationSignature {
@@ -57,7 +58,9 @@ interface GeneratePreinstalledAutomationSignature {
      * > **Note**: You must have an account permission to edit an app.
      * @param - Automation.
      */
-    (automation: Automation, options?: GeneratePreinstalledAutomationOptions | undefined): Promise<GeneratePreinstalledAutomationResponse>;
+    (automation: Automation, options?: GeneratePreinstalledAutomationOptions): Promise<NonNullablePaths<GeneratePreinstalledAutomationResponse, {
+        [P in AutomationNonNullablePaths]: `automation.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare function queryAutomations$1(httpClient: HttpClient): QueryAutomationsSignature;
 interface QueryAutomationsSignature {
@@ -75,7 +78,7 @@ interface GetAggregatedUsageInfoSignature {
     /**
      * Get aggregated info
      */
-    (options?: GetAggregatedUsageInfoOptions | undefined): Promise<GetAggregatedUsageInfoResponse>;
+    (options?: GetAggregatedUsageInfoOptions): Promise<NonNullablePaths<GetAggregatedUsageInfoResponse, `triggersUsageSummary` | `triggersUsageSummary.${number}.appId` | `triggersUsageSummary.${number}.triggerKey` | `triggersUsageSummary.${number}.automationsCount` | `actionsUsageSummary` | `actionsUsageSummary.${number}.appId` | `actionsUsageSummary.${number}.actionKey` | `actionsUsageSummary.${number}.automationsCount`>>;
 }
 declare function copyAutomation$1(httpClient: HttpClient): CopyAutomationSignature;
 interface CopyAutomationSignature {
@@ -86,14 +89,18 @@ interface CopyAutomationSignature {
      * such as clicking the **Save** button.
      * @param - ID of the automation to copy.
      */
-    (automationId: string, options?: CopyAutomationOptions | undefined): Promise<CopyAutomationResponse>;
+    (automationId: string, options?: CopyAutomationOptions): Promise<NonNullablePaths<CopyAutomationResponse, {
+        [P in AutomationNonNullablePaths]: `automation.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare function createDraftAutomation$1(httpClient: HttpClient): CreateDraftAutomationSignature;
 interface CreateDraftAutomationSignature {
     /**
      * Creates a draft automation.
      */
-    (options?: CreateDraftAutomationOptions | undefined): Promise<CreateDraftAutomationResponse>;
+    (options?: CreateDraftAutomationOptions): Promise<NonNullablePaths<CreateDraftAutomationResponse, {
+        [P in AutomationNonNullablePaths]: `automation.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare function getOrCreateDraftAutomation$1(httpClient: HttpClient): GetOrCreateDraftAutomationSignature;
 interface GetOrCreateDraftAutomationSignature {
@@ -103,7 +110,9 @@ interface GetOrCreateDraftAutomationSignature {
      * > **Note**: If the specified automation is a draft, the method returns it.
      * @param - ID of the original automation on which the draft is based.
      */
-    (originalAutomationId: string): Promise<GetOrCreateDraftAutomationResponse>;
+    (originalAutomationId: string): Promise<NonNullablePaths<GetOrCreateDraftAutomationResponse, {
+        [P in AutomationNonNullablePaths]: `automation.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare function updateDraftAutomation$1(httpClient: HttpClient): UpdateDraftAutomationSignature;
 interface UpdateDraftAutomationSignature {
@@ -111,7 +120,9 @@ interface UpdateDraftAutomationSignature {
      * Updates a draft automation.
      * @param - Automation ID.
      */
-    (_id: string, automation: UpdateDraftAutomation): Promise<UpdateDraftAutomationResponse>;
+    (_id: string, automation: UpdateDraftAutomation): Promise<NonNullablePaths<UpdateDraftAutomationResponse, {
+        [P in AutomationNonNullablePaths]: `automation.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare function queryAutomationsWithDrafts$1(httpClient: HttpClient): QueryAutomationsWithDraftsSignature;
 interface QueryAutomationsWithDraftsSignature {
@@ -130,12 +141,14 @@ interface QueryAutomationsWithDraftsSignature {
      * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
      * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
      */
-    (options?: QueryAutomationsWithDraftsOptions | undefined): Promise<QueryAutomationsWithDraftsResponse>;
+    (options?: QueryAutomationsWithDraftsOptions): Promise<NonNullablePaths<QueryAutomationsWithDraftsResponse, {
+        [P in AutomationNonNullablePaths]: `automations.${number}.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare function bulkCountAutomationsWithDrafts$1(httpClient: HttpClient): BulkCountAutomationsWithDraftsSignature;
 interface BulkCountAutomationsWithDraftsSignature {
     /** */
-    (options?: BulkCountAutomationsWithDraftsOptions | undefined): Promise<BulkCountAutomationsWithDraftsResponse>;
+    (options?: BulkCountAutomationsWithDraftsOptions): Promise<NonNullablePaths<BulkCountAutomationsWithDraftsResponse, `counts`>>;
 }
 declare function deleteDraftAutomation$1(httpClient: HttpClient): DeleteDraftAutomationSignature;
 interface DeleteDraftAutomationSignature {
@@ -151,7 +164,9 @@ interface PublishDraftAutomationSignature {
      * Publishes a draft automation. This applies any changes to the live automation.
      * @param - ID of the draft automation to publish.
      */
-    (automationId: string): Promise<PublishDraftAutomationResponse>;
+    (automationId: string): Promise<NonNullablePaths<PublishDraftAutomationResponse, {
+        [P in AutomationNonNullablePaths]: `automation.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare function validateAutomation$1(httpClient: HttpClient): ValidateAutomationSignature;
 interface ValidateAutomationSignature {
@@ -159,7 +174,7 @@ interface ValidateAutomationSignature {
      * Validates the specified automation.
      * @param - Automation to validate.
      */
-    (automation: Automation, options?: ValidateAutomationOptions | undefined): Promise<ValidateAutomationResponse>;
+    (automation: Automation, options?: ValidateAutomationOptions): Promise<NonNullablePaths<ValidateAutomationResponse, `valid` | `triggerValidationErrors` | `triggerValidationErrors.${number}.configurationError.errorType` | `triggerValidationErrors.${number}.providerConfigurationError.message` | `triggerValidationErrors.${number}.providerConfigurationError.title` | `triggerValidationErrors.${number}.errorType` | `triggerValidationErrors.${number}.severity` | `actionValidationInfo` | `actionValidationInfo.${number}.appId` | `actionValidationInfo.${number}.actionKey` | `automationValidationErrors` | `automationValidationErrors.${number}.configurationError.errorType` | `automationValidationErrors.${number}.providerConfigurationError.message` | `automationValidationErrors.${number}.providerConfigurationError.title` | `automationValidationErrors.${number}.errorType` | `automationValidationErrors.${number}.severity`>>;
 }
 declare function validateAutomationById$1(httpClient: HttpClient): ValidateAutomationByIdSignature;
 interface ValidateAutomationByIdSignature {
@@ -167,7 +182,7 @@ interface ValidateAutomationByIdSignature {
      * Validates the automation specified by ID.
      * @param - Automation ID.
      */
-    (automationId: string, options?: ValidateAutomationByIdOptions | undefined): Promise<ValidateAutomationByIdResponse>;
+    (automationId: string, options?: ValidateAutomationByIdOptions): Promise<NonNullablePaths<ValidateAutomationByIdResponse, `valid` | `triggerValidationErrors` | `triggerValidationErrors.${number}.configurationError.errorType` | `triggerValidationErrors.${number}.providerConfigurationError.message` | `triggerValidationErrors.${number}.providerConfigurationError.title` | `triggerValidationErrors.${number}.errorType` | `triggerValidationErrors.${number}.severity` | `actionValidationInfo` | `actionValidationInfo.${number}.appId` | `actionValidationInfo.${number}.actionKey` | `automationValidationErrors` | `automationValidationErrors.${number}.configurationError.errorType` | `automationValidationErrors.${number}.providerConfigurationError.message` | `automationValidationErrors.${number}.providerConfigurationError.title` | `automationValidationErrors.${number}.errorType` | `automationValidationErrors.${number}.severity`>>;
 }
 declare function getAutomationRevision$1(httpClient: HttpClient): GetAutomationRevisionSignature;
 interface GetAutomationRevisionSignature {
@@ -175,7 +190,9 @@ interface GetAutomationRevisionSignature {
      * Gets the specified automation revision.
      * @param - Automation ID.
      */
-    (automationId: string, options?: GetAutomationRevisionOptions | undefined): Promise<GetAutomationRevisionResponse>;
+    (automationId: string, options?: GetAutomationRevisionOptions): Promise<NonNullablePaths<GetAutomationRevisionResponse, {
+        [P in AutomationNonNullablePaths]: `automation.${P}`;
+    }[AutomationNonNullablePaths]>>;
 }
 declare const onAutomationCreated$1: EventDefinition<AutomationCreatedEnvelope, "wix.automations.v2.automation_created">;
 declare const onAutomationDeleted$1: EventDefinition<AutomationDeletedEnvelope, "wix.automations.v2.automation_deleted">;