@viyet/magento-client
Version:
Sotheby's Home Custom Magento API Client
681 lines • 41.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RequestConfig | @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="../modules/_modules_transport_.html">"modules/Transport"</a>
</li>
<li>
<a href="../modules/_modules_transport_.transport.html">Transport</a>
</li>
<li>
<a href="_modules_transport_.transport.requestconfig.html">RequestConfig</a>
</li>
</ul>
<h1>Interface RequestConfig</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>RequestConfig object</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">AxiosRequestConfig</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">RequestConfig</span>
</li>
</ul>
</li>
</ul>
</section>
<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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#adapter" class="tsd-kind-icon">adapter</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#auth" class="tsd-kind-icon">auth</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#baseurl" class="tsd-kind-icon">baseURL</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#canceltoken" class="tsd-kind-icon">cancel<wbr>Token</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#headers" class="tsd-kind-icon">headers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#httpagent" class="tsd-kind-icon">http<wbr>Agent</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#httpsagent" class="tsd-kind-icon">https<wbr>Agent</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#maxcontentlength" class="tsd-kind-icon">max<wbr>Content<wbr>Length</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#maxredirects" class="tsd-kind-icon">max<wbr>Redirects</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#method" class="tsd-kind-icon">method</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#ondownloadprogress" class="tsd-kind-icon">on<wbr>Download<wbr>Progress</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#onuploadprogress" class="tsd-kind-icon">on<wbr>Upload<wbr>Progress</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#params" class="tsd-kind-icon">params</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#paramsserializer" class="tsd-kind-icon">params<wbr>Serializer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#proxy" class="tsd-kind-icon">proxy</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#responsetype" class="tsd-kind-icon">response<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_transport_.transport.requestconfig.html#route" class="tsd-kind-icon">route</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#timeout" class="tsd-kind-icon">timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#transformrequest" class="tsd-kind-icon">transform<wbr>Request</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#transformresponse" class="tsd-kind-icon">transform<wbr>Response</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#url" class="tsd-kind-icon">url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#validatestatus" class="tsd-kind-icon">validate<wbr>Status</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#withcredentials" class="tsd-kind-icon">with<wbr>Credentials</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#xsrfcookiename" class="tsd-kind-icon">xsrf<wbr>Cookie<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_modules_transport_.transport.requestconfig.html#xsrfheadername" class="tsd-kind-icon">xsrf<wbr>Header<wbr>Name</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="adapter" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> adapter</h3>
<div class="tsd-signature tsd-kind-icon">adapter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosAdapter</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.adapter</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:35</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="auth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> auth</h3>
<div class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosBasicCredentials</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.auth</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:36</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="baseurl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> baseURL</h3>
<div class="tsd-signature tsd-kind-icon">baseURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.baseURL</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:26</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="canceltoken" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cancel<wbr>Token</h3>
<div class="tsd-signature tsd-kind-icon">cancel<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CancelToken</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.cancelToken</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:48</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="data" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.data</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:32</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="headers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.headers</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:29</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="httpagent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> http<wbr>Agent</h3>
<div class="tsd-signature tsd-kind-icon">http<wbr>Agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.httpAgent</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:45</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="httpsagent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> https<wbr>Agent</h3>
<div class="tsd-signature tsd-kind-icon">https<wbr>Agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.httpsAgent</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:46</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="maxcontentlength" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Content<wbr>Length</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Content<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.maxContentLength</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:42</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="maxredirects" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Redirects</h3>
<div class="tsd-signature tsd-kind-icon">max<wbr>Redirects<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.maxRedirects</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:44</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="method" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> method</h3>
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.method</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:25</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ondownloadprogress" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Download<wbr>Progress</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Download<wbr>Progress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.onDownloadProgress</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:41</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>progressEvent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>progressEvent: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="onuploadprogress" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Upload<wbr>Progress</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Upload<wbr>Progress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.onUploadProgress</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:40</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>progressEvent<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>progressEvent: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="params" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> params</h3>
<div class="tsd-signature tsd-kind-icon">params<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.params</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:30</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="paramsserializer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> params<wbr>Serializer</h3>
<div class="tsd-signature tsd-kind-icon">params<wbr>Serializer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.paramsSerializer</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:31</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>params: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="proxy" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy</h3>
<div class="tsd-signature tsd-kind-icon">proxy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosProxyConfig</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.proxy</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:47</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="responsetype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">response<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.responseType</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:37</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="route" class="tsd-anchor"></a>
<h3>route</h3>
<div class="tsd-signature tsd-kind-icon">route<span class="tsd-signature-symbol">:</span> <a href="_modules_transport_.transport.route.html" class="tsd-signature-type">Route</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Transport.ts#L22">modules/Transport.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="timeout" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout</h3>
<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.timeout</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:33</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="transformrequest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transform<wbr>Request</h3>
<div class="tsd-signature tsd-kind-icon">transform<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosTransformer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AxiosTransformer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.transformRequest</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:27</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="transformresponse" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transform<wbr>Response</h3>
<div class="tsd-signature tsd-kind-icon">transform<wbr>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosTransformer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">AxiosTransformer</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.transformResponse</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:28</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="url" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3>
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.url</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:24</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="validatestatus" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> validate<wbr>Status</h3>
<div class="tsd-signature tsd-kind-icon">validate<wbr>Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.validateStatus</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:43</li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>status: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="withcredentials" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> with<wbr>Credentials</h3>
<div class="tsd-signature tsd-kind-icon">with<wbr>Credentials<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.withCredentials</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:34</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="xsrfcookiename" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> xsrf<wbr>Cookie<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">xsrf<wbr>Cookie<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.xsrfCookieName</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:38</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="xsrfheadername" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> xsrf<wbr>Header<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">xsrf<wbr>Header<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from AxiosRequestConfig.xsrfHeaderName</p>
<ul>
<li>Defined in C:/Users/ACattaneo/OneDrive - ENDAVA/Viyet/sh-mage-client/node_modules/axios/index.d.ts:39</li>
</ul>
</aside>
</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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/_modules_transport_.transport.api.html" class="tsd-kind-icon">API</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_modules_transport_.transport.headers.html" class="tsd-kind-icon">Headers</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="_modules_transport_.transport.requestconfig.html" class="tsd-kind-icon">Request<wbr>Config</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#adapter" class="tsd-kind-icon">adapter</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#auth" class="tsd-kind-icon">auth</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#baseurl" class="tsd-kind-icon">baseURL</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#canceltoken" class="tsd-kind-icon">cancel<wbr>Token</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#headers" class="tsd-kind-icon">headers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#httpagent" class="tsd-kind-icon">http<wbr>Agent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#httpsagent" class="tsd-kind-icon">https<wbr>Agent</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#maxcontentlength" class="tsd-kind-icon">max<wbr>Content<wbr>Length</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#maxredirects" class="tsd-kind-icon">max<wbr>Redirects</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#method" class="tsd-kind-icon">method</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#ondownloadprogress" class="tsd-kind-icon">on<wbr>Download<wbr>Progress</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#onuploadprogress" class="tsd-kind-icon">on<wbr>Upload<wbr>Progress</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#params" class="tsd-kind-icon">params</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#paramsserializer" class="tsd-kind-icon">params<wbr>Serializer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#proxy" class="tsd-kind-icon">proxy</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#responsetype" class="tsd-kind-icon">response<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="_modules_transport_.transport.requestconfig.html#route" class="tsd-kind-icon">route</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#timeout" class="tsd-kind-icon">timeout</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#transformrequest" class="tsd-kind-icon">transform<wbr>Request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#transformresponse" class="tsd-kind-icon">transform<wbr>Response</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#url" class="tsd-kind-icon">url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#validatestatus" class="tsd-kind-icon">validate<wbr>Status</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#withcredentials" class="tsd-kind-icon">with<wbr>Credentials</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#xsrfcookiename" class="tsd-kind-icon">xsrf<wbr>Cookie<wbr>Name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="_modules_transport_.transport.requestconfig.html#xsrfheadername" class="tsd-kind-icon">xsrf<wbr>Header<wbr>Name</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="_modules_transport_.transport.route.html" class="tsd-kind-icon">Route</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>