@wix/auto_sdk_automations_automations-v-2 1.0.45 → 1.0.47
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.
- package/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +27 -9
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1102 -8
- package/build/cjs/meta.js +238 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +2 -2
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +27 -9
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1102 -8
- package/build/es/meta.mjs +215 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +2 -2
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +27 -9
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +1102 -8
- package/build/internal/cjs/meta.js +238 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +2 -2
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +27 -9
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +1102 -8
- package/build/internal/es/meta.mjs +215 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -79,6 +79,8 @@ interface AutomationOriginInfoOneOf {
|
|
|
79
79
|
/** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
|
|
80
80
|
preinstalledInfo?: PreinstalledOrigin;
|
|
81
81
|
}
|
|
82
|
+
interface AIMetadata {
|
|
83
|
+
}
|
|
82
84
|
interface ActionSettings {
|
|
83
85
|
/**
|
|
84
86
|
* Permanent actions. PermanentAction's skipActionExpression cannot be modified.
|
|
@@ -109,6 +111,23 @@ interface ActionSettings {
|
|
|
109
111
|
*/
|
|
110
112
|
disableConditionAddition?: boolean;
|
|
111
113
|
}
|
|
114
|
+
declare enum Domain {
|
|
115
|
+
/** User domain (default). */
|
|
116
|
+
USER = "USER",
|
|
117
|
+
/** Wix domain. */
|
|
118
|
+
WIX = "WIX",
|
|
119
|
+
/** Wix account-level domain. */
|
|
120
|
+
WIX_ACCOUNT = "WIX_ACCOUNT"
|
|
121
|
+
}
|
|
122
|
+
/** @enumType */
|
|
123
|
+
type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
|
|
124
|
+
interface Enrichment {
|
|
125
|
+
/**
|
|
126
|
+
* Enrichment input mappings.
|
|
127
|
+
* @maxSize 2
|
|
128
|
+
*/
|
|
129
|
+
inputMappings?: Record<string, any>[] | null;
|
|
130
|
+
}
|
|
112
131
|
interface AuditInfo extends AuditInfoIdOneOf {
|
|
113
132
|
/**
|
|
114
133
|
* [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
|
|
@@ -151,7 +170,7 @@ interface AutomationConfiguration {
|
|
|
151
170
|
* @format GUID
|
|
152
171
|
*/
|
|
153
172
|
rootActionIds?: string[];
|
|
154
|
-
/** Actions the automation can execute, as key:value pairs. For the key, specify the action ID. The value must be an object structured as described below. */
|
|
173
|
+
/** Actions the automation can execute, as `key:value` pairs. For the key, specify the action ID. The value must be an object structured as described below. */
|
|
155
174
|
actions?: Record<string, Action>;
|
|
156
175
|
}
|
|
157
176
|
declare enum TimeUnit {
|
|
@@ -224,6 +243,14 @@ interface RateLimit {
|
|
|
224
243
|
*/
|
|
225
244
|
uniqueIdentifierExpression?: string | null;
|
|
226
245
|
}
|
|
246
|
+
interface FilterValueSelection {
|
|
247
|
+
/**
|
|
248
|
+
* Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
|
|
249
|
+
* @maxLength 80
|
|
250
|
+
* @maxSize 50
|
|
251
|
+
*/
|
|
252
|
+
selectedFilterValues?: string[];
|
|
253
|
+
}
|
|
227
254
|
interface ConditionExpressionGroup {
|
|
228
255
|
/** Logical operator used to evaluate the condition expressions. */
|
|
229
256
|
operator?: OperatorWithLiterals;
|
|
@@ -257,11 +284,30 @@ interface CodeSnippet {
|
|
|
257
284
|
declare enum Language {
|
|
258
285
|
/** Unknown. */
|
|
259
286
|
UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
|
|
260
|
-
/**
|
|
287
|
+
/** JavaScript. */
|
|
261
288
|
JAVASCRIPT = "JAVASCRIPT"
|
|
262
289
|
}
|
|
263
290
|
/** @enumType */
|
|
264
291
|
type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
|
|
292
|
+
/** Path definition */
|
|
293
|
+
interface Path {
|
|
294
|
+
/**
|
|
295
|
+
* Unique path ID.
|
|
296
|
+
* @format GUID
|
|
297
|
+
*/
|
|
298
|
+
id?: string;
|
|
299
|
+
/**
|
|
300
|
+
* Path display name.
|
|
301
|
+
* @minLength 1
|
|
302
|
+
* @maxLength 100
|
|
303
|
+
*/
|
|
304
|
+
name?: string;
|
|
305
|
+
/**
|
|
306
|
+
* ID of the action to run when this path is taken.
|
|
307
|
+
* @format GUID
|
|
308
|
+
*/
|
|
309
|
+
postActionId?: string | null;
|
|
310
|
+
}
|
|
265
311
|
declare enum Type {
|
|
266
312
|
/** Based on the trigger. */
|
|
267
313
|
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
@@ -288,7 +334,11 @@ interface AppDefinedAction {
|
|
|
288
334
|
* @maxLength 100
|
|
289
335
|
*/
|
|
290
336
|
actionKey?: string;
|
|
291
|
-
/**
|
|
337
|
+
/**
|
|
338
|
+
* Action input mapping as defined in the action's [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/the-action-input-schema).
|
|
339
|
+
*
|
|
340
|
+
* The input mapping must include all parameters specified in the action's input schema's `required` array, and can include any other parameters from the schema.
|
|
341
|
+
*/
|
|
292
342
|
inputMapping?: Record<string, any> | null;
|
|
293
343
|
/**
|
|
294
344
|
* Action skip conditions. An action is skipped if any of the specified conditions evaluates to `true`.
|
|
@@ -351,7 +401,7 @@ interface DelayAction {
|
|
|
351
401
|
/**
|
|
352
402
|
* Time to wait before running the action. The wait time starts from when the current action completes.
|
|
353
403
|
*
|
|
354
|
-
* > **Note**: To define the wait time from a specific moment in time, use `
|
|
404
|
+
* > **Note**: To define the wait time from a specific moment in time, use `dueDateExpression`.
|
|
355
405
|
* @maxLength 1000
|
|
356
406
|
*/
|
|
357
407
|
offsetExpression?: string | null;
|
|
@@ -370,8 +420,7 @@ interface DelayAction {
|
|
|
370
420
|
*/
|
|
371
421
|
dueDateEpochExpression?: string | null;
|
|
372
422
|
/**
|
|
373
|
-
* Action run date as a timestamp
|
|
374
|
-
* The expression will be converted to JSONata and should evaluate to a timestamp/datetime format.
|
|
423
|
+
* Action run date as a timestamp or DateTime expression using bracket notation.
|
|
375
424
|
*
|
|
376
425
|
* > **Note**: If an `offsetExpression` is defined, the delay is calculated from the time of the offset.
|
|
377
426
|
* @maxLength 1000
|
|
@@ -412,6 +461,34 @@ interface RateLimitAction {
|
|
|
412
461
|
*/
|
|
413
462
|
postActionIds?: string[];
|
|
414
463
|
}
|
|
464
|
+
interface SetVariablesAction {
|
|
465
|
+
/** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
|
|
466
|
+
outputMapping?: Record<string, any> | null;
|
|
467
|
+
/**
|
|
468
|
+
* Output JSON schema representation.
|
|
469
|
+
*
|
|
470
|
+
* > **Note**: To minimize request size, you can also specify a string.
|
|
471
|
+
*/
|
|
472
|
+
outputSchema?: Record<string, any> | null;
|
|
473
|
+
/**
|
|
474
|
+
* IDs of actions to run in parallel after variable initialization.
|
|
475
|
+
* @maxSize 1
|
|
476
|
+
* @format GUID
|
|
477
|
+
*/
|
|
478
|
+
postActionIds?: string[];
|
|
479
|
+
}
|
|
480
|
+
interface OutputAction {
|
|
481
|
+
/** Output action output mapping. */
|
|
482
|
+
outputMapping?: Record<string, any> | null;
|
|
483
|
+
}
|
|
484
|
+
interface SplitAction {
|
|
485
|
+
/**
|
|
486
|
+
* List of paths to split execution into.
|
|
487
|
+
* @minSize 2
|
|
488
|
+
* @maxSize 10
|
|
489
|
+
*/
|
|
490
|
+
paths?: Path[];
|
|
491
|
+
}
|
|
415
492
|
declare enum Status {
|
|
416
493
|
/** Unknown. */
|
|
417
494
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
@@ -468,6 +545,8 @@ interface Action extends ActionInfoOneOf {
|
|
|
468
545
|
/**
|
|
469
546
|
* Action ID.
|
|
470
547
|
*
|
|
548
|
+
* Unique identifier for the action instance in the current automation. Use this to refer to this action in the automation flow.
|
|
549
|
+
*
|
|
471
550
|
* If not specified, automatically generated by Wix.
|
|
472
551
|
* @format GUID
|
|
473
552
|
*/
|
|
@@ -483,7 +562,7 @@ interface Action extends ActionInfoOneOf {
|
|
|
483
562
|
*/
|
|
484
563
|
namespace?: string | null;
|
|
485
564
|
/**
|
|
486
|
-
*
|
|
565
|
+
* Evaluated to boolean to decide whether the action is skipped.
|
|
487
566
|
* For ConditionAction: if skipped, true_post_action_ids execute; false_post_action_ids are skipped
|
|
488
567
|
* SplitAction and OutputAction do not support skip_action_expression
|
|
489
568
|
* @maxLength 1000
|
|
@@ -503,6 +582,16 @@ interface ActionInfoOneOf {
|
|
|
503
582
|
/** Details of the action when its `type` is `RATE_LIMIT`. */
|
|
504
583
|
rateLimitInfo?: RateLimitAction;
|
|
505
584
|
}
|
|
585
|
+
interface FilterableAppDefinedActions {
|
|
586
|
+
/**
|
|
587
|
+
* App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
|
|
588
|
+
* @minSize 1
|
|
589
|
+
* @maxSize 100
|
|
590
|
+
* @minLength 1
|
|
591
|
+
* @maxLength 150
|
|
592
|
+
*/
|
|
593
|
+
actionIdentifiers?: string[];
|
|
594
|
+
}
|
|
506
595
|
declare enum Origin {
|
|
507
596
|
/** Default value. */
|
|
508
597
|
UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
|
|
@@ -581,6 +670,21 @@ interface DraftInfo {
|
|
|
581
670
|
*/
|
|
582
671
|
originalAutomationId?: string | null;
|
|
583
672
|
}
|
|
673
|
+
interface Enrichments {
|
|
674
|
+
/** Whether the studio site enrichment is wanted. */
|
|
675
|
+
studioSite?: Enrichment;
|
|
676
|
+
}
|
|
677
|
+
interface ExtendedFields {
|
|
678
|
+
/**
|
|
679
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
680
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
681
|
+
*
|
|
682
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
683
|
+
*
|
|
684
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
685
|
+
*/
|
|
686
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
687
|
+
}
|
|
584
688
|
interface AutoArchivePolicy {
|
|
585
689
|
/**
|
|
586
690
|
* Date when to archive the automation
|
|
@@ -590,6 +694,177 @@ interface AutoArchivePolicy {
|
|
|
590
694
|
*/
|
|
591
695
|
archiveDate?: Date | null;
|
|
592
696
|
}
|
|
697
|
+
interface Notes {
|
|
698
|
+
}
|
|
699
|
+
interface Note {
|
|
700
|
+
}
|
|
701
|
+
interface Position {
|
|
702
|
+
}
|
|
703
|
+
interface Offset {
|
|
704
|
+
}
|
|
705
|
+
interface Dimensions {
|
|
706
|
+
}
|
|
707
|
+
interface UpdatedWithPreviousEntity {
|
|
708
|
+
/** Previous automation. */
|
|
709
|
+
previousAutomation?: Automation;
|
|
710
|
+
/** Updated automation. */
|
|
711
|
+
currentAutomation?: Automation;
|
|
712
|
+
}
|
|
713
|
+
interface DeletedWithEntity {
|
|
714
|
+
/** Deleted automation. */
|
|
715
|
+
automation?: Automation;
|
|
716
|
+
}
|
|
717
|
+
interface DraftPublished {
|
|
718
|
+
/**
|
|
719
|
+
* ID of the draft automation.
|
|
720
|
+
* @format GUID
|
|
721
|
+
*/
|
|
722
|
+
draftAutomationId?: string;
|
|
723
|
+
/**
|
|
724
|
+
* Original automation on which the draft is based.
|
|
725
|
+
*
|
|
726
|
+
* > **Note**: If the draft is not based on an existing automation, the draft itself is the original automation.
|
|
727
|
+
*/
|
|
728
|
+
draftOriginalAutomation?: Automation;
|
|
729
|
+
/** Updated, published automation. */
|
|
730
|
+
updatedAutomation?: Automation;
|
|
731
|
+
}
|
|
732
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
733
|
+
createdEvent?: EntityCreatedEvent;
|
|
734
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
735
|
+
deletedEvent?: EntityDeletedEvent;
|
|
736
|
+
actionEvent?: ActionEvent;
|
|
737
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
738
|
+
id?: string;
|
|
739
|
+
/**
|
|
740
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
741
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
742
|
+
*/
|
|
743
|
+
entityFqdn?: string;
|
|
744
|
+
/**
|
|
745
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
746
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
747
|
+
*/
|
|
748
|
+
slug?: string;
|
|
749
|
+
/** ID of the entity associated with the event. */
|
|
750
|
+
entityId?: string;
|
|
751
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
752
|
+
eventTime?: Date | null;
|
|
753
|
+
/**
|
|
754
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
755
|
+
* (for example, GDPR).
|
|
756
|
+
*/
|
|
757
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
758
|
+
/** If present, indicates the action that triggered the event. */
|
|
759
|
+
originatedFrom?: string | null;
|
|
760
|
+
/**
|
|
761
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
762
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
763
|
+
*/
|
|
764
|
+
entityEventSequence?: string | null;
|
|
765
|
+
}
|
|
766
|
+
/** @oneof */
|
|
767
|
+
interface DomainEventBodyOneOf {
|
|
768
|
+
createdEvent?: EntityCreatedEvent;
|
|
769
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
770
|
+
deletedEvent?: EntityDeletedEvent;
|
|
771
|
+
actionEvent?: ActionEvent;
|
|
772
|
+
}
|
|
773
|
+
interface EntityCreatedEvent {
|
|
774
|
+
entityAsJson?: string;
|
|
775
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
776
|
+
restoreInfo?: RestoreInfo;
|
|
777
|
+
}
|
|
778
|
+
interface RestoreInfo {
|
|
779
|
+
deletedDate?: Date | null;
|
|
780
|
+
}
|
|
781
|
+
interface EntityUpdatedEvent {
|
|
782
|
+
/**
|
|
783
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
784
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
785
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
786
|
+
*/
|
|
787
|
+
currentEntityAsJson?: string;
|
|
788
|
+
}
|
|
789
|
+
interface EntityDeletedEvent {
|
|
790
|
+
/** Entity that was deleted. */
|
|
791
|
+
deletedEntityAsJson?: string | null;
|
|
792
|
+
}
|
|
793
|
+
interface ActionEvent {
|
|
794
|
+
bodyAsJson?: string;
|
|
795
|
+
}
|
|
796
|
+
interface MessageEnvelope {
|
|
797
|
+
/**
|
|
798
|
+
* App instance ID.
|
|
799
|
+
* @format GUID
|
|
800
|
+
*/
|
|
801
|
+
instanceId?: string | null;
|
|
802
|
+
/**
|
|
803
|
+
* Event type.
|
|
804
|
+
* @maxLength 150
|
|
805
|
+
*/
|
|
806
|
+
eventType?: string;
|
|
807
|
+
/** The identification type and identity data. */
|
|
808
|
+
identity?: IdentificationData;
|
|
809
|
+
/** Stringify payload. */
|
|
810
|
+
data?: string;
|
|
811
|
+
}
|
|
812
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
813
|
+
/**
|
|
814
|
+
* ID of a site visitor that has not logged in to the site.
|
|
815
|
+
* @format GUID
|
|
816
|
+
*/
|
|
817
|
+
anonymousVisitorId?: string;
|
|
818
|
+
/**
|
|
819
|
+
* ID of a site visitor that has logged in to the site.
|
|
820
|
+
* @format GUID
|
|
821
|
+
*/
|
|
822
|
+
memberId?: string;
|
|
823
|
+
/**
|
|
824
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
825
|
+
* @format GUID
|
|
826
|
+
*/
|
|
827
|
+
wixUserId?: string;
|
|
828
|
+
/**
|
|
829
|
+
* ID of an app.
|
|
830
|
+
* @format GUID
|
|
831
|
+
*/
|
|
832
|
+
appId?: string;
|
|
833
|
+
/** @readonly */
|
|
834
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
835
|
+
}
|
|
836
|
+
/** @oneof */
|
|
837
|
+
interface IdentificationDataIdOneOf {
|
|
838
|
+
/**
|
|
839
|
+
* ID of a site visitor that has not logged in to the site.
|
|
840
|
+
* @format GUID
|
|
841
|
+
*/
|
|
842
|
+
anonymousVisitorId?: string;
|
|
843
|
+
/**
|
|
844
|
+
* ID of a site visitor that has logged in to the site.
|
|
845
|
+
* @format GUID
|
|
846
|
+
*/
|
|
847
|
+
memberId?: string;
|
|
848
|
+
/**
|
|
849
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
850
|
+
* @format GUID
|
|
851
|
+
*/
|
|
852
|
+
wixUserId?: string;
|
|
853
|
+
/**
|
|
854
|
+
* ID of an app.
|
|
855
|
+
* @format GUID
|
|
856
|
+
*/
|
|
857
|
+
appId?: string;
|
|
858
|
+
}
|
|
859
|
+
declare enum WebhookIdentityType {
|
|
860
|
+
UNKNOWN = "UNKNOWN",
|
|
861
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
862
|
+
MEMBER = "MEMBER",
|
|
863
|
+
WIX_USER = "WIX_USER",
|
|
864
|
+
APP = "APP"
|
|
865
|
+
}
|
|
866
|
+
/** @enumType */
|
|
867
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
593
868
|
interface CreateAutomationRequest {
|
|
594
869
|
/** Automation to create. */
|
|
595
870
|
automation: Automation;
|
|
@@ -685,6 +960,105 @@ interface BulkActionMetadata {
|
|
|
685
960
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
686
961
|
undetailedFailures?: number;
|
|
687
962
|
}
|
|
963
|
+
interface CreatePreinstalledAutomationRequest {
|
|
964
|
+
/** Preinstalled automation to create. */
|
|
965
|
+
automation?: Automation;
|
|
966
|
+
/**
|
|
967
|
+
* Hide the created automation behind a spec.
|
|
968
|
+
*
|
|
969
|
+
* For internal use only.
|
|
970
|
+
*/
|
|
971
|
+
specInfo?: PreinstalledAutomationSpecInfo;
|
|
972
|
+
/**
|
|
973
|
+
* Original site automation used to create the current preinstalled automation.
|
|
974
|
+
*
|
|
975
|
+
* Usually an existing automation on a site is used to create the preinstalled automation.
|
|
976
|
+
*
|
|
977
|
+
* For internal use only.
|
|
978
|
+
*/
|
|
979
|
+
originAutomationInfo?: OriginAutomationInfo;
|
|
980
|
+
/**
|
|
981
|
+
* ID of the app to which the automation belongs.
|
|
982
|
+
* @format GUID
|
|
983
|
+
*/
|
|
984
|
+
appId?: string;
|
|
985
|
+
}
|
|
986
|
+
interface PreinstalledAutomationSpecInfo {
|
|
987
|
+
/**
|
|
988
|
+
* Spec to conduct on for the automation.
|
|
989
|
+
*
|
|
990
|
+
* For internal use only.
|
|
991
|
+
* @maxLength 128
|
|
992
|
+
*/
|
|
993
|
+
spec?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Value the spec should return in order to affect the user with the operation
|
|
996
|
+
* e.g. creation - show the users the automation, update - show the users the updated automation, deletion - not show the users the automation
|
|
997
|
+
* @maxLength 128
|
|
998
|
+
*/
|
|
999
|
+
variantValue?: string | null;
|
|
1000
|
+
/**
|
|
1001
|
+
* Version from which the experiment should decide whether to expose it to users when !conduct(spec).contains(variant_value)
|
|
1002
|
+
* For example, if 50 is set, version 49 and below (including 49) will not expose the preinstalled automation to the user.
|
|
1003
|
+
*/
|
|
1004
|
+
experimentVersion?: number;
|
|
1005
|
+
}
|
|
1006
|
+
interface OriginAutomationInfo {
|
|
1007
|
+
/**
|
|
1008
|
+
* ID of the original automation.
|
|
1009
|
+
* @format GUID
|
|
1010
|
+
*/
|
|
1011
|
+
siteAutomationId?: string;
|
|
1012
|
+
/**
|
|
1013
|
+
* Metasite ID of the original automation.
|
|
1014
|
+
* @format GUID
|
|
1015
|
+
*/
|
|
1016
|
+
metaSiteId?: string;
|
|
1017
|
+
}
|
|
1018
|
+
interface CreatePreinstalledAutomationResponse {
|
|
1019
|
+
/** Details of the created preinstalled automation. */
|
|
1020
|
+
automation?: Automation;
|
|
1021
|
+
}
|
|
1022
|
+
interface UpdatePreinstalledAutomationRequest {
|
|
1023
|
+
/** Preinstalled automation to update. */
|
|
1024
|
+
automation?: Automation;
|
|
1025
|
+
/**
|
|
1026
|
+
* Hide the updated automation behind a spec.
|
|
1027
|
+
*
|
|
1028
|
+
* For internal use only.
|
|
1029
|
+
*/
|
|
1030
|
+
specInfo?: PreinstalledAutomationSpecInfo;
|
|
1031
|
+
/**
|
|
1032
|
+
* ID of the app to which the automation belongs.
|
|
1033
|
+
* @format GUID
|
|
1034
|
+
*/
|
|
1035
|
+
appId?: string;
|
|
1036
|
+
}
|
|
1037
|
+
interface UpdatePreinstalledAutomationResponse {
|
|
1038
|
+
/** Updated preinstalled automation. */
|
|
1039
|
+
automation?: Automation;
|
|
1040
|
+
}
|
|
1041
|
+
interface DeletePreinstalledAutomationRequest {
|
|
1042
|
+
/**
|
|
1043
|
+
* ID of the preinstalled component.
|
|
1044
|
+
* @format GUID
|
|
1045
|
+
*/
|
|
1046
|
+
componentId?: string;
|
|
1047
|
+
/**
|
|
1048
|
+
* Makes the deletion operation gradual.
|
|
1049
|
+
* The automation will not return if the variant returns for the site
|
|
1050
|
+
*
|
|
1051
|
+
* For internal use only.
|
|
1052
|
+
*/
|
|
1053
|
+
specInfo?: PreinstalledAutomationSpecInfo;
|
|
1054
|
+
/**
|
|
1055
|
+
* ID of the app to which the component belongs.
|
|
1056
|
+
* @format GUID
|
|
1057
|
+
*/
|
|
1058
|
+
appId?: string;
|
|
1059
|
+
}
|
|
1060
|
+
interface DeletePreinstalledAutomationResponse {
|
|
1061
|
+
}
|
|
688
1062
|
interface GeneratePreinstalledAutomationRequest {
|
|
689
1063
|
/** Automation. */
|
|
690
1064
|
automation: Automation;
|
|
@@ -698,6 +1072,19 @@ interface GeneratePreinstalledAutomationResponse {
|
|
|
698
1072
|
/** Automation. */
|
|
699
1073
|
automation?: Automation;
|
|
700
1074
|
}
|
|
1075
|
+
interface QueryPreinstalledAutomationsForAppRequest {
|
|
1076
|
+
/**
|
|
1077
|
+
* Query.
|
|
1078
|
+
*
|
|
1079
|
+
* Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
|
|
1080
|
+
*/
|
|
1081
|
+
query?: CursorQuery;
|
|
1082
|
+
/**
|
|
1083
|
+
* ID of the app for which to query preinstalled automations.
|
|
1084
|
+
* @format GUID
|
|
1085
|
+
*/
|
|
1086
|
+
appId?: string;
|
|
1087
|
+
}
|
|
701
1088
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
702
1089
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
703
1090
|
cursorPaging?: CursorPaging;
|
|
@@ -753,6 +1140,12 @@ interface CursorPaging {
|
|
|
753
1140
|
*/
|
|
754
1141
|
cursor?: string | null;
|
|
755
1142
|
}
|
|
1143
|
+
interface QueryPreinstalledAutomationsForAppResponse {
|
|
1144
|
+
/** Automations. */
|
|
1145
|
+
automations?: Automation[];
|
|
1146
|
+
/** Paging metadata. */
|
|
1147
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1148
|
+
}
|
|
756
1149
|
interface CursorPagingMetadata {
|
|
757
1150
|
/** Number of items returned in the response. */
|
|
758
1151
|
count?: number | null;
|
|
@@ -778,6 +1171,19 @@ interface Cursors {
|
|
|
778
1171
|
*/
|
|
779
1172
|
prev?: string | null;
|
|
780
1173
|
}
|
|
1174
|
+
interface QueryPreinstalledAutomationsRequest {
|
|
1175
|
+
/**
|
|
1176
|
+
* Query.
|
|
1177
|
+
* Learn more about [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language).
|
|
1178
|
+
*/
|
|
1179
|
+
query?: CursorQuery;
|
|
1180
|
+
}
|
|
1181
|
+
interface QueryPreinstalledAutomationsResponse {
|
|
1182
|
+
/** Automations. */
|
|
1183
|
+
automations?: Automation[];
|
|
1184
|
+
/** Paging metadata. */
|
|
1185
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1186
|
+
}
|
|
781
1187
|
interface QueryAutomationsRequest {
|
|
782
1188
|
/**
|
|
783
1189
|
* Query.
|
|
@@ -813,6 +1219,8 @@ interface GetAggregatedUsageInfoResponse {
|
|
|
813
1219
|
triggersUsageSummary?: TriggerUsageSummary[];
|
|
814
1220
|
/** Actions in use */
|
|
815
1221
|
actionsUsageSummary?: ActionUsageSummary[];
|
|
1222
|
+
/** Created by app ids in use */
|
|
1223
|
+
createdByAppIdUsageSummary?: CreatedByAppIdUsageSummary[];
|
|
816
1224
|
}
|
|
817
1225
|
interface TriggerUsageSummary {
|
|
818
1226
|
/**
|
|
@@ -844,6 +1252,17 @@ interface ActionUsageSummary {
|
|
|
844
1252
|
/** Number of automations that include this action. */
|
|
845
1253
|
automationsCount?: number;
|
|
846
1254
|
}
|
|
1255
|
+
interface CreatedByAppIdUsageSummary {
|
|
1256
|
+
/**
|
|
1257
|
+
* ID of the app that created the automation.
|
|
1258
|
+
* @format GUID
|
|
1259
|
+
*/
|
|
1260
|
+
appId?: string;
|
|
1261
|
+
/** Number of automations that include this app ID. */
|
|
1262
|
+
automationsCount?: number;
|
|
1263
|
+
}
|
|
1264
|
+
interface Empty {
|
|
1265
|
+
}
|
|
847
1266
|
interface CopyAutomationRequest {
|
|
848
1267
|
/**
|
|
849
1268
|
* ID of the automation to copy.
|
|
@@ -859,6 +1278,467 @@ interface CopyAutomationResponse {
|
|
|
859
1278
|
/** Copy of the automation. */
|
|
860
1279
|
automation?: Automation;
|
|
861
1280
|
}
|
|
1281
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
1282
|
+
/** Emitted on a meta site creation. */
|
|
1283
|
+
siteCreated?: SiteCreated;
|
|
1284
|
+
/** Emitted on a meta site transfer completion. */
|
|
1285
|
+
siteTransferred?: SiteTransferred;
|
|
1286
|
+
/** Emitted on a meta site deletion. */
|
|
1287
|
+
siteDeleted?: SiteDeleted;
|
|
1288
|
+
/** Emitted on a meta site restoration. */
|
|
1289
|
+
siteUndeleted?: SiteUndeleted;
|
|
1290
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1291
|
+
sitePublished?: SitePublished;
|
|
1292
|
+
/** Emitted on a meta site unpublish. */
|
|
1293
|
+
siteUnpublished?: SiteUnpublished;
|
|
1294
|
+
/** Emitted when meta site is marked as template. */
|
|
1295
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1296
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
1297
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1298
|
+
/** Emitted when an application is provisioned (installed). */
|
|
1299
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
1300
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
1301
|
+
serviceRemoved?: ServiceRemoved;
|
|
1302
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
1303
|
+
siteRenamedPayload?: SiteRenamed;
|
|
1304
|
+
/** Emitted when meta site was permanently deleted. */
|
|
1305
|
+
hardDeleted?: SiteHardDeleted;
|
|
1306
|
+
/** Emitted on a namespace change. */
|
|
1307
|
+
namespaceChanged?: NamespaceChanged;
|
|
1308
|
+
/** Emitted when Studio is attached. */
|
|
1309
|
+
studioAssigned?: StudioAssigned;
|
|
1310
|
+
/** Emitted when Studio is detached. */
|
|
1311
|
+
studioUnassigned?: StudioUnassigned;
|
|
1312
|
+
/**
|
|
1313
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1314
|
+
* the actual URL.
|
|
1315
|
+
*
|
|
1316
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1317
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1318
|
+
*/
|
|
1319
|
+
urlChanged?: SiteUrlChanged;
|
|
1320
|
+
/** Site is marked as PurgedExternally */
|
|
1321
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
1322
|
+
/** Emitted when Odeditor is attached. */
|
|
1323
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1324
|
+
/** Emitted when Odeditor is detached. */
|
|
1325
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1326
|
+
/** Emitted when Picasso is attached. */
|
|
1327
|
+
picassoAssigned?: PicassoAssigned;
|
|
1328
|
+
/** Emitted when Picasso is detached. */
|
|
1329
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1330
|
+
/**
|
|
1331
|
+
* A meta site id.
|
|
1332
|
+
* @format GUID
|
|
1333
|
+
*/
|
|
1334
|
+
metaSiteId?: string;
|
|
1335
|
+
/** A meta site version. Monotonically increasing. */
|
|
1336
|
+
version?: string;
|
|
1337
|
+
/** A timestamp of the event. */
|
|
1338
|
+
timestamp?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
1341
|
+
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
1342
|
+
* @maxSize 4000
|
|
1343
|
+
*/
|
|
1344
|
+
assets?: Asset[];
|
|
1345
|
+
}
|
|
1346
|
+
/** @oneof */
|
|
1347
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
1348
|
+
/** Emitted on a meta site creation. */
|
|
1349
|
+
siteCreated?: SiteCreated;
|
|
1350
|
+
/** Emitted on a meta site transfer completion. */
|
|
1351
|
+
siteTransferred?: SiteTransferred;
|
|
1352
|
+
/** Emitted on a meta site deletion. */
|
|
1353
|
+
siteDeleted?: SiteDeleted;
|
|
1354
|
+
/** Emitted on a meta site restoration. */
|
|
1355
|
+
siteUndeleted?: SiteUndeleted;
|
|
1356
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
1357
|
+
sitePublished?: SitePublished;
|
|
1358
|
+
/** Emitted on a meta site unpublish. */
|
|
1359
|
+
siteUnpublished?: SiteUnpublished;
|
|
1360
|
+
/** Emitted when meta site is marked as template. */
|
|
1361
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
1362
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
1363
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
1364
|
+
/** Emitted when an application is provisioned (installed). */
|
|
1365
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
1366
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
1367
|
+
serviceRemoved?: ServiceRemoved;
|
|
1368
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
1369
|
+
siteRenamedPayload?: SiteRenamed;
|
|
1370
|
+
/** Emitted when meta site was permanently deleted. */
|
|
1371
|
+
hardDeleted?: SiteHardDeleted;
|
|
1372
|
+
/** Emitted on a namespace change. */
|
|
1373
|
+
namespaceChanged?: NamespaceChanged;
|
|
1374
|
+
/** Emitted when Studio is attached. */
|
|
1375
|
+
studioAssigned?: StudioAssigned;
|
|
1376
|
+
/** Emitted when Studio is detached. */
|
|
1377
|
+
studioUnassigned?: StudioUnassigned;
|
|
1378
|
+
/**
|
|
1379
|
+
* Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
|
|
1380
|
+
* the actual URL.
|
|
1381
|
+
*
|
|
1382
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
|
|
1383
|
+
* See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
|
|
1384
|
+
*/
|
|
1385
|
+
urlChanged?: SiteUrlChanged;
|
|
1386
|
+
/** Site is marked as PurgedExternally */
|
|
1387
|
+
sitePurgedExternally?: SitePurgedExternally;
|
|
1388
|
+
/** Emitted when Odeditor is attached. */
|
|
1389
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
1390
|
+
/** Emitted when Odeditor is detached. */
|
|
1391
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
1392
|
+
/** Emitted when Picasso is attached. */
|
|
1393
|
+
picassoAssigned?: PicassoAssigned;
|
|
1394
|
+
/** Emitted when Picasso is detached. */
|
|
1395
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
1396
|
+
}
|
|
1397
|
+
interface Asset {
|
|
1398
|
+
/**
|
|
1399
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
1400
|
+
* @maxLength 36
|
|
1401
|
+
*/
|
|
1402
|
+
appDefId?: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
1405
|
+
* @maxLength 200
|
|
1406
|
+
*/
|
|
1407
|
+
instanceId?: string;
|
|
1408
|
+
/** An application state. */
|
|
1409
|
+
state?: StateWithLiterals;
|
|
1410
|
+
}
|
|
1411
|
+
declare enum State {
|
|
1412
|
+
UNKNOWN = "UNKNOWN",
|
|
1413
|
+
ENABLED = "ENABLED",
|
|
1414
|
+
DISABLED = "DISABLED",
|
|
1415
|
+
PENDING = "PENDING",
|
|
1416
|
+
DEMO = "DEMO"
|
|
1417
|
+
}
|
|
1418
|
+
/** @enumType */
|
|
1419
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
1420
|
+
interface SiteCreated {
|
|
1421
|
+
/**
|
|
1422
|
+
* A template identifier (empty if not created from a template).
|
|
1423
|
+
* @maxLength 36
|
|
1424
|
+
*/
|
|
1425
|
+
originTemplateId?: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* An account id of the owner.
|
|
1428
|
+
* @format GUID
|
|
1429
|
+
*/
|
|
1430
|
+
ownerId?: string;
|
|
1431
|
+
/** A context in which meta site was created. */
|
|
1432
|
+
context?: SiteCreatedContextWithLiterals;
|
|
1433
|
+
/**
|
|
1434
|
+
* A meta site id from which this site was created.
|
|
1435
|
+
*
|
|
1436
|
+
* In case of a creation from a template it's a template id.
|
|
1437
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
1438
|
+
* @format GUID
|
|
1439
|
+
*/
|
|
1440
|
+
originMetaSiteId?: string | null;
|
|
1441
|
+
/**
|
|
1442
|
+
* A meta site name (URL slug).
|
|
1443
|
+
* @maxLength 20
|
|
1444
|
+
*/
|
|
1445
|
+
siteName?: string;
|
|
1446
|
+
/** A namespace. */
|
|
1447
|
+
namespace?: NamespaceWithLiterals;
|
|
1448
|
+
}
|
|
1449
|
+
declare enum SiteCreatedContext {
|
|
1450
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
1451
|
+
OTHER = "OTHER",
|
|
1452
|
+
/** A meta site was created from template. */
|
|
1453
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
1454
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
1455
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
1456
|
+
/** A copy of existing meta site. */
|
|
1457
|
+
DUPLICATE = "DUPLICATE",
|
|
1458
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
1459
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
1460
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
1461
|
+
FLASH = "FLASH"
|
|
1462
|
+
}
|
|
1463
|
+
/** @enumType */
|
|
1464
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
1465
|
+
declare enum Namespace {
|
|
1466
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
1467
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
1468
|
+
WIX = "WIX",
|
|
1469
|
+
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1470
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
1471
|
+
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1472
|
+
ALBUMS = "ALBUMS",
|
|
1473
|
+
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1474
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
1475
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1476
|
+
HOTELS = "HOTELS",
|
|
1477
|
+
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1478
|
+
CLUBS = "CLUBS",
|
|
1479
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1480
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
1481
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1482
|
+
DEV_SITE = "DEV_SITE",
|
|
1483
|
+
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1484
|
+
LOGOS = "LOGOS",
|
|
1485
|
+
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1486
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
1487
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1488
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
1489
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1490
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
1491
|
+
/**
|
|
1492
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
1493
|
+
*
|
|
1494
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
1495
|
+
*/
|
|
1496
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
1497
|
+
/**
|
|
1498
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
1499
|
+
* Will be accessible from Site List and will not have a website app.
|
|
1500
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
1501
|
+
*/
|
|
1502
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
1503
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
1504
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
1505
|
+
/** It is to be used in the Business First efforts. */
|
|
1506
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
1507
|
+
/** Bookings business flow with no site. */
|
|
1508
|
+
ANYWHERE = "ANYWHERE",
|
|
1509
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
1510
|
+
HEADLESS = "HEADLESS",
|
|
1511
|
+
/**
|
|
1512
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
1513
|
+
* The site will be used for account level CSM feature for enterprise
|
|
1514
|
+
*/
|
|
1515
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
1516
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
1517
|
+
RISE = "RISE",
|
|
1518
|
+
/**
|
|
1519
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
1520
|
+
* There's a blank site behind the scene but it's blank).
|
|
1521
|
+
* The Mobile company will be the owner of this namespace.
|
|
1522
|
+
*/
|
|
1523
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
1524
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
1525
|
+
NOWNIA = "NOWNIA",
|
|
1526
|
+
/**
|
|
1527
|
+
* UGC Templates are templates that are created by users for personal use and to sale to other users.
|
|
1528
|
+
* The Partners company owns this namespace.
|
|
1529
|
+
*/
|
|
1530
|
+
UGC_TEMPLATE = "UGC_TEMPLATE",
|
|
1531
|
+
/** Codux Headless Sites */
|
|
1532
|
+
CODUX = "CODUX",
|
|
1533
|
+
/** Bobb - AI Design Creator. */
|
|
1534
|
+
MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
|
|
1535
|
+
/**
|
|
1536
|
+
* Shared Blog Site is a unique single site across Enterprise account,
|
|
1537
|
+
* This site will hold all Blog posts related to the Marketing product.
|
|
1538
|
+
*/
|
|
1539
|
+
SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
|
|
1540
|
+
/** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1541
|
+
STANDALONE_FORMS = "STANDALONE_FORMS",
|
|
1542
|
+
/** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
1543
|
+
STANDALONE_EVENTS = "STANDALONE_EVENTS",
|
|
1544
|
+
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
1545
|
+
MIMIR = "MIMIR",
|
|
1546
|
+
/** Wix Twins platform. */
|
|
1547
|
+
TWINS = "TWINS",
|
|
1548
|
+
/** Wix Nano. */
|
|
1549
|
+
NANO = "NANO"
|
|
1550
|
+
}
|
|
1551
|
+
/** @enumType */
|
|
1552
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO';
|
|
1553
|
+
/** Site transferred to another user. */
|
|
1554
|
+
interface SiteTransferred {
|
|
1555
|
+
/**
|
|
1556
|
+
* A previous owner id (user that transfers meta site).
|
|
1557
|
+
* @format GUID
|
|
1558
|
+
*/
|
|
1559
|
+
oldOwnerId?: string;
|
|
1560
|
+
/**
|
|
1561
|
+
* A new owner id (user that accepts meta site).
|
|
1562
|
+
* @format GUID
|
|
1563
|
+
*/
|
|
1564
|
+
newOwnerId?: string;
|
|
1565
|
+
}
|
|
1566
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
1567
|
+
interface SiteDeleted {
|
|
1568
|
+
/** A deletion context. */
|
|
1569
|
+
deleteContext?: DeleteContext;
|
|
1570
|
+
}
|
|
1571
|
+
interface DeleteContext {
|
|
1572
|
+
/** When the meta site was deleted. */
|
|
1573
|
+
dateDeleted?: Date | null;
|
|
1574
|
+
/** A status. */
|
|
1575
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
1576
|
+
/**
|
|
1577
|
+
* A reason (flow).
|
|
1578
|
+
* @maxLength 255
|
|
1579
|
+
*/
|
|
1580
|
+
deleteOrigin?: string;
|
|
1581
|
+
/**
|
|
1582
|
+
* A service that deleted it.
|
|
1583
|
+
* @maxLength 255
|
|
1584
|
+
*/
|
|
1585
|
+
initiatorId?: string | null;
|
|
1586
|
+
}
|
|
1587
|
+
declare enum DeleteStatus {
|
|
1588
|
+
UNKNOWN = "UNKNOWN",
|
|
1589
|
+
TRASH = "TRASH",
|
|
1590
|
+
DELETED = "DELETED",
|
|
1591
|
+
PENDING_PURGE = "PENDING_PURGE",
|
|
1592
|
+
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
1593
|
+
}
|
|
1594
|
+
/** @enumType */
|
|
1595
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
1596
|
+
/** Restoration of the meta site. */
|
|
1597
|
+
interface SiteUndeleted {
|
|
1598
|
+
}
|
|
1599
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
1600
|
+
interface SitePublished {
|
|
1601
|
+
}
|
|
1602
|
+
interface SiteUnpublished {
|
|
1603
|
+
/**
|
|
1604
|
+
* A list of URLs previously associated with the meta site.
|
|
1605
|
+
* @maxLength 4000
|
|
1606
|
+
* @maxSize 10000
|
|
1607
|
+
*/
|
|
1608
|
+
urls?: string[];
|
|
1609
|
+
}
|
|
1610
|
+
interface SiteMarkedAsTemplate {
|
|
1611
|
+
}
|
|
1612
|
+
interface SiteMarkedAsWixSite {
|
|
1613
|
+
}
|
|
1614
|
+
/**
|
|
1615
|
+
* Represents a service provisioned a site.
|
|
1616
|
+
*
|
|
1617
|
+
* Note on `origin_instance_id`:
|
|
1618
|
+
* There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
|
|
1619
|
+
* This is because of the following scenario:
|
|
1620
|
+
*
|
|
1621
|
+
* Imagine you have a template where a third-party application (TPA) includes some stub data,
|
|
1622
|
+
* such as a product catalog. When you create a site from this template, you inherit this
|
|
1623
|
+
* default product catalog. However, if the template's product catalog is modified,
|
|
1624
|
+
* your site will retain the catalog as it was at the time of site creation. This ensures that
|
|
1625
|
+
* your site remains consistent with what you initially received and does not include any
|
|
1626
|
+
* changes made to the original template afterward.
|
|
1627
|
+
* To ensure this, the TPA on the template gets a new instance_id.
|
|
1628
|
+
*/
|
|
1629
|
+
interface ServiceProvisioned {
|
|
1630
|
+
/**
|
|
1631
|
+
* Either UUID or EmbeddedServiceType.
|
|
1632
|
+
* @maxLength 36
|
|
1633
|
+
*/
|
|
1634
|
+
appDefId?: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* Not only UUID. Something here could be something weird.
|
|
1637
|
+
* @maxLength 36
|
|
1638
|
+
*/
|
|
1639
|
+
instanceId?: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* An instance id from which this instance is originated.
|
|
1642
|
+
* @maxLength 36
|
|
1643
|
+
*/
|
|
1644
|
+
originInstanceId?: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* A version.
|
|
1647
|
+
* @maxLength 500
|
|
1648
|
+
*/
|
|
1649
|
+
version?: string | null;
|
|
1650
|
+
/**
|
|
1651
|
+
* The origin meta site id
|
|
1652
|
+
* @format GUID
|
|
1653
|
+
*/
|
|
1654
|
+
originMetaSiteId?: string | null;
|
|
1655
|
+
}
|
|
1656
|
+
interface ServiceRemoved {
|
|
1657
|
+
/**
|
|
1658
|
+
* Either UUID or EmbeddedServiceType.
|
|
1659
|
+
* @maxLength 36
|
|
1660
|
+
*/
|
|
1661
|
+
appDefId?: string;
|
|
1662
|
+
/**
|
|
1663
|
+
* Not only UUID. Something here could be something weird.
|
|
1664
|
+
* @maxLength 36
|
|
1665
|
+
*/
|
|
1666
|
+
instanceId?: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* A version.
|
|
1669
|
+
* @maxLength 500
|
|
1670
|
+
*/
|
|
1671
|
+
version?: string | null;
|
|
1672
|
+
}
|
|
1673
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
1674
|
+
interface SiteRenamed {
|
|
1675
|
+
/**
|
|
1676
|
+
* A new meta site name (URL slug).
|
|
1677
|
+
* @maxLength 20
|
|
1678
|
+
*/
|
|
1679
|
+
newSiteName?: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* A previous meta site name (URL slug).
|
|
1682
|
+
* @maxLength 255
|
|
1683
|
+
*/
|
|
1684
|
+
oldSiteName?: string;
|
|
1685
|
+
}
|
|
1686
|
+
/**
|
|
1687
|
+
* Hard deletion of the meta site.
|
|
1688
|
+
*
|
|
1689
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
1690
|
+
*/
|
|
1691
|
+
interface SiteHardDeleted {
|
|
1692
|
+
/** A deletion context. */
|
|
1693
|
+
deleteContext?: DeleteContext;
|
|
1694
|
+
}
|
|
1695
|
+
interface NamespaceChanged {
|
|
1696
|
+
/** A previous namespace. */
|
|
1697
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
1698
|
+
/** A new namespace. */
|
|
1699
|
+
newNamespace?: NamespaceWithLiterals;
|
|
1700
|
+
}
|
|
1701
|
+
/** Assigned Studio editor */
|
|
1702
|
+
interface StudioAssigned {
|
|
1703
|
+
}
|
|
1704
|
+
/** Unassigned Studio editor */
|
|
1705
|
+
interface StudioUnassigned {
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
1709
|
+
*
|
|
1710
|
+
* This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
|
|
1711
|
+
* with sites and its urls, you need to listen to another topic/event. Read about it:
|
|
1712
|
+
*
|
|
1713
|
+
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
1714
|
+
*/
|
|
1715
|
+
interface SiteUrlChanged {
|
|
1716
|
+
}
|
|
1717
|
+
/**
|
|
1718
|
+
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
1719
|
+
* Consumed by other teams to remove relevant data.
|
|
1720
|
+
*/
|
|
1721
|
+
interface SitePurgedExternally {
|
|
1722
|
+
/**
|
|
1723
|
+
* @maxLength 2048
|
|
1724
|
+
* @maxSize 100
|
|
1725
|
+
* @deprecated
|
|
1726
|
+
* @targetRemovalDate 2025-04-15
|
|
1727
|
+
*/
|
|
1728
|
+
appDefId?: string[];
|
|
1729
|
+
}
|
|
1730
|
+
/** Assigned Odeditor */
|
|
1731
|
+
interface OdeditorAssigned {
|
|
1732
|
+
}
|
|
1733
|
+
/** Unassigned Odeditor */
|
|
1734
|
+
interface OdeditorUnassigned {
|
|
1735
|
+
}
|
|
1736
|
+
/** Assigned Picasso editor */
|
|
1737
|
+
interface PicassoAssigned {
|
|
1738
|
+
}
|
|
1739
|
+
/** Unassigned Picasso */
|
|
1740
|
+
interface PicassoUnassigned {
|
|
1741
|
+
}
|
|
862
1742
|
interface CreateDraftAutomationRequest {
|
|
863
1743
|
/** Draft automation to create. */
|
|
864
1744
|
automation?: Automation;
|
|
@@ -1075,6 +1955,15 @@ interface ProviderConfigurationError {
|
|
|
1075
1955
|
/** Title for the error. */
|
|
1076
1956
|
title?: string;
|
|
1077
1957
|
}
|
|
1958
|
+
declare enum ValidationErrorSeverity {
|
|
1959
|
+
UNKNOWN_VALIDATION_ERROR_SEVERITY = "UNKNOWN_VALIDATION_ERROR_SEVERITY",
|
|
1960
|
+
/** Warning. */
|
|
1961
|
+
WARNING = "WARNING",
|
|
1962
|
+
/** Error. */
|
|
1963
|
+
ERROR = "ERROR"
|
|
1964
|
+
}
|
|
1965
|
+
/** @enumType */
|
|
1966
|
+
type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
|
|
1078
1967
|
declare enum Severity {
|
|
1079
1968
|
UNKNOWN_SEVERITY = "UNKNOWN_SEVERITY",
|
|
1080
1969
|
/** Low severity error - may affect automation execution. */
|
|
@@ -1084,6 +1973,29 @@ declare enum Severity {
|
|
|
1084
1973
|
}
|
|
1085
1974
|
/** @enumType */
|
|
1086
1975
|
type SeverityWithLiterals = Severity | 'UNKNOWN_SEVERITY' | 'WARNING' | 'CRITICAL';
|
|
1976
|
+
interface ActionValidationInfo {
|
|
1977
|
+
/**
|
|
1978
|
+
* Action ID.
|
|
1979
|
+
* @format GUID
|
|
1980
|
+
*/
|
|
1981
|
+
actionId?: string | null;
|
|
1982
|
+
/**
|
|
1983
|
+
* ID of the app that defined the action.
|
|
1984
|
+
* @format GUID
|
|
1985
|
+
*/
|
|
1986
|
+
appId?: string;
|
|
1987
|
+
/**
|
|
1988
|
+
* Human-readable action identifier.
|
|
1989
|
+
* @minLength 1
|
|
1990
|
+
* @maxLength 100
|
|
1991
|
+
*/
|
|
1992
|
+
actionKey?: string;
|
|
1993
|
+
/**
|
|
1994
|
+
* Action validation errors.
|
|
1995
|
+
* @maxSize 100
|
|
1996
|
+
*/
|
|
1997
|
+
validationErrors?: ActionValidationError[];
|
|
1998
|
+
}
|
|
1087
1999
|
interface ActionValidationError extends ActionValidationErrorErrorOneOf {
|
|
1088
2000
|
/** Action configuration error. */
|
|
1089
2001
|
configurationError?: ActionConfigurationError;
|
|
@@ -1155,6 +2067,39 @@ declare enum ActionErrorType {
|
|
|
1155
2067
|
}
|
|
1156
2068
|
/** @enumType */
|
|
1157
2069
|
type ActionErrorTypeWithLiterals = ActionErrorType | 'UNKNOWN_ACTION_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'INVALID_ACTION_KEY' | 'INVALID_MAPPING' | 'MAPPING_TYPE_MISMATCH' | 'MAPPING_MISSING_REQUIRED_FIELD' | 'MAPPING_SCHEMA_MISMATCH' | 'MAPPING_VARIABLE_MISSING_FROM_SCHEMA' | 'SAMPLE_CODE_RUN_FAILED' | 'POST_ACTION_NOT_FOUND';
|
|
2070
|
+
interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
|
|
2071
|
+
/** Automation configuration error. */
|
|
2072
|
+
configurationError?: AutomationConfigurationError;
|
|
2073
|
+
/** Provider configuration error. */
|
|
2074
|
+
providerConfigurationError?: ProviderConfigurationError;
|
|
2075
|
+
/** Validation error type. */
|
|
2076
|
+
errorType?: AutomationValidationErrorValidationErrorTypeWithLiterals;
|
|
2077
|
+
/** Validation error severity */
|
|
2078
|
+
errorSeverity?: SeverityWithLiterals;
|
|
2079
|
+
}
|
|
2080
|
+
/** @oneof */
|
|
2081
|
+
interface AutomationValidationErrorErrorOneOf {
|
|
2082
|
+
/** Automation configuration error. */
|
|
2083
|
+
configurationError?: AutomationConfigurationError;
|
|
2084
|
+
/** Provider configuration error. */
|
|
2085
|
+
providerConfigurationError?: ProviderConfigurationError;
|
|
2086
|
+
}
|
|
2087
|
+
declare enum AutomationValidationErrorValidationErrorType {
|
|
2088
|
+
UNKNOWN_VALIDATION_ERROR_TYPE = "UNKNOWN_VALIDATION_ERROR_TYPE",
|
|
2089
|
+
CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
|
|
2090
|
+
PROVIDER_ERROR = "PROVIDER_ERROR"
|
|
2091
|
+
}
|
|
2092
|
+
/** @enumType */
|
|
2093
|
+
type AutomationValidationErrorValidationErrorTypeWithLiterals = AutomationValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
|
|
2094
|
+
interface AutomationConfigurationError {
|
|
2095
|
+
/** Automation error type. */
|
|
2096
|
+
errorType?: AutomationErrorTypeWithLiterals;
|
|
2097
|
+
}
|
|
2098
|
+
declare enum AutomationErrorType {
|
|
2099
|
+
UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
|
|
2100
|
+
}
|
|
2101
|
+
/** @enumType */
|
|
2102
|
+
type AutomationErrorTypeWithLiterals = AutomationErrorType | 'UNKNOWN_AUTOMATION_ERROR_TYPE';
|
|
1158
2103
|
interface ValidateAutomationByIdRequest {
|
|
1159
2104
|
/**
|
|
1160
2105
|
* Automation ID.
|
|
@@ -1178,6 +2123,155 @@ interface ValidateAutomationByIdResponse {
|
|
|
1178
2123
|
*/
|
|
1179
2124
|
actionValidationErrors?: ActionValidationError[];
|
|
1180
2125
|
}
|
|
2126
|
+
interface GetAutomationActionSchemaRequest {
|
|
2127
|
+
/**
|
|
2128
|
+
* Automation ID.
|
|
2129
|
+
* @format GUID
|
|
2130
|
+
*/
|
|
2131
|
+
automationId?: string;
|
|
2132
|
+
/**
|
|
2133
|
+
* Action ID.
|
|
2134
|
+
* @format GUID
|
|
2135
|
+
*/
|
|
2136
|
+
actionId?: string;
|
|
2137
|
+
}
|
|
2138
|
+
interface GetAutomationActionSchemaResponse {
|
|
2139
|
+
/** The accumulated payload schema for an action. */
|
|
2140
|
+
schema?: Record<string, any> | null;
|
|
2141
|
+
}
|
|
2142
|
+
interface GetActionsQuotaInfoRequest {
|
|
2143
|
+
}
|
|
2144
|
+
interface GetActionsQuotaInfoResponse {
|
|
2145
|
+
/** Action quotas. */
|
|
2146
|
+
actionProviderQuotaInfo?: ActionProviderQuotaInfo[];
|
|
2147
|
+
}
|
|
2148
|
+
interface ActionProviderQuotaInfo {
|
|
2149
|
+
/**
|
|
2150
|
+
* ID of the app that defined the action.
|
|
2151
|
+
* @format GUID
|
|
2152
|
+
*/
|
|
2153
|
+
appId?: string;
|
|
2154
|
+
/**
|
|
2155
|
+
* Action key.
|
|
2156
|
+
* @minLength 1
|
|
2157
|
+
* @maxLength 80
|
|
2158
|
+
*/
|
|
2159
|
+
actionKey?: string;
|
|
2160
|
+
/** Action quota information. */
|
|
2161
|
+
actionQuotaInfo?: ActionQuotaInfo;
|
|
2162
|
+
}
|
|
2163
|
+
interface ActionQuotaInfo {
|
|
2164
|
+
/**
|
|
2165
|
+
* Whether the quotas for your action are enforced. If you mark this as `true` in the response body,
|
|
2166
|
+
* Wix displays the information in the quota object on the site dashboard. If you mark this as `false` for
|
|
2167
|
+
* a user, Wix does not display any quota info on the site dashboard for your service.
|
|
2168
|
+
*/
|
|
2169
|
+
enforced?: boolean;
|
|
2170
|
+
/**
|
|
2171
|
+
* The plans your service provides, together with the quotas enforced by each plan. A site may be enrolled
|
|
2172
|
+
* in multiple plans. Plans and quotas can be related as follows:
|
|
2173
|
+
*
|
|
2174
|
+
* + A single plan has a single quota.
|
|
2175
|
+
* + A single plan has multiple quotas.
|
|
2176
|
+
* + Multiple plans are associated with multiple quotas.
|
|
2177
|
+
*
|
|
2178
|
+
* Plans and quotas that are related should be grouped together in a single `quotaInfo`
|
|
2179
|
+
* object.
|
|
2180
|
+
*/
|
|
2181
|
+
quotaInfo?: QuotaInfo[];
|
|
2182
|
+
}
|
|
2183
|
+
interface QuotaInfo {
|
|
2184
|
+
/** List of plans associated with the site making the request. */
|
|
2185
|
+
plans?: Plan[];
|
|
2186
|
+
/**
|
|
2187
|
+
* List of quotas associated with the plans the site is enrolled in.
|
|
2188
|
+
* @minSize 1
|
|
2189
|
+
*/
|
|
2190
|
+
quotas?: Quota[];
|
|
2191
|
+
/**
|
|
2192
|
+
* Details for an upgrade call-to-action button.
|
|
2193
|
+
* Displayed in the Wix user’s site dashboard together with the quota details.
|
|
2194
|
+
*/
|
|
2195
|
+
upgradeCta?: UpgradeCTA;
|
|
2196
|
+
}
|
|
2197
|
+
interface Plan {
|
|
2198
|
+
/** Plan ID defined by the action provider. */
|
|
2199
|
+
id?: string;
|
|
2200
|
+
/** Plan name to display in the Wix user’s site dashboard. */
|
|
2201
|
+
name?: string;
|
|
2202
|
+
}
|
|
2203
|
+
interface Quota {
|
|
2204
|
+
/**
|
|
2205
|
+
* Name of the feature the quota is related to. For example, "Messages sent".
|
|
2206
|
+
* @minLength 1
|
|
2207
|
+
*/
|
|
2208
|
+
featureName?: string;
|
|
2209
|
+
/**
|
|
2210
|
+
* Quota renewal date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
2211
|
+
* For example, 10 July 2020 at 15:00 is written as `2020-07-10 15:00:00.000`.
|
|
2212
|
+
*/
|
|
2213
|
+
renewalDate?: Date | null;
|
|
2214
|
+
/** The user's current quota usage. */
|
|
2215
|
+
currentUsage?: string;
|
|
2216
|
+
/** Quota limit data. */
|
|
2217
|
+
limit?: string | null;
|
|
2218
|
+
/** Additional information about the quota. Displayed as a tooltip in the Wix user’s dashboard. */
|
|
2219
|
+
additionalInfo?: AdditionalInfo;
|
|
2220
|
+
}
|
|
2221
|
+
interface CTA {
|
|
2222
|
+
/**
|
|
2223
|
+
* Call-to-action redirect URL.
|
|
2224
|
+
* @minLength 1
|
|
2225
|
+
*/
|
|
2226
|
+
url?: string;
|
|
2227
|
+
/**
|
|
2228
|
+
* Call-to-action label.
|
|
2229
|
+
* @minLength 1
|
|
2230
|
+
*/
|
|
2231
|
+
label?: string;
|
|
2232
|
+
}
|
|
2233
|
+
interface AdditionalInfo {
|
|
2234
|
+
/**
|
|
2235
|
+
* Tooltip content.
|
|
2236
|
+
* @minLength 1
|
|
2237
|
+
*/
|
|
2238
|
+
description?: string;
|
|
2239
|
+
/** Details for an options call-to-action link that appears in the tooltip. */
|
|
2240
|
+
cta?: CTA;
|
|
2241
|
+
}
|
|
2242
|
+
interface UpgradeCTA {
|
|
2243
|
+
/**
|
|
2244
|
+
* CTA button redirect URL.
|
|
2245
|
+
* @minLength 1
|
|
2246
|
+
*/
|
|
2247
|
+
url?: string;
|
|
2248
|
+
/**
|
|
2249
|
+
* CTA button label.
|
|
2250
|
+
* @minLength 1
|
|
2251
|
+
*/
|
|
2252
|
+
label?: string;
|
|
2253
|
+
}
|
|
2254
|
+
interface MigrateVeloActionAutomationsRequest {
|
|
2255
|
+
/** @format GUID */
|
|
2256
|
+
oldAppId?: string;
|
|
2257
|
+
/** @format GUID */
|
|
2258
|
+
newAppId?: string;
|
|
2259
|
+
/** @format GUID */
|
|
2260
|
+
newComponentId?: string;
|
|
2261
|
+
}
|
|
2262
|
+
interface MigrateVeloActionAutomationsResponse {
|
|
2263
|
+
}
|
|
2264
|
+
interface MergeOverridePreinstalledWithRuntimeVersionRequest {
|
|
2265
|
+
/**
|
|
2266
|
+
* ID of the override preinstalled automation to merge.
|
|
2267
|
+
* @format GUID
|
|
2268
|
+
*/
|
|
2269
|
+
automationId?: string;
|
|
2270
|
+
}
|
|
2271
|
+
interface MergeOverridePreinstalledWithRuntimeVersionResponse {
|
|
2272
|
+
/** The merged automation after applying the latest runtime version of the preinstalled automation. */
|
|
2273
|
+
automation?: Automation;
|
|
2274
|
+
}
|
|
1181
2275
|
interface GetAutomationRevisionRequest {
|
|
1182
2276
|
/**
|
|
1183
2277
|
* Automation ID.
|
|
@@ -1247,4 +2341,4 @@ declare function getAutomationRevision(): __PublicMethodMetaInfo<'GET', {
|
|
|
1247
2341
|
automationId: string;
|
|
1248
2342
|
}, GetAutomationRevisionRequest$1, GetAutomationRevisionRequest, GetAutomationRevisionResponse$1, GetAutomationRevisionResponse>;
|
|
1249
2343
|
|
|
1250
|
-
export { type __PublicMethodMetaInfo, bulkCountAutomationsWithDrafts, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAggregatedUsageInfo, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };
|
|
2344
|
+
export { type AIMetadata as AIMetadataOriginal, type ActionConfigurationError as ActionConfigurationErrorOriginal, ActionErrorType as ActionErrorTypeOriginal, type ActionErrorTypeWithLiterals as ActionErrorTypeWithLiteralsOriginal, type ActionEvent as ActionEventOriginal, type ActionInfoOneOf as ActionInfoOneOfOriginal, type Action as ActionOriginal, type ActionProviderQuotaInfo as ActionProviderQuotaInfoOriginal, type ActionQuotaInfo as ActionQuotaInfoOriginal, type ActionSettings as ActionSettingsOriginal, type ActionUsageSummary as ActionUsageSummaryOriginal, type ActionValidationErrorErrorOneOf as ActionValidationErrorErrorOneOfOriginal, type ActionValidationError as ActionValidationErrorOriginal, type ActionValidationInfo as ActionValidationInfoOriginal, type AdditionalInfo as AdditionalInfoOriginal, type AppDefinedAction as AppDefinedActionOriginal, type ApplicationError as ApplicationErrorOriginal, type ApplicationOrigin as ApplicationOriginOriginal, type Asset as AssetOriginal, type AuditInfoIdOneOf as AuditInfoIdOneOfOriginal, type AuditInfo as AuditInfoOriginal, type AutoArchivePolicy as AutoArchivePolicyOriginal, type AutomationConfigurationError as AutomationConfigurationErrorOriginal, type AutomationConfiguration as AutomationConfigurationOriginal, AutomationErrorType as AutomationErrorTypeOriginal, type AutomationErrorTypeWithLiterals as AutomationErrorTypeWithLiteralsOriginal, type AutomationOriginInfoOneOf as AutomationOriginInfoOneOfOriginal, type Automation as AutomationOriginal, type AutomationSettings as AutomationSettingsOriginal, type AutomationValidationErrorErrorOneOf as AutomationValidationErrorErrorOneOfOriginal, type AutomationValidationError as AutomationValidationErrorOriginal, AutomationValidationErrorValidationErrorType as AutomationValidationErrorValidationErrorTypeOriginal, type AutomationValidationErrorValidationErrorTypeWithLiterals as AutomationValidationErrorValidationErrorTypeWithLiteralsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCountAutomationsWithDraftsRequest as BulkCountAutomationsWithDraftsRequestOriginal, type BulkCountAutomationsWithDraftsResponse as BulkCountAutomationsWithDraftsResponseOriginal, type BulkDeleteAutomationsRequest as BulkDeleteAutomationsRequestOriginal, type BulkDeleteAutomationsResponse as BulkDeleteAutomationsResponseOriginal, type BulkDeleteResult as BulkDeleteResultOriginal, type CTA as CTAOriginal, type CodeConditionAction as CodeConditionActionOriginal, type CodeSnippet as CodeSnippetOriginal, type ConditionAction as ConditionActionOriginal, type ConditionExpressionGroup as ConditionExpressionGroupOriginal, type CopyAutomationRequest as CopyAutomationRequestOriginal, type CopyAutomationResponse as CopyAutomationResponseOriginal, type CreateAutomationRequest as CreateAutomationRequestOriginal, type CreateAutomationResponse as CreateAutomationResponseOriginal, type CreateDraftAutomationRequest as CreateDraftAutomationRequestOriginal, type CreateDraftAutomationResponse as CreateDraftAutomationResponseOriginal, type CreatePreinstalledAutomationRequest as CreatePreinstalledAutomationRequestOriginal, type CreatePreinstalledAutomationResponse as CreatePreinstalledAutomationResponseOriginal, type CreatedByAppIdUsageSummary as CreatedByAppIdUsageSummaryOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DelayAction as DelayActionOriginal, type DeleteAutomationRequest as DeleteAutomationRequestOriginal, type DeleteAutomationResponse as DeleteAutomationResponseOriginal, type DeleteContext as DeleteContextOriginal, type DeleteDraftAutomationRequest as DeleteDraftAutomationRequestOriginal, type DeleteDraftAutomationResponse as DeleteDraftAutomationResponseOriginal, type DeletePreinstalledAutomationRequest as DeletePreinstalledAutomationRequestOriginal, type DeletePreinstalledAutomationResponse as DeletePreinstalledAutomationResponseOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeletedWithEntity as DeletedWithEntityOriginal, type Dimensions as DimensionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, Domain as DomainOriginal, type DomainWithLiterals as DomainWithLiteralsOriginal, type DraftInfo as DraftInfoOriginal, type DraftPublished as DraftPublishedOriginal, type DraftsInfo as DraftsInfoOriginal, type Empty as EmptyOriginal, type Enrichment as EnrichmentOriginal, type Enrichments as EnrichmentsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type Filter as FilterOriginal, type FilterValueSelection as FilterValueSelectionOriginal, type FilterableAppDefinedActions as FilterableAppDefinedActionsOriginal, type FutureDateActivationOffset as FutureDateActivationOffsetOriginal, type GeneratePreinstalledAutomationRequest as GeneratePreinstalledAutomationRequestOriginal, type GeneratePreinstalledAutomationResponse as GeneratePreinstalledAutomationResponseOriginal, type GetActionsQuotaInfoRequest as GetActionsQuotaInfoRequestOriginal, type GetActionsQuotaInfoResponse as GetActionsQuotaInfoResponseOriginal, type GetAggregatedUsageInfoRequest as GetAggregatedUsageInfoRequestOriginal, type GetAggregatedUsageInfoResponse as GetAggregatedUsageInfoResponseOriginal, type GetAutomationActionSchemaRequest as GetAutomationActionSchemaRequestOriginal, type GetAutomationActionSchemaResponse as GetAutomationActionSchemaResponseOriginal, type GetAutomationRequest as GetAutomationRequestOriginal, type GetAutomationResponse as GetAutomationResponseOriginal, type GetAutomationRevisionRequest as GetAutomationRevisionRequestOriginal, type GetAutomationRevisionResponse as GetAutomationRevisionResponseOriginal, type GetOrCreateDraftAutomationRequest as GetOrCreateDraftAutomationRequestOriginal, type GetOrCreateDraftAutomationResponse as GetOrCreateDraftAutomationResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, Language as LanguageOriginal, type LanguageWithLiterals as LanguageWithLiteralsOriginal, type MergeOverridePreinstalledWithRuntimeVersionRequest as MergeOverridePreinstalledWithRuntimeVersionRequestOriginal, type MergeOverridePreinstalledWithRuntimeVersionResponse as MergeOverridePreinstalledWithRuntimeVersionResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type MigrateVeloActionAutomationsRequest as MigrateVeloActionAutomationsRequestOriginal, type MigrateVeloActionAutomationsResponse as MigrateVeloActionAutomationsResponseOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type Note as NoteOriginal, type Notes as NotesOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type Offset as OffsetOriginal, Operator as OperatorOriginal, type OperatorWithLiterals as OperatorWithLiteralsOriginal, type OriginAutomationInfo as OriginAutomationInfoOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OutputAction as OutputActionOriginal, type Path as PathOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type Plan as PlanOriginal, type Position as PositionOriginal, type PreinstalledAutomationSpecInfo as PreinstalledAutomationSpecInfoOriginal, type PreinstalledOrigin as PreinstalledOriginOriginal, type ProviderConfigurationError as ProviderConfigurationErrorOriginal, type PublishDraftAutomationRequest as PublishDraftAutomationRequestOriginal, type PublishDraftAutomationResponse as PublishDraftAutomationResponseOriginal, type QueryAutomationsRequest as QueryAutomationsRequestOriginal, type QueryAutomationsResponse as QueryAutomationsResponseOriginal, type QueryAutomationsWithDraftsRequest as QueryAutomationsWithDraftsRequestOriginal, type QueryAutomationsWithDraftsResponse as QueryAutomationsWithDraftsResponseOriginal, type QueryPreinstalledAutomationsForAppRequest as QueryPreinstalledAutomationsForAppRequestOriginal, type QueryPreinstalledAutomationsForAppResponse as QueryPreinstalledAutomationsForAppResponseOriginal, type QueryPreinstalledAutomationsRequest as QueryPreinstalledAutomationsRequestOriginal, type QueryPreinstalledAutomationsResponse as QueryPreinstalledAutomationsResponseOriginal, type QuotaInfo as QuotaInfoOriginal, type Quota as QuotaOriginal, type RateLimitAction as RateLimitActionOriginal, type RateLimit as RateLimitOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetVariablesAction as SetVariablesActionOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SplitAction as SplitActionOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, TimeUnit as TimeUnitOriginal, type TimeUnitWithLiterals as TimeUnitWithLiteralsOriginal, type TriggerConfigurationError as TriggerConfigurationErrorOriginal, TriggerErrorType as TriggerErrorTypeOriginal, type TriggerErrorTypeWithLiterals as TriggerErrorTypeWithLiteralsOriginal, type Trigger as TriggerOriginal, type TriggerUsageSummary as TriggerUsageSummaryOriginal, type TriggerValidationErrorErrorOneOf as TriggerValidationErrorErrorOneOfOriginal, type TriggerValidationError as TriggerValidationErrorOriginal, TriggerValidationErrorValidationErrorType as TriggerValidationErrorValidationErrorTypeOriginal, type TriggerValidationErrorValidationErrorTypeWithLiterals as TriggerValidationErrorValidationErrorTypeWithLiteralsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateAutomationRequest as UpdateAutomationRequestOriginal, type UpdateAutomationResponse as UpdateAutomationResponseOriginal, type UpdateDraftAutomationRequest as UpdateDraftAutomationRequestOriginal, type UpdateDraftAutomationResponse as UpdateDraftAutomationResponseOriginal, type UpdatePreinstalledAutomationRequest as UpdatePreinstalledAutomationRequestOriginal, type UpdatePreinstalledAutomationResponse as UpdatePreinstalledAutomationResponseOriginal, type UpdatedWithPreviousEntity as UpdatedWithPreviousEntityOriginal, type UpgradeCTA as UpgradeCTAOriginal, type ValidateAutomationByIdRequest as ValidateAutomationByIdRequestOriginal, type ValidateAutomationByIdResponse as ValidateAutomationByIdResponseOriginal, type ValidateAutomationRequest as ValidateAutomationRequestOriginal, type ValidateAutomationResponse as ValidateAutomationResponseOriginal, ValidationErrorSeverity as ValidationErrorSeverityOriginal, type ValidationErrorSeverityWithLiterals as ValidationErrorSeverityWithLiteralsOriginal, ValidationErrorType as ValidationErrorTypeOriginal, type ValidationErrorTypeWithLiterals as ValidationErrorTypeWithLiteralsOriginal, ValidationResultStatus as ValidationResultStatusOriginal, type ValidationResultStatusWithLiterals as ValidationResultStatusWithLiteralsOriginal, type ValidationSettings as ValidationSettingsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCountAutomationsWithDrafts, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAggregatedUsageInfo, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };
|