From 9acb667e538bc94e738f85f0128d4b909169151a Mon Sep 17 00:00:00 2001 From: angeliquem Date: Tue, 5 Sep 2023 12:52:20 +0300 Subject: [PATCH] DocWorks for wix-pricing-plans-backend - 1 change detected, but 3 issue detected changes: Service wix-pricing-plans-backend.Events message OrderCycleStartedEventData member transactionId was removed issues: Message OrderCycleStartedEventData is defined two or more times (events.js (209, 209)) Operation eq has an unknown param type * (plan-queries.js (43)) Operation ne has an unknown param type * (plan-queries.js (73)) --- .../wix-pricing-plans-backend.service.json | 3 +- .../Checkout.service.json | 9 +- .../Events.service.json | 87 +++++++++---------- .../Orders.service.json | 9 +- 4 files changed, 50 insertions(+), 58 deletions(-) diff --git a/wix-pricing-plans-backend/wix-pricing-plans-backend.service.json b/wix-pricing-plans-backend/wix-pricing-plans-backend.service.json index 572caa2e67..d6c10b8024 100644 --- a/wix-pricing-plans-backend/wix-pricing-plans-backend.service.json +++ b/wix-pricing-plans-backend/wix-pricing-plans-backend.service.json @@ -1,7 +1,6 @@ { "name": "wix-pricing-plans-backend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 193, "filename": "plans.js" }, diff --git a/wix-pricing-plans-backend/wix-pricing-plans-backend/Checkout.service.json b/wix-pricing-plans-backend/wix-pricing-plans-backend/Checkout.service.json index 0011d7aac2..daf9629c78 100644 --- a/wix-pricing-plans-backend/wix-pricing-plans-backend/Checkout.service.json +++ b/wix-pricing-plans-backend/wix-pricing-plans-backend/Checkout.service.json @@ -1,8 +1,7 @@ { "name": "Checkout", "memberOf": "wix-pricing-plans-backend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "checkout.js" }, @@ -97,8 +96,7 @@ "properties": [], "operations": [ { "name": "applyCoupon", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "orderId", @@ -744,8 +742,7 @@ "extra": { } }, { "name": "createOnlineOrder", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "planId", diff --git a/wix-pricing-plans-backend/wix-pricing-plans-backend/Events.service.json b/wix-pricing-plans-backend/wix-pricing-plans-backend/Events.service.json index f3616d0c7c..1a3815fb90 100644 --- a/wix-pricing-plans-backend/wix-pricing-plans-backend/Events.service.json +++ b/wix-pricing-plans-backend/wix-pricing-plans-backend/Events.service.json @@ -1,7 +1,8 @@ { "name": "Events", "memberOf": "wix-pricing-plans-backend", "mixes": [], - "labels": [], + "labels": + [ "changed" ], "location": { "lineno": 1, "filename": "events.js" }, @@ -83,7 +84,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 794, + [ { "lineno": 792, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order is canceled with `effectiveAt` as `NEXT_PAYMENT_DATE`.", @@ -203,7 +204,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 611, + [ { "lineno": 609, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order is canceled.", @@ -318,7 +319,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 717, + [ { "lineno": 715, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order is created.", @@ -493,7 +494,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 775, + [ { "lineno": 773, "filename": "events.js" } ], "docs": { "summary": "An event that triggers at the start of each payment cycle for online orders.", @@ -612,7 +613,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 630, + [ { "lineno": 628, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when the `endDate` of an order is postponed or made earlier.", @@ -717,7 +718,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 683, + [ { "lineno": 681, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order expires or is canceled immediately.", @@ -830,7 +831,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 593, + [ { "lineno": 591, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an offline order is marked as paid.", @@ -932,7 +933,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 666, + [ { "lineno": 664, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order is paused.", @@ -1049,7 +1050,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 552, + [ { "lineno": 550, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order is purchased.", @@ -1168,7 +1169,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 648, + [ { "lineno": 646, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order resumes.", @@ -1285,7 +1286,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 701, + [ { "lineno": 699, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when the start date of an order is changed.", @@ -1392,7 +1393,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 574, + [ { "lineno": 572, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when the start date of a purchased or free order is reached.", @@ -1507,7 +1508,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 523, + [ { "lineno": 521, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when an order is changed.", @@ -1619,7 +1620,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 483, + [ { "lineno": 481, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when a pricing plan is archived.", @@ -1703,7 +1704,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 450, + [ { "lineno": 448, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when a pricing plan is created.", @@ -1778,7 +1779,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 501, + [ { "lineno": 499, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when a member purchases a plan.", @@ -1909,7 +1910,7 @@ "ret": { "type": "void" }, "locations": - [ { "lineno": 467, + [ { "lineno": 465, "filename": "events.js" } ], "docs": { "summary": "An event that triggers when a pricing plan is changed.", @@ -1978,7 +1979,7 @@ "messages": [ { "name": "EventData", "locations": - [ { "lineno": 263, + [ { "lineno": 261, "filename": "events.js" } ], "docs": { "summary": "Event data.", @@ -2053,7 +2054,7 @@ "labels": [] }, { "name": "EventMetadata", "locations": - [ { "lineno": 273, + [ { "lineno": 271, "filename": "events.js" } ], "docs": { "summary": "Event metadata.", @@ -2414,7 +2415,7 @@ "labels": [] }, { "name": "OrderAutoRenewCanceledEvent", "locations": - [ { "lineno": 439, + [ { "lineno": 437, "filename": "events.js" } ], "docs": { "summary": "Information about the event fired when the order auto-renewal is canceled.", @@ -2525,7 +2526,7 @@ "labels": [] }, { "name": "OrderCanceledEvent", "locations": - [ { "lineno": 347, + [ { "lineno": 345, "filename": "events.js" } ], "docs": { "summary": "Information about the order cancellation event.", @@ -2632,7 +2633,7 @@ "labels": [] }, { "name": "OrderCreatedEvent", "locations": - [ { "lineno": 409, + [ { "lineno": 407, "filename": "events.js" } ], "docs": { "summary": "Information about the order's creation event.", @@ -2737,7 +2738,7 @@ "labels": [] }, { "name": "OrderCycleStartedEvent", "locations": - [ { "lineno": 429, + [ { "lineno": 427, "filename": "events.js" } ], "docs": { "summary": "Information about the event fired when the order's payment cycle is triggered. This means the next payment date has arrived.", @@ -2847,9 +2848,9 @@ "labels": [] }, { "name": "OrderCycleStartedEventData", "locations": - [ { "lineno": 210, + [ { "lineno": 209, "filename": "events.js" }, - { "lineno": 210, + { "lineno": 209, "filename": "events.js" } ], "docs": { "summary": "Event data.", @@ -2937,16 +2938,14 @@ "doc": "Order information." }, { "name": "cycleNumber", "type": "number", - "doc": "Number of the payment cycle. Zero for unlimited plan orders and orders whose plans are valid until canceled." }, - { "name": "transactionId", - "type": "string", - "doc": "Wix Pay transaction ID." } ], + "doc": "Number of the payment cycle. Zero for unlimited plan orders and orders whose plans are valid until canceled." } ], "extra": { }, - "labels": [] }, + "labels": + [ "changed" ] }, { "name": "OrderEndDatePostponedEvent", "locations": - [ { "lineno": 357, + [ { "lineno": 355, "filename": "events.js" } ], "docs": { "summary": "Information about the order postponed event.", @@ -3045,7 +3044,7 @@ "labels": [] }, { "name": "OrderEndedEvent", "locations": - [ { "lineno": 388, + [ { "lineno": 386, "filename": "events.js" } ], "docs": { "summary": "Information about the order end event.", @@ -3243,7 +3242,7 @@ "labels": [] }, { "name": "OrderEventMetadata", "locations": - [ { "lineno": 221, + [ { "lineno": 219, "filename": "events.js" } ], "docs": { "summary": "Event metadata.", @@ -3344,7 +3343,7 @@ "labels": [] }, { "name": "OrderMarkedAsPaidEvent", "locations": - [ { "lineno": 336, + [ { "lineno": 334, "filename": "events.js" } ], "docs": { "summary": "Information about the offline order \"marked as paid\" event.", @@ -3440,7 +3439,7 @@ "labels": [] }, { "name": "OrderPausedEvent", "locations": - [ { "lineno": 378, + [ { "lineno": 376, "filename": "events.js" } ], "docs": { "summary": "Information about the order pause event.", @@ -3551,7 +3550,7 @@ "labels": [] }, { "name": "OrderPurchasedEvent", "locations": - [ { "lineno": 325, + [ { "lineno": 323, "filename": "events.js" } ], "docs": { "summary": "Information about the order purchase event.", @@ -3659,7 +3658,7 @@ "labels": [] }, { "name": "OrderResumedEvent", "locations": - [ { "lineno": 367, + [ { "lineno": 365, "filename": "events.js" } ], "docs": { "summary": "Information about the order resumption event.", @@ -3770,7 +3769,7 @@ "labels": [] }, { "name": "OrderStartDateChangedEvent", "locations": - [ { "lineno": 399, + [ { "lineno": 397, "filename": "events.js" } ], "docs": { "summary": "Information about the order's start date change event.", @@ -3871,7 +3870,7 @@ "labels": [] }, { "name": "OrderUpdatedEvent", "locations": - [ { "lineno": 234, + [ { "lineno": 232, "filename": "events.js" } ], "docs": { "summary": "Information about the order update event.", @@ -4091,7 +4090,7 @@ "labels": [] }, { "name": "PlanArchivedEvent", "locations": - [ { "lineno": 287, + [ { "lineno": 285, "filename": "events.js" } ], "docs": { "summary": "Information about the plan archive event.", @@ -4169,7 +4168,7 @@ "labels": [] }, { "name": "PlanCreatedEvent", "locations": - [ { "lineno": 244, + [ { "lineno": 242, "filename": "events.js" } ], "docs": { "summary": "Information about the create plan event.", @@ -4238,7 +4237,7 @@ "labels": [] }, { "name": "PlanPurchasedEvent", "locations": - [ { "lineno": 298, + [ { "lineno": 296, "filename": "events.js" } ], "docs": { "summary": "An object representing a new pricing plan purchase.", @@ -4361,7 +4360,7 @@ "labels": [] }, { "name": "PlanUpdatedEvent", "locations": - [ { "lineno": 254, + [ { "lineno": 252, "filename": "events.js" } ], "docs": { "summary": "Information about the plan update event.", diff --git a/wix-pricing-plans-backend/wix-pricing-plans-backend/Orders.service.json b/wix-pricing-plans-backend/wix-pricing-plans-backend/Orders.service.json index 7c1356f226..dfcfa987a3 100644 --- a/wix-pricing-plans-backend/wix-pricing-plans-backend/Orders.service.json +++ b/wix-pricing-plans-backend/wix-pricing-plans-backend/Orders.service.json @@ -1,8 +1,7 @@ { "name": "Orders", "memberOf": "wix-pricing-plans-backend", "mixes": [], - "labels": - [ "changed" ], + "labels": [], "location": { "lineno": 1, "filename": "orders.js" }, @@ -696,8 +695,7 @@ "extra": { } }, { "name": "listOrders", - "labels": - [ "changed" ], + "labels": [], "nameParams": [], "params": [ { "name": "filters", @@ -1777,8 +1775,7 @@ "doc": "Date and time the order was last updated. For example, the date and time an order was paused, resumed, or canceled." } ], "extra": { }, - "labels": - [ "changed" ] }, + "labels": [] }, { "name": "OrderCopy", "locations": [ { "lineno": 72,