operations_app

OperationsApp - JavaScript client for operations_app Operations app is a secure, multi-tenanted microservice platform This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.6.0
• 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 operations_app --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 operations_app 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 OperationsApp = require('operations_app');

var defaultClient = OperationsApp.ApiClient.instance;
// Configure Bearer access token for authorization: auth
var auth = defaultClient.authentications['auth'];
auth.accessToken = "YOUR ACCESS TOKEN"

var api = new OperationsApp.BatchApiApi()
var batchId = "batchId_example"; // {String} 
var platformTenantId = "platformTenantId_example"; // {String} Tenant Id
var opts = {
  'requestId': "requestId_example", // {String} 
  'command': "'aggregate'" // {String} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.batchAggregation(batchId, platformTenantId, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://ops-bk.sandbox.fynarfin.io

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- OperationsApp.BatchApiApi | batchAggregation | GET /api/v1/batch/{batchId} | OperationsApp.BatchApiApi | batchDetails | GET /api/v1/batch | OperationsApp.BatchApiApi | batchDetails1 | GET /api/v1/batch/detail | OperationsApp.BatchApiApi | batchTransactionDetails | GET /api/v1/batch/transactions | OperationsApp.BatchApiApi | getBatch | GET /api/v1/batches | OperationsApp.BatchApiApi | getBatchAndSubBatchSummary | GET /api/v1/batches/{batchId} | OperationsApp.BatchApiApi | getSubBatchPaymentDetail | GET /api/v1/batches/{batchId}/subBatches/{subBatchId} | OperationsApp.BeneficiaryApiApi | create5 | POST /api/v1/beneficiary | OperationsApp.BeneficiaryApiApi | delete4 | DELETE /api/v1/beneficiary/{custIdentifier}/{identifier} | OperationsApp.BeneficiaryApiApi | getAllForCustomer | GET /api/v1/beneficiary/{custIdentifier} | OperationsApp.ErrorCodesCrudApiApi | addErrorCode | POST /api/v1/errorcode/ | OperationsApp.ErrorCodesCrudApiApi | deleteErrorCode | DELETE /api/v1/errorcode/{id} | OperationsApp.ErrorCodesCrudApiApi | getAllErrorCode | GET /api/v1/errorcode/ | OperationsApp.ErrorCodesCrudApiApi | getErrorCodeByFilter | GET /api/v1/errorcode/filter | OperationsApp.ErrorCodesCrudApiApi | getSpecificErrorCode | GET /api/v1/errorcode/{id} | OperationsApp.ErrorCodesCrudApiApi | updateErrorCode | PUT /api/v1/errorcode/{id} | OperationsApp.ImuConversionApiApi | create3 | POST /api/v1/imuexchange/preview | OperationsApp.ImuConversionApiApi | create4 | POST /api/v1/imuexchange/master | OperationsApp.ImuConversionApiApi | delete3 | DELETE /api/v1/imuexchange/master | OperationsApp.OperationsApiApi | refundTransfer | POST /api/v1/transfer/{transactionId}/refund | OperationsApp.OperationsApiApi | tasks | GET /api/v1/tasks | OperationsApp.OperationsApiApi | transactionRequestDetails | GET /api/v1/transactionRequest/{workflowInstanceKey} | OperationsApp.OperationsApiApi | transferDetails | GET /api/v1/transfer/{workflowInstanceKey} | OperationsApp.OperationsApiApi | variables | GET /api/v1/variables | OperationsApp.OperationsApiApi | variablesList | GET /api/v1/variables/{transactionId} | OperationsApp.OperationsDetailedAPIApi | filterTransactionRequests | POST /api/v1/transactionRequests | OperationsApp.OperationsDetailedAPIApi | transactionRequests | GET /api/v1/transactionRequests | OperationsApp.OperationsDetailedAPIApi | transfers | GET /api/v1/transfers | OperationsApp.OperationsDetailedAPIApi | transfersStatusCheck | POST /api/v1/transfers | OperationsApp.PermissionsApiApi | create2 | POST /api/v1/permission | OperationsApp.PermissionsApiApi | delete2 | DELETE /api/v1/permission/{permissionId} | OperationsApp.PermissionsApiApi | retrieveAll2 | GET /api/v1/permissions | OperationsApp.PermissionsApiApi | retrieveOne2 | GET /api/v1/permission/{permissionId} | OperationsApp.PermissionsApiApi | update2 | PUT /api/v1/permission/{permissionId} | OperationsApp.RolesApiApi | create1 | POST /api/v1/role | OperationsApp.RolesApiApi | delete1 | DELETE /api/v1/role/{roleId} | OperationsApp.RolesApiApi | permissionAssignment | PUT /api/v1/role/{roleId}/permissions | OperationsApp.RolesApiApi | retrieveAll1 | GET /api/v1/roles | OperationsApp.RolesApiApi | retrieveOne1 | GET /api/v1/role/{roleId} | OperationsApp.RolesApiApi | retrievePermissions | GET /api/v1/role/{roleId}/permissions | OperationsApp.RolesApiApi | update1 | PUT /api/v1/role/{roleId} | OperationsApp.UsersAPIApi | callDelete | DELETE /api/v1/user/{userId} | OperationsApp.UsersAPIApi | create | POST /api/v1/user | OperationsApp.UsersAPIApi | getXSignature | POST /api/v1/util/x-signature | OperationsApp.UsersAPIApi | retrieveAll | GET /api/v1/users | OperationsApp.UsersAPIApi | retrieveOne | GET /api/v1/user/{userId} | OperationsApp.UsersAPIApi | retrieveRoles | GET /api/v1/user/{userId}/roles | OperationsApp.UsersAPIApi | update | PUT /api/v1/user/{userId} | OperationsApp.UsersAPIApi | userAssignment | PUT /api/v1/user/{userId}/roles |

Documentation for Models

• OperationsApp.AppUser
• OperationsApp.Batch
• OperationsApp.BatchPaginatedResponse
• OperationsApp.Beneficiary
• OperationsApp.EntityAssignments
• OperationsApp.ErrorCode
• OperationsApp.ErrorParameter
• OperationsApp.GetXSignatureRequest
• OperationsApp.IMUConversionData
• OperationsApp.PageTransactionRequest
• OperationsApp.PageTransfer
• OperationsApp.PageTransferResponse
• OperationsApp.PageableObject
• OperationsApp.Permission
• OperationsApp.PhErrorDTO
• OperationsApp.Role
• OperationsApp.SortObject
• OperationsApp.Task
• OperationsApp.TransactionRequest
• OperationsApp.TransactionRequestDetail
• OperationsApp.Transfer
• OperationsApp.TransferDetail
• OperationsApp.TransferResponse
• OperationsApp.Variable

Documentation for Authorization

Authentication schemes defined for the API:

auth

• Type: Bearer authentication