onarrival-es-client
v0.1.0
Published
OnArrival_API_service_documentation
Downloads
4
Readme
on_arrival_client_api
OnArrivalClientApi - JavaScript client for on_arrival_client_api OnArrival API service documentation This SDK is automatically generated by the Swagger Codegen project:
- API version: v1.0
- Package version: v1.0
- Build package: io.swagger.codegen.v3.generators.javascript.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 on_arrival_client_api --save
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 OnArrivalClientApi = require('on_arrival_client_api');
var defaultClient = OnArrivalClientApi.ApiClient.instance;
var api = new OnArrivalClientApi.AuthorizationApi()
var body = new OnArrivalClientApi.ClientAuthRequest(); // {ClientAuthRequest}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getClientToken(body, callback);
Documentation for API Endpoints
All URIs are relative to http://dev-api.onarriv.io
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- OnArrivalClientApi.AuthorizationApi | getClientToken | POST /api/v1/auth/oauth/token | Get OAuth token to be used with every API transaction. The token expires every 1 day and has to be regenerated using this endpoint. OnArrivalClientApi.DiscoverTravelAncillariesApi | getQuotationByType | POST /api/v1/discover | Discover Ancillaries OnArrivalClientApi.InsuranceApi | createOrder1 | POST /api/v1/insurance/order | Place an order for insurance OnArrivalClientApi.InsuranceApi | getInsuranceQuote | POST /api/v1/insurance/quote | Get Quote for Insurance product OnArrivalClientApi.VisaApi | attachDocumentsToVisaOrder | POST /api/v1/visa/order/document | Attach document to Visa order OnArrivalClientApi.VisaApi | cancelVisaOrder | POST /api/v1/visa/cancel | OnArrivalClientApi.VisaApi | createOrder | POST /api/v1/visa/order | OnArrivalClientApi.VisaApi | createVisaDraftOrder | POST /api/v1/visa/ | Book Visa OnArrivalClientApi.VisaApi | getVisaOrderStatus | GET /api/v1/visa/status | Get visa order status
Documentation for Models
- OnArrivalClientApi.ActionLog
- OnArrivalClientApi.Address
- OnArrivalClientApi.ApplicationResponse
- OnArrivalClientApi.Attachment
- OnArrivalClientApi.BenefitDetail
- OnArrivalClientApi.BookingDetail
- OnArrivalClientApi.ClientAuthRequest
- OnArrivalClientApi.ClientAuthResponse
- OnArrivalClientApi.DateTimeAndTimeZone
- OnArrivalClientApi.DiscoveryRequest
- OnArrivalClientApi.DiscoveryResponse
- OnArrivalClientApi.InsurancePolicy
- OnArrivalClientApi.InsurancePolicyOrderResponse
- OnArrivalClientApi.InsurancePolicyQuoteResponse
- OnArrivalClientApi.InsurancePolicyRequest
- OnArrivalClientApi.Member
- OnArrivalClientApi.MemberCountValue
- OnArrivalClientApi.MemberDAO
- OnArrivalClientApi.MemberDocument
- OnArrivalClientApi.OriginDestination
- OnArrivalClientApi.OriginDestinationCode
- OnArrivalClientApi.Passport
- OnArrivalClientApi.Product
- OnArrivalClientApi.ProductInformation
- OnArrivalClientApi.ProductMeta
- OnArrivalClientApi.QuoteInsurance
- OnArrivalClientApi.RequiredDocument
- OnArrivalClientApi.Tax
- OnArrivalClientApi.TaxDetail
- OnArrivalClientApi.Trip
- OnArrivalClientApi.TripDAO
- OnArrivalClientApi.VisaFileUploadRequest
- OnArrivalClientApi.VisaFileUploadResponse
- OnArrivalClientApi.VisaOrder
- OnArrivalClientApi.VisaProduct
- OnArrivalClientApi.VisaRequest