1.0.0 • Published 8 years ago

teamwork-server-api v1.0.0

Weekly downloads
1
License
Apache-2.0
Repository
-
Last release
8 years ago

teamwork-server-api

TeamworkServerApi - JavaScript client for teamwork-server-api Teamwork Server API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-06-14T06:44:35.780Z
  • Build package: class 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 teamwork-server-api --save

git

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

    npm install YOUR_USERNAME/teamwork-server-api --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 TeamworkServerApi = require('teamwork-server-api');

var api = new TeamworkServerApi.ClientApi()

var corsDomain = new TeamworkServerApi.CORSDomain(); // {CORSDomain} CORS is removed sucessfully


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

Documentation for API Endpoints

All URIs are relative to http://esqteamworkapi.azurewebsites.net/v1

ClassMethodHTTP requestDescription
TeamworkServerApi.ClientApiazClientStorageaccessDeleteDELETE /az/client/storageaccessUn-Grant CORS to a particular domain for the Azure Storage Account.
TeamworkServerApi.ClientApiazClientStorageaccessGetGET /az/client/storageaccessGet domains granted with CORS for the Azure Storage Account.
TeamworkServerApi.ClientApiazClientStorageaccessPostPOST /az/client/storageaccessGrant CORS to a particular domain for the Azure Storage Account.
TeamworkServerApi.ClientApiazClientStorageaccessStorageAccountStorageKeyGetGET /az/client/storageaccess/{storageAccount}/{storageKey}Get domains granted with CORS for the Azure Storage Account.
TeamworkServerApi.DefaultApiazClientStorageaccessOptionsOPTIONS /az/client/storageaccessCORS Preflight request
TeamworkServerApi.DefaultApiazDeptNameOptionsOPTIONS /az/dept/{name}CORS Preflight request
TeamworkServerApi.DefaultApiazDeptNameTasksOptionsOPTIONS /az/dept/{name}/tasksCORS Preflight request
TeamworkServerApi.DefaultApiazDeptNameWorksWorkNameOptionsOPTIONS /az/dept/{name}/works/{workName}CORS Preflight request
TeamworkServerApi.DefaultApiazDeptOptionsOPTIONS /az/deptCORS Preflight request
TeamworkServerApi.DefaultApiazOrgOptionsOPTIONS /az/orgCORS Preflight request
TeamworkServerApi.DepartmentApiazDeptGetGET /az/deptGet all departments of an organization
TeamworkServerApi.DepartmentApiazDeptNameDeleteDELETE /az/dept/{name}Delete a department from an organization.
TeamworkServerApi.DepartmentApiazDeptNameGetGET /az/dept/{name}Get a department of an organization
TeamworkServerApi.DepartmentApiazDeptNamePostPOST /az/dept/{name}Add a department to an organization. If the department already exists, it will be updated.
TeamworkServerApi.OrganizationApiazOrgDeleteDELETE /az/orgDelete an organization.
TeamworkServerApi.OrganizationApiazOrgPostPOST /az/orgCreate a new organization
TeamworkServerApi.TaskApiazDeptNameTasksGetGET /az/dept/{name}/tasksGet all tasks of a department
TeamworkServerApi.TaskApiazDeptNameTasksPostPOST /az/dept/{name}/tasksAdd a task list to the department. If the department already exists, it will be updated.
TeamworkServerApi.TaskApiazDeptNameWorksWorkNameDeleteDELETE /az/dept/{name}/works/{workName}Delete all tasks of a work for a particular department

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.