@viyet/magento-client

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>"config/default" | @viyet/magento-client</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@viyet/magento-client</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="_config_default_.html">"config/default"</a> </li> </ul> <h1>External module "config/default"</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_config_default_.clientconfig.html" class="tsd-kind-icon">Client<wbr>Config</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-external-module"><a href="_config_default_.html#defaultconfig" class="tsd-kind-icon">default<wbr>Config</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Object literals</h2> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module"> <a name="defaultconfig" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Config</h3> <div class="tsd-signature tsd-kind-icon">default<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L36">config/default.ts:36</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Magento Client default configuration</p> </div> </div> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="defaultconfig.api" class="tsd-anchor"></a> <h3>api</h3> <div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L37">config/default.ts:37</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.baseurl" class="tsd-anchor"></a> <h3>base<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">base<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://sothebyshome.com/"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L38">config/default.ts:38</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes" class="tsd-anchor"></a> <h3>routes</h3> <div class="tsd-signature tsd-kind-icon">routes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L39">config/default.ts:39</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.auth" class="tsd-anchor"></a> <h3>auth</h3> <div class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L40">config/default.ts:40</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.auth.login" class="tsd-anchor"></a> <h3>login</h3> <div class="tsd-signature tsd-kind-icon">login<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "auth/index/login"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L42">config/default.ts:42</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.auth.register" class="tsd-anchor"></a> <h3>register</h3> <div class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "auth/index/register"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L43">config/default.ts:43</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.auth.sessiondata" class="tsd-anchor"></a> <h3>session<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">session<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "viyetcustomer/data/basic"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L41">config/default.ts:41</a></li> </ul> </aside> </section> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout" class="tsd-anchor"></a> <h3>checkout</h3> <div class="tsd-signature tsd-kind-icon">checkout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L45">config/default.ts:45</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout.applycoupon" class="tsd-anchor"></a> <h3>apply<wbr>Coupon</h3> <div class="tsd-signature tsd-kind-icon">apply<wbr>Coupon<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/checkout/currentOrder/applyCoupon"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L46">config/default.ts:46</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout.getaddresses" class="tsd-anchor"></a> <h3>get<wbr>Addresses</h3> <div class="tsd-signature tsd-kind-icon">get<wbr>Addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/checkout/addresses/get?form_key=:formKey"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L52">config/default.ts:52</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout.getcurrentorder" class="tsd-anchor"></a> <h3>get<wbr>Current<wbr>Order</h3> <div class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Order<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/checkout/currentOrder/get?form_key=:formKey"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L47">config/default.ts:47</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout.getformkey" class="tsd-anchor"></a> <h3>get<wbr>Form<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">get<wbr>Form<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/checkout/formkey/get"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L48">config/default.ts:48</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout.getpayments" class="tsd-anchor"></a> <h3>get<wbr>Payments</h3> <div class="tsd-signature tsd-kind-icon">get<wbr>Payments<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/checkout/payments/get?form_key=:formKey"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L49">config/default.ts:49</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout.removecoupon" class="tsd-anchor"></a> <h3>remove<wbr>Coupon</h3> <div class="tsd-signature tsd-kind-icon">remove<wbr>Coupon<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/checkout/currentOrder/deleteCoupon"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L50">config/default.ts:50</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.checkout.saveaddress" class="tsd-anchor"></a> <h3>save<wbr>Address</h3> <div class="tsd-signature tsd-kind-icon">save<wbr>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/checkout/addresses/save"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L51">config/default.ts:51</a></li> </ul> </aside> </section> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.offers" class="tsd-anchor"></a> <h3>offers</h3> <div class="tsd-signature tsd-kind-icon">offers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L54">config/default.ts:54</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.offers.accept" class="tsd-anchor"></a> <h3>accept</h3> <div class="tsd-signature tsd-kind-icon">accept<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/user/offers/:offerId/accept"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L55">config/default.ts:55</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.offers.counter" class="tsd-anchor"></a> <h3>counter</h3> <div class="tsd-signature tsd-kind-icon">counter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/user/offers/:offerId/counter"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L56">config/default.ts:56</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.offers.findall" class="tsd-anchor"></a> <h3>find<wbr>All</h3> <div class="tsd-signature tsd-kind-icon">find<wbr>All<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/user/offers"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L57">config/default.ts:57</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.offers.findbyid" class="tsd-anchor"></a> <h3>find<wbr>ById</h3> <div class="tsd-signature tsd-kind-icon">find<wbr>ById<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/user/offers/:offerId"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L58">config/default.ts:58</a></li> </ul> </aside> </section> </section> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.products" class="tsd-anchor"></a> <h3>products</h3> <div class="tsd-signature tsd-kind-icon">products<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L60">config/default.ts:60</a></li> </ul> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <a name="defaultconfig.api.routes.products.create" class="tsd-anchor"></a> <h3>create</h3> <div class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "/user/products"</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/config/default.ts#L61">config/default.ts:61</a></li> </ul> </aside> </section> </section> </section> </section> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> <a href="_magentoclient_.html">"<wbr>Magento<wbr>Client"</a> </li> <li class="current tsd-kind-external-module"> <a href="_config_default_.html">"config/default"</a> </li> <li class=" tsd-kind-external-module"> <a href="_index_.html">"index"</a> </li> <li class=" tsd-kind-external-module"> <a href="_modules_auth_.html">"modules/<wbr>Auth"</a> </li> <li class=" tsd-kind-external-module"> <a href="_modules_checkout_.html">"modules/<wbr>Checkout"</a> </li> <li class=" tsd-kind-external-module"> <a href="_modules_offers_.html">"modules/<wbr>Offers"</a> </li> <li class=" tsd-kind-external-module"> <a href="_modules_products_.html">"modules/<wbr>Products"</a> </li> <li class=" tsd-kind-external-module"> <a href="_modules_transport_.html">"modules/<wbr>Transport"</a> </li> <li class=" tsd-kind-external-module"> <a href="_modules_users_.html">"modules/<wbr>Users"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_config_default_.clientconfig.html" class="tsd-kind-icon">Client<wbr>Config</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-external-module"> <a href="_config_default_.html#defaultconfig" class="tsd-kind-icon">default<wbr>Config</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>