Skip to content

Commit 575e9ac

Browse files
erincdustinerincdustin
authored
Merge pull request #118 from erincdustin/8.0.0
8.0.0
2 parents 69d40db + a6b96e4 commit 575e9ac

28 files changed

Lines changed: 436 additions & 225 deletions

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
# [8.0.0] - 2024-10-31
9+
- This version includes a breaking change that changes the return type for the ListEligiblePromotions method
10+
811
# [7.0.0] - 2024-10-10
912
- Bring SDK up to date with API [v1.0.365](https://ordercloud.io/release-notes/v1.0.365)
1013
- This version includes a breaking change that corrects naming for Entity Sync methods

‎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

‎docs/assets/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/Resources.AdminUsers.html‎

Lines changed: 30 additions & 8 deletions
Large diffs are not rendered by default.

‎docs/classes/Resources.Cart.html‎

Lines changed: 47 additions & 47 deletions
Large diffs are not rendered by default.

‎docs/classes/Resources.EntitySynchronization.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
396396
<ul class="tsd-parameter-list">
397397
<li>
398398
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
399-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
399+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
400400
</div></li>
401401
<li>
402402
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
@@ -421,7 +421,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
421421
<ul class="tsd-parameter-list">
422422
<li>
423423
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
424-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
424+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
425425
</div></li>
426426
<li>
427427
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
@@ -446,7 +446,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
446446
<ul class="tsd-parameter-list">
447447
<li>
448448
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
449-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
449+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
450450
</div></li>
451451
<li>
452452
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
@@ -471,7 +471,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
471471
<ul class="tsd-parameter-list">
472472
<li>
473473
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
474-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
474+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
475475
</div></li>
476476
<li>
477477
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
@@ -496,7 +496,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
496496
<ul class="tsd-parameter-list">
497497
<li>
498498
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
499-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
499+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
500500
</div></li>
501501
<li>
502502
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
@@ -521,7 +521,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
521521
<ul class="tsd-parameter-list">
522522
<li>
523523
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
524-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
524+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
525525
</div></li>
526526
<li>
527527
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
@@ -546,7 +546,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
546546
<ul class="tsd-parameter-list">
547547
<li>
548548
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
549-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
549+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
550550
</div></li>
551551
<li>
552552
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>
@@ -571,7 +571,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
571571
<ul class="tsd-parameter-list">
572572
<li>
573573
<h5>entitySyncConfig: <a href="../interfaces/EntitySyncConfig.html" class="tsd-signature-type" data-tsd-kind="Interface">EntitySyncConfig</a></h5>
574-
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID</p>
574+
<div class="tsd-comment tsd-typography"><p>Required fields: DeliveryConfigID, SyncEntityChanged, SyncEntityDeleted</p>
575575
</div></li>
576576
<li>
577577
<h5>requestOptions: <a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5></li></ul></div>

0 commit comments

Comments
 (0)