Giter Club home page Giter Club logo

sprint-api-library's Introduction

sprint_service

SprintService - JavaScript client for sprint_service No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.6.0
  • Package version: 1.6.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

npm

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

Then install it via:

npm install sprint_service --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your sprint_service from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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 SprintService = require('sprint_service');


var api = new SprintService.AuthApi()
var body4 = new SprintService.Body4(); // {Body4} 
api.authForgotPasswordPost(body4).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:3000/v1

Class Method HTTP request Description
SprintService.AuthApi authForgotPasswordPost POST /auth/forgot-password Forgot password
SprintService.AuthApi authLoginPost POST /auth/login Login
SprintService.AuthApi authLogoutPost POST /auth/logout Logout
SprintService.AuthApi authRefreshTokensPost POST /auth/refresh-tokens Refresh auth tokens
SprintService.AuthApi authRegisterPost POST /auth/register Register as user
SprintService.AuthApi authResetPasswordPost POST /auth/reset-password Reset password
SprintService.BacklogsApi backlogsGet GET /backlogs Get all backlogs
SprintService.BacklogsApi backlogsIdDelete DELETE /backlogs/{id} Delete a backlog
SprintService.BacklogsApi backlogsIdGet GET /backlogs/{id} Get a backlog
SprintService.BacklogsApi backlogsIdPatch PATCH /backlogs/{id} Update a backlog
SprintService.BacklogsApi backlogsPost POST /backlogs Create a backlog
SprintService.ContactsApi contactsGet GET /contacts Get all contacts
SprintService.ContactsApi contactsIdDelete DELETE /contacts/{id} Delete a contact
SprintService.ContactsApi contactsIdGet GET /contacts/{id} Get a contact
SprintService.ContactsApi contactsIdPatch PATCH /contacts/{id} Update a contact
SprintService.ContactsApi contactsPost POST /contacts Create a contact
SprintService.InviteesApi inviteesGet GET /invitees Get all team invitees
SprintService.InviteesApi inviteesIdAcceptPost POST /invitees/{id}/accept Accept a team invitee
SprintService.InvoicesApi invoicesGet GET /invoices Get all invoices
SprintService.InvoicesApi invoicesInvoiceIdGet GET /invoices/{invoiceId} Get all invoices
SprintService.InvoicesApi invoicesPost POST /invoices Create a invoice event
SprintService.OrganizationsApi organizationsGet GET /organizations Get all organizations
SprintService.OrganizationsApi organizationsIdDelete DELETE /organizations/{id} Delete a organization
SprintService.OrganizationsApi organizationsIdGet GET /organizations/{id} Get a organization
SprintService.OrganizationsApi organizationsIdInviteUserIdDelete DELETE /organizations/{id}/invite/{userId} Remove a organization member
SprintService.OrganizationsApi organizationsIdInviteUserIdPost POST /organizations/{id}/invite/{userId} Invite a organization member
SprintService.OrganizationsApi organizationsIdPatch PATCH /organizations/{id} Update a organization
SprintService.OrganizationsApi organizationsPost POST /organizations Create a organization
SprintService.TasksApi tasksBacklogBacklogIdGet GET /tasks/backlog/{backlogId} Get all tasks
SprintService.TasksApi tasksBulkPost POST /tasks/bulk Create a task events
SprintService.TasksApi tasksDoingGet GET /tasks/doing Get all tasks
SprintService.TasksApi tasksDoneGet GET /tasks/done Get all tasks
SprintService.TasksApi tasksPost POST /tasks Create a task event
SprintService.TasksApi tasksTodoGet GET /tasks/todo Get all tasks
SprintService.TeamsApi teamsGet GET /teams Get all teams
SprintService.TeamsApi teamsIdDelete DELETE /teams/{id} Delete a team
SprintService.TeamsApi teamsIdGet GET /teams/{id} Get a team
SprintService.TeamsApi teamsIdInviteUserIdDelete DELETE /teams/{id}/invite/{userId} Remove a team member
SprintService.TeamsApi teamsIdInviteUserIdPost POST /teams/{id}/invite/{userId} Invite a team member
SprintService.TeamsApi teamsIdPatch PATCH /teams/{id} Update a team
SprintService.TeamsApi teamsPost POST /teams Create a team
SprintService.UsersApi usersGet GET /users Get all users
SprintService.UsersApi usersIdDelete DELETE /users/{id} Delete a user
SprintService.UsersApi usersIdGet GET /users/{id} Get a user
SprintService.UsersApi usersIdPatch PATCH /users/{id} Update a user
SprintService.UsersApi usersPost POST /users Create a user
SprintService.WidgetsApi widgetsGet GET /widgets Get all widgets
SprintService.WidgetsApi widgetsIdDelete DELETE /widgets/{id} Delete a widget
SprintService.WidgetsApi widgetsIdGet GET /widgets/{id} Get a widget
SprintService.WidgetsApi widgetsIdPatch PATCH /widgets/{id} Update a widget
SprintService.WidgetsApi widgetsPost POST /widgets Create a widget

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: Bearer authentication (JWT)

sprint-api-library's People

Watchers

James Cloos avatar Shadman Kudchikar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.