Skip to content

Commit 115a649

Browse files
committed
⏩ regen to API v1.0.238
1 parent b50200a commit 115a649

64 files changed

Lines changed: 5940 additions & 16 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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/orderreturns.html

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

docs/classes/products.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1044,7 +1044,7 @@ <h3>Save<wbr>Variant</h3>
10441044
</aside>
10451045
<div class="tsd-comment tsd-typography">
10461046
<div class="lead">
1047-
<p>Create or update a product variant. Update a product variant.
1047+
<p>Update a product variant. Update a product variant.
10481048
Check out the <a href="https://ordercloud.io/api-reference/product-catalogs/products/save-variant" class="external">api docs</a> for more info</p>
10491049
</div>
10501050
</div>

docs/classes/sellerapprovalrules.html

Lines changed: 468 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, LineItem, CostCenter, CreditCard, Payment, Spec, SpecOption, UserGroup, Company, Category, PriceSchedule, Shipment, SpendingAccount, User, Promotion, ApprovalRule, 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.</p>
110110
</div>
111111
</li>
112112
<li>

docs/index.html

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

docs/interfaces/apiclient.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ <h3>Properties</h3>
7676
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="apiclient.html#minimumrequiredroles" class="tsd-kind-icon">Minimum<wbr>Required<wbr>Roles</a></li>
7777
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="apiclient.html#ordercheckoutintegrationeventid" class="tsd-kind-icon">Order<wbr>Checkout<wbr>Integration<wbr>EventID</a></li>
7878
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="apiclient.html#ordercheckoutintegrationeventname" class="tsd-kind-icon">Order<wbr>Checkout<wbr>Integration<wbr>Event<wbr>Name</a></li>
79+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="apiclient.html#orderreturnintegrationeventid" class="tsd-kind-icon">Order<wbr>Return<wbr>Integration<wbr>EventID</a></li>
80+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="apiclient.html#orderreturnintegrationeventname" class="tsd-kind-icon">Order<wbr>Return<wbr>Integration<wbr>Event<wbr>Name</a></li>
7981
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="apiclient.html#refreshtokenduration" class="tsd-kind-icon">Refresh<wbr>Token<wbr>Duration</a></li>
8082
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="apiclient.html#xp" class="tsd-kind-icon">xp</a></li>
8183
</ul>
@@ -211,6 +213,20 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> Order<wbr>Checkout<wb
211213
<aside class="tsd-sources">
212214
</aside>
213215
</section>
216+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
217+
<a name="orderreturnintegrationeventid" class="tsd-anchor"></a>
218+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Order<wbr>Return<wbr>Integration<wbr>EventID</h3>
219+
<div class="tsd-signature tsd-kind-icon">Order<wbr>Return<wbr>Integration<wbr>EventID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
220+
<aside class="tsd-sources">
221+
</aside>
222+
</section>
223+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
224+
<a name="orderreturnintegrationeventname" class="tsd-anchor"></a>
225+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Order<wbr>Return<wbr>Integration<wbr>Event<wbr>Name</h3>
226+
<div class="tsd-signature tsd-kind-icon">Order<wbr>Return<wbr>Integration<wbr>Event<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
227+
<aside class="tsd-sources">
228+
</aside>
229+
</section>
214230
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
215231
<a name="refreshtokenduration" class="tsd-anchor"></a>
216232
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Refresh<wbr>Token<wbr>Duration</h3>
@@ -293,6 +309,12 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> xp</h3>
293309
<li class=" tsd-kind-property tsd-parent-kind-interface">
294310
<a href="apiclient.html#ordercheckoutintegrationeventname" class="tsd-kind-icon">Order<wbr>Checkout<wbr>Integration<wbr>Event<wbr>Name</a>
295311
</li>
312+
<li class=" tsd-kind-property tsd-parent-kind-interface">
313+
<a href="apiclient.html#orderreturnintegrationeventid" class="tsd-kind-icon">Order<wbr>Return<wbr>Integration<wbr>EventID</a>
314+
</li>
315+
<li class=" tsd-kind-property tsd-parent-kind-interface">
316+
<a href="apiclient.html#orderreturnintegrationeventname" class="tsd-kind-icon">Order<wbr>Return<wbr>Integration<wbr>Event<wbr>Name</a>
317+
</li>
296318
<li class=" tsd-kind-property tsd-parent-kind-interface">
297319
<a href="apiclient.html#refreshtokenduration" class="tsd-kind-icon">Refresh<wbr>Token<wbr>Duration</a>
298320
</li>

