baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
131 lines (130 loc) • 6.81 kB
JavaScript
"use strict";
/* globals module */
/**
* @module commercePaymentTransactionClient
* @description Commerce PaymentTransaction Client provides an easy way to consume Commerce REST API end-points. In order to obtain a needed routes `commercePaymentTransactionClient` uses `commercePaymentTransactionRoute`.
*/
Object.defineProperty(exports, "__esModule", { value: true });
var tslib_1 = require("tslib");
var inversify_1 = require("inversify");
;
var httpApi_1 = require("../../../httpApi");
var __1 = require("../");
var CommercePaymentTransactionClient = /** @class */ (function () {
function CommercePaymentTransactionClient(commercePaymentTransactionRoute, apiClient) {
this.commercePaymentTransactionRoute = commercePaymentTransactionRoute;
this.apiClient = apiClient;
}
Object.defineProperty(CommercePaymentTransactionClient.prototype, "routeDefinition", {
get: function () {
return this.commercePaymentTransactionRoute;
},
enumerable: true,
configurable: true
});
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of commerce resources matching the given criteria.
* @method
* @example commercePaymentTransactionClient.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>'
})
.then(function (collection) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
CommercePaymentTransactionClient.prototype.find = function (options) {
return this.apiClient.get(this.routeDefinition.find(options));
};
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the commerce resource.
* @method
* @example commercePaymentTransactionClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
CommercePaymentTransactionClient.prototype.get = function (id, options) {
return this.apiClient.get(this.commercePaymentTransactionRoute.get(id, options));
};
/**
* Returns a promise that is resolved once the create action has been performed. Success response returns the commerce resource.
* @method
* @example commercePaymentTransactionClient.create(data)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
CommercePaymentTransactionClient.prototype.create = function (data) {
return this.apiClient.post(this.routeDefinition.create(), this.routeDefinition.createParams(data));
};
/**
* Returns a promise that is resolved once the update commerce action has been performed; this action updates a commerce resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `commercePaymentTransactionRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(commercePaymentTransaction);
* let uri = params['model'].links('put').href;
* ```
* @method
* @example // commercePaymentTransaction is a resource previously fetched using get action.
commercePaymentTransaction.amount : 100;
commercePaymentTransactionClient.update(commercePaymentTransaction)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
CommercePaymentTransactionClient.prototype.update = function (data) {
return this.apiClient.put(this.routeDefinition.update(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove a commerce resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `commercePaymentTransactionRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(commercePaymentTransaction);
* let uri = params['model'].links('delete').href;
* ```
* @method
* @example // commercePaymentTransaction is a resource previously fetched using get action.
commercePaymentTransactionClient.remove(commercePaymentTransaction)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
CommercePaymentTransactionClient.prototype.remove = function (data) {
return this.apiClient.delete(this.routeDefinition.delete(data));
};
CommercePaymentTransactionClient = tslib_1.__decorate([
inversify_1.injectable(),
tslib_1.__param(0, inversify_1.inject(__1.TYPES.CommercePaymentTransactionRoute)),
tslib_1.__param(1, inversify_1.inject(httpApi_1.httpTYPES.ApiClient)),
tslib_1.__metadata("design:paramtypes", [__1.CommercePaymentTransactionRoute,
httpApi_1.ApiClient])
], CommercePaymentTransactionClient);
return CommercePaymentTransactionClient;
}());
exports.CommercePaymentTransactionClient = CommercePaymentTransactionClient;
/**
* @copyright (c) 2017 Mono Ltd
* @license MIT
* @author Mono Ltd
* @overview
***Notes:**
- Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- All end-point objects are transformed by the associated route service.
*/