Constructor
new Project(fullNameopt, authopt, apiBaseopt)
Create a Project.
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
fullName |
string
|
<optional> |
the project to use for user-scoped queries |
|
auth |
Requestable.auth
|
<optional> |
information required to authenticate to ApiWay |
|
apiBase |
string
|
<optional> |
https://api.apiway.io |
the base ApiWay API URL |
Methods
addEmailSubscriber(projectIdopt, options, cbopt) → {Promise}
Add a email subscriber
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
options |
object
|
- |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request
addProject(options, cbopt) → {Promise}
Add a repo as a Project
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
object
|
- |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request
deleteEmailSubscriber(projectIdopt, options, cbopt) → {Promise}
Delete a email subscriber
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
options |
object
|
- |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request
deleteProject(projectIdopt, cbopt) → {Promise}
Delete a project
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request
getProject(projectIdopt, cbopt) → {Promise}
Get project information
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
cb |
Requestable.callback
|
<optional> |
will receive the list of repositories |
Returns:
- Type:
-
Promise
- the promise for the http request
getProjectsByUser(userIdopt, cbopt) → {Promise}
Get user's project list
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userId |
string
|
<optional> |
|
cb |
Requestable.callback
|
<optional> |
will receive the list of repositories |
Returns:
- Type:
-
Promise
- the promise for the http request
updateProject(projectIdopt, options, cbopt) → {Promise}
Update data of project
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
options |
object
|
- |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request
updateScheduleCron(projectIdopt, cronopt, cbopt) → {Promise}
Update schedule of project
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
cron |
string
|
<optional> |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request
updateScheduleInterval(projectIdopt, intervalopt, cbopt) → {Promise}
Update schedule of project
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
interval |
string
|
<optional> |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request
updateScheduleWhen(projectIdopt, whenopt, cbopt) → {Promise}
Update schedule of project
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
projectId |
string
|
<optional> |
|
when |
string
|
<optional> |
|
cb |
Requestable.callback
|
<optional> |
will receive the API response |
Returns:
- Type:
-
Promise
- the promise for the http request