Skip to content

Latest commit

 

History

History
292 lines (247 loc) · 24 KB

README.md

File metadata and controls

292 lines (247 loc) · 24 KB

tractiontools_api_v1

TractionToolsApiV1 - JavaScript client for traction_tools_api___v1 No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: v1
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install traction_tools_api___v1 --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your traction_tools_api___v1 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('traction_tools_api___v1') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TractionToolsApiV1 = require('traction_tools_api___v1');

var api = new TractionToolsApiV1.HeadlinesApi()

var HEADLINE_ID = 789; // {Number} People headline ID

var opts = { 
  'includeOrigin': true, // {Boolean} 
  'includePermission': true // {Boolean} Include permission in the response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.headlinesGetHeadline(HEADLINE_ID, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://tt-devs.com

Class Method HTTP request Description
TractionToolsApiV1.HeadlinesApi headlinesGetHeadline GET /api/v1/headline/{HEADLINE_ID} Get a specific people headline
TractionToolsApiV1.HeadlinesApi headlinesGetMineHeadlines GET /api/v1/headline/users/mine Get headlines you own
TractionToolsApiV1.HeadlinesApi headlinesGetUserHeadlines GET /api/v1/headline/users/{USER_ID} Get all headlines owned by a user.
TractionToolsApiV1.HeadlinesApi headlinesRemoveHeadlines DELETE /api/v1/headline/{HEADLINE_ID} Delete a people headline
TractionToolsApiV1.HeadlinesApi headlinesUpdateHeadlines PUT /api/v1/headline/{HEADLINE_ID} Update a People Headline
TractionToolsApiV1.IssuesApi issuesComplete POST /api/v1/issues/{ISSUE_ID}/complete Mark issue as completed
TractionToolsApiV1.IssuesApi issuesCreateIssue POST /api/v1/issues/create Create a new issue in for a Level 10
TractionToolsApiV1.IssuesApi issuesEditIssue PUT /api/v1/issues/{ISSUE_ID} Update an issue
TractionToolsApiV1.IssuesApi issuesGet GET /api/v1/issues/{ISSUE_ID} Get a specific issue
TractionToolsApiV1.IssuesApi issuesGetMineIssues GET /api/v1/issues/users/mine Get all issues you own.
TractionToolsApiV1.IssuesApi issuesGetUserIssues GET /api/v1/issues/users/{USER_ID} Get all issues owned by a user.
TractionToolsApiV1.IssuesApi issuesMoveFromVto POST /api/v1/issues/{ISSUE_ID}/movefromvto Move issue from VTO
TractionToolsApiV1.IssuesApi issuesMoveToMeeting POST /api/v1/issues/{ISSUE_ID}/movetomeeting/{MEETING_ID} Move issue to another meeting
TractionToolsApiV1.IssuesApi issuesMoveToVto POST /api/v1/issues/{ISSUE_ID}/movetovto Move issue to VTO
TractionToolsApiV1.L10Api l10AddAttendee POST /api/v1/L10/{MEETING_ID}/attendees/{USER_ID} Add an existing user to a Level 10 meeting
TractionToolsApiV1.L10Api l10AttachMeasurableL10 POST /api/v1/L10/{MEETING_ID}/measurables/{MEASURABLE_ID} Add an existing scorecard measurable to a Level 10 meeting
TractionToolsApiV1.L10Api l10AttachRockMeetingL10 POST /api/v1/L10/{MEETING_ID}/rocks/{ROCK_ID} Add an existing rock to a Level 10 meeting
TractionToolsApiV1.L10Api l10CreateHeadlineL10 POST /api/v1/L10/{MEETING_ID}/headlines Create a people headline for a Level 10 meeting
TractionToolsApiV1.L10Api l10CreateIssueL10 POST /api/v1/L10/{MEETING_ID}/issues Add an issue to a Level 10 meeting
TractionToolsApiV1.L10Api l10CreateL10 POST /api/v1/L10/create Create a new Level 10 meeting.
TractionToolsApiV1.L10Api l10CreateRockL10 POST /api/v1/L10/{MEETING_ID}/rocks Create a new rock and move it to L10 meeting
TractionToolsApiV1.L10Api l10CreateTodoL10 POST /api/v1/L10/{MEETING_ID}/todos Add a to-do to a Level 10 meeting
TractionToolsApiV1.L10Api l10EditL10 PUT /api/v1/L10/{MEETING_ID} Update a Level 10 meeting
TractionToolsApiV1.L10Api l10GetL10 GET /api/v1/L10/{MEETING_ID} Get information about a Level 10 meeting
TractionToolsApiV1.L10Api l10GetL10Attendees GET /api/v1/L10/{MEETING_ID}/attendees Get a list of attendees
TractionToolsApiV1.L10Api l10GetL10List GET /api/v1/L10/list Get a list of Level 10 meetings
TractionToolsApiV1.L10Api l10GetL10Rocks GET /api/v1/L10/{MEETING_ID}/rocks Get list of L10 rocks
TractionToolsApiV1.L10Api l10GetRecurrenceHeadlines GET /api/v1/l10/{MEETING_ID}/headlines Get a list of people headlines in a Level 10 meeting
TractionToolsApiV1.L10Api l10GetRecurrenceIssues GET /api/v1/l10/{MEETING_ID}/issues Get a list of issues for a Level 10 meeting
TractionToolsApiV1.L10Api l10GetRecurrenceTodos GET /api/v1/l10/{MEETING_ID}/todos Get a list of to-dos in a Level 10 meeting
TractionToolsApiV1.L10Api l10GetUserHeadlines GET /api/v1/l10/{MEETING_ID}/users/{USER_ID}/headlines Get a list of headlines in a Level 10 meeting for a particular user
TractionToolsApiV1.L10Api l10GetUserIssues GET /api/v1/l10/{MEETING_ID}/users/{USER_ID}/issues Get a list of issues in a Level 10 meeting for a particular user
TractionToolsApiV1.L10Api l10GetUserL10List GET /api/v1/L10/{USER_ID}/list Get list of L10 meetings attended by a particular user
TractionToolsApiV1.L10Api l10GetUserMeasurables GET /api/v1/l10/{MEETING_ID}/users/{USER_ID}/measurables Get a list of measurables in a Level 10 meeting for a particular user
TractionToolsApiV1.L10Api l10GetUserRocks GET /api/v1/l10/{MEETING_ID}/users/{USER_ID}/rocks Get a list of rocks in a Level 10 meeting for a particular user
TractionToolsApiV1.L10Api l10GetUserTodos GET /api/v1/l10/{MEETING_ID}/users/{USER_ID}/todos Get a list of todos in a Level 10 meeting for a particular user
TractionToolsApiV1.L10Api l10RemoveHeadlineL10 DELETE /api/v1/L10/{MEETING_ID}/headlines/{HEADLINE_ID} Remove a headline from a Level 10 meeting
TractionToolsApiV1.L10Api l10RemoveIssueL10 DELETE /api/v1/L10/{MEETING_ID}/issues/{ISSUE_ID} Remove an issue from a Level 10 meeting
TractionToolsApiV1.L10Api l10RemoveL10 DELETE /api/v1/L10/{MEETING_ID} Delete a Level 10 meeting
TractionToolsApiV1.L10Api l10RemoveMeasurableL10 DELETE /api/v1/L10/{MEETING_ID}/measurables/{MEASURABLE_ID} Remove a scorecard measurable from a Level 10 meeting
TractionToolsApiV1.L10Api l10RemoveRockL10 DELETE /api/v1/L10/{MEETING_ID}/rocks/{ROCK_ID} Remove a rock from a Level 10 meeting
TractionToolsApiV1.Measurables_Api measurablesCreateMeasurable POST /api/v1/measurables/create Create a new measurable
TractionToolsApiV1.Measurables_Api measurablesGet GET /api/v1/measurables/{MEASURABLE_ID} Get a measurable
TractionToolsApiV1.Measurables_Api measurablesGetMeasurableScores GET /api/v1/measurables/{MEASURABLE_ID}/scores Get scores for a particular measurable
TractionToolsApiV1.Measurables_Api measurablesGetMineMeasureables GET /api/v1/measurables/user/mine Get measurables that you own
TractionToolsApiV1.Measurables_Api measurablesGetUserMeasureables GET /api/v1/measurables/user/{USER_ID} Get measurables for a particular user
TractionToolsApiV1.Measurables_Api measurablesUpdateMeasurable PUT /api/v1/measurables/{MEASURABLE_ID} Update a measureable
TractionToolsApiV1.Measurables_Api measurablesUpdateScore PUT /api/v1/measurables/{MEASURABLE_ID}/week/{WEEK_ID} Update a score for a particular measureable
TractionToolsApiV1.MilestonesApi milestonesGetMilestones GET /api/v1/milestones/{MILESTONE_ID} Get a particular milestone
TractionToolsApiV1.MilestonesApi milestonesRemoveMilestones DELETE /api/v1/milestones/{MILESTONE_ID} Delete a milestone
TractionToolsApiV1.MilestonesApi milestonesUpdateMilestones PUT /api/v1/milestones/{MILESTONE_ID} Update a milestone
TractionToolsApiV1.PositionApi positionAddPositionRoles POST /api/v1/positions/{POSITION_ID}/roles Create a role for a position
TractionToolsApiV1.PositionApi positionCreatePosition POST /api/v1/positions/create Create a new position
TractionToolsApiV1.PositionApi positionGetMinePosition GET /api/v1/positions/mine List all your positions at the organization
TractionToolsApiV1.PositionApi positionGetPositionRoles GET /api/v1/positions/{POSITION_ID}/roles Get a list of roles for a particular position
TractionToolsApiV1.PositionApi positionGetPositions GET /api/v1/positions/{POSITION_ID} Get a particular position
TractionToolsApiV1.PositionApi positionUpdatePositions PUT /api/v1/positions/{POSITION_ID} Update a position
TractionToolsApiV1.PostQuarterApi postQuarterCreate POST /api/v1/postquarter/create Create a new post quarter
TractionToolsApiV1.RocksApi rocksAddRocksMilestones POST /api/v1/rocks/{ROCK_ID}/milestones Add a milestone to a particular rock
TractionToolsApiV1.RocksApi rocksArchiveRock PUT /api/v1/rocks/{ROCK_ID}/archive Archive the rock
TractionToolsApiV1.RocksApi rocksCreateRock POST /api/v1/rocks/create Create a new rock
TractionToolsApiV1.RocksApi rocksDeleteRocks DELETE /api/v1/rocks/{ROCK_ID} Delete a rock
TractionToolsApiV1.RocksApi rocksGetArchivedRocksForUser GET /api/v1/archivedrocks/user/{USER_ID} Get a list of archived rocks for a user
TractionToolsApiV1.RocksApi rocksGetRock GET /api/v1/rocks/{ROCK_ID} Get a specific rock
TractionToolsApiV1.RocksApi rocksGetRocksForUser GET /api/v1/rocks/user/{USER_ID} Get a list of rocks for a user
TractionToolsApiV1.RocksApi rocksGetRocksMilestones GET /api/v1/rocks/{ROCK_ID}/milestones Get milestones for a particular rock
TractionToolsApiV1.RocksApi rocksGetYourArchivedRocks GET /api/v1/archivedrocks/user/mine Get a list of your archived rocks
TractionToolsApiV1.RocksApi rocksGetYourRocks GET /api/v1/rocks/user/mine Get a list of your rocks
TractionToolsApiV1.RocksApi rocksRestoreRock PUT /api/v1/rocks/{ROCK_ID}/restore Restore a rock from the archive
TractionToolsApiV1.RocksApi rocksUpdateRocks PUT /api/v1/rocks/{ROCK_ID} Update a rock
TractionToolsApiV1.RoleApi roleGetRoles GET /api/v1/role/{ROLE_ID} Get a particular role
TractionToolsApiV1.RoleApi roleRemoveRoles DELETE /api/v1/role/{ROLE_ID} Remove a role from a position
TractionToolsApiV1.RoleApi roleUpdateRoles PUT /api/v1/role/{ROLE_ID} Update a role
TractionToolsApiV1.ScorecardApi scorecardGetMeasureablesForUser GET /api/v1/scorecard/user/{USER_ID}
TractionToolsApiV1.ScorecardApi scorecardGetMineMeasureables GET /api/v1/scorecard/user/mine
TractionToolsApiV1.ScorecardApi scorecardGetScorecardForMeeting GET /api/v1/scorecard/meeting/{MEETING_ID}
TractionToolsApiV1.Scores_Api scoresGet GET /api/v1/scores/{SCORE_ID} Get a particular score
TractionToolsApiV1.Scores_Api scoresPut PUT /api/v1/scores/{SCORE_ID} Update a score
TractionToolsApiV1.SearchApi searchSearch GET /api/v1/search/all Search for users, positions, or teams by name
TractionToolsApiV1.SearchApi searchSearchUser GET /api/v1/search/user Search for users
TractionToolsApiV1.SeatsApi seatsAttachDirectReport POST /api/v1/seats/{SEAT_ID}/directreport/{USER_ID} Add a user below a seat
TractionToolsApiV1.SeatsApi seatsAttachPosition POST /api/v1/seats/{SEAT_ID}/position/{POSITION_ID} Set the position for a seat
TractionToolsApiV1.SeatsApi seatsAttachUser POST /api/v1/seats/{SEAT_ID}/user/{USER_ID} Set a user for a seat
TractionToolsApiV1.SeatsApi seatsDetachUser DELETE /api/v1/seats/{SEAT_ID}/user Remove user from a seat
TractionToolsApiV1.SeatsApi seatsGetPosition GET /api/v1/seats/{SEAT_ID}/position Get the position attached to a seat
TractionToolsApiV1.SeatsApi seatsGetSeat GET /api/v1/seats/{SEAT_ID} Get a particular seat
TractionToolsApiV1.SeatsApi seatsGetSeatUser GET /api/v1/seats/{SEAT_ID}/user Get the user for a seat
TractionToolsApiV1.SeatsApi seatsGetSeatsForMe GET /api/v1/seats/user/mine Get your seats
TractionToolsApiV1.SeatsApi seatsGetSeatsForUser GET /api/v1/seats/user/{USER_ID} Get seats for a user
TractionToolsApiV1.SeatsApi seatsRemovePosition DELETE /api/v1/seats/{SEAT_ID}/position Remove position for a seat
TractionToolsApiV1.SeatsApi seatsRemoveSeat DELETE /api/v1/seats/{SEAT_ID} Delete a seat from the accountability chart
TractionToolsApiV1.TeamsApi teamsAddTeam POST /api/v1/teams/create Create a new team
TractionToolsApiV1.TeamsApi teamsAddTeamMember POST /api/v1/teams/{TEAM_ID}/member/{USER_ID} Add a user to a team
TractionToolsApiV1.TeamsApi teamsGetTeamMembers GET /api/v1/teams/{TEAM_ID}/members Get team members
TractionToolsApiV1.TeamsApi teamsGetTeams GET /api/v1/teams/{TEAM_ID} Get a particular team
TractionToolsApiV1.TeamsApi teamsRemoveTeamMember DELETE /api/v1/teams/{TEAM_ID}/member/{USER_ID} Remove a team member
TractionToolsApiV1.TeamsApi teamsUpdateTeam PUT /api/v1/teams/{TEAM_ID} Update a team
TractionToolsApiV1.TodosApi todosCreateTodo POST /api/v1/todo/create Create a personal to-do
TractionToolsApiV1.TodosApi todosEditTodo PUT /api/v1/todo/{TODO_ID} Update a to-do
TractionToolsApiV1.TodosApi todosGet GET /api/v1/todo/{TODO_ID} Get a particular to-do
TractionToolsApiV1.TodosApi todosGetMineTodos GET /api/v1/todo/users/mine Get your to-dos
TractionToolsApiV1.TodosApi todosGetUserTodos GET /api/v1/todo/user/{USER_ID} Get to-dos for a user
TractionToolsApiV1.TodosApi todosMarkComplete POST /api/v1/todo/{TODO_ID}/complete Update the completion of a to-do
TractionToolsApiV1.Users_Api usersGetDirectReports GET /api/v1/users/{userId}/directreports Get direct reports for a particular user
TractionToolsApiV1.Users_Api usersGetMineDirectReports GET /api/v1/users/minedirectreports Get my direct reports
TractionToolsApiV1.Users_Api usersGetMineUser GET /api/v1/users/mine
TractionToolsApiV1.Users_Api usersGetMineViewable GET /api/v1/users/mineviewable Get all viewable users
TractionToolsApiV1.Users_Api usersGetUser GET /api/v1/users/{USER_ID}
TractionToolsApiV1.Week_Api weekGet GET /api/v1/weeks/current Get the current week

Documentation for Models

Documentation for Authorization

basic

  • Type: HTTP basic authentication