baasic-sdk-angularjs
Version:
AngularJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
194 lines (137 loc) • 6 kB
Markdown
# baasicCommercePaymentTransactionStatusService
Baasic Commerce PaymentTransactionStatus Service provides an easy way to consume Baasic Commerce REST API end-points. In order to obtain a needed routes `baasicCommercePaymentTransactionStatusService` uses `baasicCommercePaymentTransactionStatusRouteService`.
* * *
### baasicCommercePaymentTransactionStatusService.find()
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.
**Example**:
```js
baasicCommercePaymentTransactionStatusService.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>'
})
.success(function (collection) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.get()
Returns a promise that is resolved once the get action has been performed. Success response returns the commerce resource.
**Example**:
```js
baasicCommercePaymentTransactionStatusService.get()
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.create()
Returns a promise that is resolved once the create commerce action has been performed; this action creates a new commerce resource.
**Example**:
```js
baasicCommercePaymentTransactionStatusService.create({
name : '<name>',
abrv: '<abbreviation>',
description: '<description>'
})
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.update()
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 `baasicCommercePaymentTransactionStatusRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commercePaymentTransactionStatus);
var uri = params['model'].links('put').href;
```
**Example**:
```js
// commercePaymentTransactionStatus is a resource previously fetched using get action.
commercePaymentTransactionStatus.description = '<description>';
baasicCommercePaymentTransactionStatusService.update(commercePaymentTransactionStatus)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.remove()
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 `baasicCommercePaymentTransactionStatusRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commercePaymentTransactionStatus);
var uri = params['model'].links('delete').href;
```
**Example**:
```js
// commercePaymentTransactionStatus is a resource previously fetched using get action.
baasicCommercePaymentTransactionStatusService.remove(commercePaymentTransactionStatus)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.batch.create()
Returns a promise that is resolved once the create commerce action has been performed; this action creates a new commerce resources.
**Example**:
```js
baasicCommercePaymentTransactionStatusService.batch.create([{
name : '<name>',
abrv: '<abbreviation>',
description: '<description>'
}])
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.batch.remove()
Returns a promise that is resolved once the remove commerce action has been performed. This action will remove commerce resources from the system if successfully completed.
**Example**:
```js
baasicCommercePaymentTransactionStatusService.batch.remove(commercePaymentTransactionStatusIds)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.batch.update()
Returns a promise that is resolved once the update commerce action has been performed; this action updates specified commerce resources.
**Example**:
```js
baasicCommercePaymentTransactionStatusService.batch.update(commercePaymentTransactionStatuses)
.success(function (data) {
// perform success action here
})
.error(function (response, status, headers, config) {
// perform error handling here
});
```
### baasicCommercePaymentTransactionStatusService.routeService()
Provides direct access to `routeService`.
**Example**:
```js
baasicCommercePaymentTransactionStatusService.routeService.get(expandObject);
```
* * *
**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.
*(c) 2017 Mono Ltd*
**Author:** Mono Ltd
**License:** MIT