0.0.2 • Published 4 years ago

paymentsapi v0.0.2

Weekly downloads
1
License
Apache 2.0
Repository
-
Last release
4 years ago

paymentsapi

Paymentsapi - JavaScript client for paymentsapi Payment API help to integrate the payment methods. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.1
  • Package version: 0.0.1
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://xyz.com

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 paymentsapi --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 paymentsapi from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('paymentsapi') 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 Paymentsapi = require('paymentsapi');

var api = new Paymentsapi.PaymentsApi()

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

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
Paymentsapi.PaymentsApigetAllPaymentMethodsGET /methodsReturns all the available Payment methods.
Paymentsapi.PaymentsApigetAvailablePaymentMethodsByCountriesGET /methods/countries/{countryId}/Retrieves Available Payment by country
Paymentsapi.PaymentsApigetPaymentMethodsByRegionGET /methods/region/{regionName}Retrieves Available Payment by region

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.