openapi-node
Version:
A Node library to interact with the Wix Hive (RESTful API)
674 lines (288 loc) • 10.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Wix openapi-node Class: APIBuilder</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<a class="brand" href="index.html">Wix openapi-node</a>
<ul class="nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="API.html">Wix/API</a>
</li>
<li>
<a href="connect.html">wix/connect</a>
</li>
<li>
<a href="Connect_.html">Wix/Connect</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="Activities.html">Activities</a>
</li>
<li>
<a href="ActivityType.html">ActivityType</a>
</li>
<li>
<a href="APIBuilder.html">APIBuilder</a>
</li>
<li>
<a href="BaseWixAPIObject.html">BaseWixAPIObject</a>
</li>
<li>
<a href="Contact.html">Contact</a>
</li>
<li>
<a href="Contacts.html">Contacts</a>
</li>
<li>
<a href="Insights.html">Insights</a>
</li>
<li>
<a href="Wix.html">Wix</a>
</li>
<li>
<a href="WixActivity.html">WixActivity</a>
</li>
<li>
<a href="WixActivityData.html">WixActivityData</a>
</li>
<li>
<a href="WixAPICaller.html">WixAPICaller</a>
</li>
<li>
<a href="WixPagingData.html">WixPagingData</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: APIBuilder</h1>
<section>
<header>
<h2>
APIBuilder
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="APIBuilder"><span class="type-signature"></span>new APIBuilder<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Builder used to create new instances of the <a href="Wix.html"><code>Wix</code></a> object</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="withCredentials"><span class="type-signature"></span>withCredentials<span class="signature">(data)</span><span class="type-signature"> → {<a href="Wix.html">Wix</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a <a href="Wix.html"><code>Wix</code></a> API object with the give credentials.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
<span class="param-type"><a href="APIBuilder.html#APICredentials">APIBuilder.APICredentials</a></span>
</td>
<td class="description last"><p>JSON data containing credentials for the API</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<ul>
<li>
<div class="param-desc">
an exception if signatures don't match when using the API with the instance param
</div>
</li>
<li>
<div class="param-desc">
an exception if API credentials are missing
</div>
</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
<p>a Wix API interface object</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Wix.html">Wix</a></span>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Type Definitions</h3>
<dl>
<dt>
<h4 class="name" id="APICredentials">APICredentials</h4>
</dt>
<dd>
<div class="description">
<p>Credentials to access the Wix API. Must specific either an instance or an instanceId property</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>secretKey</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Your applications Secret Key</p></td>
</tr>
<tr>
<td class="name"><code>appId</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>Your applications App Id</p></td>
</tr>
<tr>
<td class="name"><code>instanceId</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>Your applications instanceId</p></td>
</tr>
<tr>
<td class="name"><code>instance</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The instance passed to your server from Wix</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
WixClient.js
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<a href='http://dev.wix.com'>Wix Developer Center</a>
<br />
<span class="copyright">
2014, Wix
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
on Thu Jul 31 2014 17:22:21 GMT+0300 (IDT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:false, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>