ClientAPI

ClientAPI

API for the Client entities, which represent some brand or company.

Constructor

new ClientAPI()

Source:

Methods

(async, static) createClient(payload) → {Promise}

Creates a new client with the provided information.
Source:
Parameters:
Name Type Description
payload Client An object that contains information about a client.
Returns:
Type:
Promise
The created client.

(async, static) createIterationProject(name, project, payload) → {Promise}

Creates a new iteration for the provided project.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
payload Iteration An object that contains information about an iteration.
Returns:
Type:
Promise
The newly created iteration.

(async, static) createProjectClient(name, payload) → {Promise}

Creates a new project for the provided client.
Source:
Parameters:
Name Type Description
name String The name of the client.
payload Project An object that contains information about a project.
Returns:
Type:
Promise
The newly created client's project.

(async, static) createReviewIteration(name, project, iteration, payload) → {Promise}

Creates a new review for the provided iteration.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
payload Review An object that contains information about a review.
Returns:
Type:
Promise
The newly created iteration.

(async, static) deleteClient(name) → {Promise}

Deletes the client with the provided name.
Source:
Parameters:
Name Type Description
name String The name of the client.
Returns:
Type:
Promise
Empty response.

(async, static) deleteIterationProject(name, project, iteration) → {Promise}

Deletes an iteration of the provided project.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
Returns:
Type:
Promise
Empty response.

(async, static) deleteProjectClient(name, project) → {Promise}

Deletes a project of the provided client.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
Returns:
Type:
Promise
Empty response.

(async, static) deleteReviewIteration(name, project, iteration, review) → {Promise}

Deletes a review of the provided review.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
review String The name of the review.
Returns:
Type:
Promise
Empty response.

(async, static) getClient(name) → {Promise}

Returns the client with the provided name.
Source:
Parameters:
Name Type Description
name String The name of the client.
Returns:
Type:
Promise
The client requested.

(async, static) getIterationProject(name, project, iteration) → {Promise}

Returns a client's project iteration.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
Returns:
Type:
Promise
The requested client's project iteration.

(async, static) getProjectClient(name, project) → {Promise}

Returns a project of the provided client.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
Returns:
Type:
Promise
The requested client's project.

(async, static) getReviewIteration(name, project, iteration, review) → {Promise}

Returns an iteration's review.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
review String The name of the review.
Returns:
Type:
Promise
The requested iteration's review.

(async, static) listClients(options) → {Promise}

Returns all clients in the registry.
Source:
Parameters:
Name Type Description
options Object An object of options to configure the query and its results.
Returns:
Type:
Promise
The client result list.

(async, static) listIterationsProject(name, project, options) → {Promise}

Returns a client's project iterations.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
options Object An object of options to configure the query and its results.
Returns:
Type:
Promise
The client's project iterations result list.

(async, static) listProjectsClient(name, options) → {Promise}

Returns the projects of the provided client.
Source:
Parameters:
Name Type Description
name String The name of the client.
options Object An object of options to configure the query and its results.
Returns:
Type:
Promise
The client's projects result list.

(async, static) listReviewsIteration(name, project, iteration, options) → {Promise}

Returns an iteration's reviews.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
options Object An object of options to configure the query and its results.
Returns:
Type:
Promise
The iteration's reviews result list.

(async, static) updateClient(name, payload) → {Promise}

Updates the client with the provided information.
Source:
Parameters:
Name Type Description
name String The name of the client.
payload Object An object that contains information about a client.
Returns:
Type:
Promise
The updated client.

(async, static) updateIterationProject(name, project, iteration, payload) → {Promise}

Updates an iteration of the provided project.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
payload Object An object that contains information about an iteration.
Returns:
Type:
Promise
The updated iteration.

(async, static) updateProjectClient(name, project, payload) → {Promise}

Updates a project of the provided client.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
payload Object An object that contains information about a project.
Returns:
Type:
Promise
The updated client's project.

(async, static) updateReviewIteration(name, project, iteration, review, payload) → {Promise}

Updates a review of the provided iteration.
Source:
Parameters:
Name Type Description
name String The name of the client.
project String The name of the project.
iteration String The name of the iteration.
review String The name of the review.
payload Object An object that contains information about a review.
Returns:
Type:
Promise
The updated review.