@andrefra96/rca_api v1.0.1

rca_api

RcaApi - JavaScript client for rca_api API Per la gestione del database Rca SRL This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.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 rca_api --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 rca_api 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/YOUR_USERNAME/rca_api then install it via:

    npm install YOUR_USERNAME/rca_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):

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 RcaApi = require('rca_api');

var defaultClient = RcaApi.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new RcaApi.ArticleChangeApi()
var articleChange = new RcaApi.ArticleChange(); // {ArticleChange} articleChange da aggiungere
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addArticleChange(articleChange, callback);

Documentation for API Endpoints

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

Documentation for Models

• RcaApi.ArticleChange
• RcaApi.ArticleParent
• RcaApi.ArticlePrice
• RcaApi.Articolo
• RcaApi.ArticoloMensile
• RcaApi.ArticoloOrdine
• RcaApi.ArticoloRinnovo
• RcaApi.Attivazione
• RcaApi.Attributes
• RcaApi.Cliente
• RcaApi.Contatto
• RcaApi.Gruppo
• RcaApi.InlineResponse201
• RcaApi.ItemHasAttivazione
• RcaApi.ItemHasMatricola
• RcaApi.Locale
• RcaApi.MacroTipoArticolo
• RcaApi.Matricola
• RcaApi.Mensile
• RcaApi.OrderListConfiguration
• RcaApi.Ordine
• RcaApi.Prezzo
• RcaApi.ProfiloContatto
• RcaApi.ProfiloLocale
• RcaApi.Reparto
• RcaApi.Rinnovo
• RcaApi.SelectOptions
• RcaApi.SelectOptionsOptions
• RcaApi.Stato
• RcaApi.StatusStart
• RcaApi.TipoArticolo
• RcaApi.TipoFatturazione
• RcaApi.TipoGruppo
• RcaApi.TipoOrdine
• RcaApi.Utente

Documentation for Authorization

BearerAuth

• Type: Bearer authentication (JWT)