documentation/html/RESTClient.html

<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>FAIRsharing.org Class: RESTClient</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.yeti.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html">FAIRsharing.org</a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="Static.html">Static</a></li>
				</ul>
			</li>
			
			<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="module-Curator.html">Curator</a></li><li><a href="module-Home.html">Home</a></li><li><a href="module-Login.html">Login</a></li><li><a href="module-NewRecord.html">NewRecord</a></li><li><a href="module-Pagination.html">Pagination</a></li><li><a href="module-PublicProfile.html">PublicProfile</a></li><li><a href="module-Signup.html">Signup</a></li><li><a href="module-User.html">User</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="ExternalRESTClients.html">ExternalRESTClients</a></li><li><a href="GraphQLClient.html">GraphQLClient</a></li><li><a href="RESTClient.html">RESTClient</a></li>
				</ul>
			</li>
			
			<li class="dropdown">
				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="global.html#buildFacets">buildFacets</a></li><li><a href="global.html#buildFilters">buildFilters</a></li><li><a href="global.html#filtersStore">filtersStore</a></li><li><a href="global.html#hackSearch">hackSearch</a></li><li><a href="global.html#hasValue">hasValue</a></li><li><a href="global.html#introspectionStore">introspectionStore</a></li><li><a href="global.html#isEmail">isEmail</a></li><li><a href="global.html#isImage">isImage</a></li><li><a href="global.html#isLongEnough">isLongEnough</a></li><li><a href="global.html#isOrcid">isOrcid</a></li><li><a href="global.html#isRequired">isRequired</a></li><li><a href="global.html#isUrl">isUrl</a></li><li><a href="global.html#paramsAreExpired">paramsAreExpired</a></li><li><a href="global.html#parseParam">parseParam</a></li><li><a href="global.html#recordsStore">recordsStore</a></li><li><a href="global.html#recordStore">recordStore</a></li><li><a href="global.html#states">states</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-8">
	
		<div id="main">
			

	<h1 class="page-title">Class: RESTClient</h1>
<section>

<header>
    
        <h2>
        RESTClient
        </h2>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<hr>
<dt>
    <h4 class="name" id="RESTClient"><span class="type-signature"></span>new RESTClient()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>The RESTClient is a singleton class that handles the connection and data exchange from the back-end
REST API.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-9">line 9</a>
			</li>
		</ul>
	</dd>
	

</dl>


