# baasicCommerceRecurringCyclePeriodTypeService

Baasic Commerce Recurring Cycle Period Type Service provides an easy way to consume Baasic Commerce REST API end-points. In order to obtain a needed routes `baasicCommerceRecurringCyclePeriodTypeService` uses `baasicCommerceRecurringCyclePeriodTypeRouteService`.



* * *

### baasicCommerceRecurringCyclePeriodTypeService.create() 

Returns a promise that is resolved once the create commerce action has been performed; this action creates a new commerce resource.


**Example**:
```js
baasicCommerceRecurringCyclePeriodTypeService.create({  
  name : '<name>',
  abrv: '<abbreviation>',
  description: '<description>',
  monthFactor: '<month-factor'>
})
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceRecurringCyclePeriodTypeService.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
baasicCommerceRecurringCyclePeriodTypeService.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
});    
```


### baasicCommerceRecurringCyclePeriodTypeService.get() 

Returns a promise that is resolved once the get action has been performed. Success response returns the commerce resource.


**Example**:
```js
baasicCommerceRecurringCyclePeriodTypeService.get('<recurring-cycle-period-type-id>')
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceRecurringCyclePeriodTypeService.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 `baasicCommerceRecurringCyclePeriodTypeRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commerceRecurringPeriodType);
var uri = params['model'].links('put').href;
```


**Example**:
```js
// commerceRecurringPeriodType is a resource previously fetched using get action.
commerceRecurringPeriodType.description = '<description>';
baasicCommerceRecurringCyclePeriodTypeService.update(commerceRecurringPeriodType)
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceRecurringCyclePeriodTypeService.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 `baasicCommerceRecurringCyclePeriodTypeRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commerceRecurringPeriodType);
var uri = params['model'].links('delete').href;
```


**Example**:
```js
// commerceRecurringPeriodType is a resource previously fetched using get action.				 
baasicCommerceRecurringCyclePeriodTypeService.remove(commerceRecurringPeriodType)
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});		
```


### baasicCommerceRecurringCyclePeriodTypeService.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
baasicCommerceRecurringCyclePeriodTypeService.batch.create([{  
  name : '<name>',
  abrv: '<abbreviation>',
  description: '<description>',
  monthFactor: '<month-factor'>
}])
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceRecurringCyclePeriodTypeService.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
baasicCommerceRecurringCyclePeriodTypeService.batch.remove(commerceRecurringPeriodTypeIds)
  .success(function (data) {
    // perform success action here
  })
  .error(function (response, status, headers, config) {
    // perform error handling here
  });		
```


### baasicCommerceRecurringCyclePeriodTypeService.batch.update() 

Returns a promise that is resolved once the update commerce action has been performed; this action updates specified commerce resources.


**Example**:
```js
baasicCommerceRecurringCyclePeriodTypeService.batch.update(commerceRecurringPeriodTypes)
  .success(function (data) {
    // perform success action here
  })
  .error(function (response, status, headers, config) {
    // perform error handling here
  });
```


### baasicCommerceRecurringCyclePeriodTypeService.routeService() 

Provides direct access to `routeService`.


**Example**:
```js
baasicCommerceRecurringCyclePeriodTypeService.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