1.0.1 • Published 6 years ago

namanyahillarysample v1.0.1

Weekly downloads
3
License
ISC
Repository
github
Last release
6 years ago

node_swagger_api

NodeSwaggerApi - JavaScript client for node_swagger_api RESTful API 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 node_swagger_api --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 node_swagger_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('node_swagger_api') 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/YOUR_USERNAME/node_swagger_api then install it via:

    npm install YOUR_USERNAME/node_swagger_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, 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 NodeSwaggerApi = require('node_swagger_api');

var defaultClient = NodeSwaggerApi.ApiClient.instance;

// Configure API key authorization: x-access-token
var x-access-token = defaultClient.authentications['x-access-token'];
x-access-token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-access-token.apiKeyPrefix['x-access-token'] = "Token"

var api = new NodeSwaggerApi.CurrenciesApi()

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

Documentation for API Endpoints

All URIs are relative to https://localhost:8082/api

ClassMethodHTTP requestDescription
NodeSwaggerApi.CurrenciesApicurrenciesListGetGET /currencies/list
NodeSwaggerApi.CustomersApicustomersLoginPostPOST /customers/login
NodeSwaggerApi.CustomersApicustomersRegisterPostPOST /customers/register
NodeSwaggerApi.CustomersApicustomersResetPasswordPostPOST /customers/reset-password
NodeSwaggerApi.CustomersApicustomersSendVerificationCodePostPOST /customers/send-verification-code
NodeSwaggerApi.CustomersApicustomersVerifyPhonePostPOST /customers/verify-phone
NodeSwaggerApi.WalletsApiwalletsCreatePostPOST /wallets/create
NodeSwaggerApi.WalletsApiwalletsListGetGET /wallets/list
NodeSwaggerApi.WalletsApiwalletsPaymentOptionsGetGET /wallets/payment-options
NodeSwaggerApi.WalletsApiwalletsPayoutOptionsGetGET /wallets/payout-options
NodeSwaggerApi.WalletsApiwalletsPayoutPostPOST /wallets/payout
NodeSwaggerApi.WalletsApiwalletsTopupPostPOST /wallets/topup
NodeSwaggerApi.WalletsApiwalletsTransactionsGetGET /wallets/transactions

Documentation for Models

Documentation for Authorization

x-access-token

  • Type: API key
  • API key parameter name: x-access-token
  • Location: HTTP header
1.0.1

6 years ago

1.0.0

6 years ago