topcoder-dev-api-projects

tc_project_service

TcProjectService - JavaScript client for tc_project_service Services that provide access and interaction with user projects. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• 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 tc_project_service --save

git

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

    npm install YOUR_USERNAME/tc_project_service --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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

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

var TcProjectService = require('tc_project_service');

var defaultClient = TcProjectService.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new TcProjectService.DefaultApi()

var body = new TcProjectService.ProjectRequestBody(); // {ProjectRequestBody} 


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

Documentation for API Endpoints

All URIs are relative to http://api.topcoder-dev.com/v3

Class	Method	HTTP request	Description
TcProjectService.DefaultApi	directProjectsPost	POST /direct/projects
TcProjectService.DefaultApi	directProjectsProjectIdBillingaccountDelete	DELETE /direct/projects/{projectId}/billingaccount
TcProjectService.DefaultApi	directProjectsProjectIdBillingaccountPost	POST /direct/projects/{projectId}/billingaccount
TcProjectService.DefaultApi	directProjectsProjectIdCopilotDelete	DELETE /direct/projects/{projectId}/copilot
TcProjectService.DefaultApi	directProjectsProjectIdCopilotPost	POST /direct/projects/{projectId}/copilot
TcProjectService.DefaultApi	directProjectsProjectIdGet	GET /direct/projects/{projectId}
TcProjectService.DefaultApi	directProjectsProjectIdMilestonesPost	POST /direct/projects/{projectId}/milestones
TcProjectService.DefaultApi	directProjectsProjectIdPermissionsDelete	DELETE /direct/projects/{projectId}/permissions
TcProjectService.DefaultApi	directProjectsProjectIdPermissionsGet	GET /direct/projects/{projectId}/permissions
TcProjectService.DefaultApi	directProjectsProjectIdPermissionsPost	POST /direct/projects/{projectId}/permissions
TcProjectService.DefaultApi	directProjectsProjectIdPermissionsPut	PUT /direct/projects/{projectId}/permissions
TcProjectService.DefaultApi	directProjectsUserGet	GET /direct/projects/user

Documentation for Models

• TcProjectService.AddMilestoneRequest
• TcProjectService.AddMilestoneResponse
• TcProjectService.AddMilestoneResult
• TcProjectService.BillingAccount
• TcProjectService.BillingAccountBody
• TcProjectService.BillingAccountPostResponse
• TcProjectService.BillingAccountPostResult
• TcProjectService.CopilotDeleteResponse
• TcProjectService.CopilotDeleteResult
• TcProjectService.CopilotPostContent
• TcProjectService.CopilotPostResponse
• TcProjectService.CopilotPostResult
• TcProjectService.CopilotRequestBody
• TcProjectService.DirectProjectType
• TcProjectService.GenericResponse
• TcProjectService.GenericResult
• TcProjectService.OptionalAnswer
• TcProjectService.Permission
• TcProjectService.PermissionInfo
• TcProjectService.PermissionPermissionType
• TcProjectService.PermissionsBody
• TcProjectService.ProjectAnswer
• TcProjectService.ProjectGetContent
• TcProjectService.ProjectGetContentProject
• TcProjectService.ProjectGetResponse
• TcProjectService.ProjectGetResult
• TcProjectService.ProjectPermissionsGetResponse
• TcProjectService.ProjectPostContent
• TcProjectService.ProjectPostResponse
• TcProjectService.ProjectPostResult
• TcProjectService.ProjectQuestion
• TcProjectService.ProjectQuestionOption
• TcProjectService.ProjectRequestBody
• TcProjectService.UserProjectContent
• TcProjectService.UserProjectResult
• TcProjectService.UserProjectsGetResponse

Documentation for Authorization

bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header