# pass_app_swagger_api PassAppSwaggerApi - JavaScript client for pass_app_swagger_api PassApp with Swagger This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 2.0 - Package version: 2.0 - Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/ActivityApi.md#createActivity) | **POST** /activity | *PassAppSwaggerApi.ActivityApi* | [**getActivities**](docs/ActivityApi.md#getActivities) | **GET** /activity | *PassAppSwaggerApi.ActivityApi* | [**getActivity**](docs/ActivityApi.md#getActivity) | **GET** /activity/{id} | *PassAppSwaggerApi.AuthApi* | [**forgetPassword**](docs/AuthApi.md#forgetPassword) | **PUT** /users/forget/password | *PassAppSwaggerApi.AuthApi* | [**login**](docs/AuthApi.md#login) | **POST** /users/login | *PassAppSwaggerApi.AuthApi* | [**register**](docs/AuthApi.md#register) | **POST** /users | *PassAppSwaggerApi.AuthApi* | [**resendCode**](docs/AuthApi.md#resendCode) | **GET** /users/resend/code/{id} | *PassAppSwaggerApi.AuthApi* | [**verifyUser**](docs/AuthApi.md#verifyUser) | **POST** /users/verify | *PassAppSwaggerApi.CompanyApi* | [**deleteCompany**](docs/CompanyApi.md#deleteCompany) | **DELETE** /company/{id} | *PassAppSwaggerApi.CompanyApi* | [**getCompanies**](docs/CompanyApi.md#getCompanies) | **GET** /company | *PassAppSwaggerApi.CompanyApi* | [**getCompaniesByLocation**](docs/CompanyApi.md#getCompaniesByLocation) | **POST** /company/location | *PassAppSwaggerApi.CompanyApi* | [**getCompany**](docs/CompanyApi.md#getCompany) | **GET** /company/{id} | *PassAppSwaggerApi.CompanyApi* | [**registerCompany**](docs/CompanyApi.md#registerCompany) | **POST** /company | *PassAppSwaggerApi.CompanyApi* | [**updateCompany**](docs/CompanyApi.md#updateCompany) | **PUT** /company/{id} | *PassAppSwaggerApi.EmployeesApi* | [**changePasswordEmployee**](docs/EmployeesApi.md#changePasswordEmployee) | **PUT** /employees/change/password | *PassAppSwaggerApi.EmployeesApi* | [**deleteEmployee**](docs/EmployeesApi.md#deleteEmployee) | **DELETE** /employees/{id} | *PassAppSwaggerApi.EmployeesApi* | [**getEmployee**](docs/EmployeesApi.md#getEmployee) | **GET** /employees/{id} | *PassAppSwaggerApi.EmployeesApi* | [**getEmployees**](docs/EmployeesApi.md#getEmployees) | **GET** /employees | *PassAppSwaggerApi.EmployeesApi* | [**updateEmployee**](docs/EmployeesApi.md#updateEmployee) | **PUT** /employees/{id} | *PassAppSwaggerApi.EmployeesActivityApi* | [**checkIn**](docs/EmployeesActivityApi.md#checkIn) | **PUT** /employees/activity/check/in | *PassAppSwaggerApi.EmployeesActivityApi* | [**checkOut**](docs/EmployeesActivityApi.md#checkOut) | **PUT** /employees/activity/check/out | *PassAppSwaggerApi.EmployeesActivityApi* | [**createUserByEmp**](docs/EmployeesActivityApi.md#createUserByEmp) | **POST** /employees/create/user | *PassAppSwaggerApi.EmployeesActivityApi* | [**getActivityListForEmp**](docs/EmployeesActivityApi.md#getActivityListForEmp) | **GET** /employees/activity/details | *PassAppSwaggerApi.EmployeesActivityApi* | [**getOneActivityForEmp**](docs/EmployeesActivityApi.md#getOneActivityForEmp) | **GET** /employees/activity/details/{id} | *PassAppSwaggerApi.EmployeesActivityApi* | [**getUserById**](docs/EmployeesActivityApi.md#getUserById) | **GET** /employees/search/users/{id} | *PassAppSwaggerApi.EmployeesActivityApi* | [**searchUsers**](docs/EmployeesActivityApi.md#searchUsers) | **GET** /employees/search/users | *PassAppSwaggerApi.EmployeesAuthApi* | [**forgetPasswordEmployee**](docs/EmployeesAuthApi.md#forgetPasswordEmployee) | **PUT** /employees/forget/password | *PassAppSwaggerApi.EmployeesAuthApi* | [**loginEmployee**](docs/EmployeesAuthApi.md#loginEmployee) | **POST** /employees/login | *PassAppSwaggerApi.EmployeesAuthApi* | [**registerEmployee**](docs/EmployeesAuthApi.md#registerEmployee) | **POST** /employees | *PassAppSwaggerApi.EmployeesAuthApi* | [**resendEmployeeCode**](docs/EmployeesAuthApi.md#resendEmployeeCode) | **GET** /employees/resend/code/{id} | *PassAppSwaggerApi.EmployeesAuthApi* | [**verifyEmployee**](docs/EmployeesAuthApi.md#verifyEmployee) | **POST** /employees/verify | *PassAppSwaggerApi.UserApi* | [**addUserRelation**](docs/UserApi.md#addUserRelation) | **PUT** /users/relation | *PassAppSwaggerApi.UserApi* | [**changePassword**](docs/UserApi.md#changePassword) | **PUT** /users/change/password | *PassAppSwaggerApi.UserApi* | [**deleteUser**](docs/UserApi.md#deleteUser) | **DELETE** /users/{id} | *PassAppSwaggerApi.UserApi* | [**getUser**](docs/UserApi.md#getUser) | **GET** /users/{id} | *PassAppSwaggerApi.UserApi* | [**getUserCompaniesByLocation**](docs/UserApi.md#getUserCompaniesByLocation) | **POST** /users/company/location | *PassAppSwaggerApi.UserApi* | [**getUserProfile**](docs/UserApi.md#getUserProfile) | **GET** /users/profile/details | *PassAppSwaggerApi.UserApi* | [**getUsers**](docs/UserApi.md#getUsers) | **GET** /users | *PassAppSwaggerApi.UserApi* | [**removeUserRelation**](docs/UserApi.md#removeUserRelation) | **PUT** /users/remove/relation | *PassAppSwaggerApi.UserApi* | [**updateUser**](docs/UserApi.md#updateUser) | **PUT** /users/profile | *PassAppSwaggerApi.UserApi* | [**uploadImage**](docs/UserApi.md#uploadImage) | **PUT** /users/image/upload | *PassAppSwaggerApi.UserApi* | [**userAddress**](docs/UserApi.md#userAddress) | **PUT** /users/address | *PassAppSwaggerApi.UserActivityApi* | [**getActivityListForUser**](docs/UserActivityApi.md#getActivityListForUser) | **GET** /users/activity/details | *PassAppSwaggerApi.UserActivityApi* | [**getOneActivityForUser**](docs/UserActivityApi.md#getOneActivityForUser) | **GET** /users/activity/details/{id} | *PassAppSwaggerApi.UserActivityApi* | [**userCheckIn**](docs/UserActivityApi.md#userCheckIn) | **PUT** /users/activity/check/in | *PassAppSwaggerApi.UserActivityApi* | [**userCheckOut**](docs/UserActivityApi.md#userCheckOut) | **PUT** /users/activity/check/out | ## Documentation for Models - [PassAppSwaggerApi.Activity](docs/Activity.md) - [PassAppSwaggerApi.ActivityResult](docs/ActivityResult.md) - [PassAppSwaggerApi.Address](docs/Address.md) - [PassAppSwaggerApi.Body](docs/Body.md) - [PassAppSwaggerApi.CommonError](docs/CommonError.md) - [PassAppSwaggerApi.CommonSuccess](docs/CommonSuccess.md) - [PassAppSwaggerApi.Company](docs/Company.md) - [PassAppSwaggerApi.Employee](docs/Employee.md) - [PassAppSwaggerApi.EmployeeResult](docs/EmployeeResult.md) - [PassAppSwaggerApi.ImageResult](docs/ImageResult.md) - [PassAppSwaggerApi.LocationModel](docs/LocationModel.md) - [PassAppSwaggerApi.LoginModel](docs/LoginModel.md) - [PassAppSwaggerApi.Relation](docs/Relation.md) - [PassAppSwaggerApi.User](docs/User.md) ## Documentation for Authorization ### api_key - **Type**: API key - **API key parameter name**: authorization - **Location**: HTTP header