api-swagger-js

my_api

MyApi - JavaScript client for my_api Documentation automatically generated by the swagger-autogen module. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.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 my_api --save

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

Finally, switch to the directory you want to use your my_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('my_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/my_api then install it via:

    npm install YOUR_USERNAME/my_api --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, that's to say your javascript file where you actually use this library):

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 MyApi = require('my_api');

var api = new MyApi.ClienteApi()

var cuit = "cuit_example"; // {String} cuit de la empresa.


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

Documentation for API Endpoints

All URIs are relative to http://localhost:8081

Class	Method	HTTP request	Description
MyApi.ClienteApi	clienteCuitGet	GET /cliente/{cuit}
MyApi.ClienteApi	clienteGet	GET /cliente/
MyApi.ClienteApi	clientePost	POST /cliente/
MyApi.EmpleadoApi	empleadoUsuarioGet	GET /empleado/usuario
MyApi.EstadoApi	estadoIdGet	GET /estado/{id}
MyApi.EstadoApi	estadoPut	PUT /estado/
MyApi.EstadoApi	estadoTipoEstadoGet	GET /estado/tipoEstado
MyApi.OperarioApi	operarioGet	GET /operario/
MyApi.OperarioApi	operarioIdGet	GET /operario/{id}
MyApi.OperarioApi	operarioOperarioSectorNombreSectorGet	GET /operario/operarioSector/{nombreSector}
MyApi.OrdenApi	ordenCrearOrdenProduccionPost	POST /orden/crearOrdenProduccion
MyApi.OrdenApi	ordenGet	GET /orden/
MyApi.OrdenApi	ordenIdGet	GET /orden/{id}
MyApi.OrdenApi	ordenIdPatch	PATCH /orden/{id}
MyApi.OtiApi	otiActualizarOrdenPut	PUT /oti/actualizarOrden
MyApi.OtiApi	otiDatosBasicosPost	POST /oti/datosBasicos
MyApi.OtiApi	otiGet	GET /oti/
MyApi.OtiApi	otiIdGet	GET /oti/{id}
MyApi.OtiApi	otiObtenerOrdenesFechaGet	GET /oti/obtenerOrdenes/{fecha}
MyApi.OtiApi	otiObtenerRoscasIdOrdenGet	GET /oti/obtenerRoscas/{idOrden}
MyApi.OtiApi	otiSectoresGet	GET /oti/sectores
MyApi.OtiApi	otiSectoresYTareasPut	PUT /oti/sectoresYTareas
MyApi.RoscaApi	roscaGet	GET /rosca/
MyApi.RoscaApi	roscaIdGet	GET /rosca/{id}
MyApi.RoscaApi	roscaPost	POST /rosca/
MyApi.RoscaApi	roscaTipoDeRoscaGet	GET /rosca/tipoDeRosca
MyApi.SectorApi	sectorGet	GET /sector/
MyApi.SectorApi	sectorNombreGet	GET /sector/{nombre}
MyApi.SupervisorApi	supervisorGet	GET /supervisor/
MyApi.SupervisorApi	supervisorIdGet	GET /supervisor/{id}
MyApi.TareaApi	tareaAsignarTareaPost	POST /tarea/asignarTarea
MyApi.TareaApi	tareaObtenerOtisNombreGet	GET /tarea/obtenerOtis/{nombre}
MyApi.TareaApi	tareaObtenerTareasIdGet	GET /tarea/obtenerTareas/{id}

Documentation for Models

• MyApi.ArrayOti
• MyApi.ArrayRoscas
• MyApi.ArraySector
• MyApi.ArraySupervisores
• MyApi.ArrayTipoDeRosca
• MyApi.AsignarTarea
• MyApi.CambioEstado
• MyApi.Cliente
• MyApi.Clientes
• MyApi.Empleado
• MyApi.Estados
• MyApi.Operario
• MyApi.Operarios
• MyApi.Orden
• MyApi.Ordenes
• MyApi.Oti
• MyApi.Rosca
• MyApi.Sector
• MyApi.Supervisor
• MyApi.Tarea
• MyApi.Tareas

Documentation for Authorization

api_key

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

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: https://petstore.swagger.io/oauth/authorize
• Scopes:
  • read_pets: read your pets
  • write_pets: modify pets in your account