docs/interfaces/approvalinfo.html

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
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>ApprovalInfo | 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="approvalinfo.html">ApprovalInfo</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-group tsd-index-group">
47+
<h2>API Reference</h2>
48+
<section class="tsd-panel tsd-index-panel">
49+
<div class="tsd-index-content">
50+
<section class="tsd-index-section ">
51+
<h3>Properties</h3>
52+
<ul class="tsd-index-list">
53+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="approvalinfo.html#comments" class="tsd-kind-icon">Comments</a></li>
54+
</ul>
55+
</section>
56+
</div>
57+
</section>
58+
</section>
59+
<section class="tsd-panel-group tsd-member-group ">
60+
<h2>Properties</h2>
61+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
62+
<a name="comments" class="tsd-anchor"></a>
63+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Comments</h3>
64+
<div class="tsd-signature tsd-kind-icon">Comments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
65+
<aside class="tsd-sources">
66+
</aside>
67+
</section>
68+
</section>
69+
</div>
70+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
71+
<nav class="tsd-navigation primary">
72+
<ul>
73+
</ul>
74+
</nav>
75+
<nav class="tsd-navigation secondary menu-sticky">
76+
<ul class="before-current">
77+
</ul>
78+
<ul class="current">
79+
<li class="current tsd-kind-interface">
80+
<a href="approvalinfo.html" class="tsd-kind-icon">Approval<wbr>Info</a>
81+
<ul>
82+
<li class=" tsd-kind-property tsd-parent-kind-interface">
83+
<a href="approvalinfo.html#comments" class="tsd-kind-icon">Comments</a>
84+
</li>
85+
</ul>
86+
</li>
87+
</ul>
88+
<ul class="after-current">
89+
</ul>
90+
</nav>
91+
</div>
92+
</div>
93+
</div>
94+
<footer class="with-border-bottom">
95+
<div class="container">
96+
<h2>Legend</h2>
97+
<div class="tsd-legend-group">
98+
<ul class="tsd-legend">
99+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
100+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
101+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
102+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
103+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
104+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
105+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
106+
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
107+
</ul>
108+
<ul class="tsd-legend">
109+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
110+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
111+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
112+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
113+
</ul>
114+
<ul class="tsd-legend">
115+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
116+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
117+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
118+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
119+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
120+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
121+
</ul>
122+
<ul class="tsd-legend">
123+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
124+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
125+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
126+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
127+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
128+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
129+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
130+
</ul>
131+
<ul class="tsd-legend">
132+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
133+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
134+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
135+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
136+
</ul>
137+
<ul class="tsd-legend">
138+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
139+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
140+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
141+
</ul>
142+
<ul class="tsd-legend">
143+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
144+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
145+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
146+
</ul>
147+
<ul class="tsd-legend">
148+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
149+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
150+
</ul>
151+
</div>
152+
</div>
153+
</footer>
154+
<div class="container tsd-generator">
155+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
156+
</div>
157+
<div class="overlay"></div>
158+
<script src="../assets/js/main.js"></script>
159+
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
160+
</body>
161+
</html>

