Tpaycom_technical_documentation NPM

1.1.2 • Published 7 years ago

Install

Weekly downloads

License

Unlicense

Repository

Last release

7 years ago

tpaycom_technical_documentation

TpaycomTechnicalDocumentation - JavaScript client for tpaycom_technical_documentation

API version: 1.1.2
Package version: 1.1.2
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 tpaycom_technical_documentation --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 tpaycom_technical_documentation from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

    npm install YOUR_USERNAME/tpaycom_technical_documentation --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 TpaycomTechnicalDocumentation = require('tpaycom_technical_documentation');

var api = new TpaycomTechnicalDocumentation.CardsAPIApi()

var apiKey = "apiKey_example"; // {String} The api key.

var opts = { 
  'basicData': new TpaycomTechnicalDocumentation.CheckFields() // {CheckFields} check method data
};

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

Documentation for API Endpoints

All URIs are relative to https://secure.tpay.com

Class	Method	HTTP request	Description
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeyCheckPost	POST /api/cards/{api_key}/check	check
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeyDeregisterPost	POST /api/cards/{api_key}/deregister	deregister
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeyPresalePost	POST /api/cards/{api_key}/presale	presale
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeyRefundPost	POST /api/cards/{api_key}/refund	refund
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeyRegisterSalePost	POST /api/cards/{api_key}/register_sale	register sale
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeySalePost	POST /api/cards/{api_key}/sale	sale
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeySecuresalePost	POST /api/cards/{api_key}/securesale	secure sale
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeyVisacheckoutFinishPost	POST /api/cards/{api_key}/visacheckout_finish	visacheckout finish
TpaycomTechnicalDocumentation.CardsAPIApi	apiCardsApiKeyVisacheckoutPreparePost	POST /api/cards/{api_key}/visacheckout_prepare	visacheckout prepare
TpaycomTechnicalDocumentation.MasspaymentsApi	apiGwApiKeyMasspaymentAuthorizePost	POST /api/gw/{api_key}/masspayment/authorize	authorize
TpaycomTechnicalDocumentation.MasspaymentsApi	apiGwApiKeyMasspaymentCreatePost	POST /api/gw/{api_key}/masspayment/create	create
TpaycomTechnicalDocumentation.MasspaymentsApi	apiGwApiKeyMasspaymentPacksPost	POST /api/gw/{api_key}/masspayment/packs	packs
TpaycomTechnicalDocumentation.MasspaymentsApi	apiGwApiKeyMasspaymentTransfersPost	POST /api/gw/{api_key}/masspayment/transfers	transfers
TpaycomTechnicalDocumentation.RegistrationApi	apiGwApiKeyRegistrationInputsPost	POST /api/gw/{api_key}/registration/inputs	inputs
TpaycomTechnicalDocumentation.RegistrationApi	apiGwApiKeyRegistrationRegisterPost	POST /api/gw/{api_key}/registration/register	register
TpaycomTechnicalDocumentation.TransactionAPIApi	apiGwApiKeyChargebackAnyPost	POST /api/gw/{api_key}/chargeback/any	any
TpaycomTechnicalDocumentation.TransactionAPIApi	apiGwApiKeyChargebackStatusPost	POST /api/gw/{api_key}/chargeback/status	status
TpaycomTechnicalDocumentation.TransactionAPIApi	apiGwApiKeyChargebackTransactionPost	POST /api/gw/{api_key}/chargeback/transaction	transaction
TpaycomTechnicalDocumentation.TransactionAPIApi	apiGwApiKeyTransactionBlikPost	POST /api/gw/{api_key}/transaction/blik	blik
TpaycomTechnicalDocumentation.TransactionAPIApi	apiGwApiKeyTransactionCreatePost	POST /api/gw/{api_key}/transaction/create	create
TpaycomTechnicalDocumentation.TransactionAPIApi	apiGwApiKeyTransactionGetPost	POST /api/gw/{api_key}/transaction/get	get
TpaycomTechnicalDocumentation.TransactionAPIApi	apiGwApiKeyTransactionReportPost	POST /api/gw/{api_key}/transaction/report	report

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent

@infinitebrahmanuniverse/nolb-tp @everything-registry/sub-chunk-2963

1.1.2

7 years ago