mbo-api
Version:
Implements the MINDBODY Online API.
688 lines (441 loc) • 15.8 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_ClientService</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_ClientService
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br /><i>Defined in: </i> <a href="../symbols/src/lib_services_mbo_ClientService.js.html">mbo_ClientService.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class mbo_ClientService.">
<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_ClientService.html#constructor">mbo_ClientService</a></b>(username, password)
</div>
<div class="description">Represents the MINDOBDY Client Service.</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_ClientService.">
<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_ClientService.html#getAllClients">getAllClients</a></b>(search, params)
</div>
<div class="description">Retrieves all clients, filtered by search text if given.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_ClientService.html#getClientAccountBalancesById">getClientAccountBalancesById</a></b>(ids)
</div>
<div class="description">Retrieves Account Balances for Clients</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_ClientService.html#getClientById">getClientById</a></b>(id)
</div>
<div class="description">Retrieves a single client by ID</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_ClientService.html#getClientCount">getClientCount</a></b>(search)
</div>
<div class="description">Retrieves the number of clients.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_ClientService.html#getClientIndexValues">getClientIndexValues</a></b>(id)
</div>
<div class="description">Gets the values of Client Indexes for a client.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/mbo_ClientService.html#getClientsById">getClientsById</a></b>(ids, params)
</div>
<div class="description">Retireves the clients matching the given IDs</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_ClientService</b>(username, password)
</div>
<div class="description">
Represents the MINDOBDY Client Service.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>username</b>
</dt>
<dd>Username of the MINDBODY client interacting with the service.</dd>
<dt>
<span class="light fixedFont">{string}</span> <b>password</b>
</dt>
<dd>Password of the MINDBODY client interacting with the service.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/mbo_ClientService.html">mbo_ClientService</a>}</span> Returns the Client Service.</dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="getAllClients"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span>
<b>getAllClients</b>(search, params)
</div>
<div class="description">
Retrieves all clients, filtered by search text if given.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>search</b>
<i>Optional</i>
</dt>
<dd>Search string to filter results.</dd>
<dt>
<b>params</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span> An A+ Promise passed an array of the found clients.</dd>
</dl>
<hr />
<a name="getClientAccountBalancesById"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span>
<b>getClientAccountBalancesById</b>(ids)
</div>
<div class="description">
Retrieves Account Balances for Clients
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{array}</span> <b>ids</b>
</dt>
<dd>An array of Client Ids</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span> An A+ Promise resolved to an object keyed by client Id and values of thier
Account Balance</dd>
</dl>
<hr />
<a name="getClientById"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span>
<b>getClientById</b>(id)
</div>
<div class="description">
Retrieves a single client by ID
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number}</span> <b>id</b>
</dt>
<dd>Teh ID of the requested client</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span> An A+ Promise passed an object representing the client.</dd>
</dl>
<hr />
<a name="getClientCount"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span>
<b>getClientCount</b>(search)
</div>
<div class="description">
Retrieves the number of clients.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>search</b>
<i>Optional</i>
</dt>
<dd>Search string to filter results.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span> An A+ Promise passed the total number of clients,
matching the search string if given.</dd>
</dl>
<hr />
<a name="getClientIndexValues"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span>
<b>getClientIndexValues</b>(id)
</div>
<div class="description">
Gets the values of Client Indexes for a client.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number|string}</span> <b>id</b>
</dt>
<dd>The client's Id</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span> Returns an A+ Promise resolved to an array of objects representing
the client's assigned Client Index values.
Each object has the form { index: { id, name }, value: { id, name } }.
Client Indexes which do not have an assigned value are excluded.</dd>
</dl>
<hr />
<a name="getClientsById"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span>
<b>getClientsById</b>(ids, params)
</div>
<div class="description">
Retireves the clients matching the given IDs
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{number|number[]}</span> <b>ids</b>
</dt>
<dd>An single or array of client IDs to retrieve.</dd>
<dt>
<b>params</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/_global_.html#Promise">Promise</a>}</span> An A+ Promise passed an array of clients.</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>