Skip to content

Commit b1b9d7b

Browse files
djsteinmetzdjsteinmetz
authored
Merge pull request #72 from djsteinmetz/4.9.8
4.9.8
2 parents 2061113 + 0b6d0c1 commit b1b9d7b

16 files changed

Lines changed: 945 additions & 8 deletions

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ 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+
## [4.9.8] - 2022-06-08
9+
### Added
10+
- SDK up to date with [API v1.0.241](https://ordercloud.io/release-notes/v1.0.241)
11+
- Introduces [Product Collections](https://ordercloud.io/knowledge-base/product-collections)
812
## [4.8.8] - 2022-05-19
913
### Added
1014
- SDK up to date with [API v1.0.238](https://ordercloud.io/release-notes/v1.0.238)

‎docs/assets/js/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/me.html‎

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

‎docs/classes/xpindices.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
106106
<li>
107107
<h5>thingType: <a href="../index.html#xpthingtype" class="tsd-signature-type">XpThingType</a></h5>
108108
<div class="tsd-comment tsd-typography">
109-
<p>Thing type of the xp index. Possible values: Address, Variant, Order, OrderReturn, LineItem, CostCenter, CreditCard, Payment, Spec, SpecOption, UserGroup, Company, Category, PriceSchedule, Shipment, SpendingAccount, User, Promotion, ApprovalRule, SellerApprovalRule, Catalog, ProductFacet, MessageSender, InventoryRecord.</p>
109+
<p>Thing type of the xp index. Possible values: Address, Variant, Order, OrderReturn, LineItem, CostCenter, CreditCard, Payment, Spec, SpecOption, UserGroup, Company, Category, PriceSchedule, Shipment, SpendingAccount, User, Promotion, ApprovalRule, SellerApprovalRule, Catalog, ProductFacet, MessageSender, InventoryRecord, ProductCollection.</p>
110110
</div>
111111
</li>
112112
<li>

‎docs/index.html‎

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

‎docs/interfaces/productcollection.html‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>ProductCollection | ordercloud-javascript-sdk</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="../index.html" class="title">ordercloud-javascript-sdk</a>
26+
</div>
27+
</div>
28+
</div>
29+
</div>
30+
<div class="tsd-page-title">
31+
<div class="container">
32+
<ul class="tsd-breadcrumb">
33+
<li>
34+
<a href="../index.html">OrderCloudSDK</a>
35+
</li>
36+
<li>
37+
<a href="productcollection.html">ProductCollection</a>
38+
</li>
39+
</ul>
40+
</div>
41+
</div>
42+
</header>
43+
<div class="container container-main">
44+
<div class="row">
45+
<div class="col-8 col-content">
46+
<section class="tsd-panel tsd-type-parameters">
47+
<h3>Type parameters</h3>
48+
<ul class="tsd-type-parameters">
49+
<li>
50+
<h4>TProductCollectionXp</h4>
51+
</li>
52+
</ul>
53+
</section>
54+
<section class="tsd-panel-group tsd-index-group">
55+
<h2>API Reference</h2>
56+
<section class="tsd-panel tsd-index-panel">
57+
<div class="tsd-index-content">
58+
<section class="tsd-index-section ">
59+
<h3>Properties</h3>
60+
<ul class="tsd-index-list">
61+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="productcollection.html#id" class="tsd-kind-icon">ID</a></li>
62+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="productcollection.html#name" class="tsd-kind-icon">Name</a></li>
63+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="productcollection.html#xp" class="tsd-kind-icon">xp</a></li>
64+
</ul>
65+
</section>
66+
</div>
67+
</section>
68+
</section>
69+
<section class="tsd-panel-group tsd-member-group ">
70+
<h2>Properties</h2>
71+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
72+
<a name="id" class="tsd-anchor"></a>
73+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ID</h3>
74+
<div class="tsd-signature tsd-kind-icon">ID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
75+
<aside class="tsd-sources">
76+
</aside>
77+
</section>
78+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
79+
<a name="name" class="tsd-anchor"></a>
80+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Name</h3>
81+
<div class="tsd-signature tsd-kind-icon">Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
82+
<aside class="tsd-sources">
83+
</aside>
84+
</section>
85+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
86+
<a name="xp" class="tsd-anchor"></a>
87+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> xp</h3>
88+
<div class="tsd-signature tsd-kind-icon">xp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TProductCollectionXp</span></div>
89+
<aside class="tsd-sources">
90+
</aside>
91+
</section>
92+
</section>
93+
</div>
94+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
95+
<nav class="tsd-navigation primary">
96+
<ul>
97+
</ul>
98+
</nav>
99+
<nav class="tsd-navigation secondary menu-sticky">
100+
<ul class="before-current">
101+
</ul>
102+
<ul class="current">
103+
<li class="current tsd-kind-interface tsd-has-type-parameter">
104+
<a href="productcollection.html" class="tsd-kind-icon">Product<wbr>Collection</a>
105+
<ul>
106+
<li class=" tsd-kind-property tsd-parent-kind-interface">
107+
<a href="productcollection.html#id" class="tsd-kind-icon">ID</a>
108+
</li>
109+
<li class=" tsd-kind-property tsd-parent-kind-interface">
110+
<a href="productcollection.html#name" class="tsd-kind-icon">Name</a>
111+
</li>
112+
<li class=" tsd-kind-property tsd-parent-kind-interface">
113+
<a href="productcollection.html#xp" class="tsd-kind-icon">xp</a>
114+
</li>
115+
</ul>
116+
</li>
117+
</ul>
118+
<ul class="after-current">
119+
</ul>
120+
</nav>
121+
</div>
122+
</div>
123+
</div>
124+
<footer class="with-border-bottom">
125+
<div class="container">
126+
<h2>Legend</h2>
127+
<div class="tsd-legend-group">
128+
<ul class="tsd-legend">
129+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
130+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
131+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
132+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
133+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
134+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
135+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
136+
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
137+
</ul>
138+
<ul class="tsd-legend">
139+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
140+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
141+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
142+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
143+
</ul>
144+
<ul class="tsd-legend">
145+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
146+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
147+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
148+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
149+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
150+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
151+
</ul>
152+
<ul class="tsd-legend">
153+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
154+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
155+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
156+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
157+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
158+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
159+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
160+
</ul>
161+
<ul class="tsd-legend">
162+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
163+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
164+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
165+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
166+
</ul>
167+
<ul class="tsd-legend">
168+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
169+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
170+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
171+
</ul>
172+
<ul class="tsd-legend">
173+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
174+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
175+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
176+
</ul>
177+
<ul class="tsd-legend">
178+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
179+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
180+
</ul>
181+
</div>
182+
</div>
183+
</footer>
184+
<div class="container tsd-generator">
185+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
186+
</div>
187+
<div class="overlay"></div>
188+
<script src="../assets/js/main.js"></script>
189+
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
190+
</body>
191+
</html>

‎docs/interfaces/searchablemap.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ <h3>Properties</h3>
7878
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listcostcenters" class="tsd-kind-icon">Me.<wbr>List<wbr>Cost<wbr>Centers</a></li>
7979
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listcreditcards" class="tsd-kind-icon">Me.<wbr>List<wbr>Credit<wbr>Cards</a></li>
8080
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listorders" class="tsd-kind-icon">Me.<wbr>List<wbr>Orders</a></li>
81+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listproductcollectionentries" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries</a></li>
82+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listproductcollections" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collections</a></li>
8183
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listproducts" class="tsd-kind-icon">Me.<wbr>List<wbr>Products</a></li>
8284
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listpromotions" class="tsd-kind-icon">Me.<wbr>List<wbr>Promotions</a></li>
8385
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="searchablemap.html#me_listshipmentitems" class="tsd-kind-icon">Me.<wbr>List<wbr>Shipment<wbr>Items</a></li>
@@ -325,6 +327,20 @@ <h3>Me.<wbr>List<wbr>Orders</h3>
325327
<aside class="tsd-sources">
326328
</aside>
327329
</section>
330+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
331+
<a name="me_listproductcollectionentries" class="tsd-anchor"></a>
332+
<h3>Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries</h3>
333+
<div class="tsd-signature tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
334+
<aside class="tsd-sources">
335+
</aside>
336+
</section>
337+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
338+
<a name="me_listproductcollections" class="tsd-anchor"></a>
339+
<h3>Me.<wbr>List<wbr>Product<wbr>Collections</h3>
340+
<div class="tsd-signature tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">"ID"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Name"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div>
341+
<aside class="tsd-sources">
342+
</aside>
343+
</section>
328344
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
329345
<a name="me_listproducts" class="tsd-anchor"></a>
330346
<h3>Me.<wbr>List<wbr>Products</h3>
@@ -731,6 +747,12 @@ <h3>Xp<wbr>Indices.<wbr>List</h3>
731747
<li class=" tsd-kind-property tsd-parent-kind-interface">
732748
<a href="searchablemap.html#me_listorders" class="tsd-kind-icon">Me.<wbr>List<wbr>Orders</a>
733749
</li>
750+
<li class=" tsd-kind-property tsd-parent-kind-interface">
751+
<a href="searchablemap.html#me_listproductcollectionentries" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries</a>
752+
</li>
753+
<li class=" tsd-kind-property tsd-parent-kind-interface">
754+
<a href="searchablemap.html#me_listproductcollections" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collections</a>
755+
</li>
734756
<li class=" tsd-kind-property tsd-parent-kind-interface">
735757
<a href="searchablemap.html#me_listproducts" class="tsd-kind-icon">Me.<wbr>List<wbr>Products</a>
736758
</li>

‎docs/interfaces/sortablemap.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ <h3>Properties</h3>
7878
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listcostcenters" class="tsd-kind-icon">Me.<wbr>List<wbr>Cost<wbr>Centers</a></li>
7979
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listcreditcards" class="tsd-kind-icon">Me.<wbr>List<wbr>Credit<wbr>Cards</a></li>
8080
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listorders" class="tsd-kind-icon">Me.<wbr>List<wbr>Orders</a></li>
81+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listproductcollectionentries" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries</a></li>
82+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listproductcollections" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collections</a></li>
8183
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listproducts" class="tsd-kind-icon">Me.<wbr>List<wbr>Products</a></li>
8284
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listpromotions" class="tsd-kind-icon">Me.<wbr>List<wbr>Promotions</a></li>
8385
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="sortablemap.html#me_listshipmentitems" class="tsd-kind-icon">Me.<wbr>List<wbr>Shipment<wbr>Items</a></li>
@@ -325,6 +327,20 @@ <h3>Me.<wbr>List<wbr>Orders</h3>
325327
<aside class="tsd-sources">
326328
</aside>
327329
</section>
330+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
331+
<a name="me_listproductcollectionentries" class="tsd-anchor"></a>
332+
<h3>Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries</h3>
333+
<div class="tsd-signature tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
334+
<aside class="tsd-sources">
335+
</aside>
336+
</section>
337+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
338+
<a name="me_listproductcollections" class="tsd-anchor"></a>
339+
<h3>Me.<wbr>List<wbr>Product<wbr>Collections</h3>
340+
<div class="tsd-signature tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">"ID"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Name"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"!ID"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"!Name"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div>
341+
<aside class="tsd-sources">
342+
</aside>
343+
</section>
328344
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
329345
<a name="me_listproducts" class="tsd-anchor"></a>
330346
<h3>Me.<wbr>List<wbr>Products</h3>
@@ -731,6 +747,12 @@ <h3>Xp<wbr>Indices.<wbr>List</h3>
731747
<li class=" tsd-kind-property tsd-parent-kind-interface">
732748
<a href="sortablemap.html#me_listorders" class="tsd-kind-icon">Me.<wbr>List<wbr>Orders</a>
733749
</li>
750+
<li class=" tsd-kind-property tsd-parent-kind-interface">
751+
<a href="sortablemap.html#me_listproductcollectionentries" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collection<wbr>Entries</a>
752+
</li>
753+
<li class=" tsd-kind-property tsd-parent-kind-interface">
754+
<a href="sortablemap.html#me_listproductcollections" class="tsd-kind-icon">Me.<wbr>List<wbr>Product<wbr>Collections</a>
755+
</li>
734756
<li class=" tsd-kind-property tsd-parent-kind-interface">
735757
<a href="sortablemap.html#me_listproducts" class="tsd-kind-icon">Me.<wbr>List<wbr>Products</a>
736758
</li>

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "ordercloud-javascript-sdk",
33
"description": "The offical Javascript SDK for the Ordercloud ecommerce API",
44
"author": "Four51 OrderCloud",
5-
"version": "4.8.8",
5+
"version": "4.9.8",
66
"main": "dist/index.js",
77
"umd:main": "dist/index.umd.js",
88
"module": "dist/index.esm.js",

0 commit comments

Comments
 (0)