ApiWay

ApiWay

ApiWay encapsulates the functionality to create various API wrapper objects.

Constructor

new ApiWay(authopt, apiBaseopt)

Create a new ApiWay.

Source:
Parameters:
Name Type Attributes Default Description
auth Requestable.auth <optional>

the credentials to authenticate to ApiWay. If auth is not provided requests will be made unauthenticated
apiBase string <optional>
 https://api.apiway.io

the base ApiWay API URL

Methods

getInstance(instanceopt) → {Instance}

Create a new Instance wrapper

Source:
Parameters:
Name Type Attributes Description
instance string <optional>

the id of the instance to get information about leave undefined for the authenticated user
Returns:
Type:
Instance

getProject(fullNameopt) → {Project}

Create a new Project wrapper

Source:
Parameters:
Name Type Attributes Description
fullName string <optional>

the name of the project to get information about leave undefined for the authenticated user
Returns:
Type:
Project

getSchedule(scheduleIdopt) → {Schedule}

Create a new Schedule wrapper

Source:
Parameters:
Name Type Attributes Description
scheduleId string <optional>

the id of the instance to get information about leave undefined for the authenticated user
Returns:
Type:
Schedule

getScheduler(schedulerIdopt) → {Schedule}

Create a new Scheduler wrapper

Source:
Parameters:
Name Type Attributes Description
schedulerId string <optional>

the id of the instance to get information about leave undefined for the authenticated user
Returns:
Type:
Schedule

getUser(useropt) → {User}

Create a new User wrapper

Source:
Parameters:
Name Type Attributes Description
user string <optional>

the name of the user to get information about leave undefined for the authenticated user
Returns:
Type:
User