my_api_v1 v1.1.7
my_api_v1
MyApiV1 - JavaScript client for my_api_v1 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: v1
- Package version: v1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/Secret0-OchkA
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 my_api_v1 --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 my_api_v1 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 MyApiV1 = require('my_api_v1');
var api = new MyApiV1.BugetPlanApi()
var companyId = 56; // {Number}
var departmnetId = 56; // {Number}
var opts = {
'bugetPlanView': new MyApiV1.BugetPlanView() // {BugetPlanView}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.createBugetPlan(companyId, departmnetId, opts, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
MyApiV1.BugetPlanApi | createBugetPlan | POST /api/Company/{companyId}/Department/{departmnetId}/BugetPlan | можно создать только 1 на департамент |
MyApiV1.BugetPlanApi | deletBugetPlan | DELETE /api/Company/{companyId}/Department/{departmnetId}/BugetPlan/{bugetPlanId} | delet bugetplan |
MyApiV1.BugetPlanApi | getBugetPlan | GET /api/Company/{companyId}/Department/{departmnetId}/BugetPlan | get buget plan by department |
MyApiV1.BugetPlanApi | getBugetPlanById | GET /api/Company/{companyId}/Department/{departmnetId}/BugetPlan/{bugetPlanId} | get buget plan |
MyApiV1.BugetPlanApi | setMonthBuget | PUT /api/Company/{companyId}/Department/{departmnetId}/BugetPlan/{bugetPlanId}/SetMonthBuget | |
MyApiV1.BugetPlanApi | updateBugetPlan | PUT /api/Company/{companyId}/Department/{departmnetId}/BugetPlan/{bugetPlanId} | |
MyApiV1.CompanyApi | changeName | PUT /api/Company/{id}/{name} | change name company by id |
MyApiV1.CompanyApi | createCompany | POST /api/Company | create company from object |
MyApiV1.CompanyApi | deletCompany | DELETE /api/Company/{id} | Delete company by id |
MyApiV1.CompanyApi | getCompany | GET /api/Company/{id} | get company by id |
MyApiV1.CompanyApi | getCompanyes | GET /api/Company | get all company |
MyApiV1.DepartmentApi | createDepartment | POST /api/Company/{companyId}/Department | create department in company |
MyApiV1.DepartmentApi | deleteDepartment | DELETE /api/Company/{companyId}/Department | Delete department in company |
MyApiV1.DepartmentApi | getDepartment | GET /api/Company/{companyId}/Department/{departmnetId} | get department by id in company |
MyApiV1.DepartmentApi | getDepartments | GET /api/Company/{companyId}/Department | get departments in company |
MyApiV1.DepartmentApi | setBugetDeparmtnet | PUT /api/Company/{companyId}/Department/{departmnetId} | set buget department by id in company |
MyApiV1.EmployeeApi | createEmployee | POST /api/Employee | |
MyApiV1.EmployeeApi | deleteEmployee | DELETE /api/Employee/{id} | |
MyApiV1.EmployeeApi | getEmployee | GET /api/Employee/{id} | |
MyApiV1.EmployeeApi | getEmployees | GET /api/Employee | |
MyApiV1.EmployeeFromDepartmentApi | dismissEmployee | DELETE /api/Company/{companyId}/Department/{departmnetId}/EmployeeFromDepartment/{employeeId} | remove employee from department in company |
MyApiV1.EmployeeFromDepartmentApi | getEmployeeInDepartment | GET /api/Company/{companyId}/Department/{departmnetId}/EmployeeFromDepartment/{employeeId} | get employee in department in company by id |
MyApiV1.EmployeeFromDepartmentApi | getEmployeesInDepartment | GET /api/Company/{companyId}/Department/{departmnetId}/EmployeeFromDepartment | get employees in department in company |
MyApiV1.EmployeeFromDepartmentApi | hireEmployee | POST /api/Company/{companyId}/Department/{departmnetId}/EmployeeFromDepartment/{employeeId} | add epmployee to department |
MyApiV1.ExpenseFromDepartmentApi | getExpenseInDeparment | GET /api/Company/{companyId}/ExpenseFromDepartment/department/{departmnetId}/{expenseId} | get expense in department by id |
MyApiV1.ExpenseFromDepartmentApi | getExpesesInCompany | GET /api/Company/{companyId}/ExpenseFromDepartment | get expenses in company |
MyApiV1.ExpenseFromDepartmentApi | getExpesesInDepartment | GET /api/Company/{companyId}/ExpenseFromDepartment/department/{departmnetId} | get expenses in department |
MyApiV1.ExpenseFromEmployeeApi | changeAmmount | PUT /api/Employee/{employeeId}/ExpenseFromEmployee/{expenseId}/ChangeAmmount | Change ammout if not confirmed |
MyApiV1.ExpenseFromEmployeeApi | confirmExpense | PUT /api/Employee/{employeeId}/ExpenseFromEmployee/{expenseId}/Confirm | confirm expense if expense is valid |
MyApiV1.ExpenseFromEmployeeApi | createExpense | POST /api/Employee/{employeeId}/ExpenseFromEmployee | create expense for employee |
MyApiV1.ExpenseFromEmployeeApi | deleteExpense | DELETE /api/Employee/{employeeId}/ExpenseFromEmployee/{id} | Delete expense |
MyApiV1.ExpenseFromEmployeeApi | getExpense | GET /api/Employee/{employeeId}/ExpenseFromEmployee/{expenseId} | get expense in employee |
MyApiV1.ExpenseFromEmployeeApi | getExpenses | GET /api/Employee/{employeeId}/ExpenseFromEmployee | get expenses in emploee |
MyApiV1.ExpenseFromEmployeeApi | setExpenseType | PUT /api/Employee/{employeeId}/ExpenseFromEmployee/{expenseId}/SetType/{expenseTypeId} | change type if not confirmed |
MyApiV1.ExpenseFromEmployeeApi | validateEpxense | PUT /api/Employee/{employeeId}/ExpenseFromEmployee/{expenseId}/Validate | validate expense |
MyApiV1.ExpenseTypeApi | createExpenseTypeInCompany | POST /api/Company/{companyId}/ExpenseType | create new expenseType in company |
MyApiV1.ExpenseTypeApi | deleteExpenseTypeInCompany | DELETE /api/Company/{companyId}/ExpenseType/{expenseTypeId} | delete expense type in company |
MyApiV1.ExpenseTypeApi | getEpxensTypesInCompany | GET /api/Company/{companyId}/ExpenseType | get expense types in company |
MyApiV1.ExpenseTypeApi | getExpenseTypeInCompany | GET /api/Company/{companyId}/ExpenseType/{expenseTypeId} | get expense type in company by id |
MyApiV1.ExpenseTypeApi | updateExpenseType | PUT /api/Company/{companyId}/ExpenseType/{expenseTypeId} | can change name,limit, description |
MyApiV1.OkApi | checkConnectToApi | GET /api/Ok | for check connect |
Documentation for Models
- MyApiV1.BugetPlanView
- MyApiV1.CompanyView
- MyApiV1.DepartmentView
- MyApiV1.EmployeeView
- MyApiV1.ExpenseTypeView
- MyApiV1.ExpenseView
- MyApiV1.Month
Documentation for Authorization
All endpoints do not require authorization.