0.0.9 • Published 5 years ago

@peregrinadev/core-mobile v0.0.9

Weekly downloads
1
License
Unlicense
Repository
-
Last release
5 years ago

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

ClassMethodHTTP requestDescription
MyTitle.CustomersApicustomersGetByIdGET /api/Customers/{Id}Get customer by key
MyTitle.DocumentsApidocumentsGetGET /api/Documents/{entity}/{entityId}pega o último documento da entidade
MyTitle.DocumentsApidocumentsPostPOST /api/Documents/{entity}/{entityId}adiciona um documento à entidade
MyTitle.DocumentsApidocumentsQueryPOST /api/Documents/query/{entity}/{entityId}
MyTitle.HealthApihealthDeleteDELETE /api/Healthdo nothing, just answer OK with NOW
MyTitle.HealthApihealthGetGET /api/Healthdo nothing, just answer OK with NOW
MyTitle.HealthApihealthHeadHEAD /api/Healthdo nothing, just answer OK with NOW
MyTitle.HealthApihealthOptionsOPTIONS /api/Healthdo nothing, just answer OK with NOW
MyTitle.HealthApihealthPatchPATCH /api/Healthdo nothing, just answer OK with NOW
MyTitle.HealthApihealthPostPOST /api/Healthdo nothing, just answer OK with NOW
MyTitle.HealthApihealthPutPUT /api/Healthdo nothing, just answer OK with NOW
MyTitle.HistoriesApihistoriesGetHistoriesByIdGET /api/Histories/{entity}/{entityId}Get histories by id
MyTitle.HistoriesApihistoriesHistoryAddPOST /api/Histories/{entity}/{entityId}/itenscreates a new History Item
MyTitle.HistoriesApihistoriesHistoryCreatePOST /api/Histories/{entity}/{entityId}creates a new History collection
MyTitle.PersonsApipersonsGetAuthIdPersonAggregateGET /api/Persons/{ownerAuthId}/aggregatesAuthIdNever using
MyTitle.PersonsApipersonsGetPersonAggregateGET /api/Persons/{ownerAuthId}/aggregatesGet person Aggregate by owner AuthId
MyTitle.PersonsApipersonsGetPersonByAuthIdGET /api/Persons/auth/{authId}Get Person by authId
MyTitle.PersonsApipersonsGetPersonByIdGET /api/Persons/{personId}Get Person by Id
MyTitle.PersonsApipersonsPostPersonPOST /api/Personscrerates a new Person
MyTitle.PersonsApipersonsPostPersonAggregatePOST /api/Persons/aggregatecrerates a new PersonAggregate
MyTitle.ProposalsApiproposalsGetAllProposalsBySaleIdGET /api/Proposals/sale/{saleId}Get all proposalsby saleId
MyTitle.ProposalsApiproposalsPutProposalPUT /api/Proposals/{proposalId}Get all proposalsby saleId
MyTitle.SalesApisalesDeleteSaleOptionItemDELETE /api/Sales/{saleId}/option/{saleOptionId}/item/{saleOptionItemId}Delete OptionItem from SaleOptions
MyTitle.SalesApisalesGetAllSalesGET /api/SalesGet all sales
MyTitle.SalesApisalesGetAllSalesByAttendantGET /api/Sales/attendant/{attendantId}Get all sales for attendant id
MyTitle.SalesApisalesGetAllSalesBySalesmanGET /api/Sales/salesman/{salesmanId}Get all sales for salesman id
MyTitle.SalesApisalesGetAllSalesPanelGET /api/Sales/panelGet all sales
MyTitle.SalesApisalesGetByIdGET /api/Sales/{id}Get all sales by id
MyTitle.SalesApisalesGetSaleOptionsGET /api/Sales/{saleId}/optionsGet all salesOptions by saleId
MyTitle.SalesApisalesPatchChosenSaleOptionPATCH /api/Sales/{saleId}/option/{saleOptionId}/chosenupdate chosen SaleOption for Proposal
MyTitle.SalesApisalesPatchResetChosenSaleOptionPATCH /api/Sales/{saleId}/option/resetupdate chosen SaleOption for Proposal
MyTitle.SalesApisalesPatchSaleOptionItemPATCH /api/Sales/{saleId}/option/{saleOptionId}/item/{saleOptionItemId}Inative OptionItem from SaleOptions
MyTitle.SalesApisalesPatchSaleStatusPATCH /api/Sales/{saleId}/status/{status}update
MyTitle.SalesApisalesPostPOST /api/Salescrerates a new Sale
MyTitle.SalesApisalesPostNewOptionPOST /api/Sales/{saleId}/optioncrerates a new SaleOption
MyTitle.SalesApisalesPostNewOptionItemPOST /api/Sales/{saleId}/option/{optionId}crerates a new SaleOptionItems
MyTitle.SalesApisalesPutPUT /api/Sales/{id}change the Sale

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

0.0.9

5 years ago

0.0.7

6 years ago

0.0.6

6 years ago

0.0.5

6 years ago

0.0.4

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago