openapi-node
Version:
A Node library to interact with the Wix Hive (RESTful API)
1,040 lines (411 loc) • 17.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Wix openapi-node Global</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">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<dl>
<dt>
<h4 class="name" id="GetActivitiesOptions">GetActivitiesOptions</h4>
</dt>
<dd>
<div class="description">
<p>Get Activities Query Options</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>pageSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25</p></td>
</tr>
<tr>
<td class="name"><code>activityTypes</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The activity types to filter against. Multiple activity types are separated by a comma</p></td>
</tr>
<tr>
<td class="name"><code>until</code></td>
<td class="type">
<span class="param-type">dateTime</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The ending date for activities we want to return, as an ISO 8601 timestamp This field is only relevant when a cursor is not present</p></td>
</tr>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type">dateTime</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The beginning date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present</p></td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The scope of the results to return, either for the entire site or limited to the current application. Can either be site or app. By default, all activities for the site will be returned</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>
<dt>
<h4 class="name" id="GetActivitiesOptions">GetActivitiesOptions</h4>
</dt>
<dd>
<div class="description">
<p>Get Activities Query Options</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>pageSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25</p></td>
</tr>
<tr>
<td class="name"><code>activityTypes</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The activity types to filter against. Multiple activity types are separated by a comma</p></td>
</tr>
<tr>
<td class="name"><code>until</code></td>
<td class="type">
<span class="param-type">dateTime</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The ending date for activities we want to return, as an ISO 8601 timestamp This field is only relevant when a cursor is not present</p></td>
</tr>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type">dateTime</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The beginning date for activities we want to return, as an ISO 8601 timestamp. This field is only relevant when a cursor is not present</p></td>
</tr>
<tr>
<td class="name"><code>scope</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The scope of the results to return, either for the entire site or limited to the current application. Can either be site or app. By default, all activities for the site will be returned</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>
<dt>
<h4 class="name" id="GetContactsOptions">GetContactsOptions</h4>
</dt>
<dd>
<div class="description">
<p>Get Contacts Query Options</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>pageSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25</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>
<dt>
<h4 class="name" id="GetContactsSubscribersOptions">GetContactsSubscribersOptions</h4>
</dt>
<dd>
<div class="description">
<p>Get Contacts Subscribers Query Options</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>pageSize</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The number of results to return per page of data. Valid options are: 25, 50 and 100. Defaults to 25</p></td>
</tr>
<tr>
<td class="name"><code>subscriberStatus</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="attributes">
<nullable><br>
</td>
<td class="description last"><p>The contact's subscription status in relation to the site. Can either be notSet or optIn. By default, contacts who have explicitly opted in will be returned.</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:20 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>