@peregrinadev/core-mobile v0.0.9
my_title
MyTitle - JavaScript client for my_title No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) 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_title --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_title from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('my_title')
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/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, 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 MyTitle = require('my_title');
var api = new MyTitle.CustomersApi()
var id = 789; // {Number} customer Id
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.customersGetById(id, callback);
Documentation for API Endpoints
All URIs are relative to https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
MyTitle.CustomersApi | customersGetById | GET /api/Customers/{Id} | Get customer by key |
MyTitle.DocumentsApi | documentsGet | GET /api/Documents/{entity}/{entityId} | pega o último documento da entidade |
MyTitle.DocumentsApi | documentsPost | POST /api/Documents/{entity}/{entityId} | adiciona um documento à entidade |
MyTitle.DocumentsApi | documentsQuery | POST /api/Documents/query/{entity}/{entityId} | |
MyTitle.HealthApi | healthDelete | DELETE /api/Health | do nothing, just answer OK with NOW |
MyTitle.HealthApi | healthGet | GET /api/Health | do nothing, just answer OK with NOW |
MyTitle.HealthApi | healthHead | HEAD /api/Health | do nothing, just answer OK with NOW |
MyTitle.HealthApi | healthOptions | OPTIONS /api/Health | do nothing, just answer OK with NOW |
MyTitle.HealthApi | healthPatch | PATCH /api/Health | do nothing, just answer OK with NOW |
MyTitle.HealthApi | healthPost | POST /api/Health | do nothing, just answer OK with NOW |
MyTitle.HealthApi | healthPut | PUT /api/Health | do nothing, just answer OK with NOW |
MyTitle.HistoriesApi | historiesGetHistoriesById | GET /api/Histories/{entity}/{entityId} | Get histories by id |
MyTitle.HistoriesApi | historiesHistoryAdd | POST /api/Histories/{entity}/{entityId}/itens | creates a new History Item |
MyTitle.HistoriesApi | historiesHistoryCreate | POST /api/Histories/{entity}/{entityId} | creates a new History collection |
MyTitle.PersonsApi | personsGetAuthIdPersonAggregate | GET /api/Persons/{ownerAuthId}/aggregatesAuthId | Never using |
MyTitle.PersonsApi | personsGetPersonAggregate | GET /api/Persons/{ownerAuthId}/aggregates | Get person Aggregate by owner AuthId |
MyTitle.PersonsApi | personsGetPersonByAuthId | GET /api/Persons/auth/{authId} | Get Person by authId |
MyTitle.PersonsApi | personsGetPersonById | GET /api/Persons/{personId} | Get Person by Id |
MyTitle.PersonsApi | personsPostPerson | POST /api/Persons | crerates a new Person |
MyTitle.PersonsApi | personsPostPersonAggregate | POST /api/Persons/aggregate | crerates a new PersonAggregate |
MyTitle.ProposalsApi | proposalsGetAllProposalsBySaleId | GET /api/Proposals/sale/{saleId} | Get all proposalsby saleId |
MyTitle.ProposalsApi | proposalsPutProposal | PUT /api/Proposals/{proposalId} | Get all proposalsby saleId |
MyTitle.SalesApi | salesDeleteSaleOptionItem | DELETE /api/Sales/{saleId}/option/{saleOptionId}/item/{saleOptionItemId} | Delete OptionItem from SaleOptions |
MyTitle.SalesApi | salesGetAllSales | GET /api/Sales | Get all sales |
MyTitle.SalesApi | salesGetAllSalesByAttendant | GET /api/Sales/attendant/{attendantId} | Get all sales for attendant id |
MyTitle.SalesApi | salesGetAllSalesBySalesman | GET /api/Sales/salesman/{salesmanId} | Get all sales for salesman id |
MyTitle.SalesApi | salesGetAllSalesPanel | GET /api/Sales/panel | Get all sales |
MyTitle.SalesApi | salesGetById | GET /api/Sales/{id} | Get all sales by id |
MyTitle.SalesApi | salesGetSaleOptions | GET /api/Sales/{saleId}/options | Get all salesOptions by saleId |
MyTitle.SalesApi | salesPatchChosenSaleOption | PATCH /api/Sales/{saleId}/option/{saleOptionId}/chosen | update chosen SaleOption for Proposal |
MyTitle.SalesApi | salesPatchResetChosenSaleOption | PATCH /api/Sales/{saleId}/option/reset | update chosen SaleOption for Proposal |
MyTitle.SalesApi | salesPatchSaleOptionItem | PATCH /api/Sales/{saleId}/option/{saleOptionId}/item/{saleOptionItemId} | Inative OptionItem from SaleOptions |
MyTitle.SalesApi | salesPatchSaleStatus | PATCH /api/Sales/{saleId}/status/{status} | update |
MyTitle.SalesApi | salesPost | POST /api/Sales | crerates a new Sale |
MyTitle.SalesApi | salesPostNewOption | POST /api/Sales/{saleId}/option | crerates a new SaleOption |
MyTitle.SalesApi | salesPostNewOptionItem | POST /api/Sales/{saleId}/option/{optionId} | crerates a new SaleOptionItems |
MyTitle.SalesApi | salesPut | PUT /api/Sales/{id} | change the Sale |
Documentation for Models
- MyTitle.Customer
- MyTitle.CustomerPhone
- MyTitle.DocumentsType
- MyTitle.HistoryEntityType
- MyTitle.HistoryItem
- MyTitle.HistoryOperation
- MyTitle.HistoryType
- MyTitle.Person
- MyTitle.PersonAggregate
- MyTitle.Proposal
- MyTitle.ProposalStatus
- MyTitle.ReturnMessageModel
- MyTitle.Sale
- MyTitle.SaleCardPanelModel
- MyTitle.SaleDocuments
- MyTitle.SaleOption
- MyTitle.SaleOptionEntity
- MyTitle.SaleOptionItems
- MyTitle.SaleStatus
- MyTitle.UsersModel
Documentation for Authorization
All endpoints do not require authorization.