## Classes

<dl>
<dt><a href="#Auth">Auth</a></dt>
<dd></dd>
<dt><a href="#Blueprint">Blueprint</a></dt>
<dd><p>Class representing a Blueprint resource</p>
</dd>
<dt><a href="#Breed">Breed</a></dt>
<dd><p>Class representing a Breed resource</p>
</dd>
<dt><a href="#Deployment">Deployment</a></dt>
<dd><p>Class representing a Deployment resource</p>
</dd>
<dt><a href="#VampEventListener">VampEventListener</a></dt>
<dd><p>Class that helps with listening for events from the Vamp event bus</p>
</dd>
<dt><a href="#Event">Event</a></dt>
<dd><p>Class representing an Event</p>
</dd>
<dt><a href="#Gateway">Gateway</a></dt>
<dd><p>Class representing a Gateway resource</p>
</dd>
<dt><a href="#Namespace">Namespace</a></dt>
<dd><p>Class representing a Namespace resource</p>
</dd>
<dt><a href="#Role">Role</a></dt>
<dd><p>Class representing a Role resource</p>
</dd>
<dt><a href="#Token">Token</a></dt>
<dd><p>Class representing a Token resource</p>
</dd>
<dt><a href="#User">User</a></dt>
<dd><p>Class representing a User resource</p>
</dd>
<dt><a href="#Workflow">Workflow</a></dt>
<dd><p>Class representing a Workflow resource</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#hasRights">hasRights(endpoint, access, rights)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Describes a single blueprint resource</p>
</dd>
</dl>

<a name="Auth"></a>

## Auth
**Kind**: global class  

