Naively Programmable Module

    pass_app_swagger_api

    1.0.9 • Public • Published

    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

    Class Method HTTP request Description
    PassAppSwaggerApi.ActivityApi createActivity POST /activity
    PassAppSwaggerApi.ActivityApi getActivities GET /activity
    PassAppSwaggerApi.ActivityApi getActivity GET /activity/{id}
    PassAppSwaggerApi.AuthApi forgetPassword PUT /users/forget/password
    PassAppSwaggerApi.AuthApi login POST /users/login
    PassAppSwaggerApi.AuthApi register POST /users
    PassAppSwaggerApi.AuthApi resendCode GET /users/resend/code/{id}
    PassAppSwaggerApi.AuthApi verifyUser POST /users/verify
    PassAppSwaggerApi.CompanyApi deleteCompany DELETE /company/{id}
    PassAppSwaggerApi.CompanyApi getCompanies GET /company
    PassAppSwaggerApi.CompanyApi getCompaniesByLocation POST /company/location
    PassAppSwaggerApi.CompanyApi getCompany GET /company/{id}
    PassAppSwaggerApi.CompanyApi registerCompany POST /company
    PassAppSwaggerApi.CompanyApi updateCompany PUT /company/{id}
    PassAppSwaggerApi.EmployeesApi changePasswordEmployee PUT /employees/change/password
    PassAppSwaggerApi.EmployeesApi deleteEmployee DELETE /employees/{id}
    PassAppSwaggerApi.EmployeesApi getEmployee GET /employees/{id}
    PassAppSwaggerApi.EmployeesApi getEmployees GET /employees
    PassAppSwaggerApi.EmployeesApi updateEmployee PUT /employees/{id}
    PassAppSwaggerApi.EmployeesActivityApi checkIn PUT /employees/activity/check/in
    PassAppSwaggerApi.EmployeesActivityApi checkOut PUT /employees/activity/check/out
    PassAppSwaggerApi.EmployeesActivityApi createUserByEmp POST /employees/create/user
    PassAppSwaggerApi.EmployeesActivityApi getActivityListForEmp GET /employees/activity/details
    PassAppSwaggerApi.EmployeesActivityApi getOneActivityForEmp GET /employees/activity/details/{id}
    PassAppSwaggerApi.EmployeesActivityApi getUserById GET /employees/search/users/{id}
    PassAppSwaggerApi.EmployeesActivityApi searchUsers GET /employees/search/users
    PassAppSwaggerApi.EmployeesAuthApi forgetPasswordEmployee PUT /employees/forget/password
    PassAppSwaggerApi.EmployeesAuthApi loginEmployee POST /employees/login
    PassAppSwaggerApi.EmployeesAuthApi registerEmployee POST /employees
    PassAppSwaggerApi.EmployeesAuthApi resendEmployeeCode GET /employees/resend/code/{id}
    PassAppSwaggerApi.EmployeesAuthApi verifyEmployee POST /employees/verify
    PassAppSwaggerApi.UserApi addUserRelation PUT /users/relation
    PassAppSwaggerApi.UserApi changePassword PUT /users/change/password
    PassAppSwaggerApi.UserApi deleteUser DELETE /users/{id}
    PassAppSwaggerApi.UserApi getUser GET /users/{id}
    PassAppSwaggerApi.UserApi getUserCompaniesByLocation POST /users/company/location
    PassAppSwaggerApi.UserApi getUserProfile GET /users/profile/details
    PassAppSwaggerApi.UserApi getUsers GET /users
    PassAppSwaggerApi.UserApi removeUserRelation PUT /users/remove/relation
    PassAppSwaggerApi.UserApi updateUser PUT /users/profile
    PassAppSwaggerApi.UserApi uploadImage PUT /users/image/upload
    PassAppSwaggerApi.UserApi userAddress PUT /users/address
    PassAppSwaggerApi.UserActivityApi getActivityListForUser GET /users/activity/details
    PassAppSwaggerApi.UserActivityApi getOneActivityForUser GET /users/activity/details/{id}
    PassAppSwaggerApi.UserActivityApi userCheckIn PUT /users/activity/check/in
    PassAppSwaggerApi.UserActivityApi userCheckOut PUT /users/activity/check/out

    Documentation for Models

    Documentation for Authorization

    api_key

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

    Keywords

    none

    Install

    npm i pass_app_swagger_api

    DownloadsWeekly Downloads

    2

    Version

    1.0.9

    License

    Apache 2.0

    Unpacked Size

    291 kB

    Total Files

    73

    Last publish

    Collaborators

    • avatar