</dd>

    
    </div>

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<hr>
<dt>
    <h4 class="name" id="auth_headers"><span class="type-signature"></span>auth_headers(jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Method to add authorisation to the headers.</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>jwt</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>the user's json web token</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-30">line 30</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <ul>
<li>headers with authorisation field added</li>
</ul>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">JSON</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="canClaim"><span class="type-signature">&lt;async> </span>canClaim(recordID, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Determine if a user has permission to create a MaintenanceRequest for a FairsharingRecord.</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>recordID</code></td>
            

            <td class="type">
            
                
<span class="param-type">Integer</span>


            </td>

            
            <td class="description last"><p>ID for the relevant FairsharingRecord.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-374">line 374</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="canEdit"><span class="type-signature">&lt;async> </span>canEdit(recordID, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Determine if a user has permission to edit this record.</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>recordID</code></td>
            

            <td class="type">
            
                
<span class="param-type">Integer</span>


            </td>

            
            <td class="description last"><p>ID for the relevant FairsharingRecord.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-341">line 341</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="claimRecord"><span class="type-signature">&lt;async> </span>claimRecord(recordID, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Attempt to create a MaintenanceRequest for a user for a FairsharingRecord.</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>recordID</code></td>
            

            <td class="type">
            
                
<span class="param-type">Integer</span>


            </td>

            
            <td class="description last"><p>ID for the relevant FairsharingRecord.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-357">line 357</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="confirmAccount"><span class="type-signature">&lt;async> </span>confirmAccount(token)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Validate the account given the corresponding token</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>token</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the account token to validate</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-96">line 96</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="createAccount"><span class="type-signature">&lt;async> </span>createAccount(userLogin)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Method to create a new user</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>userLogin</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the user account to create</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-80">line 80</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <p>response - server response</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="createGrant"><span class="type-signature">&lt;async> </span>createGrant(grant, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Create a given grant</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>grant</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user jwt</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-563">line 563</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="createLicenceLink"><span class="type-signature">&lt;async> </span>createLicenceLink(licenceLink, token)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Create new a licence link</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>licenceLink</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the licence link to create</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>token</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user token</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-429">line 429</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="createNewUserDefinedTag"><span class="type-signature">&lt;async> </span>createNewUserDefinedTag(term, token)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Create a new user defined tag in the database for users to tag their records.</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>term</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the string value of the term</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>token</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user JWT</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-409">line 409</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="createOrganisation"><span class="type-signature">&lt;async> </span>createOrganisation(organisation, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Create a given organisation</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>organisation</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user jwt</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-545">line 545</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="createOrganisationLink"><span class="type-signature">&lt;async> </span>createOrganisationLink(organisationLink, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Create a new link between an organisation, a record and an optional grant.</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>organisationLink</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the organisation link to create</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user jwt</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-581">line 581</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="createRecord"><span class="type-signature">&lt;async> </span>createRecord(record, jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Post the given object to the API to create the corresponding record.</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>record</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-307">line 307</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="deleteLicenceLink"><span class="type-signature">&lt;async> </span>deleteLicenceLink(id, token)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Delete the given licence</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>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last"><p>id of the licence link to delete</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>token</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user token</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-447">line 447</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="deleteOrganisationLink"><span class="type-signature">&lt;async> </span>deleteOrganisationLink(linkID, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Delete the given organisation link</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>linkID</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last"><p>the id of the link to remove</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user jwt</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-618">line 618</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="deletePublicUser"><span class="type-signature">&lt;async> </span>deletePublicUser(userID, jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Delete the user</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>userID</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-274">line 274</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="deleteRecord"><span class="type-signature">&lt;async> </span>deleteRecord(id, token)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Delete Record</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>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last"><p>id of the record link to delete</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>token</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user token</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-672">line 672</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="deleteRelations"><span class="type-signature">&lt;async> </span>deleteRelations(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Deletes the relationships as an array of items containing a targetID, a sourceID and a labelID</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>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the options to pass as {token: String, relations: Array}</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-526">line 526</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="editPublicUser"><span class="type-signature">&lt;async> </span>editPublicUser(newUser, jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Edit the current logged in user profile</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>newUser</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the new values for the logged in user</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-258">line 258</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="editUser"><span class="type-signature">&lt;async> </span>editUser(newUser, jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Edit the current logged in user profile</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>newUser</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the new values for the logged in user</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-242">line 242</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="executeQuery"><span class="type-signature">&lt;async> </span>executeQuery(query)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Trigger the given query with Axios</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>query</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-719">line 719</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;*></span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="extraMetadataFields"><span class="type-signature">&lt;async> </span>extraMetadataFields(type, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get the extra metadata fields for a RecordType</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>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>name of the record type.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user jwt</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-635">line 635</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getProfileTypes"><span class="type-signature">&lt;async> </span>getProfileTypes()</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get the list of available profile types for a user.</p>
    </div>
    

<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-702">line 702</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getPublicUser"><span class="type-signature">&lt;async> </span>getPublicUser(jwt, id)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get the current user data</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>jwt</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-211">line 211</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getRecordsWoDOIs"><span class="type-signature">&lt;async> </span>getRecordsWoDOIs(token)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get records without DOIS</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>token</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user token that needs to be a curator</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-733">line 733</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getUser"><span class="type-signature">&lt;async> </span>getUser(jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get the current user data</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>jwt</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-195">line 195</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="getUsersList"><span class="type-signature">&lt;async> </span>getUsersList(jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Get all users list</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>jwt</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-226">line 226</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="login"><span class="type-signature">&lt;async> </span>login(username, password)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Method to log in the user</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>username</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>name of the user</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>password</code></td>
            

            <td class="type">
            
            </td>

            
            <td class="description last"><p>password of the user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-42">line 42</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <ul>
<li>the response of the server</li>
</ul>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="logout"><span class="type-signature">&lt;async> </span>logout(jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Logout the user from the back, expiring the current jwt.</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>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user token to expire.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-65">line 65</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="requestResetPwd"><span class="type-signature">&lt;async> </span>requestResetPwd(email)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Method to send a reset password link to the given email address</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>email</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>to send the link to</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-111">line 111</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="resendConfirmation"><span class="type-signature">&lt;async> </span>resendConfirmation(user)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Resend the validation link for a given user</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>user</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>contains the email of the user.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-129">line 129</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="resetPassword"><span class="type-signature">&lt;async> </span>resetPassword(user)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Reset the password of the given user</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>user</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>contains the new pwd, repeated pwd and token.</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-145">line 145</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="resetPasswordWithoutToken"><span class="type-signature">&lt;async> </span>resetPasswordWithoutToken(jwt, user)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Changes the password of the logged in user</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>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user token</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>user</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>contains the current, new and repeated new password</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-162">line 162</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="reviewRecord"><span class="type-signature">&lt;async> </span>reviewRecord(recordID, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Attempt to create a RecordReview for a user for a FairsharingRecord.</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>recordID</code></td>
            

            <td class="type">
            
                
<span class="param-type">Integer</span>


            </td>

            
            <td class="description last"><p>ID for the relevant FairsharingRecord.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>JWT of the logged in user</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-390">line 390</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="saveRelations"><span class="type-signature">&lt;async> </span>saveRelations(options)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Saves the relationships as an array of items containing a targetID, a sourceID and a labelID</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>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the options to pass as {token: String, relations: Array}</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-509">line 509</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="updateLicenceLink"><span class="type-signature">&lt;async> </span>updateLicenceLink(licenceLink, token)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Update the licenceLink</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>licenceLink</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the new values for the licence link</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>token</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user token</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-464">line 464</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="updateOrganisationLink"><span class="type-signature">&lt;async> </span>updateOrganisationLink(organisationLink, linkID, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Update the organisationLink given from linkID input with the given organisationLink</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>organisationLink</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the new organisation link value</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>linkID</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last"><p>ID of the organisationLink to update</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user jwt</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-600">line 600</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="updateRecord"><span class="type-signature">&lt;async> </span>updateRecord(record)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Update the given record</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>record</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"><p>the record to update containing the ID to target, the new values
and the user token</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-324">line 324</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="updateStatusMaintenanceRequest"><span class="type-signature">&lt;async> </span>updateStatusMaintenanceRequest(maintenanceRequest, newStatus, userToken)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Update the maintenanceRequest given the new status value</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>maintenanceRequest</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last"><p>ID of the maintenanceRequest to update</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>newStatus</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>new status to update</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>userToken</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the user jwt</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-654">line 654</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="validateToken"><span class="type-signature">&lt;async> </span>validateToken(jwt)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Verify that the given JWT is still valid</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>jwt</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the token to validate</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-288">line 288</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="verifyPassword"><span class="type-signature">&lt;async> </span>verifyPassword(password)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Verify the validity of the given password</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>password</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last"><p>the password to test</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="lib_Client_RESTClient.js.html">lib/Client/RESTClient.js</a>,
				 <a href="lib_Client_RESTClient.js.html#sunlight-1-line-178">line 178</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise</span>


    </dd>
</dl>


</dd>

        </dl>
    

</article>

</section>


		</div>
	</div>

	<div class="clearfix"></div>

	
		<div class="col-md-3">
			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
		</div>
	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>


	<span class="copyright">
	DocStrap Copyright © 2012-2015 The contributors to the JSDoc3 and DocStrap projects.
	</span>

<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
	
		on Tue Aug 31st 2021
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : true,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>


<!--Navigation and Symbol Display-->


<!--Google Analytics-->


    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>