* [Auth](#Auth)
    * [new Auth(http)](#new_Auth_new)
    * [.login(credentials)](#Auth+login) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.logout()](#Auth+logout) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.getUser(namespace, username)](#Auth+getUser) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.getToken(namespace, name)](#Auth+getToken) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.createToken(namespace, token)](#Auth+createToken) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Auth_new"></a>

### new Auth(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Auth+login"></a>

### auth.login(credentials) ⇒ <code>Promise.&lt;Object&gt;</code>
Login using a passed in Javascript object.

**Kind**: instance method of [<code>Auth</code>](#Auth)  

| Param | Type | Description |
| --- | --- | --- |
| credentials | <code>object</code> | username and password. |

<a name="Auth+logout"></a>

### auth.logout() ⇒ <code>Promise.&lt;Object&gt;</code>
Logout.

**Kind**: instance method of [<code>Auth</code>](#Auth)  
<a name="Auth+getUser"></a>

### auth.getUser(namespace, username) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single user resource

**Kind**: instance method of [<code>Auth</code>](#Auth)  

| Param | Type | Description |
| --- | --- | --- |
| namespace | <code>string</code> | organisation namespace |
| username | <code>string</code> | name of the user |

<a name="Auth+getToken"></a>

### auth.getToken(namespace, name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single token resource

**Kind**: instance method of [<code>Auth</code>](#Auth)  

| Param | Type | Description |
| --- | --- | --- |
| namespace | <code>string</code> | organisation namespace |
| name | <code>string</code> | name of the token |

<a name="Auth+createToken"></a>

### auth.createToken(namespace, token) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a token based on a passed in Javascript object.

**Kind**: instance method of [<code>Auth</code>](#Auth)  

| Param | Type | Description |
| --- | --- | --- |
| namespace | <code>string</code> | organisation namespace |
| token | <code>object</code> | a token resource. |

<a name="Blueprint"></a>

## Blueprint
Class representing a Blueprint resource

**Kind**: global class  

* [Blueprint](#Blueprint)
    * [new Blueprint(http)](#new_Blueprint_new)
    * [.list()](#Blueprint+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Blueprint+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.create(blueprint)](#Blueprint+create) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.delete(name)](#Blueprint+delete) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Blueprint_new"></a>

### new Blueprint(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Blueprint+list"></a>

### blueprint.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of blueprints

**Kind**: instance method of [<code>Blueprint</code>](#Blueprint)  
<a name="Blueprint+get"></a>

### blueprint.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single blueprint resource

**Kind**: instance method of [<code>Blueprint</code>](#Blueprint)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the blueprint |

<a name="Blueprint+create"></a>

### blueprint.create(blueprint) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a blueprint based on a passed in Javascript object.

**Kind**: instance method of [<code>Blueprint</code>](#Blueprint)  

| Param | Type | Description |
| --- | --- | --- |
| blueprint | <code>object</code> | a blueprint resource. |

<a name="Blueprint+delete"></a>

### blueprint.delete(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Deletes the artifact

**Kind**: instance method of [<code>Blueprint</code>](#Blueprint)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Name of the artifact |

<a name="Breed"></a>

## Breed
Class representing a Breed resource

**Kind**: global class  

* [Breed](#Breed)
    * [new Breed(http)](#new_Breed_new)
    * [.list()](#Breed+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Breed+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.create(breed)](#Breed+create) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.delete(name)](#Breed+delete) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Breed_new"></a>

### new Breed(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Breed+list"></a>

### breed.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of breeds

**Kind**: instance method of [<code>Breed</code>](#Breed)  
<a name="Breed+get"></a>

### breed.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single breed resource

**Kind**: instance method of [<code>Breed</code>](#Breed)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the breed |

<a name="Breed+create"></a>

### breed.create(breed) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a breed based on a passed in Javascript object.

**Kind**: instance method of [<code>Breed</code>](#Breed)  

| Param | Type | Description |
| --- | --- | --- |
| breed | <code>object</code> | a breed resource. |

<a name="Breed+delete"></a>

### breed.delete(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Deletes the artifact

**Kind**: instance method of [<code>Breed</code>](#Breed)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Name of the artifact |

<a name="Deployment"></a>

## Deployment
Class representing a Deployment resource

**Kind**: global class  

* [Deployment](#Deployment)
    * [new Deployment(http)](#new_Deployment_new)
    * [.list()](#Deployment+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Deployment+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.deploy(deployment, blueprint)](#Deployment+deploy) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.scale(deploymentName, clusterName, serviceName, scaleData)](#Deployment+scale) ⇒ <code>Promise.&lt;boolean&gt;</code>
    * [.undeploy(deployment, [serviceName])](#Deployment+undeploy) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Deployment_new"></a>

### new Deployment(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Deployment+list"></a>

### deployment.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of deployments

**Kind**: instance method of [<code>Deployment</code>](#Deployment)  
<a name="Deployment+get"></a>

### deployment.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single deployment resource

**Kind**: instance method of [<code>Deployment</code>](#Deployment)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the deployment |

<a name="Deployment+deploy"></a>

### deployment.deploy(deployment, blueprint) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a deployment based on a blueprint under a specified name.

**Kind**: instance method of [<code>Deployment</code>](#Deployment)  

| Param | Type |
| --- | --- |
| deployment | <code>string</code> | 
| blueprint | <code>string</code> | 

<a name="Deployment+scale"></a>

### deployment.scale(deploymentName, clusterName, serviceName, scaleData) ⇒ <code>Promise.&lt;boolean&gt;</code>
Scales given deploymentName, cluster and service with scaleData.

**Kind**: instance method of [<code>Deployment</code>](#Deployment)  
**Returns**: <code>Promise.&lt;boolean&gt;</code> - Returns true if scale was accepted by server  

| Param |
| --- |
| deploymentName | 
| clusterName | 
| serviceName | 
| scaleData | 

<a name="Deployment+undeploy"></a>

### deployment.undeploy(deployment, [serviceName]) ⇒ <code>Promise.&lt;Object&gt;</code>
Removes a running deployment. When passed the full name, it will retrieve the deployment and then use that resource
description in the DELETE command to fully remove the whole deployment.

**Kind**: instance method of [<code>Deployment</code>](#Deployment)  

| Param | Type | Description |
| --- | --- | --- |
| deployment | <code>string</code> | name of the deployment |
| [serviceName] | <code>string</code> | name of a service to remove from a deployment |

<a name="VampEventListener"></a>

## VampEventListener
Class that helps with listening for events from the Vamp event bus

**Kind**: global class  

* [VampEventListener](#VampEventListener)
    * [new VampEventListener(http)](#new_VampEventListener_new)
    * [.listen(eventType, tags)](#VampEventListener+listen)

<a name="new_VampEventListener_new"></a>

### new VampEventListener(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="VampEventListener+listen"></a>

### vampEventListener.listen(eventType, tags)
Listen for a specific event type with specific tags. Emits a 'found' event when the event is encountered in the stream.

**Kind**: instance method of [<code>VampEventListener</code>](#VampEventListener)  

| Param | Type | Description |
| --- | --- | --- |
| eventType | <code>string</code> | the type of event to listen for. Defaults to "synchronization" |
| tags | <code>Array.&lt;string&gt;</code> | array of tags to filter the events. Multiple tags use an AND operator to filter, making the selection more specific. |

<a name="Event"></a>

## Event
Class representing an Event

**Kind**: global class  

* [Event](#Event)
    * [new Event(http)](#new_Event_new)
    * [.emit(value, tags)](#Event+emit) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.list(tags, page, perPage)](#Event+list) ⇒ <code>Promise.&lt;Array&gt;</code>

<a name="new_Event_new"></a>

### new Event(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Event+emit"></a>

### event.emit(value, tags) ⇒ <code>Promise.&lt;Object&gt;</code>
Emits an event with a set of tags

**Kind**: instance method of [<code>Event</code>](#Event)  

| Param | Type | Description |
| --- | --- | --- |
| value | <code>string</code> | the contents for the "value" key in the event |
| tags | <code>Array.&lt;string&gt;</code> | array of tags added to the "tags" key in the event |

<a name="Event+list"></a>

### event.list(tags, page, perPage) ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of events

**Kind**: instance method of [<code>Event</code>](#Event)  

| Param | Type | Description |
| --- | --- | --- |
| tags | <code>Array.&lt;string&gt;</code> | array of tags to filter the events. Multiple tags use an AND operator to filter, making the selection more specific. |
| page | <code>number</code> | page to return |
| perPage | <code>number</code> | items per page to return |

<a name="Gateway"></a>

## Gateway
Class representing a Gateway resource

**Kind**: global class  

* [Gateway](#Gateway)
    * [new Gateway(http)](#new_Gateway_new)
    * [.list()](#Gateway+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Gateway+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.delete(name)](#Gateway+delete) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.update(name, payload)](#Gateway+update) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.create(gateway)](#Gateway+create) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Gateway_new"></a>

### new Gateway(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Gateway+list"></a>

### gateway.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of gateways

**Kind**: instance method of [<code>Gateway</code>](#Gateway)  
<a name="Gateway+get"></a>

### gateway.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single gateway resource

**Kind**: instance method of [<code>Gateway</code>](#Gateway)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the breed |

<a name="Gateway+delete"></a>

### gateway.delete(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Deletes the artifact

**Kind**: instance method of [<code>Gateway</code>](#Gateway)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Name of the artifact |

<a name="Gateway+update"></a>

### gateway.update(name, payload) ⇒ <code>Promise.&lt;Object&gt;</code>
Updates a gateway

**Kind**: instance method of [<code>Gateway</code>](#Gateway)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Name of the artifact |
| payload | <code>object</code> | A full gateway artifact |

<a name="Gateway+create"></a>

### gateway.create(gateway) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a gateway based on a passed in Javascript object.

**Kind**: instance method of [<code>Gateway</code>](#Gateway)  

| Param | Type | Description |
| --- | --- | --- |
| gateway | <code>object</code> | a gateway resource. |

<a name="Namespace"></a>

## Namespace
Class representing a Namespace resource

**Kind**: global class  

* [Namespace](#Namespace)
    * [new Namespace(http)](#new_Namespace_new)
    * [.list()](#Namespace+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Namespace+get) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Namespace_new"></a>

### new Namespace(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Namespace+list"></a>

### namespace.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of namespaces

**Kind**: instance method of [<code>Namespace</code>](#Namespace)  
<a name="Namespace+get"></a>

### namespace.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single namespace resource

**Kind**: instance method of [<code>Namespace</code>](#Namespace)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the token |

<a name="Role"></a>

## Role
Class representing a Role resource

**Kind**: global class  

* [Role](#Role)
    * [new Role(http)](#new_Role_new)
    * [.list()](#Role+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Role+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.create(role)](#Role+create) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.delete(name)](#Role+delete) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Role_new"></a>

### new Role(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Role+list"></a>

### role.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of roles

**Kind**: instance method of [<code>Role</code>](#Role)  
<a name="Role+get"></a>

### role.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single role resource

**Kind**: instance method of [<code>Role</code>](#Role)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the role |

<a name="Role+create"></a>

### role.create(role) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a role based on a passed in Javascript object.

**Kind**: instance method of [<code>Role</code>](#Role)  

| Param | Type | Description |
| --- | --- | --- |
| role | <code>object</code> | a role resource. |

<a name="Role+delete"></a>

### role.delete(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Deletes the artifact

**Kind**: instance method of [<code>Role</code>](#Role)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Name of the artifact |

<a name="Token"></a>

## Token
Class representing a Token resource

**Kind**: global class  

* [Token](#Token)
    * [new Token(http)](#new_Token_new)
    * [.list()](#Token+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Token+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.create(token)](#Token+create) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.delete(name)](#Token+delete) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_Token_new"></a>

### new Token(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Token+list"></a>

### token.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of tokens

**Kind**: instance method of [<code>Token</code>](#Token)  
<a name="Token+get"></a>

### token.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single token resource

**Kind**: instance method of [<code>Token</code>](#Token)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the token |

<a name="Token+create"></a>

### token.create(token) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a token based on a passed in Javascript object.

**Kind**: instance method of [<code>Token</code>](#Token)  

| Param | Type | Description |
| --- | --- | --- |
| token | <code>object</code> | a token resource. |

<a name="Token+delete"></a>

### token.delete(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Deletes the artifact

**Kind**: instance method of [<code>Token</code>](#Token)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | Name of the artifact |

<a name="User"></a>

## User
Class representing a User resource

**Kind**: global class  

* [User](#User)
    * [new User(http)](#new_User_new)
    * [.list()](#User+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#User+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.create(user)](#User+create) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.delete(user)](#User+delete) ⇒ <code>Promise.&lt;Object&gt;</code>

<a name="new_User_new"></a>

### new User(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="User+list"></a>

### user.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of users

**Kind**: instance method of [<code>User</code>](#User)  
<a name="User+get"></a>

### user.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single user resource

**Kind**: instance method of [<code>User</code>](#User)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the user |

<a name="User+create"></a>

### user.create(user) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a role based on a passed in Javascript object.

**Kind**: instance method of [<code>User</code>](#User)  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>object</code> | a user resource. |

<a name="User+delete"></a>

### user.delete(user) ⇒ <code>Promise.&lt;Object&gt;</code>
Deletes the artifact

**Kind**: instance method of [<code>User</code>](#User)  

| Param | Type | Description |
| --- | --- | --- |
| user | <code>string</code> | Name of the artifact |

<a name="Workflow"></a>

## Workflow
Class representing a Workflow resource

**Kind**: global class  

* [Workflow](#Workflow)
    * [new Workflow(http)](#new_Workflow_new)
    * [.list()](#Workflow+list) ⇒ <code>Promise.&lt;Array&gt;</code>
    * [.get(name)](#Workflow+get) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.create(workflow)](#Workflow+create) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.delete(workflow)](#Workflow+delete) ⇒ <code>Promise.&lt;Object&gt;</code>
    * [.updateStatus(name, status)](#Workflow+updateStatus)

<a name="new_Workflow_new"></a>

### new Workflow(http)

| Param | Type | Description |
| --- | --- | --- |
| http | <code>object</code> | instantiated axios client |

<a name="Workflow+list"></a>

### workflow.list() ⇒ <code>Promise.&lt;Array&gt;</code>
Get a list of workflows

**Kind**: instance method of [<code>Workflow</code>](#Workflow)  
<a name="Workflow+get"></a>

### workflow.get(name) ⇒ <code>Promise.&lt;Object&gt;</code>
Describes a single workflow resource

**Kind**: instance method of [<code>Workflow</code>](#Workflow)  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the workflow |

<a name="Workflow+create"></a>

### workflow.create(workflow) ⇒ <code>Promise.&lt;Object&gt;</code>
Creates a workflow based on a passed in Javascript object.

**Kind**: instance method of [<code>Workflow</code>](#Workflow)  

| Param | Type | Description |
| --- | --- | --- |
| workflow | <code>object</code> | a workflow resource. |

<a name="Workflow+delete"></a>

### workflow.delete(workflow) ⇒ <code>Promise.&lt;Object&gt;</code>
Deletes the artifact

**Kind**: instance method of [<code>Workflow</code>](#Workflow)  

| Param | Type | Description |
| --- | --- | --- |
| workflow | <code>string</code> | Name of the artifact |

<a name="Workflow+updateStatus"></a>

### workflow.updateStatus(name, status)
**Kind**: instance method of [<code>Workflow</code>](#Workflow)  

| Param | Description |
| --- | --- |
| name |  |
| status | running    If the workflow is suspended, it will be restarted.                restarting    If the workflow is suspended or running, it will be restarted.                suspended/suspending    If the workflow is running or restarting, it will be suspended (stopped, but not deleted) |

<a name="hasRights"></a>

## hasRights(endpoint, access, rights) ⇒ <code>Boolean</code>
Describes a single blueprint resource

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| endpoint | <code>string</code> | the endpoint to match, i.e. '/tokens' |
| access | <code>string</code> | the privilige to match, i.e. 'WRITE' |
| rights | <code>Object</code> | object with path as key and rights as value, i.e. { 'namespace/tokens': '["READ", "WRITE"]' } |