1.0.1 • Published 4 years ago

pass_app_lib v1.0.1

Weekly downloads
-
License
Apache 2.0
Repository
-
Last release
4 years ago

pass_app_swagger_api

PassAppSwaggerApi - JavaScript client for pass_app_swagger_api PassApp with Swagger This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Package version: 2.0
  • Build package: io.swagger.codegen.v3.generators.javascript.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 pass_app_swagger_api --save

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 PassAppSwaggerApi = require('pass_app_swagger_api');

var api = new PassAppSwaggerApi.ActivityApi()
var body = new PassAppSwaggerApi.Activity(); // {Activity} activity details

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

Documentation for API Endpoints

All URIs are relative to http://localhost:3010/api/v1

ClassMethodHTTP requestDescription
PassAppSwaggerApi.ActivityApicreateActivityPOST /activity
PassAppSwaggerApi.ActivityApigetActivitiesGET /activity
PassAppSwaggerApi.ActivityApigetActivityGET /activity/{id}
PassAppSwaggerApi.AuthApiloginPOST /users/login
PassAppSwaggerApi.AuthApiregisterPOST /users
PassAppSwaggerApi.CompanyApideleteCompanyDELETE /company/{id}
PassAppSwaggerApi.CompanyApigetCompaniesGET /company
PassAppSwaggerApi.CompanyApigetCompaniesByLocationPOST /company/location
PassAppSwaggerApi.CompanyApigetCompanyGET /company/{id}
PassAppSwaggerApi.CompanyApiregisterCompanyPOST /company
PassAppSwaggerApi.CompanyApiupdateCompanyPUT /company/{id}
PassAppSwaggerApi.EmployeesApideleteEmployeeDELETE /employees/{id}
PassAppSwaggerApi.EmployeesApigetEmployeeGET /employees/{id}
PassAppSwaggerApi.EmployeesApigetEmployeesGET /employees
PassAppSwaggerApi.EmployeesApiloginEmployeePOST /employees/login
PassAppSwaggerApi.EmployeesApiregisterEmployeePOST /employees
PassAppSwaggerApi.EmployeesApiupdateEmployeePUT /employees/{id}
PassAppSwaggerApi.UserApideleteUserDELETE /users/{id}
PassAppSwaggerApi.UserApigetUserGET /users/{id}
PassAppSwaggerApi.UserApigetUsersGET /users
PassAppSwaggerApi.UserApiupdateUserPUT /users/{id}
PassAppSwaggerApi.UserApiuploadImagePUT /users/image/upload

Documentation for Models

Documentation for Authorization

api_key

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