Skip to content

Commit 68d3384

Browse files
committed
Update MIGRATION_GUIDE.md
Includes breaking change from 7x => 8x
1 parent 4f62769 commit 68d3384

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

MIGRATION_GUIDE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
The objective of this guide is to document the breaking changes and updates required to migrate from one major version to the next.
44

5+
## version 7.x.x to version 8.x.x
6+
* The return type for the `ListEligiblePromotions` method has been updated from `Promotion` to `OrderPromotion`
7+
8+
Before:
9+
```typescript
10+
ListEligiblePromotions<TPromotion>(...) : Promise<RequiredDeep<ListPage<TPromotion>>>
11+
```
12+
13+
After:
14+
```typescript
15+
ListEligiblePromotions<TOrderPromotion>(...) : Promise<RequiredDeep<ListPage<TOrderPromotion>>>
16+
```
17+
518
## version 6.x.x to version 7.x.x
619
* The method names for the `EntitySynchronization` service have been streamlined for improved clarity. The previous naming convention included the suffix `EntitySyncConfig`, which has now been removed
720

0 commit comments

Comments
 (0)