(package) new Projects(client)
Manager for functionality related to projects.
Parameters:
| Name | Type | Description |
|---|---|---|
client |
Client | Client to use |
- Source:
Methods
associateConnection(projectSlug, connectionSlug) → {Promise}
Associates a connection with a project.
Requires an API token with write access.
Parameters:
| Name | Type | Description |
|---|---|---|
projectSlug |
String | Slug of project to associate |
connectionSlug |
String | Slug of the connection to associate with |
- Source:
Returns:
Promise representing the HTTP request
- Type
- Promise
create(project) → {Promise}
Creates a project.
Requires an API token with write access.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
project |
Object | Project to create
Properties
|
- Source:
Returns:
Promise representing the HTTP request
- Type
- Promise
destroy(projectSlug) → {Promise}
Destroys a project.
Requires an API token with write access.
Parameters:
| Name | Type | Description |
|---|---|---|
projectSlug |
String | Slug of project to destroy |
- Source:
Returns:
Promise representing the HTTP request
- Type
- Promise
get(slug) → {Promise}
Gets a project.
Parameters:
| Name | Type | Description |
|---|---|---|
slug |
String | Slug of the project |
- Source:
Returns:
Promise representing the HTTP request
- Type
- Promise
getKeyPairs(projectSlug) → {Promise}
Gets the key pairs that have been generated for this project.
Requires an API token with write access.
Parameters:
| Name | Type | Description |
|---|---|---|
projectSlug |
String | Slug of the project |
- Source:
Returns:
Promise represeenting the HTTP request
- Type
- Promise
getStatements(projectSlug) → {Promise}
Gets recent statements for a project.
Parameters:
| Name | Type | Description |
|---|---|---|
projectSlug |
String | Slug of project to get statements for |
- Source:
Returns:
Promise representing the HTTP request
- Type
- Promise
list() → {Promise}
Lists all projects.
- Source:
Returns:
Promise representing the HTTP request
- Type
- Promise
update(projectSlug, project) → {Promise}
Updates a project.
Requires an API token with write access.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
projectSlug |
String | Slug of project to update | ||||||
project |
Object | Updated project
Properties
|
- Source:
Returns:
Promise representing the HTTP request
- Type
- Promise