1.3.1-RC.1 • Published 4 years ago

cloud_api_financial_operations v1.3.1-RC.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
4 years ago

cloud_api_financial_operations

CloudApiFinancialOperations - JavaScript client for cloud_api_financial_operations No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.3.1-RC.1
  • Package version: 1.3.1-RC.1
  • Build package: org.openapitools.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 cloud_api_financial_operations --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your cloud_api_financial_operations from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 CloudApiFinancialOperations = require('cloud_api_financial_operations');

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
CloudApiFinancialOperations.ApiClientInitializationApiinitializeApiClientGET /initializeValidates API key use by merchant and in successful validation delivers the pusher client configuration. Roles allowed: Partner, Merchant and Device
CloudApiFinancialOperations.TransactionsApicreateOperationPOST /transactionsPOST used to perform a certain financial operation defined in \"type\" tag in the request body

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: ApiKeyCloud
  • Location: HTTP header
1.3.1-RC.1

4 years ago

1.0.0

5 years ago