@wix/himalaya-cli 0.1074.0 → 0.1076.0
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/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/automations-v1/src/index.d.ts +1 -1
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/billing-tax-v1/src/index.d.ts +1 -1
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/business-tools-v1/src/index.d.ts +27 -10
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/comments-v1/src/index.d.ts +243 -3
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/data-collections-v1/src/index.d.ts +151 -19
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/donations/src/index.d.ts +10 -17
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/email-marketing-v1/src/index.d.ts +136 -20
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/faq-v2/src/index.d.ts +39 -28
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/gift-cards/src/index.d.ts +28 -17
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/redirects-v1/src/index.d.ts +2 -7
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/seo-v1/src/index.d.ts +0 -6
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/workflows-v1/src/index.d.ts +5 -0
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-business-tools.mjs +9 -0
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-comments.mjs +53 -5
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-data-collections.mjs +40 -0
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-donations.mjs +9 -0
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-email-marketing.mjs +90 -0
- package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-faq.mjs +10 -0
- package/dist/cli.mjs +20 -6
- package/guides/sdk-reference.json +744 -391
- package/package.json +2 -2
- package/templates/beauty-salon-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/community-club-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/events-meetups-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/gym-fitness-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/nonprofit-cause-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/owner-lite/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/podcast-creator-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/portfolio-creative-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/restaurant-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/retail-store-owner/tier5-src/_shared/owner-module-data.ts +6 -2
- package/templates/yoga-studio-owner/tier5-src/_shared/owner-module-data.ts +6 -2
|
@@ -48,6 +48,7 @@ export interface WixDataCollection {
|
|
|
48
48
|
pagingModes?: string[];
|
|
49
49
|
createdDate?: string;
|
|
50
50
|
updatedDate?: string;
|
|
51
|
+
deprecation?: WixDeprecation;
|
|
51
52
|
}
|
|
52
53
|
export interface WixSort {
|
|
53
54
|
fieldKey?: string;
|
|
@@ -153,7 +154,7 @@ export interface Wix_Object {
|
|
|
153
154
|
}
|
|
154
155
|
export interface Wix_Array {
|
|
155
156
|
elementType?: string;
|
|
156
|
-
typeMetadata?:
|
|
157
|
+
typeMetadata?: WixTypeMetadata;
|
|
157
158
|
}
|
|
158
159
|
export interface WixPageLink {
|
|
159
160
|
calculator?: WixCalculator;
|
|
@@ -396,6 +397,10 @@ export interface WixAllowedDataPermissions {
|
|
|
396
397
|
itemUpdate?: boolean;
|
|
397
398
|
itemRemove?: boolean;
|
|
398
399
|
}
|
|
400
|
+
export interface WixDeprecation {
|
|
401
|
+
deprecated?: boolean;
|
|
402
|
+
deprecationMessage?: string;
|
|
403
|
+
}
|
|
399
404
|
export interface WixDataCollectionClonedEvent {
|
|
400
405
|
originInstanceId?: string;
|
|
401
406
|
originId?: string;
|
|
@@ -547,6 +552,87 @@ export interface WixDeleteDataCollectionPluginRequest {
|
|
|
547
552
|
export interface WixDeleteDataCollectionPluginResponse {
|
|
548
553
|
dataCollection?: WixDataCollection;
|
|
549
554
|
}
|
|
555
|
+
export interface WixAddPublishPluginRequest {
|
|
556
|
+
dataCollectionId?: string;
|
|
557
|
+
publishOptions?: WixPublishPluginOptions;
|
|
558
|
+
draftItemsPluginConflictAction?: string;
|
|
559
|
+
}
|
|
560
|
+
export interface WixAddPublishPluginResponse {
|
|
561
|
+
dataCollection?: WixDataCollection;
|
|
562
|
+
}
|
|
563
|
+
export interface WixDeletePublishPluginRequest {
|
|
564
|
+
dataCollectionId?: string;
|
|
565
|
+
}
|
|
566
|
+
export interface WixDeletePublishPluginResponse {
|
|
567
|
+
dataCollection?: WixDataCollection;
|
|
568
|
+
}
|
|
569
|
+
export interface WixAddUrlizedPluginRequest {
|
|
570
|
+
dataCollectionId?: string;
|
|
571
|
+
urlizedOptions?: WixUrlizedPluginOptions;
|
|
572
|
+
}
|
|
573
|
+
export interface WixAddUrlizedPluginResponse {
|
|
574
|
+
dataCollection?: WixDataCollection;
|
|
575
|
+
}
|
|
576
|
+
export interface WixDeleteUrlizedPluginRequest {
|
|
577
|
+
dataCollectionId?: string;
|
|
578
|
+
}
|
|
579
|
+
export interface WixDeleteUrlizedPluginResponse {
|
|
580
|
+
dataCollection?: WixDataCollection;
|
|
581
|
+
}
|
|
582
|
+
export interface WixAddMultilingualPluginRequest {
|
|
583
|
+
dataCollectionId?: string;
|
|
584
|
+
multilingualOptions?: WixMultilingualOptions;
|
|
585
|
+
}
|
|
586
|
+
export interface WixAddMultilingualPluginResponse {
|
|
587
|
+
dataCollection?: WixDataCollection;
|
|
588
|
+
}
|
|
589
|
+
export interface WixDeleteMultilingualPluginRequest {
|
|
590
|
+
dataCollectionId?: string;
|
|
591
|
+
}
|
|
592
|
+
export interface WixDeleteMultilingualPluginResponse {
|
|
593
|
+
dataCollection?: WixDataCollection;
|
|
594
|
+
}
|
|
595
|
+
export interface WixAddCmsPluginRequest {
|
|
596
|
+
dataCollectionId?: string;
|
|
597
|
+
cmsOptions?: WixPluginCmsOptions;
|
|
598
|
+
}
|
|
599
|
+
export interface WixAddCmsPluginResponse {
|
|
600
|
+
dataCollection?: WixDataCollection;
|
|
601
|
+
}
|
|
602
|
+
export interface WixDeleteCmsPluginRequest {
|
|
603
|
+
dataCollectionId?: string;
|
|
604
|
+
}
|
|
605
|
+
export interface WixDeleteCmsPluginResponse {
|
|
606
|
+
dataCollection?: WixDataCollection;
|
|
607
|
+
}
|
|
608
|
+
export interface WixAddCatalogPluginRequest {
|
|
609
|
+
dataCollectionId?: string;
|
|
610
|
+
catalogOptions?: WixCatalogOptions;
|
|
611
|
+
}
|
|
612
|
+
export interface WixAddCatalogPluginResponse {
|
|
613
|
+
dataCollection?: WixDataCollection;
|
|
614
|
+
}
|
|
615
|
+
export interface WixDeleteCatalogPluginRequest {
|
|
616
|
+
dataCollectionId?: string;
|
|
617
|
+
}
|
|
618
|
+
export interface WixDeleteCatalogPluginResponse {
|
|
619
|
+
dataCollection?: WixDataCollection;
|
|
620
|
+
}
|
|
621
|
+
export interface WixAddDraftItemsPluginRequest {
|
|
622
|
+
dataCollectionId?: string;
|
|
623
|
+
draftItemsOptions?: WixDraftItemsPluginOptions;
|
|
624
|
+
publishPluginConflictAction?: string;
|
|
625
|
+
}
|
|
626
|
+
export interface WixAddDraftItemsPluginResponse {
|
|
627
|
+
dataCollection?: WixDataCollection;
|
|
628
|
+
}
|
|
629
|
+
export interface WixDeleteDraftItemsPluginRequest {
|
|
630
|
+
dataCollectionId?: string;
|
|
631
|
+
draftItemsRemovalAction?: string;
|
|
632
|
+
}
|
|
633
|
+
export interface WixDeleteDraftItemsPluginResponse {
|
|
634
|
+
dataCollection?: WixDataCollection;
|
|
635
|
+
}
|
|
550
636
|
export interface WixPatchDataCollectionFieldRequest {
|
|
551
637
|
dataCollectionId?: string;
|
|
552
638
|
field?: WixField;
|
|
@@ -735,6 +821,7 @@ export interface WixPatchDataCollection {
|
|
|
735
821
|
pagingModes?: string[];
|
|
736
822
|
createdDate?: string;
|
|
737
823
|
updatedDate?: string;
|
|
824
|
+
deprecation?: WixDeprecation;
|
|
738
825
|
}
|
|
739
826
|
export interface WixCreateDataCollectionFieldOptions {
|
|
740
827
|
field?: WixField;
|
|
@@ -751,6 +838,29 @@ export interface WixAddDataCollectionPluginOptions {
|
|
|
751
838
|
export interface WixDeleteDataCollectionPluginOptions {
|
|
752
839
|
pluginType?: string;
|
|
753
840
|
}
|
|
841
|
+
export interface WixAddPublishPluginOptions {
|
|
842
|
+
publishOptions?: WixPublishPluginOptions;
|
|
843
|
+
draftItemsPluginConflictAction?: string;
|
|
844
|
+
}
|
|
845
|
+
export interface WixAddUrlizedPluginOptions {
|
|
846
|
+
urlizedOptions?: WixUrlizedPluginOptions;
|
|
847
|
+
}
|
|
848
|
+
export interface WixAddMultilingualPluginOptions {
|
|
849
|
+
multilingualOptions?: WixMultilingualOptions;
|
|
850
|
+
}
|
|
851
|
+
export interface WixAddCmsPluginOptions {
|
|
852
|
+
cmsOptions?: WixPluginCmsOptions;
|
|
853
|
+
}
|
|
854
|
+
export interface WixAddCatalogPluginOptions {
|
|
855
|
+
catalogOptions?: WixCatalogOptions;
|
|
856
|
+
}
|
|
857
|
+
export interface WixAddDraftItemsPluginOptions {
|
|
858
|
+
draftItemsOptions?: WixDraftItemsPluginOptions;
|
|
859
|
+
publishPluginConflictAction?: string;
|
|
860
|
+
}
|
|
861
|
+
export interface WixDeleteDraftItemsPluginOptions {
|
|
862
|
+
draftItemsRemovalAction?: string;
|
|
863
|
+
}
|
|
754
864
|
export interface WixCreateIndexRequest {
|
|
755
865
|
index?: WixIndex;
|
|
756
866
|
dataCollectionId?: string;
|
|
@@ -823,12 +933,6 @@ export interface WixIndexUpdatedEnvelope {
|
|
|
823
933
|
export interface WixListIndexesOptions {
|
|
824
934
|
paging?: WixPaging;
|
|
825
935
|
}
|
|
826
|
-
export interface WixCreateIndexSignature {
|
|
827
|
-
}
|
|
828
|
-
export interface WixDropIndexSignature {
|
|
829
|
-
}
|
|
830
|
-
export interface WixListIndexesSignature {
|
|
831
|
-
}
|
|
832
936
|
export interface WixSpecialPermissions {
|
|
833
937
|
userId?: string;
|
|
834
938
|
policyId?: string;
|
|
@@ -1063,18 +1167,6 @@ export interface WixUpdateSpecialPermissions {
|
|
|
1063
1167
|
itemUpdate?: string;
|
|
1064
1168
|
itemRemove?: string;
|
|
1065
1169
|
}
|
|
1066
|
-
export interface WixGetPermissionsSignature {
|
|
1067
|
-
}
|
|
1068
|
-
export interface WixUpdatePermissionsSignature {
|
|
1069
|
-
}
|
|
1070
|
-
export interface WixAddSpecialPermissionsSignature {
|
|
1071
|
-
}
|
|
1072
|
-
export interface WixUpdateSpecialPermissionsSignature {
|
|
1073
|
-
}
|
|
1074
|
-
export interface WixRemoveSpecialPermissionsSignature {
|
|
1075
|
-
}
|
|
1076
|
-
export interface WixGetMyPermissionsSignature {
|
|
1077
|
-
}
|
|
1078
1170
|
export declare function getDataCollection(dataCollectionId: string, opts?: WixCallOptions): Promise<WixGetDataCollectionResponse>;
|
|
1079
1171
|
export declare function listDataCollections(req?: WixListDataCollectionsRequest, opts?: WixCallOptions): Promise<WixListDataCollectionsResponse>;
|
|
1080
1172
|
export declare function deleteDataCollection(dataCollectionId: string, opts?: WixCallOptions): Promise<WixDeleteDataCollectionResponse>;
|
|
@@ -1082,6 +1174,46 @@ export declare function restoreDataCollection(dataCollectionId: string, req?: Wi
|
|
|
1082
1174
|
export declare function deleteDataCollectionField(req?: WixDeleteDataCollectionFieldRequest, opts?: WixCallOptions): Promise<WixDeleteDataCollectionFieldResponse>;
|
|
1083
1175
|
export declare function addDataCollectionPlugin(req?: WixAddDataCollectionPluginRequest, opts?: WixCallOptions): Promise<WixAddDataCollectionPluginResponse>;
|
|
1084
1176
|
export declare function deleteDataCollectionPlugin(req?: WixDeleteDataCollectionPluginRequest, opts?: WixCallOptions): Promise<WixDeleteDataCollectionPluginResponse>;
|
|
1177
|
+
/**
|
|
1178
|
+
* Adds a new field to the structure of a data collection.
|
|
1179
|
+
*
|
|
1180
|
+
* Wix permissions: WIX_DATA.CREATE_COLLECTION_FIELD.
|
|
1181
|
+
*
|
|
1182
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
1183
|
+
*
|
|
1184
|
+
* POST /wix-data/v2/collections/create-field
|
|
1185
|
+
*/
|
|
1186
|
+
export declare function createDataCollectionField(req?: WixCreateDataCollectionFieldRequest, opts?: WixCallOptions): Promise<WixCreateDataCollectionFieldResponse>;
|
|
1187
|
+
/**
|
|
1188
|
+
* Updates specified properties of a data collection.
|
|
1189
|
+
*
|
|
1190
|
+
* Wix permissions: WIX_DATA.UPDATE_COLLECTION.
|
|
1191
|
+
*
|
|
1192
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
1193
|
+
*
|
|
1194
|
+
* PATCH /wix-data/v2/collections/{dataCollectionId}
|
|
1195
|
+
*/
|
|
1196
|
+
export declare function patchDataCollection(dataCollectionId: string, req?: WixPatchDataCollectionRequest, opts?: WixCallOptions): Promise<WixPatchDataCollectionResponse>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Updates specified properties in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
|
|
1199
|
+
*
|
|
1200
|
+
* Wix permissions: WIX_DATA.UPDATE_COLLECTION_FIELD.
|
|
1201
|
+
*
|
|
1202
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
1203
|
+
*
|
|
1204
|
+
* PATCH /wix-data/v2/collections/{dataCollectionId}/patch-field
|
|
1205
|
+
*/
|
|
1206
|
+
export declare function patchDataCollectionField(dataCollectionId: string, req?: WixPatchDataCollectionFieldRequest, opts?: WixCallOptions): Promise<WixPatchDataCollectionFieldResponse>;
|
|
1207
|
+
/**
|
|
1208
|
+
* Updates properties in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
|
|
1209
|
+
*
|
|
1210
|
+
* Wix permissions: WIX_DATA.UPDATE_COLLECTION_FIELD.
|
|
1211
|
+
*
|
|
1212
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
1213
|
+
*
|
|
1214
|
+
* POST /wix-data/v2/collections/update-field
|
|
1215
|
+
*/
|
|
1216
|
+
export declare function updateDataCollectionField(req?: WixUpdateDataCollectionFieldRequest, opts?: WixCallOptions): Promise<WixUpdateDataCollectionFieldResponse>;
|
|
1085
1217
|
export declare function createIndex(req?: WixCreateIndexRequest, opts?: WixCallOptions): Promise<WixCreateIndexResponse>;
|
|
1086
1218
|
export declare function dropIndex(req?: WixDropIndexRequest, opts?: WixCallOptions): Promise<WixDropIndexResponse>;
|
|
1087
1219
|
export declare function listIndexes(req?: WixListIndexesRequest, opts?: WixCallOptions): Promise<WixListIndexesResponse>;
|
|
@@ -351,7 +351,6 @@ export interface WixDonationCampaignsQueryBuilder {
|
|
|
351
351
|
le?: unknown;
|
|
352
352
|
lt?: unknown;
|
|
353
353
|
startsWith?: unknown;
|
|
354
|
-
hasSome?: unknown;
|
|
355
354
|
in?: unknown;
|
|
356
355
|
exists?: unknown;
|
|
357
356
|
ascending?: unknown;
|
|
@@ -378,22 +377,6 @@ export interface WixBulkUpdateDonationCampaignTagsByFilterOptions {
|
|
|
378
377
|
assignTags?: WixTags;
|
|
379
378
|
unassignTags?: WixTags;
|
|
380
379
|
}
|
|
381
|
-
export interface WixCreateDonationCampaignSignature {
|
|
382
|
-
}
|
|
383
|
-
export interface WixGetDonationCampaignSignature {
|
|
384
|
-
}
|
|
385
|
-
export interface WixUpdateDonationCampaignSignature {
|
|
386
|
-
}
|
|
387
|
-
export interface WixBulkCreateDonationCampaignsSignature {
|
|
388
|
-
}
|
|
389
|
-
export interface WixBulkUpdateDonationCampaignsSignature {
|
|
390
|
-
}
|
|
391
|
-
export interface WixGetDonationCampaignMetricsSignature {
|
|
392
|
-
}
|
|
393
|
-
export interface WixBulkUpdateDonationCampaignTagsSignature {
|
|
394
|
-
}
|
|
395
|
-
export interface WixBulkUpdateDonationCampaignTagsByFilterSignature {
|
|
396
|
-
}
|
|
397
380
|
export declare function createDonationCampaign(req?: WixCreateDonationCampaignRequest, opts?: WixCallOptions): Promise<WixCreateDonationCampaignResponse>;
|
|
398
381
|
export declare function getDonationCampaign(donationCampaignId: string, opts?: WixCallOptions): Promise<WixGetDonationCampaignResponse>;
|
|
399
382
|
export declare function updateDonationCampaign(donationCampaignId: string, req?: WixUpdateDonationCampaignRequest, opts?: WixCallOptions): Promise<WixUpdateDonationCampaignResponse>;
|
|
@@ -402,4 +385,14 @@ export declare function getDonationCampaignMetrics(donationCampaignId: string, o
|
|
|
402
385
|
export declare function bulkCreateDonationCampaigns(req?: WixBulkCreateDonationCampaignsRequest, opts?: WixCallOptions): Promise<WixBulkCreateDonationCampaignsResponse>;
|
|
403
386
|
export declare function bulkUpdateDonationCampaignTags(req?: WixBulkUpdateDonationCampaignTagsRequest, opts?: WixCallOptions): Promise<WixBulkUpdateDonationCampaignTagsResponse>;
|
|
404
387
|
export declare function bulkUpdateDonationCampaignTagsByFilter(req?: WixBulkUpdateDonationCampaignTagsByFilterRequest, opts?: WixCallOptions): Promise<WixBulkUpdateDonationCampaignTagsByFilterResponse>;
|
|
388
|
+
/**
|
|
389
|
+
* Updates multiple donation campaigns in a single request.
|
|
390
|
+
*
|
|
391
|
+
* Wix permissions: WIX_DONATIONS.DONATION_CAMPAIGN_UPDATE.
|
|
392
|
+
*
|
|
393
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
394
|
+
*
|
|
395
|
+
* POST /donation-campaigns/v2/bulk/donation-campaigns/update
|
|
396
|
+
*/
|
|
397
|
+
export declare function bulkUpdateDonationCampaigns(req?: WixBulkUpdateDonationCampaignsRequest, opts?: WixCallOptions): Promise<WixBulkUpdateDonationCampaignsResponse>;
|
|
405
398
|
export * from "./extensions.js";
|
|
@@ -48,6 +48,7 @@ export interface WixPublishingData {
|
|
|
48
48
|
landingPageUrl?: string;
|
|
49
49
|
statistics?: WixCampaignStatistics;
|
|
50
50
|
datePublished?: string;
|
|
51
|
+
wasResentToNonOpeners?: boolean;
|
|
51
52
|
}
|
|
52
53
|
export interface WixCampaignStatistics {
|
|
53
54
|
landingPage?: WixLandingPageStatistics;
|
|
@@ -195,8 +196,9 @@ export interface WixEmailDistributionOptions {
|
|
|
195
196
|
emailSubject?: string;
|
|
196
197
|
labelIds?: string[];
|
|
197
198
|
contactIds?: string[];
|
|
198
|
-
filterIds?: string[];
|
|
199
199
|
sendAt?: string;
|
|
200
|
+
segmentIds?: string[];
|
|
201
|
+
activeContactsOnly?: boolean;
|
|
200
202
|
}
|
|
201
203
|
export interface WixPublishCampaignResponse {
|
|
202
204
|
publishingData?: WixPublishingData;
|
|
@@ -371,9 +373,7 @@ export interface WixReuseCampaignResponse {
|
|
|
371
373
|
}
|
|
372
374
|
export interface WixPreviewCampaignRequest {
|
|
373
375
|
campaignId?: string;
|
|
374
|
-
language?: string;
|
|
375
376
|
placeholders?: Record<string, unknown>;
|
|
376
|
-
forceHideAd?: boolean;
|
|
377
377
|
removeMissingPlaceholders?: boolean;
|
|
378
378
|
}
|
|
379
379
|
export interface WixPreviewCampaignResponse {
|
|
@@ -382,7 +382,6 @@ export interface WixPreviewCampaignResponse {
|
|
|
382
382
|
}
|
|
383
383
|
export interface WixGetComposerRequest {
|
|
384
384
|
campaignId?: string;
|
|
385
|
-
language?: string;
|
|
386
385
|
}
|
|
387
386
|
export interface WixGetComposerResponse {
|
|
388
387
|
composer?: WixComposer;
|
|
@@ -399,7 +398,6 @@ export interface WixDefaultValues {
|
|
|
399
398
|
export interface WixUpdateComposerRequest {
|
|
400
399
|
campaignId?: string;
|
|
401
400
|
composer?: WixComposer;
|
|
402
|
-
campaignEditorType?: WixCampaignEditorType;
|
|
403
401
|
emailSubject?: string;
|
|
404
402
|
emailPreheader?: string;
|
|
405
403
|
}
|
|
@@ -417,6 +415,7 @@ export interface WixCreateCampaignResponse {
|
|
|
417
415
|
export interface WixResendToNonOpenersRequest {
|
|
418
416
|
campaignId?: string;
|
|
419
417
|
emailSubject?: string;
|
|
418
|
+
sendAt?: string;
|
|
420
419
|
}
|
|
421
420
|
export interface WixResendToNonOpenersResponse {
|
|
422
421
|
campaignId?: string;
|
|
@@ -588,6 +587,13 @@ export interface WixGetCampaignMappingRequest {
|
|
|
588
587
|
export interface WixGetCampaignMappingResponse {
|
|
589
588
|
campaignId?: string;
|
|
590
589
|
}
|
|
590
|
+
export interface WixLookupCampaignMappingRequest {
|
|
591
|
+
automationRuleId?: string;
|
|
592
|
+
templateId?: string;
|
|
593
|
+
}
|
|
594
|
+
export interface WixLookupCampaignMappingResponse {
|
|
595
|
+
campaignId?: string;
|
|
596
|
+
}
|
|
591
597
|
export interface WixUpsertTranslationRequest {
|
|
592
598
|
campaignId?: string;
|
|
593
599
|
composer?: WixComposer;
|
|
@@ -605,13 +611,6 @@ export interface WixGetUsedPlaceholderKeysRequest {
|
|
|
605
611
|
export interface WixGetUsedPlaceholderKeysResponse {
|
|
606
612
|
placeholderKeys?: string[];
|
|
607
613
|
}
|
|
608
|
-
export interface WixLookupCampaignMappingRequest {
|
|
609
|
-
automationRuleId?: string;
|
|
610
|
-
templateId?: string;
|
|
611
|
-
}
|
|
612
|
-
export interface WixLookupCampaignMappingResponse {
|
|
613
|
-
campaignId?: string;
|
|
614
|
-
}
|
|
615
614
|
export interface WixUpsertAutomationTranslatorContentRequest {
|
|
616
615
|
campaignId?: string;
|
|
617
616
|
automationTranslatorContent?: WixAutomationTranslatorContent;
|
|
@@ -628,6 +627,12 @@ export interface WixGetAutomationTranslatorContentRequest {
|
|
|
628
627
|
export interface WixGetAutomationTranslatorContentResponse {
|
|
629
628
|
automationTranslatorContent?: WixAutomationTranslatorContent;
|
|
630
629
|
}
|
|
630
|
+
export interface WixUpsertTranslatorContentIdRequest {
|
|
631
|
+
messageId?: string;
|
|
632
|
+
translatorContentId?: string;
|
|
633
|
+
}
|
|
634
|
+
export interface WixUpsertTranslatorContentIdResponse {
|
|
635
|
+
}
|
|
631
636
|
export interface WixSendTestBulkRequest {
|
|
632
637
|
campaignId?: string;
|
|
633
638
|
toEmailAddress?: string;
|
|
@@ -638,6 +643,17 @@ export interface WixSendTestBulkRequest {
|
|
|
638
643
|
}
|
|
639
644
|
export interface WixSendTestBulkResponse {
|
|
640
645
|
}
|
|
646
|
+
export interface WixConvertAutomationToMjmlRequest {
|
|
647
|
+
campaignId?: string;
|
|
648
|
+
}
|
|
649
|
+
export interface WixConvertAutomationToMjmlResponse {
|
|
650
|
+
}
|
|
651
|
+
export interface WixCreateAutomationFromCampaignRequest {
|
|
652
|
+
sourceCampaignId?: string;
|
|
653
|
+
}
|
|
654
|
+
export interface WixCreateAutomationFromCampaignResponse {
|
|
655
|
+
campaignId?: string;
|
|
656
|
+
}
|
|
641
657
|
export interface WixBaseEventMetadata {
|
|
642
658
|
instanceId?: string;
|
|
643
659
|
eventType?: string;
|
|
@@ -714,6 +730,24 @@ export interface WixSendTestOptions {
|
|
|
714
730
|
emailSubject?: string;
|
|
715
731
|
toEmailAddress?: string;
|
|
716
732
|
}
|
|
733
|
+
export interface WixPreviewOptions {
|
|
734
|
+
placeholders?: Record<string, unknown>;
|
|
735
|
+
removeMissingPlaceholders?: boolean;
|
|
736
|
+
}
|
|
737
|
+
export interface WixUpdateComposerOptions {
|
|
738
|
+
composer?: WixComposer;
|
|
739
|
+
emailSubject?: string;
|
|
740
|
+
emailPreheader?: string;
|
|
741
|
+
}
|
|
742
|
+
export interface WixCreateOptions {
|
|
743
|
+
campaignEditorType?: WixCampaignEditorType;
|
|
744
|
+
emailSubject?: string;
|
|
745
|
+
emailPreheader?: string;
|
|
746
|
+
}
|
|
747
|
+
export interface WixResendToNonOpenersOptions {
|
|
748
|
+
emailSubject?: string;
|
|
749
|
+
sendAt?: string;
|
|
750
|
+
}
|
|
717
751
|
export interface WixSenderDetails {
|
|
718
752
|
fromName?: string;
|
|
719
753
|
fromEmail?: string;
|
|
@@ -745,14 +779,6 @@ export interface WixSenderDetailsUpdatedEnvelope {
|
|
|
745
779
|
entity?: WixSenderDetails;
|
|
746
780
|
metadata?: WixEventMetadata;
|
|
747
781
|
}
|
|
748
|
-
export interface WixGetSenderDetailsSignature {
|
|
749
|
-
}
|
|
750
|
-
export interface WixUpdateSenderDetailsSignature {
|
|
751
|
-
}
|
|
752
|
-
export interface WixVerifyEmailSignature {
|
|
753
|
-
}
|
|
754
|
-
export interface WixResolveActualFromAddressSignature {
|
|
755
|
-
}
|
|
756
782
|
export interface WixGetResponse {
|
|
757
783
|
}
|
|
758
784
|
export interface WixUpdateResponse {
|
|
@@ -769,6 +795,96 @@ export declare function pauseScheduling(campaignId: string, req?: WixPauseSchedu
|
|
|
769
795
|
export declare function reschedule(campaignId: string, req?: WixRescheduleRequest, opts?: WixCallOptions): Promise<WixRescheduleResponse>;
|
|
770
796
|
export declare function reuse(campaignId: string, opts?: WixCallOptions): Promise<WixCampaign>;
|
|
771
797
|
export declare function getAudience(campaignId: string, req?: WixGetAudienceRequest, opts?: WixCallOptions): Promise<WixGetAudienceResponse>;
|
|
798
|
+
/**
|
|
799
|
+
* Creates a new email marketing campaign from editor data.
|
|
800
|
+
*
|
|
801
|
+
* Wix permissions: shoutout.manage.
|
|
802
|
+
*
|
|
803
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
804
|
+
*
|
|
805
|
+
* POST /email-marketing/v1/campaigns
|
|
806
|
+
*/
|
|
807
|
+
export declare function create(req?: WixCreateCampaignRequest, opts?: WixCallOptions): Promise<WixCreateCampaignResponse>;
|
|
808
|
+
/**
|
|
809
|
+
* Permanently deletes a campaign.
|
|
810
|
+
*
|
|
811
|
+
* Wix permissions: shoutout.manage.
|
|
812
|
+
*
|
|
813
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
814
|
+
*
|
|
815
|
+
* DELETE /email-marketing/v1/campaigns/{campaignId}
|
|
816
|
+
*/
|
|
817
|
+
export declare function deleteCampaign(campaignId: string, opts?: WixCallOptions): Promise<WixDeleteCampaignResponse>;
|
|
818
|
+
/**
|
|
819
|
+
* Retrieves information about an email campaign.
|
|
820
|
+
*
|
|
821
|
+
* Wix permissions: shoutout.manage.
|
|
822
|
+
*
|
|
823
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
824
|
+
*
|
|
825
|
+
* GET /email-marketing/v1/campaigns/{campaignId}
|
|
826
|
+
*/
|
|
827
|
+
export declare function getCampaign(campaignId: string, opts?: WixCallOptions): Promise<WixGetCampaignResponse>;
|
|
828
|
+
/**
|
|
829
|
+
* Retrieves a campaign's editor data, including the content and subject line.
|
|
830
|
+
*
|
|
831
|
+
* Wix permissions: shoutout.manage.
|
|
832
|
+
*
|
|
833
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
834
|
+
*
|
|
835
|
+
* GET /email-marketing/v1/campaigns/{campaignId}/composer
|
|
836
|
+
*/
|
|
837
|
+
export declare function getComposer(campaignId: string, opts?: WixCallOptions): Promise<WixGetComposerResponse>;
|
|
838
|
+
/**
|
|
839
|
+
* Builds an HTML preview of the campaign. Use this to display what the email will look like before publishing.
|
|
840
|
+
*
|
|
841
|
+
* Wix permissions: shoutout.manage.
|
|
842
|
+
*
|
|
843
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
844
|
+
*
|
|
845
|
+
* POST /email-marketing/v1/campaigns/{campaignId}/preview
|
|
846
|
+
*/
|
|
847
|
+
export declare function preview(campaignId: string, req?: WixPreviewCampaignRequest, opts?: WixCallOptions): Promise<WixPreviewCampaignResponse>;
|
|
848
|
+
/**
|
|
849
|
+
* Publishes and sends a specified campaign.
|
|
850
|
+
*
|
|
851
|
+
* Wix permissions: shoutout.manage.
|
|
852
|
+
*
|
|
853
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
854
|
+
*
|
|
855
|
+
* POST /email-marketing/v1/campaigns/{campaignId}/publish
|
|
856
|
+
*/
|
|
857
|
+
export declare function publishCampaign(campaignId: string, req?: WixPublishCampaignRequest, opts?: WixCallOptions): Promise<WixPublishCampaignResponse>;
|
|
858
|
+
/**
|
|
859
|
+
* Resends a copy of the campaign to recipients who didn't open the original. Optionally, a different subject line can be used to improve open rates.
|
|
860
|
+
*
|
|
861
|
+
* Wix permissions: shoutout.manage.
|
|
862
|
+
*
|
|
863
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
864
|
+
*
|
|
865
|
+
* POST /email-marketing/v1/campaigns/{campaignId}/resend
|
|
866
|
+
*/
|
|
867
|
+
export declare function resendToNonOpeners(campaignId: string, req?: WixResendToNonOpenersRequest, opts?: WixCallOptions): Promise<WixResendToNonOpenersResponse>;
|
|
868
|
+
/**
|
|
869
|
+
* Creates a copy of an existing campaign.
|
|
870
|
+
*
|
|
871
|
+
* Wix permissions: shoutout.manage.
|
|
872
|
+
*
|
|
873
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
874
|
+
*
|
|
875
|
+
* POST /email-marketing/v1/campaigns/{campaignId}/reuse
|
|
876
|
+
*/
|
|
877
|
+
export declare function reuseCampaign(campaignId: string, req?: WixReuseCampaignRequest, opts?: WixCallOptions): Promise<WixReuseCampaignResponse>;
|
|
878
|
+
/**
|
|
879
|
+
* Updates a campaign's editor data, including the content and subject line.
|
|
880
|
+
*
|
|
881
|
+
* Wix permissions: shoutout.manage.
|
|
882
|
+
*
|
|
883
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
884
|
+
*
|
|
885
|
+
* POST /email-marketing/v1/campaigns/{campaignId}/composer
|
|
886
|
+
*/
|
|
887
|
+
export declare function updateComposer(campaignId: string, req?: WixUpdateComposerRequest, opts?: WixCallOptions): Promise<WixUpdateComposerResponse>;
|
|
772
888
|
export declare function identifySenderAddress(req?: WixIdentifySenderAddressRequest, opts?: WixCallOptions): Promise<WixIdentifySenderAddressResponse>;
|
|
773
889
|
export declare function validateLink(req?: WixValidateLinkRequest, opts?: WixCallOptions): Promise<WixValidateLinkResponse>;
|
|
774
890
|
export declare function validateHtmlLinks(req?: WixValidateHtmlLinksRequest, opts?: WixCallOptions): Promise<WixValidateHtmlLinksResponse>;
|
|
@@ -266,18 +266,6 @@ export interface WixCategoryQuerySpec {
|
|
|
266
266
|
export interface WixUpdateExtendedFieldsOptions {
|
|
267
267
|
namespaceData?: Record<string, unknown>;
|
|
268
268
|
}
|
|
269
|
-
export interface WixCreateCategorySignature {
|
|
270
|
-
}
|
|
271
|
-
export interface WixGetCategorySignature {
|
|
272
|
-
}
|
|
273
|
-
export interface WixUpdateCategorySignature {
|
|
274
|
-
}
|
|
275
|
-
export interface WixDeleteCategorySignature {
|
|
276
|
-
}
|
|
277
|
-
export interface WixListCategoriesSignature {
|
|
278
|
-
}
|
|
279
|
-
export interface WixUpdateExtendedFieldsSignature {
|
|
280
|
-
}
|
|
281
269
|
export interface WixQuestionEntry {
|
|
282
270
|
draftjs?: string;
|
|
283
271
|
richContent?: WixRichContent;
|
|
@@ -341,6 +329,7 @@ export interface WixNode {
|
|
|
341
329
|
smartBlockCellData?: WixSmartBlockCellData;
|
|
342
330
|
checkboxListData?: WixCheckboxListData;
|
|
343
331
|
listItemData?: WixListItemNodeData;
|
|
332
|
+
slotData?: WixSlotData;
|
|
344
333
|
type?: string;
|
|
345
334
|
id?: string;
|
|
346
335
|
nodes?: WixNode[];
|
|
@@ -382,6 +371,7 @@ export interface WixNodeDataOneOf {
|
|
|
382
371
|
smartBlockCellData?: WixSmartBlockCellData;
|
|
383
372
|
checkboxListData?: WixCheckboxListData;
|
|
384
373
|
listItemData?: WixListItemNodeData;
|
|
374
|
+
slotData?: WixSlotData;
|
|
385
375
|
}
|
|
386
376
|
export interface WixNodeStyle {
|
|
387
377
|
paddingTop?: string;
|
|
@@ -838,6 +828,13 @@ export interface WixAnchorData {
|
|
|
838
828
|
export interface WixColorData {
|
|
839
829
|
background?: string;
|
|
840
830
|
foreground?: string;
|
|
831
|
+
foregroundStyle?: WixColorDataBackground;
|
|
832
|
+
backgroundStyle?: WixColorDataBackground;
|
|
833
|
+
}
|
|
834
|
+
export interface WixColorDataBackground {
|
|
835
|
+
type?: string;
|
|
836
|
+
color?: string;
|
|
837
|
+
gradient?: WixGradient;
|
|
841
838
|
}
|
|
842
839
|
export interface WixLinkData {
|
|
843
840
|
link?: WixLink;
|
|
@@ -1193,6 +1190,26 @@ export interface WixListItemNodeData {
|
|
|
1193
1190
|
checked?: boolean;
|
|
1194
1191
|
animation?: WixAnimation;
|
|
1195
1192
|
}
|
|
1193
|
+
export interface WixSlotData {
|
|
1194
|
+
integrationType?: string;
|
|
1195
|
+
resourceId?: string;
|
|
1196
|
+
animation?: WixAnimation;
|
|
1197
|
+
design?: WixSlotDesign;
|
|
1198
|
+
}
|
|
1199
|
+
export interface WixSlotDesign {
|
|
1200
|
+
textColor?: string;
|
|
1201
|
+
accentColor?: string;
|
|
1202
|
+
buttonColor?: string;
|
|
1203
|
+
buttonTextColor?: string;
|
|
1204
|
+
backgroundColor?: string;
|
|
1205
|
+
borderColor?: string;
|
|
1206
|
+
borderWidth?: number;
|
|
1207
|
+
borderRadius?: number;
|
|
1208
|
+
paddingHorizontal?: number;
|
|
1209
|
+
paddingVertical?: number;
|
|
1210
|
+
rowGap?: number;
|
|
1211
|
+
columnGap?: number;
|
|
1212
|
+
}
|
|
1196
1213
|
export interface WixMetadata {
|
|
1197
1214
|
version?: number;
|
|
1198
1215
|
createdTimestamp?: string;
|
|
@@ -1552,28 +1569,22 @@ export interface WixBulkUpdateQuestionEntryOptions {
|
|
|
1552
1569
|
questionEntries?: WixMaskedQuestionEntry[];
|
|
1553
1570
|
returnFullEntity?: boolean;
|
|
1554
1571
|
}
|
|
1555
|
-
export interface WixCreateQuestionEntrySignature {
|
|
1556
|
-
}
|
|
1557
|
-
export interface WixGetQuestionEntrySignature {
|
|
1558
|
-
}
|
|
1559
|
-
export interface WixUpdateQuestionEntrySignature {
|
|
1560
|
-
}
|
|
1561
|
-
export interface WixDeleteQuestionEntrySignature {
|
|
1562
|
-
}
|
|
1563
|
-
export interface WixListQuestionEntriesSignature {
|
|
1564
|
-
}
|
|
1565
|
-
export interface WixBulkDeleteQuestionEntriesSignature {
|
|
1566
|
-
}
|
|
1567
|
-
export interface WixSetQuestionEntryLabelsSignature {
|
|
1568
|
-
}
|
|
1569
|
-
export interface WixBulkUpdateQuestionEntrySignature {
|
|
1570
|
-
}
|
|
1571
1572
|
export declare function createCategory(req?: WixCreateCategoryRequest, opts?: WixCallOptions): Promise<WixCreateCategoryResponse>;
|
|
1572
1573
|
export declare function getCategory(categoryId: string, opts?: WixCallOptions): Promise<WixGetCategoryResponse>;
|
|
1573
1574
|
export declare function updateCategory(categoryId: string, req?: WixUpdateCategoryRequest, opts?: WixCallOptions): Promise<WixUpdateCategoryResponse>;
|
|
1574
1575
|
export declare function deleteCategory(categoryId: string, opts?: WixCallOptions): Promise<WixDeleteCategoryResponse>;
|
|
1575
1576
|
export declare function listCategories(req?: WixListCategoriesRequest, opts?: WixCallOptions): Promise<WixListCategoriesResponse>;
|
|
1576
1577
|
export declare function queryCategories(req?: WixQueryCategoriesRequest, opts?: WixCallOptions): Promise<WixQueryCategoriesResponse>;
|
|
1578
|
+
/**
|
|
1579
|
+
* Updates extended fields of a category without incrementing `revision`.
|
|
1580
|
+
*
|
|
1581
|
+
* Wix permissions: FAQ.UPDATE_CATEGORY.
|
|
1582
|
+
*
|
|
1583
|
+
* @scope owner — requires an owner / business identity — a visitor session gets 403.
|
|
1584
|
+
*
|
|
1585
|
+
* POST /faq/v2/categories/{id}/update-extended-fields
|
|
1586
|
+
*/
|
|
1587
|
+
export declare function updateExtendedFields(id: string, req?: WixUpdateExtendedFieldsRequest, opts?: WixCallOptions): Promise<WixUpdateExtendedFieldsResponse>;
|
|
1577
1588
|
export declare function createQuestionEntry(req?: WixCreateQuestionEntryRequest, opts?: WixCallOptions): Promise<WixCreateQuestionEntryResponse>;
|
|
1578
1589
|
export declare function getQuestionEntry(questionEntryId: string, opts?: WixCallOptions): Promise<WixGetQuestionEntryResponse>;
|
|
1579
1590
|
export declare function updateQuestionEntry(questionEntryId: string, req?: WixUpdateQuestionEntryRequest, opts?: WixCallOptions): Promise<WixUpdateQuestionEntryResponse>;
|