mbo-api
Version:
Implements the MINDBODY Online API.
738 lines (478 loc) • 17.1 kB
HTML
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>JsDoc Reference - mbo_Service</title>
<style type="text/css">
/* default.css */
body
{
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
width: 800px;
}
.header
{
clear: both;
background-color: #ccc;
padding: 8px;
}
h1
{
font-size: 150%;
font-weight: bold;
padding: 0;
margin: 1em 0 0 .3em;
}
hr
{
border: none 0;
border-top: 1px solid #7F8FB1;
height: 1px;
}
pre.code
{
display: block;
padding: 8px;
border: 1px dashed #ccc;
}
#index
{
margin-top: 24px;
float: left;
width: 160px;
position: absolute;
left: 8px;
background-color: #F3F3F3;
padding: 8px;
}
#content
{
margin-left: 190px;
width: 600px;
}
.classList
{
list-style-type: none;
padding: 0;
margin: 0 0 0 8px;
font-family: arial, sans-serif;
font-size: 1em;
overflow: auto;
}
.classList li
{
padding: 0;
margin: 0 0 8px 0;
}
.summaryTable { width: 100%; }
h1.classTitle
{
font-size:170%;
line-height:130%;
}
h2 { font-size: 110%; }
caption, div.sectionTitle
{
background-color: #7F8FB1;
color: #fff;
font-size:130%;
text-align: left;
padding: 2px 6px 2px 6px;
border: 1px #7F8FB1 solid;
}
div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }
.summaryTable td
{
vertical-align: top;
padding: 4px;
border-bottom: 1px #7F8FB1 solid;
border-right: 1px #7F8FB1 solid;
}
/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
border-left: 1px #7F8FB1 solid;
width: 140px;
text-align: right;
}
td.attributes, .fixedFont
{
line-height: 15px;
color: #002EBE;
font-family: "Courier New",Courier,monospace;
font-size: 13px;
}
.summaryTable td.nameDescription
{
text-align: left;
font-size: 13px;
line-height: 15px;
}
.summaryTable td.nameDescription, .description
{
line-height: 15px;
padding: 4px;
padding-left: 4px;
}
.summaryTable { margin-bottom: 8px; }
ul.inheritsList
{
list-style: square;
margin-left: 20px;
padding-left: 0;
}
.detailList {
margin-left: 20px;
line-height: 15px;
}
.detailList dt { margin-left: 20px; }
.detailList .heading
{
font-weight: bold;
padding-bottom: 6px;
margin-left: 0;
}
.light, td.attributes, .light a:link, .light a:visited
{
color: #777;
font-style: italic;
}
.fineprint
{
text-align: right;
font-size: 10px;
}
</style>
</head>
<body>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div id="header">
</div>
<!-- end static/header.html -->
<!-- ============================== classes index ============================ -->
<div id="index">
<!-- begin publish.classesIndex -->
<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
<li><a href="../symbols/mbo_ClassService.html">mbo_ClassService</a></li>
<li><a href="../symbols/mbo_ClientService.html">mbo_ClientService</a></li>
<li><a href="../symbols/mbo_SaleService.html">mbo_SaleService</a></li>
<li><a href="../symbols/mbo_Service.html">mbo_Service</a></li>
<li><a href="../symbols/mbo_SiteService.html">mbo_SiteService</a></li>
<li><a href="../symbols/mbo_StaffService.html">mbo_StaffService</a></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Class mbo_Service
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br /><i>Defined in: </i> <a href="../symbols/src/lib_services_mbo_Service.js.html">mbo_Service.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class mbo_Service.">
<caption>Class Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/mbo_Service.html#constructor">mbo_Service</a></b>(service, sourceName, sourcePassword, siteIds, apiVersion)
</div>
<div class="description">This class is not meant to be instantiated, and only serves as a base class for the actual Service classes.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class mbo_Service.">
<caption>Method Summary</caption>
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_Service.html#addSiteIds">addSiteIds</a></b>(siteIds)
</div>
<div class="description">Adds Site Ids to the current users accessible sites.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_Service.html#defaultParam">defaultParam</a></b>(name, value)
</div>
<div class="description">Gets or Sets defaults passed to every request.</div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">mbo_Service.<b><a href="../symbols/mbo_Service.html#.getSoapFault">getSoapFault</a></b>(result)
</div>
<div class="description">Check if the SOAP call returned a SOAP Fualt.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_Service.html#log">log</a></b>(type, , host, port)
</div>
<div class="description">Enables or disables the logging of calls to the API.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_Service.html#setUserCredentials">setUserCredentials</a></b>(username, password, siteIds)
</div>
<div class="description">Sets the User Credentials to use for any call, and sets them to be used.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_Service.html#useDefaultUserCredentials">useDefaultUserCredentials</a></b>(val)
</div>
<div class="description">Sets the default credentials to the default value.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
<b>mbo_Service</b>(service, sourceName, sourcePassword, siteIds, apiVersion)
</div>
<div class="description">
This class is not meant to be instantiated, and only serves as a base class for the actual Service classes.
Creates a new MBO Service.
Retrieves the WSDL of the given service and creates two methods for each SOAP method in the WSDL.
For each SOAP method a function is created:
1) Bearing the same name that either extracts the result of the same name, and
2) Bearing the name with 'Response' post-fixed, which returns an array of the
i) Raw response converted to a JS object
ii) Raw XML response
iii) Raw XML SOAP header info
Each of these functions returns an A+ Promise.
Each method of the service methods accepts an Object as a parameter as well.
Each element of the object will be included in the Request section of the SOAP Request.
Emits an 'initialized' event once all methods have been defined.
A 'ready' event is triggered by the ServiceFactory once User Credentails have been set.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string|boolean}</span> <b>service</b>
</dt>
<dd>The full name of the service to be implemented. E.g 'SaleService'
Set to False if no service is desired.</dd>
<dt>
<span class="light fixedFont">{string}</span> <b>sourceName</b>
</dt>
<dd>Your MINDBODY developer Source Name, included in all service calls.</dd>
<dt>
<span class="light fixedFont">{string}</span> <b>sourcePassword</b>
</dt>
<dd>Your MINDBODY developer Source Password, included in all service calls.</dd>
<dt>
<span class="light fixedFont">{int[]}</span> <b>siteIds</b>
<i>Optional</i>
</dt>
<dd>An array containg site Ids to add.</dd>
<dt>
<span class="light fixedFont">{number}</span> <b>apiVersion</b>
</dt>
<dd>The MINDBODY API version you wish to use.
Defaults to the most recent stable release.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/mbo_Service.html">mbo_Service</a>}</span> An absract service to interact with the MINDBODY API service.</dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="addSiteIds"> </a>
<div class="fixedFont">
<b>addSiteIds</b>(siteIds)
</div>
<div class="description">
Adds Site Ids to the current users accessible sites.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number|number[]}</span> <b>siteIds</b>
</dt>
<dd>A single, or array of, Site ID(s) which the client can interact with.</dd>
</dl>
<hr />
<a name="defaultParam"> </a>
<div class="fixedFont">
<span class="light">{string}</span>
<b>defaultParam</b>(name, value)
</div>
<div class="description">
Gets or Sets defaults passed to every request.
If second argument is included, the key is set to that value.
If the second parameter is not included, the current value of the key is returned.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>name</b>
</dt>
<dd>The key of the default parameter to get or set</dd>
<dt>
<span class="light fixedFont">{string}</span> <b>value</b>
<i>Optional</i>
</dt>
<dd>The value to set the key to.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{string}</span> If getting a value the value is returned. If setting a value, nothing is returned.</dd>
</dl>
<hr />
<a name=".getSoapFault"> </a>
<div class="fixedFont"><static>
<span class="light">{boolean}</span>
<span class="light">mbo_Service.</span><b>getSoapFault</b>(result)
</div>
<div class="description">
Check if the SOAP call returned a SOAP Fualt.
Triggers a 'SoapFault' event if found.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{object}</span> <b>result</b>
</dt>
<dd>The object representation of the SOAP response.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Deprecated:</dt>
<dt>
MBO Services respond with status codes instead of SOAP Faults.
</dt>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{boolean}</span> Whether the response contained a SOAP Fault of not.</dd>
</dl>
<hr />
<a name="log"> </a>
<div class="fixedFont">
<b>log</b>(type, , host, port)
</div>
<div class="description">
Enables or disables the logging of calls to the API.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string|boolean}</span> <b>type</b>
</dt>
<dd>The type of Logger to use -- 'local' or 'remote' --
or false to disable.</dd>
<dt>
<span class="light fixedFont">{string}</span> <b></b>
</dt>
<dd></dd>
<dt>
<b>host</b>
</dt>
<dd></dd>
<dt>
<b>port</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Throws:</dt>
<dt>
<span class="light fixedFont">{Error}</span> <b></b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="setUserCredentials"> </a>
<div class="fixedFont">
<b>setUserCredentials</b>(username, password, siteIds)
</div>
<div class="description">
Sets the User Credentials to use for any call, and sets them to be used.
Not all calls require user credentials.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>username</b>
</dt>
<dd>The username of the MINDOBDY client you're interacting with.</dd>
<dt>
<span class="light fixedFont">{string}</span> <b>password</b>
</dt>
<dd>The password of the MINDBODY client you're interacting with.</dd>
<dt>
<span class="light fixedFont">{number|number[]}</span> <b>siteIds</b>
</dt>
<dd>A single, or array of, Site ID(s) which the client can interact with.</dd>
</dl>
<hr />
<a name="useDefaultUserCredentials"> </a>
<div class="fixedFont">
<b>useDefaultUserCredentials</b>(val)
</div>
<div class="description">
Sets the default credentials to the default value.
This appends an underscore before the Source Name, and uses the Source's password.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>val</b>
</dt>
<dd></dd>
</dl>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sun Jul 22 2018 23:41:33 GMT+0200 (CEST)
</div>
</body>
</html>