Skip to content

Commit 470ed3a

Browse files
author
Crhistian Ramirez
committed
⏩ regen to api v1.0.196
https://ordercloud.io/release-notes/v1.0.196
1 parent 7ad0070 commit 470ed3a

13 files changed

Lines changed: 688 additions & 11 deletions

File tree

‎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/certs.html‎

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
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>Certs | 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="certs.html">Certs</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>Methods</h3>
52+
<ul class="tsd-index-list">
53+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="certs.html#as" class="tsd-kind-icon">As</a></li>
54+
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="certs.html#getpublickey" class="tsd-kind-icon">Get<wbr>Public<wbr>Key</a></li>
55+
</ul>
56+
</section>
57+
</div>
58+
</section>
59+
</section>
60+
<section class="tsd-panel-group tsd-member-group ">
61+
<h2>Methods</h2>
62+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
63+
<a name="as" class="tsd-anchor"></a>
64+
<h3>As</h3>
65+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
66+
<li class="tsd-signature tsd-kind-icon">As<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
67+
</ul>
68+
<ul class="tsd-descriptions">
69+
<li class="tsd-description">
70+
<aside class="tsd-sources">
71+
</aside>
72+
<div class="tsd-comment tsd-typography">
73+
<dl class="tsd-comment-tags">
74+
<dt>description</dt>
75+
<dd><p>enables impersonation by calling the subsequent method with the stored impersonation token</p>
76+
</dd>
77+
<dt>example</dt>
78+
<dd><p>Certs.As().List() // lists Certs using the impersonated users&#39; token</p>
79+
</dd>
80+
</dl>
81+
</div>
82+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
83+
</li>
84+
</ul>
85+
</section>
86+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
87+
<a name="getpublickey" class="tsd-anchor"></a>
88+
<h3>Get<wbr>Public<wbr>Key</h3>
89+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
90+
<li class="tsd-signature tsd-kind-icon">Get<wbr>Public<wbr>Key&lt;TPublicKey&gt;<span class="tsd-signature-symbol">(</span>ID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, requestOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/requestoptions.html" class="tsd-signature-type">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="../index.html#requireddeep" class="tsd-signature-type">RequiredDeep</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TPublicKey</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
91+
</ul>
92+
<ul class="tsd-descriptions">
93+
<li class="tsd-description">
94+
<aside class="tsd-sources">
95+
</aside>
96+
<div class="tsd-comment tsd-typography">
97+
<div class="lead">
98+
<p>Get a single cert public key.
99+
Check out the <a href="https://ordercloud.io/api-reference/authentication-and-authorization/certs/get-public-key" class="external">api docs</a> for more info</p>
100+
</div>
101+
</div>
102+
<h4 class="tsd-type-parameters-title">Type parameters</h4>
103+
<ul class="tsd-type-parameters">
104+
<li>
105+
<h4>TPublicKey<span class="tsd-signature-symbol">: </span><a href="../interfaces/publickey.html" class="tsd-signature-type">PublicKey</a></h4>
106+
</li>
107+
</ul>
108+
<h4 class="tsd-parameters-title">Parameters</h4>
109+
<ul class="tsd-parameters">
110+
<li>
111+
<h5>ID: <span class="tsd-signature-type">string</span></h5>
112+
<div class="tsd-comment tsd-typography">
113+
<p>ID of the public key.</p>
114+
</div>
115+
</li>
116+
<li>
117+
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> requestOptions: <a href="../interfaces/requestoptions.html" class="tsd-signature-type">RequestOptions</a><span class="tsd-signature-symbol"> = {}</span></h5>
118+
</li>
119+
</ul>
120+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../index.html#requireddeep" class="tsd-signature-type">RequiredDeep</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TPublicKey</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
121+
</li>
122+
</ul>
123+
</section>
124+
</section>
125+
</div>
126+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
127+
<nav class="tsd-navigation primary">
128+
<ul>
129+
</ul>
130+
</nav>
131+
<nav class="tsd-navigation secondary menu-sticky">
132+
<ul class="before-current">
133+
</ul>
134+
<ul class="current">
135+
<li class="current tsd-kind-class">
136+
<a href="certs.html" class="tsd-kind-icon">Certs</a>
137+
<ul>
138+
<li class=" tsd-kind-method tsd-parent-kind-class">
139+
<a href="certs.html#as" class="tsd-kind-icon">As</a>
140+
</li>
141+
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
142+
<a href="certs.html#getpublickey" class="tsd-kind-icon">Get<wbr>Public<wbr>Key</a>
143+
</li>
144+
</ul>
145+
</li>
146+
</ul>
147+
<ul class="after-current">
148+
</ul>
149+
</nav>
150+
</div>
151+
</div>
152+
</div>
153+
<footer class="with-border-bottom">
154+
<div class="container">
155+
<h2>Legend</h2>
156+
<div class="tsd-legend-group">
157+
<ul class="tsd-legend">
158+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
159+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
160+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
161+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
162+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
163+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
164+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
165+
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
166+
</ul>
167+
<ul class="tsd-legend">
168+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
169+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
170+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
171+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
172+
</ul>
173+
<ul class="tsd-legend">
174+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
175+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
176+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
177+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
178+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
179+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
180+
</ul>
181+
<ul class="tsd-legend">
182+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
183+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
184+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
185+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
186+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
187+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
188+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
189+
</ul>
190+
<ul class="tsd-legend">
191+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
192+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
193+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
194+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
195+
</ul>
196+
<ul class="tsd-legend">
197+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
198+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
199+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
200+
</ul>
201+
<ul class="tsd-legend">
202+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
203+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
204+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
205+
</ul>
206+
<ul class="tsd-legend">
207+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
208+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
209+
</ul>
210+
</div>
211+
</div>
212+
</footer>
213+
<div class="container tsd-generator">
214+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
215+
</div>
216+
<div class="overlay"></div>
217+
<script src="../assets/js/main.js"></script>
218+
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
219+
</body>
220+
</html>

‎docs/classes/orderclouderror.html‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ <h3>Properties</h3>
6363
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="orderclouderror.html#name" class="tsd-kind-icon">name</a></li>
6464
<li class="tsd-kind-property tsd-parent-kind-class"><a href="orderclouderror.html#request" class="tsd-kind-icon">request</a></li>
6565
<li class="tsd-kind-property tsd-parent-kind-class"><a href="orderclouderror.html#response" class="tsd-kind-icon">response</a></li>
66-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="orderclouderror.html#stack" class="tsd-kind-icon">stack</a></li>
66+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="orderclouderror.html#stack" class="tsd-kind-icon">stack</a></li>
6767
<li class="tsd-kind-property tsd-parent-kind-class"><a href="orderclouderror.html#status" class="tsd-kind-icon">status</a></li>
6868
<li class="tsd-kind-property tsd-parent-kind-class"><a href="orderclouderror.html#statustext" class="tsd-kind-icon">status<wbr>Text</a></li>
6969
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="orderclouderror.html#error" class="tsd-kind-icon">Error</a></li>
@@ -148,13 +148,12 @@ <h3>response</h3>
148148
<aside class="tsd-sources">
149149
</aside>
150150
</section>
151-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
151+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
152152
<a name="stack" class="tsd-anchor"></a>
153153
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
154154
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
155155
<aside class="tsd-sources">
156156
<p>Inherited from <a href="orderclouderror.html">OrderCloudError</a>.<a href="orderclouderror.html#stack">stack</a></p>
157-
<p>Overrides <a href="orderclouderror.html">OrderCloudError</a>.<a href="orderclouderror.html#stack">stack</a></p>
158157
</aside>
159158
</section>
160159
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
@@ -216,7 +215,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
216215
<li class=" tsd-kind-property tsd-parent-kind-class">
217216
<a href="orderclouderror.html#response" class="tsd-kind-icon">response</a>
218217
</li>
219-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
218+
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
220219
<a href="orderclouderror.html#stack" class="tsd-kind-icon">stack</a>
221220
</li>
222221
<li class=" tsd-kind-property tsd-parent-kind-class">

‎docs/index.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ <h3>Classes</h3>
5757
<li class="tsd-kind-class"><a href="classes/buyers.html" class="tsd-kind-icon">Buyers</a></li>
5858
<li class="tsd-kind-class"><a href="classes/catalogs.html" class="tsd-kind-icon">Catalogs</a></li>
5959
<li class="tsd-kind-class"><a href="classes/categories.html" class="tsd-kind-icon">Categories</a></li>
60+
<li class="tsd-kind-class"><a href="classes/certs.html" class="tsd-kind-icon">Certs</a></li>
6061
<li class="tsd-kind-class"><a href="classes/configuration.html" class="tsd-kind-icon">Configuration</a></li>
6162
<li class="tsd-kind-class"><a href="classes/costcenters.html" class="tsd-kind-icon">Cost<wbr>Centers</a></li>
6263
<li class="tsd-kind-class"><a href="classes/creditcards.html" class="tsd-kind-icon">Credit<wbr>Cards</a></li>
@@ -168,6 +169,7 @@ <h3>Interfaces</h3>
168169
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/promotion.html" class="tsd-kind-icon">Promotion</a></li>
169170
<li class="tsd-kind-interface"><a href="interfaces/promotionassignment.html" class="tsd-kind-icon">Promotion<wbr>Assignment</a></li>
170171
<li class="tsd-kind-interface"><a href="interfaces/promotionoverride.html" class="tsd-kind-icon">Promotion<wbr>Override</a></li>
172+
<li class="tsd-kind-interface"><a href="interfaces/publickey.html" class="tsd-kind-icon">Public<wbr>Key</a></li>
171173
<li class="tsd-kind-interface"><a href="interfaces/requestoptions.html" class="tsd-kind-icon">Request<wbr>Options</a></li>
172174
<li class="tsd-kind-interface"><a href="interfaces/sdkconfiguration.html" class="tsd-kind-icon">Sdk<wbr>Configuration</a></li>
173175
<li class="tsd-kind-interface"><a href="interfaces/searchablemap.html" class="tsd-kind-icon">Searchable<wbr>Map</a></li>
@@ -541,6 +543,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
541543
<li class=" tsd-kind-class">
542544
<a href="classes/categories.html" class="tsd-kind-icon">Categories</a>
543545
</li>
546+
<li class=" tsd-kind-class">
547+
<a href="classes/certs.html" class="tsd-kind-icon">Certs</a>
548+
</li>
544549
<li class=" tsd-kind-class">
545550
<a href="classes/configuration.html" class="tsd-kind-icon">Configuration</a>
546551
</li>
@@ -859,6 +864,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
859864
<li class=" tsd-kind-interface">
860865
<a href="interfaces/promotionoverride.html" class="tsd-kind-icon">Promotion<wbr>Override</a>
861866
</li>
867+
<li class=" tsd-kind-interface">
868+
<a href="interfaces/publickey.html" class="tsd-kind-icon">Public<wbr>Key</a>
869+
</li>
862870
<li class=" tsd-kind-interface">
863871
<a href="interfaces/requestoptions.html" class="tsd-kind-icon">Request<wbr>Options</a>
864872
</li>

0 commit comments

Comments
 (0)