docs/interfaces/buyerproduct.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ <h3>Properties</h3>
7070
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="buyerproduct.html#name" class="tsd-kind-icon">Name</a></li>
7171
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="buyerproduct.html#priceschedule" class="tsd-kind-icon">Price<wbr>Schedule</a></li>
7272
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="buyerproduct.html#quantitymultiplier" class="tsd-kind-icon">Quantity<wbr>Multiplier</a></li>
73+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="buyerproduct.html#returnable" class="tsd-kind-icon">Returnable</a></li>
7374
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="buyerproduct.html#shipfromaddressid" class="tsd-kind-icon">Ship<wbr>From<wbr>AddressID</a></li>
7475
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="buyerproduct.html#shipheight" class="tsd-kind-icon">Ship<wbr>Height</a></li>
7576
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="buyerproduct.html#shiplength" class="tsd-kind-icon">Ship<wbr>Length</a></li>
@@ -148,6 +149,13 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> Quantity<wbr>Multipli
148149
<aside class="tsd-sources">
149150
</aside>
150151
</section>
152+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
153+
<a name="returnable" class="tsd-anchor"></a>
154+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Returnable</h3>
155+
<div class="tsd-signature tsd-kind-icon">Returnable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
156+
<aside class="tsd-sources">
157+
</aside>
158+
</section>
151159
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
152160
<a name="shipfromaddressid" class="tsd-anchor"></a>
153161
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Ship<wbr>From<wbr>AddressID</h3>
@@ -245,6 +253,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> xp</h3>
245253
<li class=" tsd-kind-property tsd-parent-kind-interface">
246254
<a href="buyerproduct.html#quantitymultiplier" class="tsd-kind-icon">Quantity<wbr>Multiplier</a>
247255
</li>
256+
<li class=" tsd-kind-property tsd-parent-kind-interface">
257+
<a href="buyerproduct.html#returnable" class="tsd-kind-icon">Returnable</a>
258+
</li>
248259
<li class=" tsd-kind-property tsd-parent-kind-interface">
249260
<a href="buyerproduct.html#shipfromaddressid" class="tsd-kind-icon">Ship<wbr>From<wbr>AddressID</a>
250261
</li>

docs/interfaces/extendedlineitem.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ <h3>Properties</h3>
8888
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#linetotal" class="tsd-kind-icon">Line<wbr>Total</a></li>
8989
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#order" class="tsd-kind-icon">Order</a></li>
9090
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#orderid" class="tsd-kind-icon">OrderID</a></li>
91+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#priceoverridden" class="tsd-kind-icon">Price<wbr>Overridden</a></li>
92+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#pricescheduleid" class="tsd-kind-icon">Price<wbr>ScheduleID</a></li>
9193
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#product" class="tsd-kind-icon">Product</a></li>
9294
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#productid" class="tsd-kind-icon">ProductID</a></li>
9395
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="extendedlineitem.html#promotiondiscount" class="tsd-kind-icon">Promotion<wbr>Discount</a></li>
@@ -173,6 +175,20 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> OrderID</h3>
173175
<aside class="tsd-sources">
174176
</aside>
175177
</section>
178+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
179+
<a name="priceoverridden" class="tsd-anchor"></a>
180+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Price<wbr>Overridden</h3>
181+
<div class="tsd-signature tsd-kind-icon">Price<wbr>Overridden<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
182+
<aside class="tsd-sources">
183+
</aside>
184+
</section>
185+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
186+
<a name="pricescheduleid" class="tsd-anchor"></a>
187+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Price<wbr>ScheduleID</h3>
188+
<div class="tsd-signature tsd-kind-icon">Price<wbr>ScheduleID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
189+
<aside class="tsd-sources">
190+
</aside>
191+
</section>
176192
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
177193
<a name="product" class="tsd-anchor"></a>
178194
<h3><span class="tsd-flag ts-flagOptional">Optional</span> Product</h3>
@@ -319,6 +335,12 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> xp</h3>
319335
<li class=" tsd-kind-property tsd-parent-kind-interface">
320336
<a href="extendedlineitem.html#orderid" class="tsd-kind-icon">OrderID</a>
321337
</li>
338+
<li class=" tsd-kind-property tsd-parent-kind-interface">
339+
<a href="extendedlineitem.html#priceoverridden" class="tsd-kind-icon">Price<wbr>Overridden</a>
340+
</li>
341+
<li class=" tsd-kind-property tsd-parent-kind-interface">
342+
<a href="extendedlineitem.html#pricescheduleid" class="tsd-kind-icon">Price<wbr>ScheduleID</a>
343+
</li>
322344
<li class=" tsd-kind-property tsd-parent-kind-interface">
323345
<a href="extendedlineitem.html#product" class="tsd-kind-icon">Product</a>
324346
</li>

0 commit comments

Comments
 (0)