⏩ regen to API 1.0.436

Author: erincdustin

README.md

@@ -206,6 +206,7 @@ Simply set the options you need to override and the SDK will merge it with the d
 import { Configuration } from 'ordercloud-javascript-sdk';
 
 Configuration.Set({
+  // This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal.
   baseApiUrl: 'https://sandboxapi.ordercloud.io',
   timeoutInMilliseconds: 20 * 1000
 })

codegen/templates/Configuration.ts

@@ -2,6 +2,7 @@ import { SdkConfiguration } from './models'
 
 class Configuration {
   private defaultConfig: SdkConfiguration = {
+    // This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal.
     baseApiUrl: 'https://api.ordercloud.io',
     apiVersion: 'v1',
     timeoutInMilliseconds: 60 * 1000, // 60 seconds by default

codegen/templates/models/SdkConfiguration.ts

@@ -4,6 +4,7 @@ export interface SdkConfiguration {
   /**
    * The apiurl that will be used to talk to the ordercloud API.
    * It may be useful to change this to interact with different environments
+   * This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal.
    *
    * Defaults to: https://api.ordercloud.io
    */

docs/classes/Resources.Configuration.html

@@ -43,7 +43,7 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>config</span><a href="#config" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature">config<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SdkConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">SdkConfiguration</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in Configuration.ts:17</li></ul></aside></section>
+<li>Defined in Configuration.ts:18</li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="defaultConfig" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>default<wbr/>Config</span><a href="#defaultConfig" 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>
 <div class="tsd-signature">default<wbr/>Config<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SdkConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">SdkConfiguration</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
@@ -58,7 +58,7 @@ <h3 class="tsd-anchor-link"><span>Get</span><a href="#Get" aria-label="Permalink
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/SdkConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">SdkConfiguration</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in Configuration.ts:37</li></ul></aside></li></ul></section>
+<li>Defined in Configuration.ts:38</li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="Set" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>Set</span><a href="#Set" 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">
@@ -71,7 +71,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>config: <a href="../interfaces/SdkConfiguration.html" class="tsd-signature-type" data-tsd-kind="Interface">SdkConfiguration</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in Configuration.ts:28</li></ul></aside></li></ul></section></section></div>
+<li>Defined in Configuration.ts:29</li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/classes/Resources.Me.html

@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">CookieOptions</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L42">models/SdkConfiguration.ts:42</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L43">models/SdkConfiguration.ts:43</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -42,38 +42,38 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <div class="tsd-comment tsd-typography"><p>The cookie will be available only for this domain and its sub-domains</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L46">models/SdkConfiguration.ts:46</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L47">models/SdkConfiguration.ts:47</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="path" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>path</span><a href="#path" 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>
 <div class="tsd-signature">path<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>defines which paths on the domain the cookie will be accessible on
 defaults to &#39;/&#39; which means it is available on all paths in the domain</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L69">models/SdkConfiguration.ts:69</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L70">models/SdkConfiguration.ts:70</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="prefix" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>prefix</span><a href="#prefix" 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>
 <div class="tsd-signature">prefix<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>prefix for all cookies set by ordercloud</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L63">models/SdkConfiguration.ts:63</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L64">models/SdkConfiguration.ts:64</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="samesite" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>samesite</span><a href="#samesite" 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>
 <div class="tsd-signature">samesite<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;none&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;strict&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;lax&quot;</span></div>
 <div class="tsd-comment tsd-typography"><p>Defines protocol for how cookies should be sent
 in first or third party contexts <a href="https://adzerk.com/blog/chrome-samesite/">https://adzerk.com/blog/chrome-samesite/</a></p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L58">models/SdkConfiguration.ts:58</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L59">models/SdkConfiguration.ts:59</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="secure" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>secure</span><a href="#secure" 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>
 <div class="tsd-signature">secure<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
 <div class="tsd-comment tsd-typography"><p>If true, then the cookie will only be available through a
 secured connection (generally https)</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L52">models/SdkConfiguration.ts:52</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/ordercloud-api/ordercloud-javascript-sdk/blob/master/src/models/SdkConfiguration.ts#L53">models/SdkConfiguration.ts:53</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">