Skip to content

Commit 6965c16

Browse files
wix-docs-fedsAriGoldWix
wix-docs-feds
and
AriGoldWix
authored
Updated a couple of descriptions in Pricing Plans Orders Events.
changes: Service wix-pricing-plans-backend.Events operation onOrderAutoRenewCanceled has changed description Service wix-pricing-plans-backend.Events operation onOrderCanceled has changed description Service wix-pricing-plans-backend.Events operation onOrderUpdated has changed description issues: Message OrderCycleStartedEventData is defined two or more times (events.js (210, 210)) Operation eq has an unknown param type * (plan-queries.js (43)) Operation ne has an unknown param type * (plan-queries.js (73)) Co-authored-by: AriGoldWix <[email protected]>
1 parent 0ccc168 commit 6965c16

File tree

4 files changed

+25
-42
lines changed

4 files changed

+25
-42
lines changed

‎media/orderEvents.png

25.2 KB
Loading

‎wix-pricing-plans-backend/wix-pricing-plans-backend/Checkout.service.json

+6-12
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
{ "name": "Checkout",
22
"memberOf": "wix-pricing-plans-backend",
33
"mixes": [],
4-
"labels":
5-
[ "changed" ],
4+
"labels": [],
65
"location":
76
{ "lineno": 1,
87
"filename": "checkout.js" },
@@ -1292,8 +1291,7 @@
12921291
"extra":
12931292
{ } },
12941293
{ "name": "previewPrice",
1295-
"labels":
1296-
[ "changed" ],
1294+
"labels": [],
12971295
"nameParams": [],
12981296
"params":
12991297
[ { "name": "planId",
@@ -1468,8 +1466,7 @@
14681466
"optional": true } ],
14691467
"extra":
14701468
{ },
1471-
"labels":
1472-
[ "changed" ] },
1469+
"labels": [] },
14731470
{ "name": "CreateOnlineOrderOptions",
14741471
"locations":
14751472
[ { "lineno": 140,
@@ -1490,8 +1487,7 @@
14901487
"optional": true } ],
14911488
"extra":
14921489
{ },
1493-
"labels":
1494-
[ "changed" ] },
1490+
"labels": [] },
14951491
{ "name": "OrderPreview",
14961492
"locations":
14971493
[ { "lineno": 292,
@@ -1536,8 +1532,7 @@
15361532
"optional": true } ],
15371533
"extra":
15381534
{ },
1539-
"labels":
1540-
[ "changed" ] },
1535+
"labels": [] },
15411536
{ "name": "PreviewOnlineOrderOptions",
15421537
"locations":
15431538
[ { "lineno": 161,
@@ -1558,8 +1553,7 @@
15581553
"optional": true } ],
15591554
"extra":
15601555
{ },
1561-
"labels":
1562-
[ "changed" ] },
1556+
"labels": [] },
15631557
{ "name": "PricePreview",
15641558
"locations":
15651559
[ { "lineno": 373,

‎wix-pricing-plans-backend/wix-pricing-plans-backend/Events.service.json

+16-24
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@
7575
"properties": [],
7676
"operations":
7777
[ { "name": "onOrderAutoRenewCanceled",
78-
"labels": [],
78+
"labels":
79+
[ "changed" ],
7980
"nameParams": [],
8081
"params":
8182
[ { "name": "event",
@@ -84,7 +85,7 @@
8485
"ret":
8586
{ "type": "void" },
8687
"locations":
87-
[ { "lineno": 799,
88+
[ { "lineno": 794,
8889
"filename": "events.js" } ],
8990
"docs":
9091
{ "summary": "An event that triggers when an order is canceled with `effectiveAt` as `NEXT_PAYMENT_DATE`.",
@@ -96,11 +97,6 @@
9697
" + If the order was canceled with `effectiveAt` as `IMMEDIATELY`.",
9798
" + When an order expires by reaching its `endDate` and was not canceled. ",
9899
" ",
99-
" If you want to trigger an automation to go off any time an order is canceled, use both `onOrderCanceled()`, to catch ",
100-
" orders that are canceled `IMMEDIATELY`, and `onOrderAutoRenewCanceled()`, to catch orders that are canceled ",
101-
" at `NEXT_PAYMENT_DATE`. To avoid performing the same automation twice for a single cancellation, be sure to exclude any ",
102-
" `entityId` in an `onOrderCanceled()` event that matches an `entityId` already recorded in an `onOrderAutoRenewCanceled()` events. ",
103-
"",
104100
" > **Note:** Backend events don't work when previewing your site." ],
105101
"links": [],
106102
"examples":
@@ -200,7 +196,8 @@
200196
"extra":
201197
{ } },
202198
{ "name": "onOrderCanceled",
203-
"labels": [],
199+
"labels":
200+
[ "changed" ],
204201
"nameParams": [],
205202
"params":
206203
[ { "name": "event",
@@ -219,11 +216,6 @@
219216
"",
220217
" The `onOrderCanceled()` event will *not* trigger immediately when the order is canceled with `effectiveAt` as `NEXT_PAYMENT_DATE`. ",
221218
" In that case, the [`onOrderAutoRenewCanceled()`](wix-pricing-plans-backend/events/onorderautorenewcanceled) event will trigger immediately and the `onOrderCanceled()` event will trigger following the current payment cycle.",
222-
" ",
223-
" If you want to trigger an automation to go off any time an order is canceled, use both `onOrderCanceled()`, to catch ",
224-
" orders that are canceled `IMMEDIATELY`, and `onOrderAutoRenewCanceled()`, to catch orders that are canceled ",
225-
" at `NEXT_PAYMENT_DATE`. To avoid performing the same automation twice for a single cancellation, be sure to exclude any ",
226-
" `entityId` in an `onOrderCanceled()` event that matches an `entityId` already recorded in an `onOrderAutoRenewCanceled()` event.",
227219
"",
228220
" > **Note:** Backend events don't work when previewing your site." ],
229221
"links": [],
@@ -329,7 +321,7 @@
329321
"ret":
330322
{ "type": "void" },
331323
"locations":
332-
[ { "lineno": 722,
324+
[ { "lineno": 717,
333325
"filename": "events.js" } ],
334326
"docs":
335327
{ "summary": "An event that triggers when an order is created.",
@@ -504,7 +496,7 @@
504496
"ret":
505497
{ "type": "void" },
506498
"locations":
507-
[ { "lineno": 780,
499+
[ { "lineno": 775,
508500
"filename": "events.js" } ],
509501
"docs":
510502
{ "summary": "An event that triggers at the start of each payment cycle for online orders.",
@@ -623,7 +615,7 @@
623615
"ret":
624616
{ "type": "void" },
625617
"locations":
626-
[ { "lineno": 635,
618+
[ { "lineno": 630,
627619
"filename": "events.js" } ],
628620
"docs":
629621
{ "summary": "An event that triggers when the `endDate` of an order is postponed or made earlier.",
@@ -728,7 +720,7 @@
728720
"ret":
729721
{ "type": "void" },
730722
"locations":
731-
[ { "lineno": 688,
723+
[ { "lineno": 683,
732724
"filename": "events.js" } ],
733725
"docs":
734726
{ "summary": "An event that triggers when an order expires or is canceled immediately.",
@@ -943,7 +935,7 @@
943935
"ret":
944936
{ "type": "void" },
945937
"locations":
946-
[ { "lineno": 671,
938+
[ { "lineno": 666,
947939
"filename": "events.js" } ],
948940
"docs":
949941
{ "summary": "An event that triggers when an order is paused.",
@@ -1179,7 +1171,7 @@
11791171
"ret":
11801172
{ "type": "void" },
11811173
"locations":
1182-
[ { "lineno": 653,
1174+
[ { "lineno": 648,
11831175
"filename": "events.js" } ],
11841176
"docs":
11851177
{ "summary": "An event that triggers when an order resumes.",
@@ -1296,7 +1288,7 @@
12961288
"ret":
12971289
{ "type": "void" },
12981290
"locations":
1299-
[ { "lineno": 706,
1291+
[ { "lineno": 701,
13001292
"filename": "events.js" } ],
13011293
"docs":
13021294
{ "summary": "An event that triggers when the start date of an order is changed.",
@@ -1509,7 +1501,8 @@
15091501
"extra":
15101502
{ } },
15111503
{ "name": "onOrderUpdated",
1512-
"labels": [],
1504+
"labels":
1505+
[ "changed" ],
15131506
"nameParams": [],
15141507
"params":
15151508
[ { "name": "event",
@@ -1531,7 +1524,7 @@
15311524
" if any of the following happens: ",
15321525
" + An order is paid. In this case, the [`onOrderPurchased()`](wix-pricing-plans-backend/events/onorderpurchased) event handler also runs.",
15331526
" + An order reaches its start date. In this case, the [`onOrderStarted()`](wix-pricing-plans-backend/events/onorderstarted) event handler also runs.",
1534-
" + An order is cancelled. In this case, the [`onOrderCanceled()`](wix-pricing-plans-backend/events/onordercanceled) event handler also runs.",
1527+
" + An order is canceled. In this case, the [`onOrderCanceled()`](wix-pricing-plans-backend/events/onordercanceled) event handler also runs.",
15351528
" + The end date of an order is postponed or brought forward. In this case, the `onOrderEndDatePostponed()` event handler also runs. ",
15361529
" + An order is paused or resumed. In this case, the [`onOrderPaused()`](wix-pricing-plans-backend/events/onorderpaused) or the [`onOrderResumed()`](wix-pricing-plans-backend/events/onorderresumed) event handler also runs.",
15371530
" + An order expired by reaching its end date. In this case, the [`onOrderEnded()`](wix-pricing-plans-backend/events/onorderended) event handler also runs.",
@@ -2422,8 +2415,7 @@
24222415
"doc": "Role assigned after ordering the plan." } ],
24232416
"extra":
24242417
{ },
2425-
"labels":
2426-
[ "changed" ] },
2418+
"labels": [] },
24272419
{ "name": "OrderAutoRenewCanceledEvent",
24282420
"locations":
24292421
[ { "lineno": 439,

‎wix-pricing-plans-backend/wix-pricing-plans-backend/Orders.service.json

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
{ "name": "Orders",
22
"memberOf": "wix-pricing-plans-backend",
33
"mixes": [],
4-
"labels":
5-
[ "changed" ],
4+
"labels": [],
65
"location":
76
{ "lineno": 1,
87
"filename": "orders.js" },
@@ -1523,8 +1522,7 @@
15231522
"doc": "Coupon ID." } ],
15241523
"extra":
15251524
{ },
1526-
"labels":
1527-
[ "changed" ] },
1525+
"labels": [] },
15281526
{ "name": "CurrentCycle",
15291527
"locations":
15301528
[ { "lineno": 60,
@@ -1934,8 +1932,7 @@
19341932
"doc": "Three-letter currency code in [ISO 4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format." } ],
19351933
"extra":
19361934
{ },
1937-
"labels":
1938-
[ "changed" ] },
1935+
"labels": [] },
19391936
{ "name": "PriceDetails",
19401937
"locations":
19411938
[ { "lineno": 148,

0 commit comments

Comments
 (0)