Merge pull request #122 from erincdustin/9.0.0

9.0.0

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [9.0.0] - 2024-12-05
+- This version includes a breaking change that updates the following return types:
+- `ProductCollectionBuyerProduct` (updated from `BuyerProduct`) is the new type returned from `Me.ListProductCollectionEntries` 
+- `ProductCollectionProduct` (updated from `Product`) is the new type returned from `ProductCollections.ListEntries`
+
 # [8.0.2] - 2024-12-03
 - Bug fix for "process is undefined" accessor error when not using NextJS
 

MIGRATION_GUIDE.md

@@ -2,6 +2,31 @@
 
 The objective of this guide is to document the breaking changes and updates required to migrate from one major version to the next.
 
+## version 8.x.x to version 9.x.x
+* The return type for the `Me.ListProductCollectionEntries` method has been updated from `BuyerProduct` to `ProductCollectionBuyerProduct`
+
+    Before:
+    ```typescript
+    ListProductCollectionEntries<TBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TBuyerProduct>>>
+    ```
+
+    After:
+    ```typescript
+    ListProductCollectionEntries<TProductCollectionBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProductCollectionBuyerProduct>>>
+    ```
+
+    * The return type for the `ProductCollections.ListEntries` method has been updated from `Product` to `ProductCollectionProduct`
+
+    Before:
+    ```typescript
+    ListEntries<TProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProduct>>>
+    ```
+
+    After:
+    ```typescript
+    ListEntries<TProductCollectionBuyerProduct>(...) : Promise<RequiredDeep<ListPageWithFacets<TProductCollectionBuyerProduct>>>
+    ```
+
 ## version 7.x.x to version 8.x.x
 * The return type for the `ListEligiblePromotions` method has been updated from `Promotion` to `OrderPromotion`
 

docs/classes/Resources.ProductCollections.html

@@ -145,7 +145,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="ListEntries" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>List<wbr/>Entries</span><a href="#ListEntries" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
-<li class="tsd-signature tsd-anchor-link" id="ListEntries.ListEntries-1">List<wbr/>Entries<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProduct</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>buyerID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, productCollectionID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>filters<span class="tsd-signature-symbol">?: </span><a href="../types/Filters.html" class="tsd-signature-type" data-tsd-kind="Type alias">Filters</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>page<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>search<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>searchOn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>searchType<span class="tsd-signature-symbol">?: </span><a href="../types/SearchType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SearchType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>sortBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Resources.RequiredObjectDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredObjectDeep</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ListPageWithFacets.html" class="tsd-signature-type" data-tsd-kind="Interface">ListPageWithFacets</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProduct</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#ListEntries.ListEntries-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
+<li class="tsd-signature tsd-anchor-link" id="ListEntries.ListEntries-1">List<wbr/>Entries<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProductCollectionProduct</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>buyerID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, productCollectionID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>filters<span class="tsd-signature-symbol">?: </span><a href="../types/Filters.html" class="tsd-signature-type" data-tsd-kind="Type alias">Filters</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>page<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>pageSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>search<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>searchOn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>searchType<span class="tsd-signature-symbol">?: </span><a href="../types/SearchType.html" class="tsd-signature-type" data-tsd-kind="Type alias">SearchType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>sortBy<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RequestOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RequestOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Resources.RequiredObjectDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredObjectDeep</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ListPageWithFacets.html" class="tsd-signature-type" data-tsd-kind="Interface">ListPageWithFacets</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProductCollectionProduct</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#ListEntries.ListEntries-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>Get a list of product collection entries. 
 Check out the <a href="https://ordercloud.io/api-reference/buyers/product-collections/list-entries%7Capi">docs</a> for more info</p>
@@ -154,7 +154,7 @@ <h3 class="tsd-anchor-link"><span>List<wbr/>Entries</span><a href="#ListEntries"
 <h4>Type Parameters</h4>
 <ul class="tsd-type-parameters">
 <li>
-<h4>TProduct<span class="tsd-signature-symbol"> extends </span><a href="../interfaces/Product.html" class="tsd-signature-type" data-tsd-kind="Interface">Product</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProduct</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
+<h4>TProductCollectionProduct<span class="tsd-signature-symbol"> extends </span><a href="../interfaces/ProductCollectionProduct.html" class="tsd-signature-type" data-tsd-kind="Interface">ProductCollectionProduct</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProductCollectionProduct</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -199,7 +199,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> sort<wbr/>By<span clas
 </div></li></ul></li>
 <li>
 <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>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Resources.RequiredObjectDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredObjectDeep</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ListPageWithFacets.html" class="tsd-signature-type" data-tsd-kind="Interface">ListPageWithFacets</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProduct</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Resources.RequiredObjectDeep.html" class="tsd-signature-type" data-tsd-kind="Type alias">RequiredObjectDeep</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ListPageWithFacets.html" class="tsd-signature-type" data-tsd-kind="Interface">ListPageWithFacets</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TProductCollectionProduct</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
 <li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/api/ProductCollections.ts#L94">api/ProductCollections.ts:94</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">

docs/index.html

@@ -78,6 +78,7 @@ <h3 class="tsd-index-heading">Interfaces</h3>
 <a href="interfaces/Incrementor.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Incrementor</span></a>
 <a href="interfaces/IntegrationEvent.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Integration<wbr/>Event</span></a>
 <a href="interfaces/Inventory.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Inventory</span></a>
+<a href="interfaces/InventoryIntegration.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Inventory<wbr/>Integration</span></a>
 <a href="interfaces/InventoryRecord.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Inventory<wbr/>Record</span></a>
 <a href="interfaces/InventoryRecordAssignment.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Inventory<wbr/>Record<wbr/>Assignment</span></a>
 <a href="interfaces/KafkaConfig.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Kafka<wbr/>Config</span></a>
@@ -150,7 +151,10 @@ <h3 class="tsd-index-heading">Interfaces</h3>
 <a href="interfaces/ProductAssignment.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Assignment</span></a>
 <a href="interfaces/ProductCatalogAssignment.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Catalog<wbr/>Assignment</span></a>
 <a href="interfaces/ProductCollection.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Collection</span></a>
+<a href="interfaces/ProductCollectionBuyerProduct.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Collection<wbr/>Buyer<wbr/>Product</span></a>
+<a href="interfaces/ProductCollectionEntry.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Collection<wbr/>Entry</span></a>
 <a href="interfaces/ProductCollectionInvitation.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Collection<wbr/>Invitation</span></a>
+<a href="interfaces/ProductCollectionProduct.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Collection<wbr/>Product</span></a>
 <a href="interfaces/ProductFacet.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Facet</span></a>
 <a href="interfaces/ProductSeller.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Seller</span></a>
 <a href="interfaces/ProductSupplier.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Product<wbr/>Supplier</span></a>
@@ -261,6 +265,7 @@ <h3 class="tsd-index-heading">Variables</h3>
 <a href="variables/ImpersonationConfigs.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Impersonation<wbr/>Configs</span></a>
 <a href="variables/Incrementors.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Incrementors</span></a>
 <a href="variables/IntegrationEvents.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Integration<wbr/>Events</span></a>
+<a href="variables/InventoryIntegrations.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Inventory<wbr/>Integrations</span></a>
 <a href="variables/InventoryRecords.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Inventory<wbr/>Records</span></a>
 <a href="variables/LineItems.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Line<wbr/>Items</span></a>
 <a href="variables/Locales.html" class="tsd-index-link tsd-kind-variable"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg><span>Locales</span></a>