@wix/auto_sdk_loyalty_programs 1.0.2 → 1.0.4
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/src/loyalty-v1-program-programs.http.d.ts +3 -3
- package/build/cjs/src/loyalty-v1-program-programs.http.js +3 -3
- package/build/cjs/src/loyalty-v1-program-programs.public.d.ts +3 -3
- package/build/cjs/src/loyalty-v1-program-programs.types.d.ts +194 -44
- package/build/cjs/src/loyalty-v1-program-programs.types.js.map +1 -1
- package/build/cjs/src/loyalty-v1-program-programs.universal.d.ts +205 -49
- package/build/cjs/src/loyalty-v1-program-programs.universal.js +3 -3
- package/build/cjs/src/loyalty-v1-program-programs.universal.js.map +1 -1
- package/build/es/src/loyalty-v1-program-programs.http.d.ts +3 -3
- package/build/es/src/loyalty-v1-program-programs.http.js +3 -3
- package/build/es/src/loyalty-v1-program-programs.public.d.ts +3 -3
- package/build/es/src/loyalty-v1-program-programs.types.d.ts +194 -44
- package/build/es/src/loyalty-v1-program-programs.types.js.map +1 -1
- package/build/es/src/loyalty-v1-program-programs.universal.d.ts +205 -49
- package/build/es/src/loyalty-v1-program-programs.universal.js +3 -3
- package/build/es/src/loyalty-v1-program-programs.universal.js.map +1 -1
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.d.ts +3 -3
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.js +3 -3
- package/build/internal/cjs/src/loyalty-v1-program-programs.public.d.ts +3 -3
- package/build/internal/cjs/src/loyalty-v1-program-programs.types.d.ts +194 -44
- package/build/internal/cjs/src/loyalty-v1-program-programs.types.js.map +1 -1
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.d.ts +205 -49
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.js +3 -3
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.js.map +1 -1
- package/build/internal/es/src/loyalty-v1-program-programs.http.d.ts +3 -3
- package/build/internal/es/src/loyalty-v1-program-programs.http.js +3 -3
- package/build/internal/es/src/loyalty-v1-program-programs.public.d.ts +3 -3
- package/build/internal/es/src/loyalty-v1-program-programs.types.d.ts +194 -44
- package/build/internal/es/src/loyalty-v1-program-programs.types.js.map +1 -1
- package/build/internal/es/src/loyalty-v1-program-programs.universal.d.ts +205 -49
- package/build/internal/es/src/loyalty-v1-program-programs.universal.js +3 -3
- package/build/internal/es/src/loyalty-v1-program-programs.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -4,7 +4,11 @@
|
|
|
4
4
|
* [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
|
|
5
5
|
*/
|
|
6
6
|
export interface LoyaltyProgram {
|
|
7
|
-
/**
|
|
7
|
+
/**
|
|
8
|
+
* Program name.
|
|
9
|
+
* @minLength 2
|
|
10
|
+
* @maxLength 50
|
|
11
|
+
*/
|
|
8
12
|
name?: string | null;
|
|
9
13
|
/** Information about the program's collectible entity. */
|
|
10
14
|
pointDefinition?: PointDefinition;
|
|
@@ -42,6 +46,7 @@ export interface PointDefinition {
|
|
|
42
46
|
* In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.
|
|
43
47
|
*
|
|
44
48
|
* Default: `Points`.
|
|
49
|
+
* @maxLength 20
|
|
45
50
|
*/
|
|
46
51
|
customName?: string | null;
|
|
47
52
|
/** Image URL. See [Image]($w/image/introduction) for more information on URL formats for images. */
|
|
@@ -73,9 +78,17 @@ export interface PointsExpiration {
|
|
|
73
78
|
* @readonly
|
|
74
79
|
*/
|
|
75
80
|
status?: Status;
|
|
76
|
-
/**
|
|
81
|
+
/**
|
|
82
|
+
* How many months a member should be inactive to lose the collected points.
|
|
83
|
+
* @min 1
|
|
84
|
+
* @max 12
|
|
85
|
+
*/
|
|
77
86
|
monthsOfInactivity?: number;
|
|
78
|
-
/**
|
|
87
|
+
/**
|
|
88
|
+
* Percentage of points that a member loses after being inactive.
|
|
89
|
+
* @min 1
|
|
90
|
+
* @max 100
|
|
91
|
+
*/
|
|
79
92
|
expiringPointsPercentage?: number;
|
|
80
93
|
}
|
|
81
94
|
export declare enum Status {
|
|
@@ -104,7 +117,10 @@ export interface PremiumFeatures {
|
|
|
104
117
|
pointsExpiration?: boolean;
|
|
105
118
|
}
|
|
106
119
|
export interface SocialMediaSettings {
|
|
107
|
-
/**
|
|
120
|
+
/**
|
|
121
|
+
* List of social media channels
|
|
122
|
+
* @maxSize 5
|
|
123
|
+
*/
|
|
108
124
|
channels?: SocialMediaChannel[];
|
|
109
125
|
}
|
|
110
126
|
export interface SocialMediaChannel {
|
|
@@ -112,11 +128,16 @@ export interface SocialMediaChannel {
|
|
|
112
128
|
type?: Type;
|
|
113
129
|
/** Enable or disable social media channel */
|
|
114
130
|
enabled?: boolean;
|
|
115
|
-
/**
|
|
131
|
+
/**
|
|
132
|
+
* Social media channel ID. For example, Instagram username.
|
|
133
|
+
* @minLength 1
|
|
134
|
+
* @maxLength 255
|
|
135
|
+
*/
|
|
116
136
|
_id?: string;
|
|
117
137
|
/**
|
|
118
138
|
* Social media channel URL
|
|
119
139
|
* @readonly
|
|
140
|
+
* @format WEB_URL
|
|
120
141
|
*/
|
|
121
142
|
url?: string | null;
|
|
122
143
|
}
|
|
@@ -147,7 +168,10 @@ export interface BulkGetLoyaltyProgramResponse {
|
|
|
147
168
|
programInSites?: ProgramInSite[];
|
|
148
169
|
}
|
|
149
170
|
export interface ProgramInSite {
|
|
150
|
-
/**
|
|
171
|
+
/**
|
|
172
|
+
* Metasite ID.
|
|
173
|
+
* @format GUID
|
|
174
|
+
*/
|
|
151
175
|
metaSiteId?: string;
|
|
152
176
|
/** Loyalty program. */
|
|
153
177
|
loyaltyProgram?: LoyaltyProgram;
|
|
@@ -187,7 +211,10 @@ export interface PauseLoyaltyProgramResponse {
|
|
|
187
211
|
loyaltyProgram?: LoyaltyProgram;
|
|
188
212
|
}
|
|
189
213
|
export interface GetLoyaltyProgramDescriptionRequest {
|
|
190
|
-
/**
|
|
214
|
+
/**
|
|
215
|
+
* List of description fields to retrieve. Supported values: `description`, `updatedDate`.
|
|
216
|
+
* @maxSize 2
|
|
217
|
+
*/
|
|
191
218
|
fields?: string[];
|
|
192
219
|
}
|
|
193
220
|
export interface GetLoyaltyProgramDescriptionResponse {
|
|
@@ -197,7 +224,11 @@ export interface GetLoyaltyProgramDescriptionResponse {
|
|
|
197
224
|
_updatedDate?: Date | null;
|
|
198
225
|
}
|
|
199
226
|
export interface UpdateLoyaltyProgramDescriptionRequest {
|
|
200
|
-
/**
|
|
227
|
+
/**
|
|
228
|
+
* Loyalty program description to update.
|
|
229
|
+
* @minLength 1
|
|
230
|
+
* @maxLength 1000000
|
|
231
|
+
*/
|
|
201
232
|
description?: string;
|
|
202
233
|
}
|
|
203
234
|
export interface UpdateLoyaltyProgramDescriptionResponse {
|
|
@@ -274,7 +305,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
274
305
|
studioAssigned?: StudioAssigned;
|
|
275
306
|
/** Emitted when Studio is detached. */
|
|
276
307
|
studioUnassigned?: StudioUnassigned;
|
|
277
|
-
/**
|
|
308
|
+
/**
|
|
309
|
+
* A meta site id.
|
|
310
|
+
* @format GUID
|
|
311
|
+
*/
|
|
278
312
|
metaSiteId?: string;
|
|
279
313
|
/** A meta site version. Monotonically increasing. */
|
|
280
314
|
version?: string;
|
|
@@ -283,6 +317,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
283
317
|
/**
|
|
284
318
|
* TODO(meta-site): Change validation once validations are disabled for consumers
|
|
285
319
|
* More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
|
|
320
|
+
* @maxSize 4000
|
|
286
321
|
*/
|
|
287
322
|
assets?: Asset[];
|
|
288
323
|
}
|
|
@@ -320,9 +355,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
320
355
|
studioUnassigned?: StudioUnassigned;
|
|
321
356
|
}
|
|
322
357
|
export interface Asset {
|
|
323
|
-
/**
|
|
358
|
+
/**
|
|
359
|
+
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
360
|
+
* @maxLength 36
|
|
361
|
+
*/
|
|
324
362
|
appDefId?: string;
|
|
325
|
-
/**
|
|
363
|
+
/**
|
|
364
|
+
* An instance id. For legacy reasons may be UUID or a string.
|
|
365
|
+
* @maxLength 200
|
|
366
|
+
*/
|
|
326
367
|
instanceId?: string;
|
|
327
368
|
/** An application state. */
|
|
328
369
|
state?: State;
|
|
@@ -335,9 +376,15 @@ export declare enum State {
|
|
|
335
376
|
DEMO = "DEMO"
|
|
336
377
|
}
|
|
337
378
|
export interface SiteCreated {
|
|
338
|
-
/**
|
|
379
|
+
/**
|
|
380
|
+
* A template identifier (empty if not created from a template).
|
|
381
|
+
* @maxLength 36
|
|
382
|
+
*/
|
|
339
383
|
originTemplateId?: string;
|
|
340
|
-
/**
|
|
384
|
+
/**
|
|
385
|
+
* An account id of the owner.
|
|
386
|
+
* @format GUID
|
|
387
|
+
*/
|
|
341
388
|
ownerId?: string;
|
|
342
389
|
/** A context in which meta site was created. */
|
|
343
390
|
context?: SiteCreatedContext;
|
|
@@ -346,9 +393,13 @@ export interface SiteCreated {
|
|
|
346
393
|
*
|
|
347
394
|
* In case of a creation from a template it's a template id.
|
|
348
395
|
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
396
|
+
* @format GUID
|
|
349
397
|
*/
|
|
350
398
|
originMetaSiteId?: string | null;
|
|
351
|
-
/**
|
|
399
|
+
/**
|
|
400
|
+
* A meta site name (URL slug).
|
|
401
|
+
* @maxLength 20
|
|
402
|
+
*/
|
|
352
403
|
siteName?: string;
|
|
353
404
|
/** A namespace. */
|
|
354
405
|
namespace?: Namespace;
|
|
@@ -445,9 +496,15 @@ export declare enum Namespace {
|
|
|
445
496
|
}
|
|
446
497
|
/** Site transferred to another user. */
|
|
447
498
|
export interface SiteTransferred {
|
|
448
|
-
/**
|
|
499
|
+
/**
|
|
500
|
+
* A previous owner id (user that transfers meta site).
|
|
501
|
+
* @format GUID
|
|
502
|
+
*/
|
|
449
503
|
oldOwnerId?: string;
|
|
450
|
-
/**
|
|
504
|
+
/**
|
|
505
|
+
* A new owner id (user that accepts meta site).
|
|
506
|
+
* @format GUID
|
|
507
|
+
*/
|
|
451
508
|
newOwnerId?: string;
|
|
452
509
|
}
|
|
453
510
|
/** Soft deletion of the meta site. Could be restored. */
|
|
@@ -460,9 +517,15 @@ export interface DeleteContext {
|
|
|
460
517
|
dateDeleted?: Date | null;
|
|
461
518
|
/** A status. */
|
|
462
519
|
deleteStatus?: DeleteStatus;
|
|
463
|
-
/**
|
|
520
|
+
/**
|
|
521
|
+
* A reason (flow).
|
|
522
|
+
* @maxLength 255
|
|
523
|
+
*/
|
|
464
524
|
deleteOrigin?: string;
|
|
465
|
-
/**
|
|
525
|
+
/**
|
|
526
|
+
* A service that deleted it.
|
|
527
|
+
* @maxLength 255
|
|
528
|
+
*/
|
|
466
529
|
initiatorId?: string | null;
|
|
467
530
|
}
|
|
468
531
|
export declare enum DeleteStatus {
|
|
@@ -478,7 +541,11 @@ export interface SiteUndeleted {
|
|
|
478
541
|
export interface SitePublished {
|
|
479
542
|
}
|
|
480
543
|
export interface SiteUnpublished {
|
|
481
|
-
/**
|
|
544
|
+
/**
|
|
545
|
+
* A list of URLs previously associated with the meta site.
|
|
546
|
+
* @maxLength 4000
|
|
547
|
+
* @maxSize 10000
|
|
548
|
+
*/
|
|
482
549
|
urls?: string[];
|
|
483
550
|
}
|
|
484
551
|
export interface SiteMarkedAsTemplate {
|
|
@@ -501,30 +568,60 @@ export interface SiteMarkedAsWixSite {
|
|
|
501
568
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
502
569
|
*/
|
|
503
570
|
export interface ServiceProvisioned {
|
|
504
|
-
/**
|
|
571
|
+
/**
|
|
572
|
+
* Either UUID or EmbeddedServiceType.
|
|
573
|
+
* @maxLength 36
|
|
574
|
+
*/
|
|
505
575
|
appDefId?: string;
|
|
506
|
-
/**
|
|
576
|
+
/**
|
|
577
|
+
* Not only UUID. Something here could be something weird.
|
|
578
|
+
* @maxLength 36
|
|
579
|
+
*/
|
|
507
580
|
instanceId?: string;
|
|
508
|
-
/**
|
|
581
|
+
/**
|
|
582
|
+
* An instance id from which this instance is originated.
|
|
583
|
+
* @maxLength 36
|
|
584
|
+
*/
|
|
509
585
|
originInstanceId?: string;
|
|
510
|
-
/**
|
|
586
|
+
/**
|
|
587
|
+
* A version.
|
|
588
|
+
* @maxLength 500
|
|
589
|
+
*/
|
|
511
590
|
version?: string | null;
|
|
512
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* The origin meta site id
|
|
593
|
+
* @format GUID
|
|
594
|
+
*/
|
|
513
595
|
originMetaSiteId?: string | null;
|
|
514
596
|
}
|
|
515
597
|
export interface ServiceRemoved {
|
|
516
|
-
/**
|
|
598
|
+
/**
|
|
599
|
+
* Either UUID or EmbeddedServiceType.
|
|
600
|
+
* @maxLength 36
|
|
601
|
+
*/
|
|
517
602
|
appDefId?: string;
|
|
518
|
-
/**
|
|
603
|
+
/**
|
|
604
|
+
* Not only UUID. Something here could be something weird.
|
|
605
|
+
* @maxLength 36
|
|
606
|
+
*/
|
|
519
607
|
instanceId?: string;
|
|
520
|
-
/**
|
|
608
|
+
/**
|
|
609
|
+
* A version.
|
|
610
|
+
* @maxLength 500
|
|
611
|
+
*/
|
|
521
612
|
version?: string | null;
|
|
522
613
|
}
|
|
523
614
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
524
615
|
export interface SiteRenamed {
|
|
525
|
-
/**
|
|
616
|
+
/**
|
|
617
|
+
* A new meta site name (URL slug).
|
|
618
|
+
* @maxLength 20
|
|
619
|
+
*/
|
|
526
620
|
newSiteName?: string;
|
|
527
|
-
/**
|
|
621
|
+
/**
|
|
622
|
+
* A previous meta site name (URL slug).
|
|
623
|
+
* @maxLength 255
|
|
624
|
+
*/
|
|
528
625
|
oldSiteName?: string;
|
|
529
626
|
}
|
|
530
627
|
/**
|
|
@@ -633,11 +730,13 @@ export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
|
633
730
|
/**
|
|
634
731
|
* Information about a transfer from another account.
|
|
635
732
|
* __Deprecated__. Use `reason.transferred_from_another_account` instead.
|
|
733
|
+
* @format GUID
|
|
636
734
|
*/
|
|
637
735
|
transferredFromAccount?: string | null;
|
|
638
736
|
/**
|
|
639
737
|
* Information about a transfer from another site.
|
|
640
738
|
* __Deprecated__. Use `reason.reassigned_from_site` instead.
|
|
739
|
+
* @format GUID
|
|
641
740
|
*/
|
|
642
741
|
reassignedFromMetasite?: string | null;
|
|
643
742
|
}
|
|
@@ -686,6 +785,8 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
686
785
|
*
|
|
687
786
|
* Min: 2 characters
|
|
688
787
|
* Max: 50 characters
|
|
788
|
+
* @minLength 2
|
|
789
|
+
* @maxLength 50
|
|
689
790
|
*/
|
|
690
791
|
uniqueName?: string;
|
|
691
792
|
/**
|
|
@@ -724,6 +825,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
724
825
|
/**
|
|
725
826
|
* ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
|
|
726
827
|
* to which the feature instance belongs.
|
|
828
|
+
* @format GUID
|
|
727
829
|
*/
|
|
728
830
|
subscriptionId?: string | null;
|
|
729
831
|
/**
|
|
@@ -757,6 +859,7 @@ export interface FeatureContext {
|
|
|
757
859
|
/**
|
|
758
860
|
* ID of the Wix account that the feature instance belongs to.
|
|
759
861
|
* Available for both site and account level feature instances.
|
|
862
|
+
* @format GUID
|
|
760
863
|
*/
|
|
761
864
|
userId?: string;
|
|
762
865
|
/**
|
|
@@ -764,6 +867,7 @@ export interface FeatureContext {
|
|
|
764
867
|
* Only available for site level feature instances that are assigned to a Wix
|
|
765
868
|
* site. Not available for account level and unassigned site level feature
|
|
766
869
|
* instances.
|
|
870
|
+
* @format GUID
|
|
767
871
|
*/
|
|
768
872
|
metaSiteId?: string | null;
|
|
769
873
|
}
|
|
@@ -820,12 +924,18 @@ export interface QuotaInfo {
|
|
|
820
924
|
}
|
|
821
925
|
/** Subscription transferred from another account, features on the current account were enabled. */
|
|
822
926
|
export interface TransferredFromAnotherAccountReason {
|
|
823
|
-
/**
|
|
927
|
+
/**
|
|
928
|
+
* Information about a transfer from another account.
|
|
929
|
+
* @format GUID
|
|
930
|
+
*/
|
|
824
931
|
transferredFromAccount?: string;
|
|
825
932
|
}
|
|
826
933
|
/** Subscription moved from one site to another in the same account, features enabled on the target site */
|
|
827
934
|
export interface ReassignedFromSiteReason {
|
|
828
|
-
/**
|
|
935
|
+
/**
|
|
936
|
+
* Information about a transfer from another site.
|
|
937
|
+
* @format GUID
|
|
938
|
+
*/
|
|
829
939
|
reassignedFromMetasite?: string;
|
|
830
940
|
}
|
|
831
941
|
/** Subscription was floating and assigned to site, features enabled on the target site */
|
|
@@ -862,7 +972,10 @@ export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
|
862
972
|
* possibly its new context.
|
|
863
973
|
*/
|
|
864
974
|
feature?: Feature;
|
|
865
|
-
/**
|
|
975
|
+
/**
|
|
976
|
+
* ID of the meta site for which the feature has been disabled.
|
|
977
|
+
* @format GUID
|
|
978
|
+
*/
|
|
866
979
|
metaSiteId?: string | null;
|
|
867
980
|
}
|
|
868
981
|
/** @oneof */
|
|
@@ -888,7 +1001,10 @@ export interface ReplacedByAnotherSubscriptionReason {
|
|
|
888
1001
|
}
|
|
889
1002
|
/** Subscription was assigned to another site, causing features on the origin site to be disabled. */
|
|
890
1003
|
export interface ReassignedToAnotherSiteReason {
|
|
891
|
-
/**
|
|
1004
|
+
/**
|
|
1005
|
+
* Information about a transfer to the site.
|
|
1006
|
+
* @format GUID
|
|
1007
|
+
*/
|
|
892
1008
|
reassignedToMetasite?: string;
|
|
893
1009
|
}
|
|
894
1010
|
/** Feature updated, for example Quota was increased due to upgrade */
|
|
@@ -930,6 +1046,7 @@ export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
|
930
1046
|
/**
|
|
931
1047
|
* Information about a transfer to the account.
|
|
932
1048
|
* __Deprecated__. Use `reason.transferred_to_account` instead.
|
|
1049
|
+
* @format GUID
|
|
933
1050
|
*/
|
|
934
1051
|
transferredToAccount?: string | null;
|
|
935
1052
|
}
|
|
@@ -944,7 +1061,10 @@ export interface FeatureCancelledReasonOneOf {
|
|
|
944
1061
|
}
|
|
945
1062
|
/** Subscription was transferred to another account, features in the origin account were cancelled */
|
|
946
1063
|
export interface TransferredToAnotherAccountReason {
|
|
947
|
-
/**
|
|
1064
|
+
/**
|
|
1065
|
+
* Information about a transfer to the account.
|
|
1066
|
+
* @format GUID
|
|
1067
|
+
*/
|
|
948
1068
|
transferredToAccount?: string;
|
|
949
1069
|
}
|
|
950
1070
|
/** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
|
|
@@ -1021,9 +1141,15 @@ export interface ActionEvent {
|
|
|
1021
1141
|
body?: string;
|
|
1022
1142
|
}
|
|
1023
1143
|
export interface MessageEnvelope {
|
|
1024
|
-
/**
|
|
1144
|
+
/**
|
|
1145
|
+
* App instance ID.
|
|
1146
|
+
* @format GUID
|
|
1147
|
+
*/
|
|
1025
1148
|
instanceId?: string | null;
|
|
1026
|
-
/**
|
|
1149
|
+
/**
|
|
1150
|
+
* Event type.
|
|
1151
|
+
* @maxLength 150
|
|
1152
|
+
*/
|
|
1027
1153
|
eventType?: string;
|
|
1028
1154
|
/** The identification type and identity data. */
|
|
1029
1155
|
identity?: IdentificationData;
|
|
@@ -1031,26 +1157,50 @@ export interface MessageEnvelope {
|
|
|
1031
1157
|
data?: string;
|
|
1032
1158
|
}
|
|
1033
1159
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1034
|
-
/**
|
|
1160
|
+
/**
|
|
1161
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1162
|
+
* @format GUID
|
|
1163
|
+
*/
|
|
1035
1164
|
anonymousVisitorId?: string;
|
|
1036
|
-
/**
|
|
1165
|
+
/**
|
|
1166
|
+
* ID of a site visitor that has logged in to the site.
|
|
1167
|
+
* @format GUID
|
|
1168
|
+
*/
|
|
1037
1169
|
memberId?: string;
|
|
1038
|
-
/**
|
|
1170
|
+
/**
|
|
1171
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1172
|
+
* @format GUID
|
|
1173
|
+
*/
|
|
1039
1174
|
wixUserId?: string;
|
|
1040
|
-
/**
|
|
1175
|
+
/**
|
|
1176
|
+
* ID of an app.
|
|
1177
|
+
* @format GUID
|
|
1178
|
+
*/
|
|
1041
1179
|
appId?: string;
|
|
1042
1180
|
/** @readonly */
|
|
1043
1181
|
identityType?: WebhookIdentityType;
|
|
1044
1182
|
}
|
|
1045
1183
|
/** @oneof */
|
|
1046
1184
|
export interface IdentificationDataIdOneOf {
|
|
1047
|
-
/**
|
|
1185
|
+
/**
|
|
1186
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1187
|
+
* @format GUID
|
|
1188
|
+
*/
|
|
1048
1189
|
anonymousVisitorId?: string;
|
|
1049
|
-
/**
|
|
1190
|
+
/**
|
|
1191
|
+
* ID of a site visitor that has logged in to the site.
|
|
1192
|
+
* @format GUID
|
|
1193
|
+
*/
|
|
1050
1194
|
memberId?: string;
|
|
1051
|
-
/**
|
|
1195
|
+
/**
|
|
1196
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1197
|
+
* @format GUID
|
|
1198
|
+
*/
|
|
1052
1199
|
wixUserId?: string;
|
|
1053
|
-
/**
|
|
1200
|
+
/**
|
|
1201
|
+
* ID of an app.
|
|
1202
|
+
* @format GUID
|
|
1203
|
+
*/
|
|
1054
1204
|
appId?: string;
|
|
1055
1205
|
}
|
|
1056
1206
|
export declare enum WebhookIdentityType {
|
|
@@ -1119,9 +1269,15 @@ export interface DisablePointsExpirationResponseNonNullableFields {
|
|
|
1119
1269
|
loyaltyProgram?: LoyaltyProgramNonNullableFields;
|
|
1120
1270
|
}
|
|
1121
1271
|
export interface BaseEventMetadata {
|
|
1122
|
-
/**
|
|
1272
|
+
/**
|
|
1273
|
+
* App instance ID.
|
|
1274
|
+
* @format GUID
|
|
1275
|
+
*/
|
|
1123
1276
|
instanceId?: string | null;
|
|
1124
|
-
/**
|
|
1277
|
+
/**
|
|
1278
|
+
* Event type.
|
|
1279
|
+
* @maxLength 150
|
|
1280
|
+
*/
|
|
1125
1281
|
eventType?: string;
|
|
1126
1282
|
/** The identification type and identity data. */
|
|
1127
1283
|
identity?: IdentificationData;
|
|
@@ -1211,7 +1367,7 @@ export declare function bulkGetLoyaltyProgram(): Promise<BulkGetLoyaltyProgramRe
|
|
|
1211
1367
|
*
|
|
1212
1368
|
* The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
|
|
1213
1369
|
*
|
|
1214
|
-
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty
|
|
1370
|
+
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
|
|
1215
1371
|
*
|
|
1216
1372
|
* >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
|
|
1217
1373
|
* @param loyaltyProgram - Loyalty program fields to update.
|
|
@@ -1231,10 +1387,10 @@ export declare function updateLoyaltyProgram(loyaltyProgram: LoyaltyProgram): Pr
|
|
|
1231
1387
|
*
|
|
1232
1388
|
* Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
|
|
1233
1389
|
*
|
|
1234
|
-
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty
|
|
1390
|
+
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
|
|
1235
1391
|
*
|
|
1236
1392
|
* To temporarily pause your loyalty program you must follow three steps:
|
|
1237
|
-
* 1. Remove all [`earnPoints()`](wix-loyalty
|
|
1393
|
+
* 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
|
|
1238
1394
|
* 1. Hide the loyalty page from your site.
|
|
1239
1395
|
* 1. Delete the My Rewards page from the Member pages.
|
|
1240
1396
|
* See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
|
|
@@ -277,7 +277,7 @@ exports.bulkGetLoyaltyProgram = bulkGetLoyaltyProgram;
|
|
|
277
277
|
*
|
|
278
278
|
* The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
|
|
279
279
|
*
|
|
280
|
-
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty
|
|
280
|
+
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
|
|
281
281
|
*
|
|
282
282
|
* >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
|
|
283
283
|
* @param loyaltyProgram - Loyalty program fields to update.
|
|
@@ -328,10 +328,10 @@ exports.updateLoyaltyProgram = updateLoyaltyProgram;
|
|
|
328
328
|
*
|
|
329
329
|
* Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
|
|
330
330
|
*
|
|
331
|
-
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty
|
|
331
|
+
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
|
|
332
332
|
*
|
|
333
333
|
* To temporarily pause your loyalty program you must follow three steps:
|
|
334
|
-
* 1. Remove all [`earnPoints()`](wix-loyalty
|
|
334
|
+
* 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
|
|
335
335
|
* 1. Hide the loyalty page from your site.
|
|
336
336
|
* 1. Delete the My Rewards page from the Member pages.
|
|
337
337
|
* See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"loyalty-v1-program-programs.universal.js","sourceRoot":"","sources":["../../../src/loyalty-v1-program-programs.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,qGAAuF;AACvF,kEAAsF;AACtF,kEAAsF;AACtF,sFAAkF;
|
|
1
|
+
{"version":3,"file":"loyalty-v1-program-programs.universal.js","sourceRoot":"","sources":["../../../src/loyalty-v1-program-programs.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sEAAuF;AACvF,oFAGiD;AAEjD,qGAAuF;AACvF,kEAAsF;AACtF,kEAAsF;AACtF,sFAAkF;AAqElF,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAA8B;IAC9B,oCAAmB,CAAA;IACnB,kDAAkD;IAClD,gCAAe,CAAA;IACf,yBAAyB;IACzB,kCAAiB,CAAA;IACjB,8HAA8H;IAC9H,kCAAiB,CAAA;AACnB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;AAsBD,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,gEAAgE;IAChE,2CAAiC,CAAA;IACjC,6CAA6C;IAC7C,+BAAqB,CAAA;IACrB,4CAA4C;IAC5C,6BAAmB,CAAA;AACrB,CAAC,EAPW,MAAM,sBAAN,MAAM,QAOjB;AA+CD,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AA4OD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AAgCD,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,6EAA6E;IAC7E,qCAAe,CAAA;IACf,6CAA6C;IAC7C,qDAA+B,CAAA;IAC/B,wEAAwE;IACxE,+EAAyD,CAAA;IACzD,oCAAoC;IACpC,6CAAuB,CAAA;IACvB,wGAAwG;IACxG,6DAAuC,CAAA;IACvC,2DAA2D;IAC3D,qCAAe,CAAA;AACjB,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B;AAED,IAAY,SA2EX;AA3ED,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B,0EAA0E;IAC1E,8BAAiB,CAAA;IACjB;;;OAGG;IACH,0CAA6B,CAAA;IAC7B,2BAA2B;IAC3B,4BAAe,CAAA;IACf,gCAAgC;IAChC,0DAA6C,CAAA;IAC7C;;;OAGG;IACH,8DAAiD,CAAA;AACnD,CAAC,EA3EW,SAAS,yBAAT,SAAS,QA2EpB;AAuCD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAgXD,uDAAuD;AACvD,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,8BAAa,CAAA;IACb,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,8BAAa,CAAA;AACf,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AA2UD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B;AAsJD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,iBAAiB;IAGrC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,6BAA6B,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEzE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAC5C,IAAA,gCAAc,EAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;aACzD;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,8CAwCC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,qBAAqB;IAGzC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,6BAA6B,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAE7E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAC5C,IAAA,gCAAc,EAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE;oBACL,EAAE,IAAI,EAAE,oDAAoD,EAAE;iBAC/D;aACF;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA1CD,sDA0CC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,oBAAoB,CACxC,cAA8B;IAI9B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,gCAAc,EAC5B,IAAA,8DAAqC,EAAC,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC,EACzE;QACE;YACE,WAAW,EAAE,oCAA4B;YACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;SACzD;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,6BAA6B,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAE5E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAC5C,IAAA,gCAAc,EAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;aACzD;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE;YACpD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,gBAAgB,CAAC,CACnB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAlDD,oDAkDC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,sBAAsB;IAI1C,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,6BAA6B,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAC5C,IAAA,gCAAc,EAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;aACzD;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAzCD,wDAyCC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,mBAAmB;IAGvC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,6BAA6B,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAC5C,IAAA,gCAAc,EAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;aACzD;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAxCD,kDAwCC;AAED;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,gCAAgC;IAIpD,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,6BAA6B,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;IAE1E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAnCD,4EAmCC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,sBAAsB;IAI1C,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,6BAA6B,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAC5C,IAAA,gCAAc,EAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;aACzD;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAzCD,wDAyCC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,uBAAuB;IAI3C,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,8DAAqC,EAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,6BAA6B,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAEjE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,IAAA,gEAAuC,EAC5C,IAAA,gCAAc,EAAC,MAAM,CAAC,IAAI,EAAE;YAC1B;gBACE,WAAW,EAAE,oCAA4B;gBACzC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAC;aACzD;SACF,CAAC,CACF,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AA1CD,0DA0CC"}
|
|
@@ -16,7 +16,7 @@ export declare function bulkGetLoyaltyProgram(payload: object): RequestOptionsFa
|
|
|
16
16
|
*
|
|
17
17
|
* The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
|
|
18
18
|
*
|
|
19
|
-
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty
|
|
19
|
+
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
|
|
20
20
|
*
|
|
21
21
|
* >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
|
|
22
22
|
*/
|
|
@@ -28,10 +28,10 @@ export declare function updateLoyaltyProgram(payload: object): RequestOptionsFac
|
|
|
28
28
|
*
|
|
29
29
|
* Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
|
|
30
30
|
*
|
|
31
|
-
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty
|
|
31
|
+
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
|
|
32
32
|
*
|
|
33
33
|
* To temporarily pause your loyalty program you must follow three steps:
|
|
34
|
-
* 1. Remove all [`earnPoints()`](wix-loyalty
|
|
34
|
+
* 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
|
|
35
35
|
* 1. Hide the loyalty page from your site.
|
|
36
36
|
* 1. Delete the My Rewards page from the Member pages.
|
|
37
37
|
* See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
|
|
@@ -168,7 +168,7 @@ export function bulkGetLoyaltyProgram(payload) {
|
|
|
168
168
|
*
|
|
169
169
|
* The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
|
|
170
170
|
*
|
|
171
|
-
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty
|
|
171
|
+
* With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
|
|
172
172
|
*
|
|
173
173
|
* >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
|
|
174
174
|
*/
|
|
@@ -231,10 +231,10 @@ export function updateLoyaltyProgram(payload) {
|
|
|
231
231
|
*
|
|
232
232
|
* Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
|
|
233
233
|
*
|
|
234
|
-
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty
|
|
234
|
+
* This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
|
|
235
235
|
*
|
|
236
236
|
* To temporarily pause your loyalty program you must follow three steps:
|
|
237
|
-
* 1. Remove all [`earnPoints()`](wix-loyalty
|
|
237
|
+
* 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
|
|
238
238
|
* 1. Hide the loyalty page from your site.
|
|
239
239
|
* 1. Delete the My Rewards page from the Member pages.
|
|
240
240
|
* See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
|